| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- """Implements a fully blocking kernel client.
- Useful for test suites and blocking terminal interfaces.
- """
- # Copyright (c) Jupyter Development Team.
- # Distributed under the terms of the Modified BSD License.
- from __future__ import annotations
- import typing as t
- from traitlets import Type
- from ..channels import HBChannel, ZMQSocketChannel
- from ..client import KernelClient, reqrep
- from ..utils import run_sync
- def wrapped(meth: t.Callable, channel: str) -> t.Callable:
- """Wrap a method on a channel and handle replies."""
- def _(self: BlockingKernelClient, *args: t.Any, **kwargs: t.Any) -> t.Any:
- reply = kwargs.pop("reply", False)
- timeout = kwargs.pop("timeout", None)
- msg_id = meth(self, *args, **kwargs)
- if not reply:
- return msg_id
- return self._recv_reply(msg_id, timeout=timeout, channel=channel)
- return _
- class BlockingKernelClient(KernelClient):
- """A KernelClient with blocking APIs
- ``get_[channel]_msg()`` methods wait for and return messages on channels,
- raising :exc:`queue.Empty` if no message arrives within ``timeout`` seconds.
- """
- # --------------------------------------------------------------------------
- # Channel proxy methods
- # --------------------------------------------------------------------------
- get_shell_msg = run_sync(KernelClient._async_get_shell_msg)
- get_iopub_msg = run_sync(KernelClient._async_get_iopub_msg)
- get_stdin_msg = run_sync(KernelClient._async_get_stdin_msg)
- get_control_msg = run_sync(KernelClient._async_get_control_msg)
- wait_for_ready = run_sync(KernelClient._async_wait_for_ready)
- # The classes to use for the various channels
- shell_channel_class = Type(ZMQSocketChannel) # type:ignore[assignment]
- iopub_channel_class = Type(ZMQSocketChannel) # type:ignore[assignment]
- stdin_channel_class = Type(ZMQSocketChannel) # type:ignore[assignment]
- hb_channel_class = Type(HBChannel) # type:ignore[assignment]
- control_channel_class = Type(ZMQSocketChannel) # type:ignore[assignment]
- _recv_reply = run_sync(KernelClient._async_recv_reply)
- # replies come on the shell channel
- execute = reqrep(wrapped, KernelClient.execute)
- history = reqrep(wrapped, KernelClient.history)
- complete = reqrep(wrapped, KernelClient.complete)
- inspect = reqrep(wrapped, KernelClient.inspect)
- kernel_info = reqrep(wrapped, KernelClient.kernel_info)
- comm_info = reqrep(wrapped, KernelClient.comm_info)
- is_alive = run_sync(KernelClient._async_is_alive)
- execute_interactive = run_sync(KernelClient._async_execute_interactive)
- # replies come on the control channel
- shutdown = reqrep(wrapped, KernelClient.shutdown, channel="control")
|
