orangeqs.juice.schemas.ipython

IPython related schemas.

Module Contents

Classes

IPythonKernelConfigs	Configurations for IPython kernels of all services.
KernelConnectionInfo	IPython kernel connection of a single service.
KernelConnectionRegistry	Registry of IPython kernel connection information for all services.

API

class orangeqs.juice.schemas.ipython.IPythonKernelConfigs(/, **data: Any)

Bases: orangeqs.juice.settings.Configurable

Configurations for IPython kernels of all services.

IPython kernels in OrangeQS Juice services use the default configuration of IPython if not configured here. This means that the kernel will use a random key and ports by default.

This configuration allows to override the default IPython configuration.

filename: ClassVar[str]

‘ipykernel’

services: dict[str, KernelConnectionInfo]

‘Field(…)’

IPython kernel configuration for all services.

class orangeqs.juice.schemas.ipython.KernelConnectionInfo(/, **data: Any)

Bases: pydantic.BaseModel

IPython kernel connection of a single service.

This schema is compatible with the connection info used by IPython, for example jupyter_client.client.KernelClient.load_connection_info().

shell_port: orangeqs.juice.schemas.common.PortNumber | None

None

IPython shell port.

iopub_port: orangeqs.juice.schemas.common.PortNumber | None

None

IPython IOPub port.

stdin_port: orangeqs.juice.schemas.common.PortNumber | None

None

IPython standard input port.

control_port: orangeqs.juice.schemas.common.PortNumber | None

None

IPython control port.

hb_port: orangeqs.juice.schemas.common.PortNumber | None

None

IPython heartbeat port.

key: str | None

None

Communication secret key.

ip: str | None

None

IP address service listens, or the hostname that will resolve to IP address.

transport: Literal[tcp, ipc] | None

None

IPython transport.

signature_scheme: str | None

None

IPython communication signature scheme.

class orangeqs.juice.schemas.ipython.KernelConnectionRegistry(/, **data: Any)

Bases: orangeqs.juice.settings.RuntimeData

Registry of IPython kernel connection information for all services.

IPython services store their connection information in this registry on start. IPython clients use this registry to load the connection information for the service they want to connect to. The registry is stored in the shared runtime data directory

filename: ClassVar[str]

‘ipykernel-connection’

services: dict[str, orangeqs.juice.schemas.ipython.KernelConnectionInfo]

‘Field(…)’

Kernel connection information for all services.