async-kernel 0.12.3

A concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.

Async kernel

Async kernel is a Python Jupyter kernel with concurrent message handling.

Messages are processed fairly whilst preventing asynchronous deadlocks by using a unique message handler per channel, message_type and subshell_id.

Highlights

• Experimental support for Jupyterlite try it online here 👈
• Debugger client
• anyio compatible event loops
  • asyncio (default)
  • trio
• aiologic thread-safe synchronisation primitives
• Easy multi-thread / multi-event loop management
• IPython shell
• Per-subshell user_ns
• GUI event loops [^gui note][^gui caller note]
  • inline
  • ipympl
  • tk with asyncio[^asyncio guest] or trio backend running as a guest
  • qt with asyncio[^asyncio guest] or trio backend running as a guest

[^gui note]: A gui event loop is provided by starting the event loop (host) and then running an asynchronous backend as a guest in the event loop. Kernel messaging is performed as usual in the asynchronous backend. For this reason it is not possible to enable a gui event loop at runtime.

[^gui caller note]: It is also possible to use a caller to run a gui event loop in a separate thread (with a backend running as a guest) if the gui allows it (qt will only run in the main thread). Also note that pyplot will only permit one interactive gui library in a process.

[^asyncio guest]: The asyncio implementation of start_guest_run was written by the author of aiologic and provided as a (gist).

Documentation

Installation

pip install async-kernel

Kernel specs

A kernel spec with the name 'async' is added when async kernel is installed.

Kernel specs can be added/removed via the command line.

The kernel is configured via the interface with the options:

• interface.backend
• interface.backend_options
• interface.loop
• interface.loop_options

Backends

The backend defines the asynchronous library provided in the thread in which it is running.

• asyncio
• trio

Example - change kernel spec to use trio

pip install trio
async-kernel -a async --interface.backend=trio

Gui event loop

The kernel can be started with a gui event loop as the host and the backend running as a guest.

asyncio backend

# tk
async-kernel -a async-tk --interface.loop=tk

# qt
pip install PySide6-Essentials
async-kernel -a async-qt --interface.loop=qt

trio backend

pip install trio
# tk
async-kernel -a async-tk --interface.loop=tk --interface.backend=trio

# qt
pip install PySide6-Essentials
async-kernel -a async-qt --interface.loop=qt --interface.backend=trio

For further detail about kernel spec customisation see command line usage.

Origin

Async kernel started as a fork of IPyKernel. Thank you to the original contributors of IPyKernel that made Async kernel possible.