API reference

rubin.nublado.client Package

Client for Nublado, not including JupyterHub plugins.

Functions

register_mock_jupyter(respx_mock, *[, ...])

Set up a mock JupyterHub and JupyterLab.

Classes

CodeContext([node, image, notebook, cell, ...])	Optional context for exception reporting during code execution.
JupyterAsyncClient(*, discovery_client, ...)	Wrapper around an HTTP client with JupyterHub and JupyterLab support.
JupyterLabSession(*, username, session_id, ...)	Open WebSocket session to a JupyterLab.
JupyterLabSessionManager(*, username, ...[, ...])	Manage JupyterLab sessions.
MockJupyter(base_url, *[, use_subdomains])	A mock Jupyter state machine.
MockJupyterAction(value[, names, module, ...])	Possible actions on the Jupyter lab state machine.
MockJupyterLabSession(kernel_name, name, ...)	Metadata for an open Jupyter lab session.
MockJupyterState(value[, names, module, ...])	Possible states the Jupyter lab can be in.
NotebookExecutionError	An error from the notebook execution extension endpoint.
NotebookExecutionResult	Result from the notebook execution extension endpoint.
NubladoClient(username, token, *[, ...])	Client for talking to JupyterHub and Jupyter labs that use Nublado.
NubladoDiscoveryError(message[, user, ...])	Error finding a required service in service discovery.
NubladoError(message[, user, context, ...])	A Nublado client error.
NubladoExecutionError(user, *[, code, ...])	Error generated by code execution in a notebook on JupyterLab.
NubladoImage	Base class for different ways of specifying the lab image to spawn.
NubladoImageByClass	Spawn the recommended image.
NubladoImageByReference	Spawn an image by full Docker reference.
NubladoImageByTag	Spawn an image by image tag.
NubladoImageClass(value[, names, module, ...])	Possible ways of selecting an image.
NubladoImageSize(value[, names, module, ...])	Acceptable sizes of images to spawn.
NubladoProtocolError(message[, user, ...])	Unexpected response from JupyterHub or JupyterLab.
NubladoRedirectError(message[, user, ...])	Loop or unexpected redirect outside of the Nublado URL space.
NubladoSpawnError(message, log[, user, ...])	Nublado failed to spawn the requested JupyterLab instance.
NubladoTimeoutError(message[, user, ...])	Timed out opening or waiting for WebSocket messages.
NubladoWebError(message[, user, body, ...])	Represents an exception that can be reported to Slack.
NubladoWebError(message[, user, body, ...])	Represents an exception that can be reported to Slack.
NubladoWebSocketError(message, user, *[, ...])	An error occurred talking to the Jupyter lab WebSocket.
SpawnProgressMessage(progress, message, ready)	A progress message from lab spawning.

Class Inheritance Diagram