Config file and command line options

The notebook server can be run with a variety of command line arguments. A list of available options can be found below in the options section.

Defaults for these options can also be set by creating a file named jupyter_notebook_config.py in your Jupyter folder. The Jupyter folder is in your home directory, ~/.jupyter.

To create a jupyter_notebook_config.py file, with all the defaults commented out, you can use the following command line:

$ jupyter notebook --generate-config

Options

This list of options can be generated by running the following and hitting enter:

$ jupyter notebook --help

Application.log_datefmtUnicode

Default: '%Y-%m-%d %H:%M:%S'

The date format used by logging formatters for %(asctime)s

Application.log_formatUnicode

Default: '[%(name)s]%(highlevel)s %(message)s'

The Logging format template

Application.log_levelany of 0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’``

Default: 30

Set the log level by value or name.

Application.logging_configDict

Default: {}

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 formatter console.

• 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'],
        },
    }
}

Application.show_configBool

Default: False

Instead of starting the Application, dump configuration to stdout

Application.show_config_jsonBool

Default: False

Instead of starting the Application, dump configuration to stdout (as JSON)

JupyterApp.answer_yesBool

Default: False

Answer yes to any prompts.

JupyterApp.config_fileUnicode

Default: ''

Full path of a config file.

JupyterApp.config_file_nameUnicode

Default: ''

Specify a config file to load.

JupyterApp.generate_configBool

Default: False

Generate default config file.

JupyterApp.log_datefmtUnicode

Default: '%Y-%m-%d %H:%M:%S'

The date format used by logging formatters for %(asctime)s

JupyterApp.log_formatUnicode

Default: '[%(name)s]%(highlevel)s %(message)s'

The Logging format template

JupyterApp.log_levelany of 0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’``

Default: 30

Set the log level by value or name.

JupyterApp.logging_configDict

Default: {}

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 formatter console.

• 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'],
        },
    }
}

JupyterApp.show_configBool

Default: False

Instead of starting the Application, dump configuration to stdout

JupyterApp.show_config_jsonBool

Default: False

Instead of starting the Application, dump configuration to stdout (as JSON)

NotebookApp.allow_credentialsBool

Default: False

Set the Access-Control-Allow-Credentials: true header

NotebookApp.allow_originUnicode

Default: ''

Set the Access-Control-Allow-Origin header

Use ‘*’ to allow any origin to access your server.

Takes precedence over allow_origin_pat.

NotebookApp.allow_origin_patUnicode

Default: ''

Use a regular expression for the Access-Control-Allow-Origin header

Requests from an origin matching the expression will get replies with:

Access-Control-Allow-Origin: origin

where origin is the origin of the request.

Ignored if allow_origin is set.

NotebookApp.allow_password_changeBool

Default: True

Allow password to be changed at login for the notebook server.

While logging in with a token, the notebook server UI will give the opportunity to the user to enter a new password at the same time that will replace the token login mechanism.

This can be set to false to prevent changing password from the UI/API.

NotebookApp.allow_remote_accessBool

Default: False

Allow requests where the Host header doesn’t point to a local server

By default, requests get a 403 forbidden response if the ‘Host’ header shows that the browser thinks it’s on a non-local domain. Setting this option to True disables this check.

This protects against ‘DNS rebinding’ attacks, where a remote web server serves you a page and then changes its DNS to send later requests to a local IP, bypassing same-origin checks.

Local IP addresses (such as 127.0.0.1 and ::1) are allowed as local, along with hostnames configured in local_hostnames.

NotebookApp.allow_rootBool

Default: False

Whether to allow the user to run the notebook as root.

NotebookApp.answer_yesBool

Default: False

Answer yes to any prompts.

NotebookApp.authenticate_prometheusBool

Default: True

“

Require authentication to access prometheus metrics.

NotebookApp.autoreloadBool

Default: False

Reload the webapp when changes are made to any Python src files.

NotebookApp.base_project_urlUnicode

Default: '/'

DEPRECATED use base_url

NotebookApp.base_urlUnicode

Default: '/'

The base URL for the notebook server.

Leading and trailing slashes can be omitted, and will automatically be added.

NotebookApp.browserUnicode

Default: ''

Specify what command to use to invoke a web

browser when opening the notebook. If not specified, the default browser will be determined by the webbrowser standard library module, which allows setting of the BROWSER environment variable to override it.

NotebookApp.certfileUnicode

Default: ''

The full path to an SSL/TLS certificate file.

NotebookApp.client_caUnicode

Default: ''

The full path to a certificate authority certificate for SSL/TLS client authentication.

NotebookApp.config_fileUnicode

Default: ''

Full path of a config file.

NotebookApp.config_file_nameUnicode

Default: ''

Specify a config file to load.

NotebookApp.config_manager_classType

Default: 'notebook.services.config.manager.ConfigManager'

The config manager class to use

NotebookApp.contents_manager_classTypeFromClasses

Default: 'notebook.services.contents.largefilemanager.LargeFileManager'

The notebook manager class to use.

NotebookApp.cookie_optionsDict

