Application#
Module: jupyterlab_server.app
#
JupyterLab Server Application
LabServerApp
#
- class jupyterlab_server.app.LabServerApp(**kwargs: Any)#
A Lab Server Application that runs out-of-the-box
- allowed_extensions_uris c.LabServerApp.allowed_extensions_uris = Unicode('')#
“A list of comma-separated URIs to get the allowed extensions list
Changed in version 2.0.0: LabServerApp.whitetlist_uris renamed to allowed_extensions_uris
- answer_yes c.LabServerApp.answer_yes = Bool(False)#
Answer yes to any prompts.
- app_settings_dir c.LabServerApp.app_settings_dir = Unicode('')#
The application settings directory.
- app_url c.LabServerApp.app_url = Unicode('/lab')#
The url path for the application.
- blacklist_uris c.LabServerApp.blacklist_uris = Unicode('')#
Deprecated, use LabServerApp.blocked_extensions_uris
- blocked_extensions_uris c.LabServerApp.blocked_extensions_uris = Unicode('')#
A list of comma-separated URIs to get the blocked extensions list
Changed in version 2.0.0: LabServerApp.blacklist_uris renamed to blocked_extensions_uris
- cache_files c.LabServerApp.cache_files = Bool(True)#
Whether to cache files on the server. This should be True except in dev mode.
- config_file c.LabServerApp.config_file = Unicode('')#
Full path of a config file.
- config_file_name c.LabServerApp.config_file_name = Unicode('')#
Specify a config file to load.
- copy_absolute_path c.LabServerApp.copy_absolute_path = Bool(False)#
Whether getting a relative (False) or absolute (True) path when copying a path.
- extra_labextensions_path c.LabServerApp.extra_labextensions_path = List()#
Extra paths to look for federated JupyterLab extensions
- generate_config c.LabServerApp.generate_config = Bool(False)#
Generate default config file.
- handlers c.LabServerApp.handlers = List()#
Handlers appended to the server.
- jinja2_options c.LabServerApp.jinja2_options = Dict()#
Options to pass to the jinja2 environment for this
- labextensions_path c.LabServerApp.labextensions_path = List()#
The standard paths to look in for federated JupyterLab extensions
- labextensions_url c.LabServerApp.labextensions_url = Unicode('')#
The url for federated JupyterLab extensions
- listings_refresh_seconds c.LabServerApp.listings_refresh_seconds = Int(3600)#
The interval delay in seconds to refresh the lists
- listings_request_options c.LabServerApp.listings_request_options = Dict()#
The optional kwargs to use for the listings HTTP requests as described on https://2.python-requests.org/en/v2.7.0/api/#requests.request
- listings_url c.LabServerApp.listings_url = Unicode('')#
The listings url.
- log_datefmt c.LabServerApp.log_datefmt = Unicode('%Y-%m-%d %H:%M:%S')#
The date format used by logging formatters for %(asctime)s
- log_format c.LabServerApp.log_format = Unicode('[%(name)s]%(highlevel)s %(message)s')#
The Logging format template
- log_level c.LabServerApp.log_level = Enum(30)#
Set the log level by value or name.
- logging_config c.LabServerApp.logging_config = Dict()#
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { 'handlers': { 'file': { 'class': 'logging.FileHandler', 'level': 'DEBUG', 'filename': '<path/to/file>', } }, 'loggers': { '<application-name>': { 'level': 'DEBUG', # NOTE: if you don't list the default "console" # handler here then it will be disabled 'handlers': ['console', 'file'], }, } }
- notebook_starts_kernel c.LabServerApp.notebook_starts_kernel = Bool(True)#
Whether a notebook should start a kernel automatically.
- open_browser c.LabServerApp.open_browser = Bool(False)#
Whether to open in a browser after starting. The specific browser used is platform dependent and determined by the python standard library webbrowser module, unless it is overridden using the –browser (ServerApp.browser) configuration option.
- schemas_dir c.LabServerApp.schemas_dir = Unicode('')#
The optional location of the settings schemas directory. If given, a handler will be added for settings.
- settings c.LabServerApp.settings = Dict()#
Settings that will passed to the server.
- settings_url c.LabServerApp.settings_url = Unicode('')#
The url path of the settings handler.
- show_config c.LabServerApp.show_config = Bool(False)#
Instead of starting the Application, dump configuration to stdout
- show_config_json c.LabServerApp.show_config_json = Bool(False)#
Instead of starting the Application, dump configuration to stdout (as JSON)
- static_dir c.LabServerApp.static_dir = Unicode('')#
The optional location of local static files. If given, a static file handler will be added.
- static_paths c.LabServerApp.static_paths = List()#
paths to search for serving static files.
This allows adding javascript/css to be available from the notebook server machine, or overriding individual files in the IPython
- static_url_prefix c.LabServerApp.static_url_prefix = Unicode('')#
Url where the static assets for the extension are served.
- template_paths c.LabServerApp.template_paths = List()#
Paths to search for serving jinja templates.
Can be used to override templates from notebook.templates.
- templates_dir c.LabServerApp.templates_dir = Unicode('')#
The application templates directory.
- themes_dir c.LabServerApp.themes_dir = Unicode('')#
The optional location of the themes directory. If given, a handler will be added for themes.
- themes_url c.LabServerApp.themes_url = Unicode('')#
The theme url.
- translations_api_url c.LabServerApp.translations_api_url = Unicode('')#
The url path of the translations handler.
- tree_url c.LabServerApp.tree_url = Unicode('')#
The url path of the tree handler.
- user_settings_dir c.LabServerApp.user_settings_dir = Unicode('')#
The optional location of the user settings directory.
- whitelist_uris c.LabServerApp.whitelist_uris = Unicode('')#
Deprecated, use LabServerApp.allowed_extensions_uris
- workspaces_api_url c.LabServerApp.workspaces_api_url = Unicode('')#
The url path of the workspaces API.
- workspaces_dir c.LabServerApp.workspaces_dir = Unicode('')#
The optional location of the saved workspaces directory. If given, a handler will be added for workspaces.