brk-code

jupyterlab の API リファレンス

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

リポジトリ: jupyterlab/jupyterlab

種別件数
クラス16
関数36
メソッド19

API 一覧

funcclean.resolve_pattern(pat:str) -> list[str]
handle a leading `#` or `@` in a pattern
funcgalata.update_snapshots.sha1(path:Path) -> str
Calculate hashes of all png files in the test/directory
classjupyterlab.browser_check.LogErrorHandler
A handler that exits with 1 on a logged error.
funcjupyterlab.browser_check.run_async_process(cmd:Sequence[str], **kwargs:Any) -> tuple[bytes, bytes]
Run an asynchronous command
funcjupyterlab.browser_check.run_browser(url:str)
Run the browser test and return an exit code.
funcjupyterlab.browser_check.run_browser_sync(url:str) -> int
Run the browser test and return an exit code.
funcjupyterlab.browser_check.run_test_async(app:LabApp, func:BrowserTest)
Run a test against the application.
classjupyterlab.commands.AppOptions
Options object for build system
funcjupyterlab.commands.build_check(app_options:AppOptionsLike=None) -> list[str]
Determine whether JupyterLab should be built.
funcjupyterlab.commands.check_extension(extension:str, installed:bool=False, app_options:AppOptionsLike=None) -> bool
Check if a JupyterLab extension is enabled or disabled.
funcjupyterlab.commands.clean(app_options:AppOptionsLike=None) -> None
Clean the JupyterLab application directory.
funcjupyterlab.commands.disable_extension(extension:str, app_options:AppOptionsLike=None, level:str='sys_prefix') -> bool
Disable a JupyterLab extension/plugin.
funcjupyterlab.commands.enable_extension(extension:str, app_options:AppOptionsLike=None, level:str='sys_prefix') -> bool
Enable a JupyterLab extension/plugin.
funcjupyterlab.commands.ensure_app(app_dir:str) -> list[str] | None
Ensure that an application directory is available.
funcjupyterlab.commands.ensure_core(logger:logging.Logger | None=None) -> None
Ensure that the core assets are available.
funcjupyterlab.commands.ensure_dev(logger:logging.Logger | None=None) -> None
Ensure that the dev assets are available.
funcjupyterlab.commands.ensure_node_modules(cwd:str, logger:logging.Logger | None=None) -> bool
Ensure that node_modules is up to date.
funcjupyterlab.commands.get_app_dir() -> str
Get the configured JupyterLab app directory.
funcjupyterlab.commands.get_app_info(app_options:AppOptionsLike=None) -> dict[str, Any]
Get a dictionary of information about the app.
funcjupyterlab.commands.get_app_version(app_options:AppOptionsLike=None) -> str
Get the application version.
funcjupyterlab.commands.get_user_settings_dir() -> str
Get the configured JupyterLab user settings directory.
funcjupyterlab.commands.get_workspaces_dir() -> str
Get the configured JupyterLab workspaces directory.
funcjupyterlab.commands.install_extension(extension:str, app_options:AppOptionsLike=None, pin:str | None=None) -> bool
Install an extension package into JupyterLab.
funcjupyterlab.commands.link_package(path:str | os.PathLike[str], app_options:AppOptionsLike=None) -> bool
Link a package against the JupyterLab build.
funcjupyterlab.commands.list_extensions(app_options:AppOptionsLike=None) -> None
List the extensions.
funcjupyterlab.commands.lock_extension(extension:str, app_options:AppOptionsLike=None, level:str='sys_prefix') -> bool
Lock a JupyterLab extension/plugin.
funcjupyterlab.commands.pjoin(*args:str | os.PathLike[str]) -> str
Join paths to create a real path.
funcjupyterlab.commands.read_package(target:str | os.PathLike[str]) -> dict[str, Any]
Read the package data in a given target tarball.
funcjupyterlab.commands.uninstall_extension(name:str | None=None, app_options:AppOptionsLike=None, all_:bool=False) -> bool
Uninstall an extension by name or path.
funcjupyterlab.commands.unlink_package(package:str | os.PathLike[str], app_options:AppOptionsLike=None) -> bool
Unlink a package from JupyterLab by path or name.
funcjupyterlab.commands.unlock_extension(extension:str, app_options:AppOptionsLike=None, level:str='sys_prefix') -> bool
Unlock a JupyterLab extension/plugin.
funcjupyterlab.commands.update_extension(name:str | None=None, all_:bool=False, app_dir:str | None=None, app_options:AppOptionsLike=None) -> bool
Update an extension by name, or all extensions.
funcjupyterlab.commands.watch(app_options:AppOptionsLike=None) -> list[WatchHelper]
Watch the application.
funcjupyterlab.commands.watch_dev(logger:logging.Logger | None=None) -> list[WatchHelper]
Run watch mode in a given directory.
funcjupyterlab.commands.watch_packages(logger:logging.Logger | None=None) -> list[WatchHelper]
Run watch mode for the source packages.
classjupyterlab.coreconfig.CoreConfig
An object representing a core config.
methodjupyterlab.coreconfig.CoreConfig.add(name:str, semver:str, extension:bool=False, mime_extension:bool=False)
Remove an extension/singleton.
methodjupyterlab.coreconfig.CoreConfig.clear_packages(lab_only:bool=True)
Clear the packages/extensions.
methodjupyterlab.coreconfig.CoreConfig.extensions() -> dict[str, str]
A dict mapping all extension names to their semver
methodjupyterlab.coreconfig.CoreConfig.remove(name:str)
Remove a package/extension.
funcjupyterlab.coreconfig.pjoin(*args:str | os.PathLike[str]) -> str
Join paths to create a real path.
funcjupyterlab.extensions.get_pypi_manager(app_options:dict | None=None, ext_options:dict | None=None, parent:Configurable | None=None) -> ExtensionManager
PyPi Extension Manager factory
funcjupyterlab.extensions.get_readonly_manager(app_options:dict | None=None, ext_options:dict | None=None, parent:Configurable | None=None) -> ExtensionManager
Read-Only Extension Manager factory
classjupyterlab.extensions.manager.ExtensionManager
Base abstract extension manager.
methodjupyterlab.extensions.manager.ExtensionManager.get_normalized_name(extension:ExtensionPackage) -> str
Normalize extension name.
methodjupyterlab.extensions.manager.ExtensionManager.get_semver_version(version:str) -> str
Convert a Python version to Semver version.
methodjupyterlab.extensions.manager.ExtensionManager.install(extension:str, version:str | None=None) -> ActionResult
Install the required extension.
methodjupyterlab.extensions.manager.ExtensionManager.list_packages(query:str, page:int, per_page:int) -> tuple[dict[str, ExtensionPackage], int | None]
List the available extensions.
methodjupyterlab.extensions.manager.ExtensionManager.metadata() -> ExtensionManagerMetadata
Extension manager metadata.
methodjupyterlab.extensions.manager.ExtensionManager.refresh(query:str | None, page:int, per_page:int) -> None
Refresh the list of extensions.
methodjupyterlab.extensions.manager.ExtensionManager.uninstall(extension:str) -> ActionResult
Uninstall the required extension.
classjupyterlab.extensions.manager.ExtensionManagerMetadata
Extension manager metadata.
classjupyterlab.extensions.manager.ExtensionManagerOptions
Extension manager options.
classjupyterlab.extensions.manager.ExtensionPackage
Extension package entry.
methodjupyterlab.extensions.manager.PluginManager.disable(plugins:str | list[str]) -> ActionResult
Disable a set of plugins (or an extension).
methodjupyterlab.extensions.manager.PluginManager.enable(plugins:str | list[str]) -> ActionResult
Enable a set of plugins (or an extension).
classjupyterlab.extensions.manager.PluginManagerOptions
Plugin manager options.
classjupyterlab.extensions.readonly.ReadOnlyExtensionManager
Extension manager without installation capabilities.
methodjupyterlab.extensions.readonly.ReadOnlyExtensionManager.install(extension:str, version:str | None=None) -> ActionResult
Install the required extension.
methodjupyterlab.extensions.readonly.ReadOnlyExtensionManager.list_packages(query:str, page:int, per_page:int) -> tuple[dict[str, ExtensionPackage], int | None]
List the available extensions.
methodjupyterlab.extensions.readonly.ReadOnlyExtensionManager.metadata() -> ExtensionManagerMetadata
Extension manager metadata.
methodjupyterlab.extensions.readonly.ReadOnlyExtensionManager.uninstall(extension:str) -> ActionResult
Uninstall the required extension.
classjupyterlab.handlers.announcements.CheckForUpdate
Default class to check for update.
classjupyterlab.handlers.announcements.CheckForUpdateABC
Abstract class to check for update.
classjupyterlab.handlers.announcements.CheckForUpdateHandler
Check for Updates API handler.
methodjupyterlab.handlers.announcements.CheckForUpdateHandler.get()
Check for updates.
classjupyterlab.handlers.announcements.NeverCheckForUpdate
Check update version that does nothing.
classjupyterlab.handlers.announcements.NewsHandler
News API handler.
methodjupyterlab.handlers.announcements.NewsHandler.get() -> None
Get the news.
classjupyterlab.labextensions.LabExtensionApp
Base jupyter labextension command entry point
classjupyterlab.utils.deprecated
Decorator to mark deprecated functions with warning.

この情報について

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

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