Default: {}

Extra keyword arguments to pass to set_secure_cookie. See tornado’s set_secure_cookie docs for details.

NotebookApp.cookie_secretBytes

Default: b''

The random bytes used to secure cookies.

By default this is a new random number every time you start the Notebook. Set it to a value in a config file to enable logins to persist across server sessions.

Note: Cookie secrets should be kept private, do not share config files with cookie_secret stored in plaintext (you can read the value from a file).

NotebookApp.cookie_secret_fileUnicode

Default: ''

The file where the cookie secret is stored.

NotebookApp.custom_display_urlUnicode

Default: ''

Override URL shown to users.

Replace actual URL, including protocol, address, port and base URL, with the given value when displaying URL to the users. Do not change the actual connection URL. If authentication token is enabled, the token is added to the custom URL automatically.

This option is intended to be used when the URL to display to the user cannot be determined reliably by the Jupyter notebook server (proxified or containerized setups for example).

NotebookApp.default_urlUnicode

Default: '/tree'

The default URL to redirect to from /

NotebookApp.disable_check_xsrfBool

Default: False

Disable cross-site-request-forgery protection

Jupyter notebook 4.3.1 introduces protection from cross-site request forgeries, requiring API requests to either:

• originate from pages served by this server (validated with XSRF cookie and token), or

• authenticate with a token

Some anonymous compute resources still desire the ability to run code, completely without authentication. These services can disable all authentication and security checks, with the full knowledge of what that implies.

NotebookApp.enable_mathjaxBool

Default: True

Whether to enable MathJax for typesetting math/TeX

MathJax is the javascript library Jupyter uses to render math/LaTeX. It is very large, so you may want to disable it if you have a slow internet connection, or for offline use of the notebook.

When disabled, equations etc. will appear as their untransformed TeX source.

NotebookApp.extra_nbextensions_pathList

Default: []

extra paths to look for Javascript notebook extensions

NotebookApp.extra_servicesList

Default: []

handlers that should be loaded at higher priority than the default services

NotebookApp.extra_static_pathsList

Default: []

Extra 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

NotebookApp.extra_template_pathsList

Default: []

Extra paths to search for serving jinja templates.

Can be used to override templates from notebook.templates.

NotebookApp.file_to_runUnicode

Default: ''

No description

NotebookApp.generate_configBool

Default: False

Generate default config file.

NotebookApp.get_secure_cookie_kwargsDict

Default: {}

Extra keyword arguments to pass to get_secure_cookie. See tornado’s get_secure_cookie docs for details.

NotebookApp.ignore_minified_jsBool

Default: False

Deprecated: Use minified JS file or not, mainly use during dev to avoid JS recompilation

NotebookApp.iopub_data_rate_limitFloat

Default: 1000000

(bytes/sec)

Maximum rate at which stream output can be sent on iopub before they are limited.

NotebookApp.iopub_msg_rate_limitFloat

Default: 1000

(msgs/sec)

Maximum rate at which messages can be sent on iopub before they are limited.

NotebookApp.ipUnicode

Default: 'localhost'

The IP address the notebook server will listen on.

NotebookApp.jinja_environment_optionsDict

Default: {}

Supply extra arguments that will be passed to Jinja environment.

NotebookApp.jinja_template_varsDict

Default: {}

Extra variables to supply to jinja templates when rendering.

NotebookApp.kernel_manager_classType

Default: 'notebook.services.kernels.kernelmanager.MappingKernelManager'

The kernel manager class to use.

NotebookApp.kernel_spec_manager_classType

Default: 'jupyter_client.kernelspec.KernelSpecManager'

The kernel spec manager class to use. Should be a subclass of jupyter_client.kernelspec.KernelSpecManager.

The Api of KernelSpecManager is provisional and might change without warning between this version of Jupyter and the next stable one.

NotebookApp.keyfileUnicode

Default: ''

The full path to a private key file for usage with SSL/TLS.

NotebookApp.local_hostnamesList

Default: ['localhost']

Hostnames to allow as local when allow_remote_access is False.

Local IP addresses (such as 127.0.0.1 and ::1) are automatically accepted as local as well.

NotebookApp.log_datefmtUnicode

Default: '%Y-%m-%d %H:%M:%S'

The date format used by logging formatters for %(asctime)s

NotebookApp.log_formatUnicode

Default: '[%(name)s]%(highlevel)s %(message)s'

The Logging format template

NotebookApp.log_jsonBool

Default: False

Set to True to enable JSON formatted logs. Run “pip install notebook[json-logging]” to install the required dependent packages. Can also be set using the environment variable JUPYTER_ENABLE_JSON_LOGGING=true.

NotebookApp.log_levelany of 0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’``

Default: 30

Set the log level by value or name.

NotebookApp.logging_configDict

Default: {}

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 formatter console.

• 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'],
        },
    }
}

NotebookApp.login_handler_classType

Default: 'notebook.auth.login.LoginHandler'

The login handler class to use.

NotebookApp.logout_handler_classType

