brk-code

jupyterlab_server の API リファレンス

jupyterlab_server (jupyterlab/jupyterlab_server) の公開 API 69 件 —— クラス 18、関数 15、メソッド 36。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: jupyterlab/jupyterlab_server

種別件数
クラス18
関数15
メソッド36

API 一覧

classjupyterlab_server.app.LabServerApp
A Lab Server Application that runs out-of-the-box
methodjupyterlab_server.app.LabServerApp.initialize_handlers() -> None
Initialize handlers.
methodjupyterlab_server.app.LabServerApp.initialize_templates() -> None
Initialize templates.
classjupyterlab_server.config.LabConfig
The lab application configuration object.
funcjupyterlab_server.config.get_allowed_levels() -> list[str]
Returns the levels where configs can be stored.
funcjupyterlab_server.config.get_federated_extensions(labextensions_path:list[str]) -> dict[str, Any]
Get the metadata about federated extensions
funcjupyterlab_server.config.get_package_url(data:dict[str, Any]) -> str
Get the url from the extension data
funcjupyterlab_server.config.load_config(path:str) -> Any
Load either a json5 or a json config file.
funcjupyterlab_server.config.write_page_config(page_config:dict[str, Any], level:str='all') -> None
Write page config to disk
classjupyterlab_server.handlers.LabHandler
Render the JupyterLab View.
methodjupyterlab_server.handlers.LabHandler.get(mode:str | None=None, workspace:str | None=None, tree:str | None=None) -> None
Get the JupyterLab html page.
methodjupyterlab_server.handlers.LabHandler.get_page_config() -> dict[str, Any]
Construct the page config object
classjupyterlab_server.handlers.NotFoundHandler
A handler for page not found.
methodjupyterlab_server.handlers.NotFoundHandler.get_page_config() -> dict[str, Any]
Get the page config.
funcjupyterlab_server.handlers.add_handlers(handlers:list[Any], extension_app:LabServerApp) -> None
Add the appropriate handlers to the web app.
funcjupyterlab_server.handlers.is_url(url:str) -> bool
Test whether a string is a full url (e.g.
classjupyterlab_server.licenses_app.LicensesApp
A license management app.
methodjupyterlab_server.licenses_app.LicensesApp.init_licenses_manager() -> None
Initialize the license manager.
methodjupyterlab_server.licenses_app.LicensesApp.initialize(*args:Any, **kwargs:Any) -> None
Initialize the app.
methodjupyterlab_server.licenses_app.LicensesApp.start() -> None
Start the app.
classjupyterlab_server.listings_handler.ListingsHandler
An handler that returns the listings specs.
methodjupyterlab_server.listings_handler.ListingsHandler.get(path:str) -> None
Get the listings for the extension manager.
funcjupyterlab_server.listings_handler.fetch_listings(logger:Logger | None) -> None
Fetch the listings for the extension manager.
classjupyterlab_server.process.Process
A wrapper for a child process.
methodjupyterlab_server.process.Process.get_log() -> Logger
Get our logger.
methodjupyterlab_server.process.Process.terminate() -> int
Terminate the process and return the exit code.
methodjupyterlab_server.process.Process.wait() -> int
Wait for the process to finish.
methodjupyterlab_server.process.Process.wait_async() -> Any
Asynchronously wait for the process to finish.
classjupyterlab_server.process.WatchHelper
A process helper for a watch process.
methodjupyterlab_server.process.WatchHelper.terminate() -> int
Terminate the process.
funcjupyterlab_server.process.list2cmdline(cmd_list:list[str]) -> str
Shim for list2cmdline on posix.
funcjupyterlab_server.process.which(command:str, env:dict[str, str] | None=None) -> str
Get the full path to a command.
classjupyterlab_server.settings_handler.SettingsHandler
A settings API handler.
methodjupyterlab_server.settings_handler.SettingsHandler.initialize(name:str, app_settings_dir:str, schemas_dir:str, settings_dir:str, labextensions_path:list[str], overrides:dict[str, Any] | None=None, **kwargs:Any) -> None
Initialize the handler.
methodjupyterlab_server.settings_handler.SettingsHandler.put(schema_name:str) -> None
Update a setting
classjupyterlab_server.settings_utils.SchemaHandler
Base handler for handler requiring access to settings.
methodjupyterlab_server.settings_utils.SchemaHandler.initialize(app_settings_dir:str, schemas_dir:str, settings_dir:str, labextensions_path:list[str] | None, overrides:dict[str, Any] | None=None, **kwargs:Any) -> None
Initialize the handler.
funcjupyterlab_server.settings_utils.get_settings(app_settings_dir:str, schemas_dir:str, settings_dir:str, schema_name:str='', overrides:dict[str, Any] | None=None, labextensions_path:list[str] | None=None, translator:Any=None, ids_only:bool=False) -> tuple[dict[str, Any], list[Any]]
Get settings.
funcjupyterlab_server.spec.get_openapi_spec() -> Spec
Get the OpenAPI spec object.
funcjupyterlab_server.spec.get_openapi_spec_dict() -> dict[str, typing.Any]
Get the OpenAPI spec as a dictionary.
classjupyterlab_server.themes_handler.ThemesHandler
A file handler that mangles local urls in CSS files.
funcjupyterlab_server.themes_handler.ThemesHandler.replacer(m:Any) -> Any
Replace the matched relative url with the mangled url.
funcjupyterlab_server.translation_utils.is_valid_locale(locale_:str) -> bool
Check if a `locale_` value is valid.
classjupyterlab_server.translation_utils.translator
Translations manager.
methodjupyterlab_server.translation_utils.translator.load(domain:str) -> TranslationBundle
Load translation domain.
methodjupyterlab_server.translation_utils.translator.normalize_domain(domain:str) -> str
Normalize a domain name.
methodjupyterlab_server.translation_utils.translator.set_locale(locale_:str) -> None
Set locale for the translation bundles based on the settings.
methodjupyterlab_server.translation_utils.translator.translate_schema(schema:dict) -> dict
Translate a schema.
classjupyterlab_server.translations_handler.TranslationsHandler
An API handler for translations.
methodjupyterlab_server.translations_handler.TranslationsHandler.get(locale:str | None=None) -> None
Get installed language packs.
classjupyterlab_server.workspaces_app.WorkspaceExportApp
A workspace export app.
methodjupyterlab_server.workspaces_app.WorkspaceExportApp.initialize(*args:Any, **kwargs:Any) -> None
Initialize the app.
methodjupyterlab_server.workspaces_app.WorkspaceExportApp.start() -> None
Start the app.
classjupyterlab_server.workspaces_app.WorkspaceImportApp
A workspace import app.
methodjupyterlab_server.workspaces_app.WorkspaceImportApp.initialize(*args:Any, **kwargs:Any) -> None
Initialize the app.
methodjupyterlab_server.workspaces_app.WorkspaceImportApp.start() -> None
Start the app.
classjupyterlab_server.workspaces_app.WorkspaceListApp
An app to list workspaces.
methodjupyterlab_server.workspaces_app.WorkspaceListApp.initialize(*args:Any, **kwargs:Any) -> None
Initialize the app.
methodjupyterlab_server.workspaces_app.WorkspaceListApp.start() -> None
Start the app.
classjupyterlab_server.workspaces_handler.WorkspacesHandler
A workspaces API handler.
methodjupyterlab_server.workspaces_handler.WorkspacesHandler.delete(space_name:str) -> None
Remove a workspace
methodjupyterlab_server.workspaces_handler.WorkspacesHandler.get(space_name:str='') -> Any
Get workspace(s) data
methodjupyterlab_server.workspaces_handler.WorkspacesHandler.initialize(name:str, manager:WorkspacesManager, **kwargs:Any) -> None
Initialize the handler.
methodjupyterlab_server.workspaces_handler.WorkspacesHandler.put(space_name:str='') -> None
Update workspace data
classjupyterlab_server.workspaces_handler.WorkspacesManager
A manager for workspaces.
methodjupyterlab_server.workspaces_handler.WorkspacesManager.delete(space_name:str) -> None
Remove a workspace ``space_name``.
methodjupyterlab_server.workspaces_handler.WorkspacesManager.list_workspaces() -> list
List all available workspaces.
methodjupyterlab_server.workspaces_handler.WorkspacesManager.load(space_name:str) -> dict
Load the workspace ``space_name``.
methodjupyterlab_server.workspaces_handler.WorkspacesManager.save(space_name:str, raw:str) -> Path
Save the ``raw`` data as workspace ``space_name``.

この情報について

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

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