async_kernel.typing

Classes:

• SocketID –

  Mapping of Kernel.port_<id> for sockets. Ref.

• RunMode –

  An Enum of the kernel run modes available for

• KernelConcurrencyMode –
• MsgType –

  An enumeration of Message msg_type for shell and control messages.

• MetadataKeys –

  This is an enum of keys for metadata in kernel messages

• Tags –

  Tags recognised by the kernel.

• MsgHeader –

  A message header.

• Message –

  A message.

• Job –

  An async_kernel.typing.Message bundled with sockit_id, socket and ident.

async_kernel.typing.SocketID

Bases: StrEnum

Mapping of Kernel.port_<id> for sockets. Ref.

Attributes:

• heartbeat –
• shell –
• stdin –
• control –
• iopub –

heartbeat class-attribute instance-attribute

heartbeat = 'hb'

shell class-attribute instance-attribute

shell = 'shell'

stdin class-attribute instance-attribute

stdin = 'stdin'

control class-attribute instance-attribute

control = 'control'

iopub class-attribute instance-attribute

iopub = 'iopub'

async_kernel.typing.RunMode

Bases: StrEnum

An Enum of the kernel run modes available for altering how message requests are run.

String match options

Each of these options will give a match.

• <value>
• <##value>
• 'RunMode.<value>.

special usage

Run mode can be used in execute requests. Add it at the top line (or use the string equivalent "##") of a code cell.

Methods:

• get_mode –

  Get a RunMode from the code if it is found.

Attributes:

• queue –

  The message for the handler is run sequentially with other messages that are queued.

• task –

  The message for the handler are run concurrently in task (starting immediately).

• thread –

  Messages for the handler are run concurrently in a thread (starting immediately).

• blocking –

  Run the handler directly as soon as it is received.

queue class-attribute instance-attribute

queue = 'queue'

The message for the handler is run sequentially with other messages that are queued.

task class-attribute instance-attribute

task = 'task'

The message for the handler are run concurrently in task (starting immediately).

thread class-attribute instance-attribute

thread = 'thread'

Messages for the handler are run concurrently in a thread (starting immediately).

blocking class-attribute instance-attribute

blocking = 'blocking'

Run the handler directly as soon as it is received.

Warning

This mode blocks the message loop.

Use this for short running messages that should be processed as soon as it is received.

get_mode classmethod

get_mode(code: str) -> RunMode | None

Get a RunMode from the code if it is found.

Source code in src/async_kernel/typing.py

@classmethod
def get_mode(cls, code: str) -> RunMode | None:
    "Get a RunMode from the code if it is found."
    try:
        if (code := code.strip().split("\n")[0].strip()).startswith("##"):
            return RunMode(code.removeprefix("##"))
        if code.startswith("RunMode."):
            return RunMode(code.removeprefix("RunMode."))
    except ValueError:
        return None

async_kernel.typing.KernelConcurrencyMode

Bases: StrEnum

Attributes:

• default –

  The default concurrency mode

• blocking –

  All handlers are run with the blocking.

default class-attribute instance-attribute

default = 'default'

The default concurrency mode

blocking class-attribute instance-attribute

blocking = 'blocking'

All handlers are run with the blocking.

async_kernel.typing.MsgType

Bases: StrEnum

An enumeration of Message msg_type for shell and control messages.

Some message types are on the control channel only.

Attributes:

• kernel_info_request –

  async_kernel.Kernel.kernel_info_request

• comm_info_request –

  async_kernel.Kernel.comm_info_request

• execute_request –

  async_kernel.Kernel.execute_request

• complete_request –

  async_kernel.Kernel.complete_request

• is_complete_request –

  async_kernel.Kernel.is_complete_request

• inspect_request –

  async_kernel.Kernel.inspect_request

• history_request –

  async_kernel.Kernel.history_request

• comm_open –

  async_kernel.Kernel.comm_open

• comm_msg –

  async_kernel.Kernel.comm_msg

• comm_close –

  async_kernel.Kernel.comm_close

• interrupt_request –

  async_kernel.Kernel.interrupt_request (control channel only)

• shutdown_request –

  async_kernel.Kernel.shutdown_request (control channel only)

• debug_request –

  async_kernel.Kernel.debug_request (control channel only)

kernel_info_request class-attribute instance-attribute

kernel_info_request = 'kernel_info_request'

async_kernel.Kernel.kernel_info_request

comm_info_request class-attribute instance-attribute

comm_info_request = 'comm_info_request'

async_kernel.Kernel.comm_info_request

execute_request class-attribute instance-attribute

execute_request = 'execute_request'

async_kernel.Kernel.execute_request

complete_request class-attribute instance-attribute

complete_request = 'complete_request'

async_kernel.Kernel.complete_request

is_complete_request class-attribute instance-attribute

is_complete_request = 'is_complete_request'

async_kernel.Kernel.is_complete_request

inspect_request class-attribute instance-attribute

inspect_request = 'inspect_request'

async_kernel.Kernel.inspect_request

history_request class-attribute instance-attribute