Default: 'notebook.auth.logout.LogoutHandler'

The logout handler class to use.

NotebookApp.mathjax_configUnicode

Default: 'TeX-AMS-MML_HTMLorMML-full,Safe'

The MathJax.js configuration file that is to be used.

NotebookApp.mathjax_urlUnicode

Default: ''

A custom url for MathJax.js.

Should be in the form of a case-sensitive url to MathJax, for example: /static/components/MathJax/MathJax.js

NotebookApp.max_body_sizeInt

Default: 536870912

Sets the maximum allowed size of the client request body, specified in the Content-Length request header field. If the size in a request exceeds the configured value, a malformed HTTP message is returned to the client.

Note: max_body_size is applied even in streaming mode.

NotebookApp.max_buffer_sizeInt

Default: 536870912

Gets or sets the maximum amount of memory, in bytes, that is allocated for use by the buffer manager.

NotebookApp.min_open_files_limitInt

Default: 0

Gets or sets a lower bound on the open file handles process resource limit. This may need to be increased if you run into an OSError: [Errno 24] Too many open files. This is not applicable when running on Windows.

NotebookApp.nbserver_extensionsDict

Default: {}

Dict of Python modules to load as notebook server extensions. Entry values can be used to enable and disable the loading of the extensions. The extensions will be loaded in alphabetical order.

NotebookApp.notebook_dirUnicode

Default: ''

The directory to use for notebooks and kernels.

NotebookApp.open_browserBool

Default: True

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 (NotebookApp.browser) configuration option.

NotebookApp.passwordUnicode

Default: ''

Hashed password to use for web authentication.

To generate, type in a python/IPython shell:

from notebook.auth import passwd; passwd()

The string should be of the form type:salt:hashed-password.

NotebookApp.password_requiredBool

Default: False

Forces users to use a password for the Notebook server.

This is useful in a multi user environment, for instance when everybody in the LAN can access each other’s machine through ssh.

In such a case, serving the notebook server on localhost is not secure since any user can connect to the notebook server via ssh.

NotebookApp.portInt

Default: 8888

The port the notebook server will listen on (env: JUPYTER_PORT).

NotebookApp.port_retriesInt

Default: 50

The number of additional ports to try if the specified port is not available (env: JUPYTER_PORT_RETRIES).

NotebookApp.pylabUnicode

Default: 'disabled'

DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.

NotebookApp.quit_buttonBool

Default: True

If True, display a button in the dashboard to quit

(shutdown the notebook server).

NotebookApp.rate_limit_windowFloat

Default: 3

(sec) Time window used to

check the message and data rate limits.

NotebookApp.reraise_server_extension_failuresBool

Default: False

Reraise exceptions encountered loading server extensions?

NotebookApp.server_extensionsList

Default: []

DEPRECATED use the nbserver_extensions dict instead

NotebookApp.session_manager_classType

Default: 'notebook.services.sessions.sessionmanager.SessionManager'

The session manager class to use.

NotebookApp.show_bannerBool

Default: True

Whether the banner is displayed on the page.

By default, the banner is displayed.

NotebookApp.show_configBool

Default: False

Instead of starting the Application, dump configuration to stdout

NotebookApp.show_config_jsonBool

Default: False

Instead of starting the Application, dump configuration to stdout (as JSON)

NotebookApp.shutdown_no_activity_timeoutInt

Default: 0

Shut down the server after N seconds with no kernels or terminals running and no activity. This can be used together with culling idle kernels (MappingKernelManager.cull_idle_timeout) to shutdown the notebook server when it’s not in use. This is not precisely timed: it may shut down up to a minute later. 0 (the default) disables this automatic shutdown.

NotebookApp.sockUnicode

Default: ''

The UNIX socket the notebook server will listen on.

NotebookApp.sock_modeUnicode

Default: '0600'

The permissions mode for UNIX socket creation (default: 0600).

NotebookApp.ssl_optionsDict

Default: {}

Supply SSL options for the tornado HTTPServer.

See the tornado docs for details.

NotebookApp.terminado_settingsDict

Default: {}

Supply overrides for terminado. Currently only supports “shell_command”. On Unix, if “shell_command” is not provided, a non-login shell is launched by default when the notebook server is connected to a terminal, a login shell otherwise.

NotebookApp.terminals_enabledBool

Default: True

Set to False to disable terminals.

This does not make the notebook server more secure by itself. Anything the user can in a terminal, they can also do in a notebook.

Terminals may also be automatically disabled if the terminado package is not available.

NotebookApp.tokenUnicode

Default: '<generated>'

Token used for authenticating first-time connections to the server.

The token can be read from the file referenced by JUPYTER_TOKEN_FILE or set directly with the JUPYTER_TOKEN environment variable.

When no password is enabled, the default is to generate a new, random token.

Setting to an empty string disables authentication altogether, which is NOT RECOMMENDED.

NotebookApp.tornado_settingsDict

Default: {}

Supply overrides for the tornado.web.Application that the Jupyter notebook uses.

NotebookApp.trust_xheadersBool

