jupyter_client
User Documentation
Messaging in Jupyter
Versioning
Introduction
General Message Format
Compatibility
The Wire Protocol
Python API
Messages on the shell (ROUTER/DEALER) channel
Request-Reply
Execute
Execution counter (prompt number)
Execution results
Payloads (DEPRECATED)
Introspection
Completion
History
Code completeness
Connect
Comm info
Kernel info
Kernel shutdown
Messages on the IOPub (PUB/SUB) channel
Streams (stdout, stderr, etc)
Display Data
Update Display Data
Code inputs
Execution results
Execution errors
Kernel status
Clear output
Messages on the stdin (ROUTER/DEALER) channel
Heartbeat for kernels
Custom Messages
Opening a Comm
Comm Messages
Tearing Down Comms
Output Side Effects
To Do
Developer documentation
Making kernels for Jupyter
Connection files
Handling messages
Kernel specs
Making simple Python wrapper kernels
Required steps
Example
Optional steps
API
jupyter_client API
kernelspec - discovering kernels
manager - starting, stopping, signalling
multikernelmanager - controlling multiple kernels
Utility functions
client - communicating with kernels
Changes
Changes in Jupyter Client
5.0
5.0.1
5.0.0
4.4
4.4.0
4.3
4.3.0
4.2
4.2.2
4.2.1
4.2.0
4.1
4.1.0
4.0
jupyter_client
Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
R
|
S
|
T
A
argv (jupyter_client.kernelspec.KernelSpec attribute)
B
banner (MyKernel attribute)
blocking_client() (jupyter_client.KernelManager method)
BlockingKernelClient (class in jupyter_client)
C
client() (jupyter_client.KernelManager method)
comm_info() (jupyter_client.KernelClient method)
complete() (jupyter_client.KernelClient method)
D
display_name (jupyter_client.kernelspec.KernelSpec attribute)
do_complete() (MyKernel method)
do_execute() (MyKernel method)
do_history() (MyKernel method)
do_inspect() (MyKernel method)
do_is_complete() (MyKernel method)
do_shutdown() (MyKernel method)
E
env (jupyter_client.kernelspec.KernelSpec attribute)
environment variable
JUPYTER_PATH
execute() (jupyter_client.KernelClient method)
execute_interactive() (jupyter_client.BlockingKernelClient method)
F
find_kernel_specs() (in module jupyter_client.kernelspec)
(jupyter_client.kernelspec.KernelSpecManager method)
G
get_all_specs() (jupyter_client.kernelspec.KernelSpecManager method)
get_iopub_msg() (jupyter_client.KernelClient method)
get_kernel() (jupyter_client.MultiKernelManager method)
get_kernel_spec() (in module jupyter_client.kernelspec)
(jupyter_client.kernelspec.KernelSpecManager method)
get_shell_msg() (jupyter_client.KernelClient method)
get_stdin_msg() (jupyter_client.KernelClient method)
H
history() (jupyter_client.KernelClient method)
I
implementation (MyKernel attribute)
implementation_version (MyKernel attribute)
input() (jupyter_client.KernelClient method)
inspect() (jupyter_client.KernelClient method)
install_kernel_spec() (in module jupyter_client.kernelspec)
(jupyter_client.kernelspec.KernelSpecManager method)
interrupt_kernel() (jupyter_client.KernelManager method)
is_alive() (jupyter_client.KernelManager method)
is_complete() (jupyter_client.KernelClient method)
J
jupyter_client (module)
jupyter_client.kernelspec (module)
JUPYTER_PATH
K
kernel (jupyter_client.KernelManager attribute)
kernel_name (jupyter_client.KernelManager attribute)
KernelClient (class in jupyter_client)
KernelManager (class in jupyter_client)
KernelSpec (class in jupyter_client.kernelspec)
KernelSpecManager (class in jupyter_client.kernelspec)
L
language (jupyter_client.kernelspec.KernelSpec attribute)
language_info (MyKernel attribute)
list_kernel_ids() (jupyter_client.MultiKernelManager method)
load_connection_file() (jupyter_client.KernelClient method)
load_connection_info() (jupyter_client.KernelClient method)
M
MultiKernelManager (class in jupyter_client)
MyKernel (built-in class)
,
[1]
N
name (jupyter_client.kernelspec.NoSuchKernel attribute)
NoSuchKernel
R
remove_kernel() (jupyter_client.MultiKernelManager method)
resource_dir (jupyter_client.kernelspec.KernelSpec attribute)
restart_kernel() (jupyter_client.KernelManager method)
run_kernel() (in module jupyter_client)
S
send_response() (ipykernel.kernelbase.Kernel method)
shutdown() (jupyter_client.KernelClient method)
shutdown_all() (jupyter_client.MultiKernelManager method)
shutdown_kernel() (jupyter_client.KernelManager method)
signal_kernel() (jupyter_client.KernelManager method)
start_channels() (jupyter_client.KernelClient method)
start_kernel() (jupyter_client.KernelManager method)
(jupyter_client.MultiKernelManager method)
T
to_json() (jupyter_client.kernelspec.KernelSpec method)