history_request = 'history_request'

async_kernel.Kernel.history_request

comm_open class-attribute instance-attribute

comm_open = 'comm_open'

async_kernel.Kernel.comm_open

comm_msg class-attribute instance-attribute

comm_msg = 'comm_msg'

async_kernel.Kernel.comm_msg

comm_close class-attribute instance-attribute

comm_close = 'comm_close'

async_kernel.Kernel.comm_close

interrupt_request class-attribute instance-attribute

interrupt_request = 'interrupt_request'

async_kernel.Kernel.interrupt_request (control channel only)

shutdown_request class-attribute instance-attribute

shutdown_request = 'shutdown_request'

async_kernel.Kernel.shutdown_request (control channel only)

debug_request class-attribute instance-attribute

debug_request = 'debug_request'

async_kernel.Kernel.debug_request (control channel only)

async_kernel.typing.MetadataKeys

Bases: StrEnum

This is an enum of keys for metadata in kernel messages that are used in async_kernel.

Note

Metadata can be edited in Jupyter lab "Advanced tools" and Tags can be added using "common tools" in the right side bar.

Attributes:

• tags –

  The tags metadata key corresponds to is a list of strings.

• timeout –

  The timeout metadata key is used to specify a timeout for execution of the code.

• suppress_error_message –

  A message to print when the error has been suppressed using async_kernel.typing.Tags.suppress_error.

tags class-attribute instance-attribute

tags = 'tags'

The tags metadata key corresponds to is a list of strings.

The list can be edited by the user in a notebook. see also: Tags.

timeout class-attribute instance-attribute

timeout = 'timeout'

The timeout metadata key is used to specify a timeout for execution of the code.

The value should be a floating point value of the timeout in seconds.

suppress_error_message class-attribute instance-attribute

suppress_error_message = 'suppress-error-message'

A message to print when the error has been suppressed using async_kernel.typing.Tags.suppress_error.

Note

The default message is '⚠'.

async_kernel.typing.Tags

Bases: StrEnum

Tags recognised by the kernel.

Info

Tags are can be added per cell.

• Jupyter: via the right side bar.
• VScode: via Jupyter variables explorer/

Attributes:

• suppress_error –

  Suppress exceptions that occur during execution of the code cell.

suppress_error class-attribute instance-attribute

suppress_error = 'suppress-error'

Suppress exceptions that occur during execution of the code cell.

Warning

The code block will return as 'ok' and there will be no message recorded.

async_kernel.typing.MsgHeader

Bases: TypedDict

A message header.

Attributes:

• msg_id (str) –
• session (str) –
• username (str) –
• date (str) –
• msg_type (MsgType) –
• version (str) –

msg_id instance-attribute

msg_id: str

session instance-attribute

session: str

username instance-attribute

username: str

date instance-attribute

date: str

msg_type instance-attribute

msg_type: MsgType

version instance-attribute

version: str

async_kernel.typing.Message

Bases: TypedDict, Generic[T]

A message.

Attributes:

• header (MsgHeader) –

  ref

• parent_header (MsgHeader) –

  ref

• metadata (Mapping[MetadataKeys | str, Any]) –

  ref

• content (T | Content) –

  ref

• buffers (list[bytearray | bytes]) –

header instance-attribute

header: MsgHeader

ref

parent_header instance-attribute

parent_header: MsgHeader

ref

metadata instance-attribute

metadata: Mapping[MetadataKeys | str, Any]

ref

content instance-attribute

content: T | Content

ref

See also:

• ExecuteContent

buffers instance-attribute

buffers: list[bytearray | bytes]

async_kernel.typing.Job

Bases: TypedDict, Generic[T]

An async_kernel.typing.Message bundled with sockit_id, socket and ident.

Attributes:

• msg (Message[T]) –
• socket_id (Literal[control, shell]) –
• socket (Socket) –
• ident (bytes | list[bytes]) –
• received_time (float) –

  The time the message was received.

• run_mode (RunMode) –

  The run mode.

msg instance-attribute

msg: Message[T]

socket_id instance-attribute

socket_id: Literal[control, shell]

socket instance-attribute

socket: Socket

ident instance-attribute

ident: bytes | list[bytes]

received_time instance-attribute

received_time: float

The time the message was received.

run_mode instance-attribute

run_mode: RunMode

The run mode.

async_kernel.typing.ExecuteContent

Bases: TypedDict

Ref. see also: Message

Attributes:

• code (str) –

  The code to execute.

• silent (bool) –
• store_history (bool) –
• user_expressions (dict[str, str]) –
• allow_stdin (bool) –
• stop_on_error (bool) –

code instance-attribute

code: str

The code to execute.

silent instance-attribute

silent: bool

store_history instance-attribute

store_history: bool

user_expressions instance-attribute

user_expressions: dict[str, str]

allow_stdin instance-attribute

allow_stdin: bool

stop_on_error instance-attribute

stop_on_error: bool

async_kernel.typing.CallerStartNewOptions

Bases: TypedDict

Options for async_kernel.caller.Caller.start_new.