Default: False

Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers sent by the upstream reverse proxy. Necessary if the proxy handles SSL

NotebookApp.use_redirect_fileBool

Default: True

Disable launching browser by redirect file

For versions of notebook > 5.7.2, a security feature measure was added that prevented the authentication token used to launch the browser from being visible. This feature makes it difficult for other users on a multi-user system from running code in your Jupyter session as you.

However, some environments (like Windows Subsystem for Linux (WSL) and Chromebooks), launching a browser using a redirect file can lead the browser failing to load. This is because of the difference in file structures/paths between the runtime and the browser.

Disabling this setting to False will disable this behavior, allowing the browser to launch by using a URL and visible token (as before).

NotebookApp.webapp_settingsDict

Default: {}

DEPRECATED, use tornado_settings

NotebookApp.webbrowser_open_newInt

Default: 2

Specify Where to open the notebook on startup. This is the

new argument passed to the standard library method webbrowser.open. The behaviour is not guaranteed, but depends on browser support. Valid values are:

• 2 opens a new tab,

• 1 opens a new window,

• 0 opens in an existing window.

See the webbrowser.open documentation for details.

NotebookApp.websocket_compression_optionsAny

Default: None

Set the tornado compression options for websocket connections.

This value will be returned from WebSocketHandler.get_compression_options(). None (default) will disable compression. A dict (even an empty one) will enable compression.

See the tornado docs for WebSocketHandler.get_compression_options for details.

NotebookApp.websocket_urlUnicode

Default: ''

The base URL for websockets,

if it differs from the HTTP server (hint: it almost certainly doesn’t).

Should be in the form of an HTTP origin: ws[s]://hostname[:port]

ConnectionFileMixin.connection_fileUnicode

Default: ''

JSON file in which to store connection info [default: kernel-<pid>.json]

This file will contain the IP, ports, and authentication key needed to connect clients to this kernel. By default, this file will be created in the security dir of the current profile, but can be specified by absolute path.

ConnectionFileMixin.control_portInt

Default: 0

set the control (ROUTER) port [default: random]

ConnectionFileMixin.hb_portInt

Default: 0

set the heartbeat port [default: random]

ConnectionFileMixin.iopub_portInt

Default: 0

set the iopub (PUB) port [default: random]

ConnectionFileMixin.ipUnicode

Default: ''

Set the kernel’s IP address [default localhost].

If the IP address is something other than localhost, then Consoles on other machines will be able to connect to the Kernel, so be careful!

ConnectionFileMixin.shell_portInt

Default: 0

set the shell (ROUTER) port [default: random]

ConnectionFileMixin.stdin_portInt

Default: 0

set the stdin (ROUTER) port [default: random]

ConnectionFileMixin.transportany of 'tcp'``|’ipc’`` (case-insensitive)

Default: 'tcp'

No description

KernelManager.autorestartBool

Default: True

Should we autorestart the kernel if it dies.

KernelManager.connection_fileUnicode

Default: ''

JSON file in which to store connection info [default: kernel-<pid>.json]

This file will contain the IP, ports, and authentication key needed to connect clients to this kernel. By default, this file will be created in the security dir of the current profile, but can be specified by absolute path.

KernelManager.control_portInt

Default: 0

set the control (ROUTER) port [default: random]

KernelManager.hb_portInt

Default: 0

set the heartbeat port [default: random]

KernelManager.iopub_portInt

Default: 0

set the iopub (PUB) port [default: random]

KernelManager.ipUnicode

Default: ''

Set the kernel’s IP address [default localhost].

If the IP address is something other than localhost, then Consoles on other machines will be able to connect to the Kernel, so be careful!

KernelManager.shell_portInt

Default: 0

set the shell (ROUTER) port [default: random]

KernelManager.shutdown_wait_timeFloat

Default: 5.0

Time to wait for a kernel to terminate before killing it, in seconds. When a shutdown request is initiated, the kernel will be immediately sent an interrupt (SIGINT), followedby a shutdown_request message, after 1/2 of shutdown_wait_time`it will be sent a terminate (SIGTERM) request, and finally at the end of `shutdown_wait_time will be killed (SIGKILL). terminate and kill may be equivalent on windows. Note that this value can beoverridden by the in-use kernel provisioner since shutdown times mayvary by provisioned environment.

KernelManager.stdin_portInt

Default: 0

set the stdin (ROUTER) port [default: random]

KernelManager.transportany of 'tcp'``|’ipc’`` (case-insensitive)

Default: 'tcp'

No description

Session.buffer_thresholdInt

Default: 1024

Threshold (in bytes) beyond which an object’s buffer should be extracted to avoid pickling.

Session.check_pidBool

Default: True

Whether to check PID to protect against calls after fork.

This check can be disabled if fork-safety is handled elsewhere.

Session.copy_thresholdInt

Default: 65536

Threshold (in bytes) beyond which a buffer should be sent without copying.

Session.debugBool

Default: False

Debug output in the Session

Session.digest_history_sizeInt

Default: 65536

The maximum number of digests to remember.

