brk-code

jupyter_server の API リファレンス

jupyter_server (jupyter-server/jupyter_server) の公開 API 197 件 —— クラス 70、関数 20、メソッド 107。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: jupyter-server/jupyter_server

種別件数
クラス70
関数20
メソッド107

API 一覧

classjupyter_server._tz.tzUTC
tzinfo object for UTC (zero offset)
methodjupyter_server._tz.tzUTC.dst(d:datetime | None) -> timedelta
Compute dst.
methodjupyter_server._tz.tzUTC.utcoffset(d:datetime | None) -> timedelta
Compute utcoffset.
funcjupyter_server._tz.utcnow() -> datetime
Return timezone-aware UTC timestamp
funcjupyter_server.auth.__main__.main(argv)
The main cli handler.
funcjupyter_server.auth.__main__.set_password(args)
Set a password.
methodjupyter_server.auth.identity.IdentityProvider.auth_enabled()
Is authentication enabled?
methodjupyter_server.auth.identity.IdentityProvider.check_update(user_data:dict[UpdatableField, str]) -> None
Raises if some fields to update are not updatable.
methodjupyter_server.auth.identity.IdentityProvider.generate_anonymous_user(handler:web.RequestHandler) -> User
Generate a random anonymous user.
methodjupyter_server.auth.identity.IdentityProvider.identity_model(user:User) -> dict[str, t.Any]
Return a User as an Identity model
methodjupyter_server.auth.identity.IdentityProvider.is_token_authenticated(handler:web.RequestHandler) -> bool
Returns True if handler has been token authenticated.
methodjupyter_server.auth.identity.IdentityProvider.persist_user_model(handler:web.RequestHandler) -> None
Persist the user model (i.e.
methodjupyter_server.auth.identity.IdentityProvider.should_check_origin(handler:web.RequestHandler) -> bool
Should the Handler check for CORS origin validation?
methodjupyter_server.auth.identity.IdentityProvider.update_user_model(current_user:User, user_data:dict[UpdatableField, str]) -> User
Update user information.
methodjupyter_server.auth.identity.IdentityProvider.user_from_cookie(cookie_value:str) -> User | None
Inverse of user_to_cookie
methodjupyter_server.auth.identity.IdentityProvider.validate_security(app:t.Any, ssl_options:dict[str, t.Any] | None=None) -> None
Check the application's security.
classjupyter_server.auth.identity.PasswordIdentityProvider
A password identity provider.
methodjupyter_server.auth.identity.PasswordIdentityProvider.auth_enabled() -> bool
Return whether any auth is enabled
methodjupyter_server.auth.identity.PasswordIdentityProvider.cookie_secret_hook(h:hmac.HMAC) -> hmac.HMAC
Include password in cookie secret.
methodjupyter_server.auth.identity.PasswordIdentityProvider.persist_user_model(handler:web.RequestHandler) -> None
Persist the user model to a cookie.
methodjupyter_server.auth.identity.PasswordIdentityProvider.update_user_model(current_user:User, user_data:dict[UpdatableField, str]) -> User
Update user information.
methodjupyter_server.auth.identity.PasswordIdentityProvider.validate_security(app:t.Any, ssl_options:dict[str, t.Any] | None=None) -> None
Handle security validation.
classjupyter_server.auth.logout.LogoutHandler
An auth logout handler.
methodjupyter_server.auth.logout.LogoutHandler.get()
Handle a logout.
funcjupyter_server.auth.utils.get_anonymous_username() -> str
Get a random user-name based on the moons of Jupyter.
funcjupyter_server.auth.utils.warn_disabled_authorization()
DEPRECATED, does nothing
classjupyter_server.base.handlers.APIHandler
Base class for API handlers
methodjupyter_server.base.handlers.APIHandler.finish(*args:Any, **kwargs:Any) -> Future[Any]
Finish an API response.
methodjupyter_server.base.handlers.APIHandler.get_login_url() -> str
Get the login url.
methodjupyter_server.base.handlers.APIHandler.options(*args:Any, **kwargs:Any) -> None
Get the options.
methodjupyter_server.base.handlers.APIHandler.prepare() -> None
Prepare an API response.
methodjupyter_server.base.handlers.APIHandler.update_api_activity() -> None
Update last_activity of API requests
methodjupyter_server.base.handlers.APIHandler.write_error(status_code:int, **kwargs:Any) -> None
APIHandler errors are JSON, not human pages
classjupyter_server.base.handlers.APIVersionHandler
An API handler for the server version.
methodjupyter_server.base.handlers.APIVersionHandler.get() -> None
Get the server version info.
classjupyter_server.base.handlers.AuthenticatedHandler
A RequestHandler with an authenticated user.
methodjupyter_server.base.handlers.AuthenticatedHandler.clear_login_cookie() -> None
Clear a login cookie.
methodjupyter_server.base.handlers.AuthenticatedHandler.force_clear_cookie(name:str, path:str='/', domain:str | None=None) -> None
Force a cookie clear.
methodjupyter_server.base.handlers.AuthenticatedHandler.get_current_user() -> str
Get the current user.
methodjupyter_server.base.handlers.AuthenticatedHandler.logged_in() -> bool
Is a user currently logged in?
methodjupyter_server.base.handlers.AuthenticatedHandler.login_available() -> bool
May a user proceed to log in?
methodjupyter_server.base.handlers.AuthenticatedHandler.set_default_headers() -> None
Set the default headers.
methodjupyter_server.base.handlers.AuthenticatedHandler.token_authenticated() -> bool
Have I been authenticated with a token?
classjupyter_server.base.handlers.MainHandler
Simple handler for base_url.
methodjupyter_server.base.handlers.MainHandler.get() -> None
Get the main template.
classjupyter_server.base.handlers.PrometheusMetricsHandler
Return prometheus metrics for this server
methodjupyter_server.base.handlers.PrometheusMetricsHandler.get() -> None
Get prometheus metrics.
classjupyter_server.base.handlers.Template404
Render our 404 template
methodjupyter_server.base.handlers.Template404.prepare() -> None
Prepare a 404 response.
funcjupyter_server.base.handlers.json_errors(method:Any) -> Any
Decorate methods with this to return GitHub style JSON errors.
funcjupyter_server.base.handlers.json_sys_info()
Get sys info as json.
funcjupyter_server.base.handlers.log() -> Logger
Get the application log.
classjupyter_server.base.websocket.WebSocketMixin
Mixin for common websocket options
methodjupyter_server.base.websocket.WebSocketMixin.check_origin(origin:str | None=None) -> bool
Check Origin == Host or Access-Control-Allow-Origin.
methodjupyter_server.base.websocket.WebSocketMixin.on_pong(data)
Handle a pong message.
methodjupyter_server.base.websocket.WebSocketMixin.open(*args, **kwargs)
Open the websocket.
methodjupyter_server.base.websocket.WebSocketMixin.prepare(*args, **kwargs)
Handle a get request.
funcjupyter_server.config_manager.recursive_update(target:StrDict, new:StrDict) -> None
Recursively update one dictionary using another.
classjupyter_server.extension.handler.ExtensionHandlerMixin
Base class for Jupyter server extension handlers.
methodjupyter_server.extension.manager.ExtensionPackage.link_point(point_name, serverapp)
Link an extension point.
methodjupyter_server.extension.manager.ExtensionPackage.load_point(point_name, serverapp)
Load an extension point.
methodjupyter_server.extension.manager.ExtensionPackage.start_point(point_name, serverapp)
Load an extension point.
classjupyter_server.extension.serverextension.BaseExtensionApp
Base extension installer app
classjupyter_server.extension.serverextension.DisableServerExtensionApp
An App that disables Server Extensions
classjupyter_server.extension.serverextension.ServerExtensionApp
Root level server extension app
methodjupyter_server.extension.serverextension.ServerExtensionApp.start() -> None
Perform the App's actions as configured
classjupyter_server.extension.serverextension.ToggleServerExtensionApp
A base class for enabling/disabling extensions
methodjupyter_server.extension.serverextension.ToggleServerExtensionApp.start() -> None
Perform the App's actions as configured
methodjupyter_server.extension.serverextension.ToggleServerExtensionApp.toggle_server_extension(import_name:str) -> None
Change the status of a named server extension.
classjupyter_server.extension.utils.ExtensionLoadingError
An extension loading error.
classjupyter_server.extension.utils.ExtensionMetadataError
An extension metadata error.
classjupyter_server.extension.utils.ExtensionModuleNotFound
An extension module not found error.
classjupyter_server.extension.utils.NotAnExtensionApp
An error raised when a module is not an extension.
classjupyter_server.gateway.gateway_client.GatewayClient
This class manages the configuration.
methodjupyter_server.gateway.gateway_client.GatewayClient.update_cookies(headers:HTTPHeaders) -> None
Update cookies from response headers
classjupyter_server.gateway.handlers.WebSocketChannelsHandler
Gateway web socket channels handler.
methodjupyter_server.gateway.handlers.WebSocketChannelsHandler.get(kernel_id, *args, **kwargs)
Get the socket.
methodjupyter_server.gateway.handlers.WebSocketChannelsHandler.initialize()
Initialize the socket.
methodjupyter_server.gateway.handlers.WebSocketChannelsHandler.on_close()
Handle a closing socket.
classjupyter_server.gateway.managers.ChannelQueue
A queue for a named channel.
methodjupyter_server.gateway.managers.ChannelQueue.get_msg(*args:Any, **kwargs:Any) -> dict[str, Any]
Get a message from the queue.
methodjupyter_server.gateway.managers.ChannelQueue.is_alive() -> bool
Whether the queue is alive.
methodjupyter_server.gateway.managers.ChannelQueue.send(msg:dict[str, Any]) -> None
Send a message to the queue.
methodjupyter_server.gateway.managers.ChannelQueue.start() -> None
Start the queue.
methodjupyter_server.gateway.managers.ChannelQueue.stop() -> None
Stop the queue.
classjupyter_server.gateway.managers.GatewayKernelSpecManager
A gateway kernel spec manager.
classjupyter_server.gateway.managers.GatewaySessionManager
A gateway session manager.
classjupyter_server.gateway.managers.HBChannelQueue
A queue for the heartbeat channel.
methodjupyter_server.gateway.managers.HBChannelQueue.is_beating() -> bool
Whether the channel is beating.
classjupyter_server.kernelspecs.handlers.KernelSpecResourceHandler
A Kernelspec resource handler.
methodjupyter_server.kernelspecs.handlers.KernelSpecResourceHandler.get(kernel_name:str, path:str, include_body:bool=True)
Get a kernelspec resource.
methodjupyter_server.kernelspecs.handlers.KernelSpecResourceHandler.head(kernel_name:str, path:str) -> None
Get the head info for a kernel resource.
methodjupyter_server.kernelspecs.handlers.KernelSpecResourceHandler.initialize() -> None
Initialize a kernelspec resource handler.
classjupyter_server.nbconvert.handlers.NbconvertFileHandler
An nbconvert file handler.
classjupyter_server.nbconvert.handlers.NbconvertPostHandler
An nbconvert post handler.
classjupyter_server.serverapp.JupyterPasswordApp
Set a password for the Jupyter server.
methodjupyter_server.serverapp.JupyterPasswordApp.start()
Start the password app.
classjupyter_server.serverapp.JupyterServerListApp
An application to list running Jupyter servers.
classjupyter_server.serverapp.JupyterServerStopApp
An application to stop a Jupyter server.
methodjupyter_server.serverapp.JupyterServerStopApp.parse_command_line(argv=None)
Parse command line options.
methodjupyter_server.serverapp.JupyterServerStopApp.shutdown_server(server)
Shut down a server.
methodjupyter_server.serverapp.JupyterServerStopApp.start()
Start the server stop app.
classjupyter_server.serverapp.ServerApp
The Jupyter Server application class.
methodjupyter_server.serverapp.ServerApp.cleanup_extensions() -> None
Call shutdown hooks in all extensions.
methodjupyter_server.serverapp.ServerApp.cleanup_kernels() -> None
Shutdown all kernels.
methodjupyter_server.serverapp.ServerApp.find_server_extensions() -> None
Searches Jupyter paths for jpserver_extensions.
methodjupyter_server.serverapp.ServerApp.init_configurables() -> None
Initialize configurables.
methodjupyter_server.serverapp.ServerApp.init_event_logger() -> None
Initialize the Event Bus.
methodjupyter_server.serverapp.ServerApp.init_logging() -> None
Initialize logging.
methodjupyter_server.serverapp.ServerApp.init_resources() -> None
initialize system resources
methodjupyter_server.serverapp.ServerApp.init_shutdown_no_activity() -> None
Initialize a shutdown on no activity.
methodjupyter_server.serverapp.ServerApp.init_signal() -> None
Initialize signal handlers.
methodjupyter_server.serverapp.ServerApp.init_webapp() -> None
initialize tornado webapp
methodjupyter_server.serverapp.ServerApp.launch_browser() -> None
Launch the browser.
methodjupyter_server.serverapp.ServerApp.load_server_extensions() -> None
Load any extensions specified by config.
methodjupyter_server.serverapp.ServerApp.parse_command_line(argv:list[str] | None=None) -> None
Parse the command line options.
methodjupyter_server.serverapp.ServerApp.start_app() -> None
Start the Jupyter Server application.
methodjupyter_server.serverapp.ServerApp.start_ioloop() -> None
Start the IO Loop.
methodjupyter_server.serverapp.ServerApp.starter_app() -> t.Any
Get the Extension that started this server.
methodjupyter_server.serverapp.ServerApp.static_file_path() -> list[str]
return extra paths + the default location
methodjupyter_server.serverapp.ServerApp.stop(from_signal:bool=False) -> None
Cleanup resources and stop the server.
methodjupyter_server.serverapp.ServerApp.template_file_path() -> list[str]
return extra paths + the default locations
classjupyter_server.serverapp.ServerWebApplication
A server web application.
funcjupyter_server.serverapp.load_handlers(name:str) -> t.Any
Load the (URL pattern, handler) tuples for each component.
funcjupyter_server.serverapp.random_ports(port:int, n:int) -> t.Generator[int, None, None]
Generate a list of n random ports near the given port.
classjupyter_server.services.api.handlers.APISpecHandler
A spec handler for the REST API.
methodjupyter_server.services.api.handlers.APISpecHandler.get()
Get the API spec.
methodjupyter_server.services.api.handlers.APISpecHandler.get_content_type()
Get the content type.
classjupyter_server.services.api.handlers.APIStatusHandler
An API status handler.
methodjupyter_server.services.api.handlers.APIStatusHandler.get() -> None
Get the API status.
classjupyter_server.services.api.handlers.IdentityHandler
Get or patch the current user's identity model
methodjupyter_server.services.api.handlers.IdentityHandler.get()
Get the identity model.
methodjupyter_server.services.api.handlers.IdentityHandler.patch()
Update user information.
classjupyter_server.services.api.handlers.PathResolverHandler
Path resolver handler.
methodjupyter_server.services.api.handlers.PathResolverHandler.get()
Resolve the path.
classjupyter_server.services.config.handlers.ConfigHandler
A config API handler.
classjupyter_server.services.config.manager.ConfigManager
Config Manager used for storing frontend config
funcjupyter_server.services.contents.fileio.replace_file(src, dst)
replace dst with src
classjupyter_server.services.contents.filemanager.AsyncFileContentsManager
An async file contents manager.
methodjupyter_server.services.contents.filemanager.AsyncFileContentsManager.file_exists(path:str) -> bool
Does a file exist at the given path
methodjupyter_server.services.contents.filemanager.AsyncFileContentsManager.rename_file(old_path, new_path)
Rename a file.
classjupyter_server.services.contents.filemanager.FileContentsManager
A file contents manager.
methodjupyter_server.services.contents.filemanager.FileContentsManager.delete_file(path)
Delete file at path.
methodjupyter_server.services.contents.filemanager.FileContentsManager.rename_file(old_path, new_path)
Rename a file.
methodjupyter_server.services.contents.filemanager.FileContentsManager.resolve_path(path:str) -> str | None
Resolve path relative to root resource.
classjupyter_server.services.contents.handlers.CheckpointsHandler
A checkpoints API handler.
classjupyter_server.services.contents.handlers.ContentsAPIHandler
A contents API handler.
classjupyter_server.services.contents.handlers.ContentsHandler
A contents handler.
classjupyter_server.services.contents.handlers.ModifyCheckpointsHandler
A checkpoints modification handler.
classjupyter_server.services.contents.handlers.NotebooksRedirectHandler
Redirect /api/notebooks to /api/contents
classjupyter_server.services.contents.handlers.TrustNotebooksHandler
Handles trust/signing of notebooks
classjupyter_server.services.contents.largefilemanager.AsyncLargeFileManager
Handle large file upload asynchronously
classjupyter_server.services.contents.largefilemanager.LargeFileManager
Handle large file upload.
classjupyter_server.services.contents.manager.ContentsManager
Base class for serving files and directories.
methodjupyter_server.services.contents.manager.ContentsManager.create_checkpoint(path)
Create a checkpoint.
classjupyter_server.services.events.handlers.EventHandler
REST api handler for events
methodjupyter_server.services.events.handlers.EventHandler.post()
Emit an event.
classjupyter_server.services.events.handlers.SubscribeWebsocket
Websocket handler for subscribing to events
methodjupyter_server.services.events.handlers.SubscribeWebsocket.get(*args, **kwargs)
Get an event socket.
methodjupyter_server.services.events.handlers.SubscribeWebsocket.on_close()
Handle a socket close.
funcjupyter_server.services.events.handlers.get_timestamp(data:dict[str, Any]) -> datetime | None
Parses timestamp from the JSON request body
classjupyter_server.services.kernels.connection.channels.ZMQChannelsWebsocketConnection
A Jupyter Server Websocket Connection
funcjupyter_server.services.kernels.connection.channels.ZMQChannelsWebsocketConnection.cleanup(_=None)
Common cleanup
methodjupyter_server.services.kernels.connection.channels.ZMQChannelsWebsocketConnection.close()
Close the connection.
methodjupyter_server.services.kernels.connection.channels.ZMQChannelsWebsocketConnection.connect() -> asyncio.Future[None] | None
Handle a connection.
methodjupyter_server.services.kernels.connection.channels.ZMQChannelsWebsocketConnection.disconnect()
Handle a disconnect.
classjupyter_server.services.kernels.handlers.KernelActionHandler
A kernel action API handler.
classjupyter_server.services.kernels.handlers.KernelHandler
A kernel API handler.
methodjupyter_server.services.kernels.handlers.KernelHandler.delete(kernel_id)
Remove a kernel.
methodjupyter_server.services.kernels.handlers.KernelHandler.get(kernel_id)
Get a kernel model.
classjupyter_server.services.kernels.handlers.KernelsAPIHandler
A kernels API handler.
classjupyter_server.services.kernels.handlers.MainKernelHandler
The root kernel handler.
methodjupyter_server.services.kernels.handlers.MainKernelHandler.post()
Start a kernel.
classjupyter_server.services.kernels.kernelmanager.AsyncMappingKernelManager
An asynchronous mapping kernel manager.
classjupyter_server.services.kernels.kernelmanager.ServerKernelManager
A server-specific kernel manager.
classjupyter_server.services.kernels.websocket.KernelWebsocketHandler
The kernels websocket should connect
methodjupyter_server.services.kernels.websocket.KernelWebsocketHandler.pre_get()
Handle a pre_get.
classjupyter_server.services.kernelspecs.handlers.KernelSpecHandler
A handler for an individual kernel spec.
classjupyter_server.services.kernelspecs.handlers.KernelSpecsAPIHandler
A kernel spec API handler.
classjupyter_server.services.kernelspecs.handlers.MainKernelSpecHandler
The root kernel spec handler.
classjupyter_server.services.nbconvert.handlers.NbconvertRootHandler
The nbconvert root API handler.
classjupyter_server.services.sessions.handlers.SessionHandler
A handler for a single session.
classjupyter_server.services.sessions.handlers.SessionRootHandler
A Session Root API handler.
methodjupyter_server.services.sessions.handlers.SessionRootHandler.post()
Create a new session.
classjupyter_server.services.sessions.handlers.SessionsAPIHandler
A Sessions API handler.
classjupyter_server.services.sessions.sessionmanager.SessionManager
A session manager.
methodjupyter_server.services.sessions.sessionmanager.SessionManager.new_session_id() -> str
Create a uuid for a new session
classjupyter_server.services.shutdown.ShutdownHandler
A shutdown API handler.
methodjupyter_server.services.shutdown.ShutdownHandler.post()
Shut down the server.
funcjupyter_server.utils.filefind(filename:str, path_dirs:Sequence[str]) -> str
Find a file by looking through a sequence of paths.
funcjupyter_server.utils.import_item(name:str) -> Any
Import and return ``bar`` given the string ``foo.bar``.
funcjupyter_server.utils.path2url(path:str) -> str
Convert a local file path to a URL
funcjupyter_server.utils.url2path(url:str) -> str
Convert a URL to a local file path
funcjupyter_server.utils.url_escape(path:str) -> str
Escape special characters in a URL path Turns '/foo bar/' into '/foo%20bar/'
funcjupyter_server.utils.url_is_absolute(url:str) -> bool
Determine whether a given URL is absolute
classjupyter_server.view.handlers.ViewHandler
Render HTML files within an iframe.
methodjupyter_server.view.handlers.ViewHandler.get(path)
Get a view on a given path.

この情報について

掲載しているシグネチャは jupyter-server/jupyter_server の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る