bundles / jupyter_client 8.10.0 / jupyter_client / client / KernelClient
MetaHasTraits
jupyter_client.client:KernelClient
source: /jupyter_client/client.py:77
Signature
def KernelClient(**kwargs: t.Any) → NoneMembers
__annotate____del___async_execute_interactive_async_get_control_msg_async_get_iopub_msg_async_get_shell_msg_async_get_stdin_msg_async_is_alive_async_recv_reply_async_wait_for_ready_context_default_handle_kernel_info_reply_output_hook_default_output_hook_kernel_stdin_hook_defaultcomm_infocompleteexecutehistoryinputinspectis_completekernel_infoshutdownstart_channelsstop_channels
Summary
Communicates with a single kernel on any host via zmq channels.
Extended Summary
There are five channels associated with each kernel:
shell: for request/reply calls to the kernel.
iopub: for the kernel to publish results to frontends.
hb: for monitoring the kernel's heartbeat.
stdin: for frontends to reply to raw_input calls in the kernel.
control: for kernel management calls to the kernel.
The messages that can be sent on these channels are exposed as methods of the client (KernelClient.execute, complete, history, etc.). These methods only send the message, they don't wait for a reply. To get results, use e.g. get_shell_msg to fetch messages from the shell channel.
Aliases
jupyter_client.KernelClient