The digest history will be culled when it exceeds this value.

Session.item_thresholdInt

Default: 64

The maximum number of items for a container to be introspected for custom serialization.

Containers larger than this are pickled outright.

Session.keyCBytes

Default: b''

execution key, for signing messages.

Session.keyfileUnicode

Default: ''

path to file containing execution key.

Session.metadataDict

Default: {}

Metadata dictionary, which serves as the default top-level metadata dict for each message.

Session.packerDottedObjectName

Default: 'json'

The name of the packer for serializing messages.

Should be one of ‘json’, ‘pickle’, or an import name for a custom callable serializer.

Session.sessionCUnicode

Default: ''

The UUID identifying this session.

Session.signature_schemeUnicode

Default: 'hmac-sha256'

The digest scheme used to construct the message signatures.

Must have the form ‘hmac-HASH’.

Session.unpackerDottedObjectName

Default: 'json'

The name of the unpacker for unserializing messages.

Only used with custom functions for packer.

Session.usernameUnicode

Default: 'username'

Username for the Session. Default is your system username.

MultiKernelManager.default_kernel_nameUnicode

Default: 'python3'

The name of the default kernel to start

MultiKernelManager.kernel_manager_classDottedObjectName

Default: 'jupyter_client.ioloop.IOLoopKernelManager'

The kernel manager class. This is configurable to allow

subclassing of the KernelManager for customized behavior.

MultiKernelManager.shared_contextBool

Default: True

Share a single zmq.Context to talk to all my kernels

MappingKernelManager.allowed_message_typesList

Default: []

White list of allowed kernel message types.

When the list is empty, all message types are allowed.

MappingKernelManager.buffer_offline_messagesBool

Default: True

Whether messages from kernels whose frontends have disconnected should be buffered in-memory.

When True (default), messages are buffered and replayed on reconnect, avoiding lost messages due to interrupted connectivity. Disable if long-running kernels will produce too much output while no frontends are connected.

MappingKernelManager.cull_busyBool

Default: False

Whether to consider culling kernels which are busy.

Only effective if cull_idle_timeout > 0.

MappingKernelManager.cull_connectedBool

Default: False

Whether to consider culling kernels which have one or more connections.

Only effective if cull_idle_timeout > 0.

MappingKernelManager.cull_idle_timeoutInt

Default: 0

Timeout (in seconds) after which a kernel is considered idle and ready to be culled.

Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled for users with poor network connections.

MappingKernelManager.cull_intervalInt

Default: 300

The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.

MappingKernelManager.default_kernel_nameUnicode

Default: 'python3'

The name of the default kernel to start

MappingKernelManager.kernel_info_timeoutFloat

Default: 60

Timeout for giving up on a kernel (in seconds).

On starting and restarting kernels, we check whether the kernel is running and responsive by sending kernel_info_requests. This sets the timeout in seconds for how long the kernel can take before being presumed dead. This affects the MappingKernelManager (which handles kernel restarts) and the ZMQChannelsHandler (which handles the startup).

MappingKernelManager.kernel_manager_classDottedObjectName

Default: 'jupyter_client.ioloop.IOLoopKernelManager'

The kernel manager class. This is configurable to allow

subclassing of the KernelManager for customized behavior.

MappingKernelManager.root_dirUnicode

Default: ''

No description

MappingKernelManager.shared_contextBool

Default: True

Share a single zmq.Context to talk to all my kernels

KernelSpecManager.allowed_kernelspecsSet

Default: set()

List of allowed kernel names.

By default, all installed kernels are allowed.

KernelSpecManager.ensure_native_kernelBool

Default: True

If there is no Python kernelspec registered and the IPython

kernel is available, ensure it is added to the spec list.

KernelSpecManager.kernel_spec_classType

Default: 'jupyter_client.kernelspec.KernelSpec'

The kernel spec class. This is configurable to allow

subclassing of the KernelSpecManager for customized behavior.

KernelSpecManager.whitelistSet

Default: set()

Deprecated, use KernelSpecManager.allowed_kernelspecs

ContentsManager.allow_hiddenBool

Default: False

Allow access to hidden files

ContentsManager.checkpointsInstance

Default: None

No description

ContentsManager.checkpoints_classType

Default: 'notebook.services.contents.checkpoints.Checkpoints'

No description

ContentsManager.checkpoints_kwargsDict

Default: {}

No description

ContentsManager.files_handler_classType

Default: 'notebook.files.handlers.FilesHandler'

handler class to use when serving raw file requests.

Default is a fallback that talks to the ContentsManager API, which may be inefficient, especially for large files.

Local files-based ContentsManagers can use a StaticFileHandler subclass, which will be much more efficient.

Access to these files should be Authenticated.

ContentsManager.files_handler_paramsDict

Default: {}

Extra parameters to pass to files_handler_class.

For example, StaticFileHandlers generally expect a path argument specifying the root directory from which to serve files.

ContentsManager.hide_globsList

Default: ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dyl...

Glob patterns to hide in file and directory listings.

ContentsManager.pre_save_hookAny

