orangeqs.juice.service._info#

Module Contents#

Functions#

store_service_info

Store OrangeQS Juice service information in the shared runtime data folder.

API#

orangeqs.juice.service._info.store_service_info(service_name: str, *, shell_port: int | None = None, iopub_port: int | None = None, stdin_port: int | None = None, control_port: int | None = None, hb_port: int | None = None, ip: str | None = None, init_module: str | None = None) → None#

Store OrangeQS Juice service information in the shared runtime data folder.

Retrieves information about the currently running service and stores it under the given service name in the shared runtime data folder.

Failures while gathering or storing this information are logged as a warning and do not raise - this should never prevent a service from starting.

Parameters#

  • service_name (str): The name of the currently running service to store information for.

  • shell_port (int, optional): The IPython kernel’s shell port, if known. Defaults to None.

  • iopub_port (int, optional): The IPython kernel’s IOPub port, if known. Defaults to None.

  • stdin_port (int, optional): The IPython kernel’s stdin port, if known. Defaults to None.

  • control_port (int, optional): The IPython kernel’s control port, if known. Defaults to None.

  • hb_port (int, optional): The IPython kernel’s heartbeat port, if known. Defaults to None.

  • ip (str, optional): The IP address or hostname the kernel listens on, if known. Defaults to None.

  • init_module (str, optional): The dotted import path of the init module executed on startup, if any. Defaults to None.