Default: None

Python callable or importstring thereof

To be called on a contents model prior to save.

This can be used to process the structure, such as removing notebook outputs or other side effects that should not be saved.

It will be called as (all arguments passed by keyword):

hook(path=path, model=model, contents_manager=self)

• model: the model to be saved. Includes file contents. Modifying this dict will affect the file that is stored.

• path: the API path of the save destination

• contents_manager: this ContentsManager instance

ContentsManager.root_dirUnicode

Default: '/'

No description

ContentsManager.untitled_directoryUnicode

Default: 'Untitled Folder'

The base name used when creating untitled directories.

ContentsManager.untitled_fileUnicode

Default: 'untitled'

The base name used when creating untitled files.

ContentsManager.untitled_notebookUnicode

Default: 'Untitled'

The base name used when creating untitled notebooks.

FileManagerMixin.use_atomic_writingBool

Default: True

By default notebooks are saved on disk on a temporary file and then if successfully written, it replaces the old ones.

This procedure, namely ‘atomic_writing’, causes some bugs on file system without operation order enforcement (like some networked fs). If set to False, the new notebook is written directly on the old one which could fail (eg: full filesystem or quota )

FileContentsManager.allow_hiddenBool

Default: False

Allow access to hidden files

FileContentsManager.checkpointsInstance

Default: None

No description

FileContentsManager.checkpoints_classType

Default: 'notebook.services.contents.checkpoints.Checkpoints'

No description

FileContentsManager.checkpoints_kwargsDict

Default: {}

No description

FileContentsManager.delete_to_trashBool

Default: True

If True (default), deleting files will send them to the

platform’s trash/recycle bin, where they can be recovered. If False, deleting files really deletes them.

FileContentsManager.files_handler_classType

Default: 'notebook.files.handlers.FilesHandler'

handler class to use when serving raw file requests.

Default is a fallback that talks to the ContentsManager API, which may be inefficient, especially for large files.

Local files-based ContentsManagers can use a StaticFileHandler subclass, which will be much more efficient.

Access to these files should be Authenticated.

FileContentsManager.files_handler_paramsDict

Default: {}

Extra parameters to pass to files_handler_class.

For example, StaticFileHandlers generally expect a path argument specifying the root directory from which to serve files.

FileContentsManager.hide_globsList

Default: ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dyl...

Glob patterns to hide in file and directory listings.

FileContentsManager.post_save_hookAny

Default: None

Python callable or importstring thereof

to be called on the path of a file just saved.

This can be used to process the file on disk, such as converting the notebook to a script or HTML via nbconvert.

It will be called as (all arguments passed by keyword):

hook(os_path=os_path, model=model, contents_manager=instance)

• path: the filesystem path to the file just written

• model: the model representing the file

• contents_manager: this ContentsManager instance

FileContentsManager.pre_save_hookAny

Default: None

Python callable or importstring thereof

To be called on a contents model prior to save.

This can be used to process the structure, such as removing notebook outputs or other side effects that should not be saved.

It will be called as (all arguments passed by keyword):

hook(path=path, model=model, contents_manager=self)

• model: the model to be saved. Includes file contents. Modifying this dict will affect the file that is stored.

• path: the API path of the save destination

• contents_manager: this ContentsManager instance

FileContentsManager.root_dirUnicode

Default: ''

No description

FileContentsManager.save_scriptBool

Default: False

DEPRECATED, use post_save_hook. Will be removed in Notebook 5.0

FileContentsManager.untitled_directoryUnicode

Default: 'Untitled Folder'

The base name used when creating untitled directories.

FileContentsManager.untitled_fileUnicode

Default: 'untitled'

The base name used when creating untitled files.

FileContentsManager.untitled_notebookUnicode

Default: 'Untitled'

The base name used when creating untitled notebooks.

FileContentsManager.use_atomic_writingBool

Default: True

By default notebooks are saved on disk on a temporary file and then if successfully written, it replaces the old ones.

This procedure, namely ‘atomic_writing’, causes some bugs on file system without operation order enforcement (like some networked fs). If set to False, the new notebook is written directly on the old one which could fail (eg: full filesystem or quota )

NotebookNotary.algorithmany of 'md5'``|’blake2b’|’blake2s’|’sha1’|’sha3_224’|’sha3_256’|’sha384’|’sha512’|’sha256’|’sha3_512’|’sha224’|’sha3_384’``

Default: 'sha256'

The hashing algorithm used to sign notebooks.

NotebookNotary.data_dirUnicode

Default: ''

The storage directory for notary secret and database.

NotebookNotary.db_fileUnicode

Default: ''

The sqlite file in which to store notebook signatures.

By default, this will be in your Jupyter data directory. You can set it to ‘:memory:’ to disable sqlite writing to the filesystem.

NotebookNotary.secretBytes

Default: b''

The secret key with which notebooks are signed.

NotebookNotary.secret_fileUnicode

Default: ''

The file where the secret key is stored.

NotebookNotary.store_factoryCallable

Default: traitlets.Undefined

A callable returning the storage backend for notebook signatures.

The default uses an SQLite database.

AsyncMultiKernelManager.default_kernel_nameUnicode

Default: 'python3'

The name of the default kernel to start

AsyncMultiKernelManager.kernel_manager_classDottedObjectName

Default: 'jupyter_client.ioloop.AsyncIOLoopKernelManager'

The kernel manager class. This is configurable to allow

subclassing of the AsyncKernelManager for customized behavior.

AsyncMultiKernelManager.shared_contextBool

Default: True

Share a single zmq.Context to talk to all my kernels

AsyncMultiKernelManager.use_pending_kernelsBool

Default: False

Whether to make kernels available before the process has started. The

kernel has a .ready future which can be awaited before connecting

AsyncMappingKernelManager.allowed_message_typesList

Default: []

White list of allowed kernel message types.

When the list is empty, all message types are allowed.

AsyncMappingKernelManager.buffer_offline_messagesBool

Default: True

Whether messages from kernels whose frontends have disconnected should be buffered in-memory.

When True (default), messages are buffered and replayed on reconnect, avoiding lost messages due to interrupted connectivity. Disable if long-running kernels will produce too much output while no frontends are connected.

AsyncMappingKernelManager.cull_busyBool

Default: False

Whether to consider culling kernels which are busy.

Only effective if cull_idle_timeout > 0.

AsyncMappingKernelManager.cull_connectedBool

Default: False

Whether to consider culling kernels which have one or more connections.

Only effective if cull_idle_timeout > 0.

AsyncMappingKernelManager.cull_idle_timeoutInt

Default: 0

Timeout (in seconds) after which a kernel is considered idle and ready to be culled.

Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled for users with poor network connections.

AsyncMappingKernelManager.cull_intervalInt

Default: 300

The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.

AsyncMappingKernelManager.default_kernel_nameUnicode

Default: 'python3'

The name of the default kernel to start

AsyncMappingKernelManager.kernel_info_timeoutFloat

Default: 60

Timeout for giving up on a kernel (in seconds).

On starting and restarting kernels, we check whether the kernel is running and responsive by sending kernel_info_requests. This sets the timeout in seconds for how long the kernel can take before being presumed dead. This affects the MappingKernelManager (which handles kernel restarts) and the ZMQChannelsHandler (which handles the startup).

AsyncMappingKernelManager.kernel_manager_classDottedObjectName

Default: 'jupyter_client.ioloop.AsyncIOLoopKernelManager'

The kernel manager class. This is configurable to allow

subclassing of the AsyncKernelManager for customized behavior.

AsyncMappingKernelManager.root_dirUnicode

Default: ''

No description

AsyncMappingKernelManager.shared_contextBool

Default: True

Share a single zmq.Context to talk to all my kernels

AsyncMappingKernelManager.use_pending_kernelsBool

Default: False

Whether to make kernels available before the process has started. The

kernel has a .ready future which can be awaited before connecting

GatewayKernelManager.allowed_message_typesList

Default: []

White list of allowed kernel message types.

When the list is empty, all message types are allowed.

GatewayKernelManager.buffer_offline_messagesBool

Default: True

Whether messages from kernels whose frontends have disconnected should be buffered in-memory.

When True (default), messages are buffered and replayed on reconnect, avoiding lost messages due to interrupted connectivity. Disable if long-running kernels will produce too much output while no frontends are connected.

GatewayKernelManager.cull_busyBool

Default: False

Whether to consider culling kernels which are busy.

Only effective if cull_idle_timeout > 0.

GatewayKernelManager.cull_connectedBool

Default: False

Whether to consider culling kernels which have one or more connections.

Only effective if cull_idle_timeout > 0.

GatewayKernelManager.cull_idle_timeoutInt

Default: 0

Timeout (in seconds) after which a kernel is considered idle and ready to be culled.

Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled for users with poor network connections.

GatewayKernelManager.cull_intervalInt

Default: 300

The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.

GatewayKernelManager.default_kernel_nameUnicode

Default: 'python3'

The name of the default kernel to start

GatewayKernelManager.kernel_info_timeoutFloat

Default: 60

Timeout for giving up on a kernel (in seconds).

On starting and restarting kernels, we check whether the kernel is running and responsive by sending kernel_info_requests. This sets the timeout in seconds for how long the kernel can take before being presumed dead. This affects the MappingKernelManager (which handles kernel restarts) and the ZMQChannelsHandler (which handles the startup).

GatewayKernelManager.kernel_manager_classDottedObjectName

Default: 'jupyter_client.ioloop.AsyncIOLoopKernelManager'

The kernel manager class. This is configurable to allow

subclassing of the AsyncKernelManager for customized behavior.

GatewayKernelManager.root_dirUnicode

Default: ''

No description

GatewayKernelManager.shared_contextBool

Default: True

Share a single zmq.Context to talk to all my kernels

GatewayKernelManager.use_pending_kernelsBool

Default: False

Whether to make kernels available before the process has started. The

kernel has a .ready future which can be awaited before connecting

GatewayKernelSpecManager.allowed_kernelspecsSet

Default: set()

List of allowed kernel names.

By default, all installed kernels are allowed.

GatewayKernelSpecManager.ensure_native_kernelBool

Default: True

If there is no Python kernelspec registered and the IPython

kernel is available, ensure it is added to the spec list.

GatewayKernelSpecManager.kernel_spec_classType

Default: 'jupyter_client.kernelspec.KernelSpec'

The kernel spec class. This is configurable to allow

subclassing of the KernelSpecManager for customized behavior.

GatewayKernelSpecManager.whitelistSet

Default: set()

Deprecated, use KernelSpecManager.allowed_kernelspecs

GatewayClient.auth_tokenUnicode

Default: None

The authorization token used in the HTTP headers. (JUPYTER_GATEWAY_AUTH_TOKEN env var)

GatewayClient.ca_certsUnicode

Default: None

The filename of CA certificates or None to use defaults. (JUPYTER_GATEWAY_CA_CERTS env var)

GatewayClient.client_certUnicode

Default: None

The filename for client SSL certificate, if any. (JUPYTER_GATEWAY_CLIENT_CERT env var)

GatewayClient.client_keyUnicode

Default: None

The filename for client SSL key, if any. (JUPYTER_GATEWAY_CLIENT_KEY env var)

GatewayClient.connect_timeoutFloat

Default: 40.0

The time allowed for HTTP connection establishment with the Gateway server.

(JUPYTER_GATEWAY_CONNECT_TIMEOUT env var)

GatewayClient.env_whitelistUnicode

Default: ''

A comma-separated list of environment variable names that will be included, along with

their values, in the kernel startup request. The corresponding env_whitelist configuration value must also be set on the Gateway server - since that configuration value indicates which environmental values to make available to the kernel. (JUPYTER_GATEWAY_ENV_WHITELIST env var)

GatewayClient.gateway_retry_intervalFloat

Default: 1.0

The time allowed for HTTP reconnection with the Gateway server for the first time.

Next will be JUPYTER_GATEWAY_RETRY_INTERVAL multiplied by two in factor of numbers of retries but less than JUPYTER_GATEWAY_RETRY_INTERVAL_MAX. (JUPYTER_GATEWAY_RETRY_INTERVAL env var)

GatewayClient.gateway_retry_interval_maxFloat

Default: 30.0

The maximum time allowed for HTTP reconnection retry with the Gateway server.

(JUPYTER_GATEWAY_RETRY_INTERVAL_MAX env var)

GatewayClient.gateway_retry_maxInt

Default: 5

The maximum retries allowed for HTTP reconnection with the Gateway server.

(JUPYTER_GATEWAY_RETRY_MAX env var)

GatewayClient.headersUnicode

Default: '{}'

Additional HTTP headers to pass on the request. This value will be converted to a dict.

(JUPYTER_GATEWAY_HEADERS env var)

GatewayClient.http_pwdUnicode

Default: None

The password for HTTP authentication. (JUPYTER_GATEWAY_HTTP_PWD env var)

GatewayClient.http_userUnicode

Default: None

The username for HTTP authentication. (JUPYTER_GATEWAY_HTTP_USER env var)

GatewayClient.kernels_endpointUnicode

Default: '/api/kernels'

The gateway API endpoint for accessing kernel resources (JUPYTER_GATEWAY_KERNELS_ENDPOINT env var)

GatewayClient.kernelspecs_endpointUnicode

Default: '/api/kernelspecs'

The gateway API endpoint for accessing kernelspecs (JUPYTER_GATEWAY_KERNELSPECS_ENDPOINT env var)

GatewayClient.kernelspecs_resource_endpointUnicode

Default: '/kernelspecs'

The gateway endpoint for accessing kernelspecs resources

(JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINT env var)

GatewayClient.request_timeoutFloat

Default: 40.0

The time allowed for HTTP request completion. (JUPYTER_GATEWAY_REQUEST_TIMEOUT env var)

GatewayClient.urlUnicode

Default: None

The url of the Kernel or Enterprise Gateway server where

kernel specifications are defined and kernel management takes place. If defined, this Notebook server acts as a proxy for all kernel management and kernel specification retrieval. (JUPYTER_GATEWAY_URL env var)

GatewayClient.validate_certBool

Default: True

For HTTPS requests, determines if server’s certificate should be validated or not.

(JUPYTER_GATEWAY_VALIDATE_CERT env var)

GatewayClient.ws_urlUnicode

Default: None

The websocket url of the Kernel or Enterprise Gateway server. If not provided, this value

will correspond to the value of the Gateway url with ‘ws’ in place of ‘http’. (JUPYTER_GATEWAY_WS_URL env var)

TerminalManager.cull_inactive_timeoutInt

Default: 0

Timeout (in seconds) in which a terminal has been inactive and ready to be culled.

Values of 0 or lower disable culling.

TerminalManager.cull_intervalInt

Default: 300

The interval (in seconds) on which to check for terminals exceeding the inactive timeout value.