$ python -m ipykernel --help-all
IPython: an enhanced interactive Python shell.
Subcommands
===========
Subcommands are launched as `ipython-kernel cmd [args]`. For information on
using subcommand 'cmd', do: `ipython-kernel cmd -h`.
install
Install the IPython kernel
Options
=======
The options below are convenience aliases to configurable class-options,
as listed in the "Equivalent to" description-line of the aliases.
To see all configurable class-options for some <cmd>, use:
<cmd> --help-all
--debug
set log level to logging.DEBUG (maximize logging output)
Equivalent to: [--Application.log_level=10]
--show-config
Show the application's configuration (human-readable format)
Equivalent to: [--Application.show_config=True]
--show-config-json
Show the application's configuration (json format)
Equivalent to: [--Application.show_config_json=True]
--quiet
set log level to logging.CRITICAL (minimize logging output)
Equivalent to: [--Application.log_level=50]
--init
Initialize profile with default config files. This is equivalent
to running `ipython profile create <profile>` prior to startup.
Equivalent to: [--BaseIPythonApplication.copy_config_files=True --BaseIPythonApplication.auto_create=True]
--no-stdout
redirect stdout to the null device
Equivalent to: [--IPKernelApp.no_stdout=True]
--no-stderr
redirect stderr to the null device
Equivalent to: [--IPKernelApp.no_stderr=True]
--pylab
Pre-load matplotlib and numpy for interactive use with
the default matplotlib backend.
Equivalent to: [--InteractiveShellApp.pylab=auto]
--trio-loop
Enable Trio as main event loop.
Equivalent to: [--InteractiveShell.trio_loop=False]
--autoindent
Turn on autoindenting.
Equivalent to: [--InteractiveShell.autoindent=True]
--no-autoindent
Turn off autoindenting.
Equivalent to: [--InteractiveShell.autoindent=False]
--automagic
Turn on the auto calling of magic commands. Type %%magic at the
IPython prompt for more information.
Equivalent to: [--InteractiveShell.automagic=True]
--no-automagic
Turn off the auto calling of magic commands.
Equivalent to: [--InteractiveShell.automagic=False]
--pdb
Enable auto calling the pdb debugger after every exception.
Equivalent to: [--InteractiveShell.pdb=True]
--no-pdb
Disable auto calling the pdb debugger after every exception.
Equivalent to: [--InteractiveShell.pdb=False]
--pprint
Enable auto pretty printing of results.
Equivalent to: [--PlainTextFormatter.pprint=True]
--no-pprint
Disable auto pretty printing of results.
Equivalent to: [--PlainTextFormatter.pprint=False]
--color-info
IPython can display information about objects via a set of functions,
and optionally can use colors for this, syntax highlighting
source code and various other elements. This is on by default, but can cause
problems with some pagers. If you see such problems, you can disable the
colours.
Equivalent to: [--InteractiveShell.color_info=True]
--no-color-info
Disable using colors for info related things.
Equivalent to: [--InteractiveShell.color_info=False]
--ignore-cwd
Exclude the current working directory from sys.path
Equivalent to: [--InteractiveShellApp.ignore_cwd=True]
--no-ignore-cwd
Include the current working directory in sys.path
Equivalent to: [--InteractiveShellApp.ignore_cwd=False]
--nosep
Eliminate all spacing between prompts.
Equivalent to: [--InteractiveShell.separate_in= --InteractiveShell.separate_out= --InteractiveShell.separate_out2=]
--matplotlib
Configure matplotlib for interactive use with
the default matplotlib backend.
Equivalent to: [--InteractiveShellApp.matplotlib=auto]
--secure
Use HMAC digests for authentication of messages.
Setting this flag will generate a new UUID to use as the HMAC key.
Equivalent to: [--Session.key=b'4ef9de0a-6c27b98ebfc2b64b10e5da4b' --Session.keyfile=]
--no-secure
Don't authenticate messages.
Equivalent to: [--Session.key=b'' --Session.keyfile=]
--log-level=<Enum>
Set the log level by value or name.
Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
Default: 30
Equivalent to: [--Application.log_level]
--profile-dir=<Unicode>
Set the profile location directly. This overrides the logic used by the
`profile` option.
Default: ''
Equivalent to: [--ProfileDir.location]
--profile=<Unicode>
The IPython profile to use.
Default: 'default'
Equivalent to: [--BaseIPythonApplication.profile]
--ipython-dir=<Unicode>
The name of the IPython directory. This directory is used for logging
configuration (through profiles), history storage, etc. The default is
usually $HOME/.ipython. This option can also be specified through the
environment variable IPYTHONDIR.
Default: ''
Equivalent to: [--BaseIPythonApplication.ipython_dir]
--config=<Unicode>
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython
config.
Default: ''
Equivalent to: [--BaseIPythonApplication.extra_config_file]
--ip=<Unicode>
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!
Default: ''
Equivalent to: [--IPKernelApp.ip]
--hb=<Int>
set the heartbeat port [default: random]
Default: 0
Equivalent to: [--IPKernelApp.hb_port]
--shell=<Int>
set the shell (ROUTER) port [default: random]
Default: 0
Equivalent to: [--IPKernelApp.shell_port]
--iopub=<Int>
set the iopub (PUB) port [default: random]
Default: 0
Equivalent to: [--IPKernelApp.iopub_port]
--stdin=<Int>
set the stdin (ROUTER) port [default: random]
Default: 0
Equivalent to: [--IPKernelApp.stdin_port]
--control=<Int>
set the control (ROUTER) port [default: random]
Default: 0
Equivalent to: [--IPKernelApp.control_port]
-f=<Unicode>
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.
Default: ''
Equivalent to: [--IPKernelApp.connection_file]
--transport=<CaselessStrEnum>
Choices: any of ['tcp', 'ipc'] (case-insensitive)
Default: 'tcp'
Equivalent to: [--IPKernelApp.transport]
--autocall=<Enum>
Make IPython automatically call any callable object even if you didn't type
explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
The value can be '0' to disable the feature, '1' for 'smart' autocall, where
it is not applied if there are no more arguments on the line, and '2' for
'full' autocall, where all callable objects are automatically called (even
if no arguments are present).
Choices: any of [0, 1, 2]
Default: 0
Equivalent to: [--InteractiveShell.autocall]
--colors=<CaselessStrEnum>
Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
Default: 'Neutral'
Equivalent to: [--InteractiveShell.colors]
--logfile=<Unicode>
The name of the logfile to use.
Default: ''
Equivalent to: [--InteractiveShell.logfile]
--logappend=<Unicode>
Start logging to the given file in append mode. Use `logfile` to specify a
log file to **overwrite** logs to.
Default: ''
Equivalent to: [--InteractiveShell.logappend]
-c=<Unicode>
Execute the given command string.
Default: ''
Equivalent to: [--InteractiveShellApp.code_to_run]
-m=<Unicode>
Run the module as a script.
Default: ''
Equivalent to: [--InteractiveShellApp.module_to_run]
--ext=<list-item-1>...
Dotted module name(s) of one or more IPython extensions to load.
For specifying extra extensions to load on the command-line.
.. versionadded:: 7.10
Default: []
Equivalent to: [--InteractiveShellApp.extra_extensions]
--gui=<CaselessStrEnum>
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
'gtk2', 'qt4').
Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
Default: None
Equivalent to: [--InteractiveShellApp.gui]
--pylab=<CaselessStrEnum>
Pre-load matplotlib and numpy for interactive use,
selecting a particular matplotlib backend and loop integration.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
Equivalent to: [--InteractiveShellApp.pylab]
--matplotlib=<CaselessStrEnum>
Configure matplotlib for interactive use with
the default matplotlib backend.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
Equivalent to: [--InteractiveShellApp.matplotlib]
--cache-size=<Int>
Set the size of the output cache. The default is 1000, you can change it
permanently in your config file. Setting it to 0 completely disables the
caching system, and the minimum value accepted is 3 (if you provide a value
less than 3, it is reset to 0 and a warning is issued). This limit is
defined because otherwise you'll spend more time re-flushing a too small
cache than working
Default: 1000
Equivalent to: [--InteractiveShell.cache_size]
--ident=<CUnicode>
The UUID identifying this session.
Default: ''
Equivalent to: [--Session.session]
--user=<Unicode>
Username for the Session. Default is your system username.
Default: 'musk'
Equivalent to: [--Session.username]
--keyfile=<Unicode>
path to file containing execution key.
Default: ''
Equivalent to: [--Session.keyfile]
Class options
=============
The command-line option below sets the respective configurable class-parameter:
--Class.parameter=value
This line is evaluated in Python, so simple expressions are allowed.
For instance, to set `C.a=[0,1,2]`, you may type this:
--C.a='range(3)'
ConnectionFileMixin(LoggingConfigurable) options
------------------------------------------------
--ConnectionFileMixin.connection_file=<Unicode>
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.
Default: ''
--ConnectionFileMixin.control_port=<Int>
set the control (ROUTER) port [default: random]
Default: 0
--ConnectionFileMixin.hb_port=<Int>
set the heartbeat port [default: random]
Default: 0
--ConnectionFileMixin.iopub_port=<Int>
set the iopub (PUB) port [default: random]
Default: 0
--ConnectionFileMixin.ip=<Unicode>
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!
Default: ''
--ConnectionFileMixin.shell_port=<Int>
set the shell (ROUTER) port [default: random]
Default: 0
--ConnectionFileMixin.stdin_port=<Int>
set the stdin (ROUTER) port [default: random]
Default: 0
--ConnectionFileMixin.transport=<CaselessStrEnum>
Choices: any of ['tcp', 'ipc'] (case-insensitive)
Default: 'tcp'
InteractiveShellApp(Configurable) options
-----------------------------------------
--InteractiveShellApp.code_to_run=<Unicode>
Execute the given command string.
Default: ''
--InteractiveShellApp.exec_PYTHONSTARTUP=<Bool>
Run the file referenced by the PYTHONSTARTUP environment
variable at IPython startup.
Default: True
--InteractiveShellApp.exec_files=<list-item-1>...
List of files to run at IPython startup.
Default: []
--InteractiveShellApp.exec_lines=<list-item-1>...
lines of code to run at IPython startup.
Default: []
--InteractiveShellApp.extensions=<list-item-1>...
A list of dotted module names of IPython extensions to load.
Default: []
--InteractiveShellApp.extra_extensions=<list-item-1>...
Dotted module name(s) of one or more IPython extensions to load.
For specifying extra extensions to load on the command-line.
.. versionadded:: 7.10
Default: []
--InteractiveShellApp.file_to_run=<Unicode>
A file to be run
Default: ''
--InteractiveShellApp.gui=<CaselessStrEnum>
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
'gtk2', 'qt4').
Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
Default: None
--InteractiveShellApp.hide_initial_ns=<Bool>
Should variables loaded at startup (by startup files, exec_lines, etc.)
be hidden from tools like %who?
Default: True
--InteractiveShellApp.ignore_cwd=<Bool>
If True, IPython will not add the current working directory to sys.path.
When False, the current working directory is added to sys.path, allowing imports
of modules defined in the current directory.
Default: False
--InteractiveShellApp.matplotlib=<CaselessStrEnum>
Configure matplotlib for interactive use with
the default matplotlib backend.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
--InteractiveShellApp.module_to_run=<Unicode>
Run the module as a script.
Default: ''
--InteractiveShellApp.pylab=<CaselessStrEnum>
Pre-load matplotlib and numpy for interactive use,
selecting a particular matplotlib backend and loop integration.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
--InteractiveShellApp.pylab_import_all=<Bool>
If true, IPython will populate the user namespace with numpy, pylab, etc.
and an ``import *`` is done from numpy and pylab, when using pylab mode.
When False, pylab mode should not import any names into the user
namespace.
Default: True
--InteractiveShellApp.reraise_ipython_extension_failures=<Bool>
Reraise exceptions encountered loading IPython extensions?
Default: False
Application(SingletonConfigurable) options
------------------------------------------
--Application.log_datefmt=<Unicode>
The date format used by logging formatters for %(asctime)s
Default: '%Y-%m-%d %H:%M:%S'
--Application.log_format=<Unicode>
The Logging format template
Default: '[%(name)s]%(highlevel)s %(message)s'
--Application.log_level=<Enum>
Set the log level by value or name.
Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
Default: 30
--Application.logging_config=<key-1>=<value-1>...
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:
.. code-block:: python
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'],
},
}
}
Default: {
}
--Application.show_config=<Bool>
Instead of starting the Application, dump configuration to stdout
Default: False
--Application.show_config_json=<Bool>
Instead of starting the Application, dump configuration to stdout (as JSON)
Default: False
BaseIPythonApplication(Application) options
-------------------------------------------
--BaseIPythonApplication.add_ipython_dir_to_sys_path=<Bool>
Default: False
--BaseIPythonApplication.auto_create=<Bool>
Whether to create profile dir if it doesn't exist
Default: False
--BaseIPythonApplication.copy_config_files=<Bool>
Whether to install the default config files into the profile dir.
If a new profile is being created, and IPython contains config files for that
profile, then they will be staged into the new directory. Otherwise,
default config files will be automatically generated.
Default: False
--BaseIPythonApplication.extra_config_file=<Unicode>
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython
config.
Default: ''
--BaseIPythonApplication.ipython_dir=<Unicode>
The name of the IPython directory. This directory is used for logging
configuration (through profiles), history storage, etc. The default is
usually $HOME/.ipython. This option can also be specified through the
environment variable IPYTHONDIR.
Default: ''
--BaseIPythonApplication.log_datefmt=<Unicode>
The date format used by logging formatters for %(asctime)s
Default: '%Y-%m-%d %H:%M:%S'
--BaseIPythonApplication.log_format=<Unicode>
The Logging format template
Default: '[%(name)s]%(highlevel)s %(message)s'
--BaseIPythonApplication.log_level=<Enum>
Set the log level by value or name.
Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
Default: 30
--BaseIPythonApplication.logging_config=<key-1>=<value-1>...
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:
.. code-block:: python
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'],
},
}
}
Default: {
}
--BaseIPythonApplication.overwrite=<Bool>
Whether to overwrite existing config files when copying
Default: False
--BaseIPythonApplication.profile=<Unicode>
The IPython profile to use.
Default: 'default'
--BaseIPythonApplication.show_config=<Bool>
Instead of starting the Application, dump configuration to stdout
Default: False
--BaseIPythonApplication.show_config_json=<Bool>
Instead of starting the Application, dump configuration to stdout (as JSON)
Default: False
--BaseIPythonApplication.verbose_crash=<Bool>
Create a massive crash report when IPython encounters what may be an
internal error. The default is to append a short message to the
usual traceback
Default: False
IPKernelApp(BaseIPythonApplication, InteractiveShellApp, ConnectionFileMixin) options
-------------------------------------------------------------------------------------
--IPKernelApp.add_ipython_dir_to_sys_path=<Bool>
Default: False
--IPKernelApp.auto_create=<Bool>
Whether to create profile dir if it doesn't exist
Default: False
--IPKernelApp.capture_fd_output=<Bool>
Attempt to capture and forward low-level output, e.g. produced by Extension
libraries.
Default: True
--IPKernelApp.code_to_run=<Unicode>
Execute the given command string.
Default: ''
--IPKernelApp.connection_file=<Unicode>
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.
Default: ''
--IPKernelApp.control_port=<Int>
set the control (ROUTER) port [default: random]
Default: 0
--IPKernelApp.copy_config_files=<Bool>
Whether to install the default config files into the profile dir.
If a new profile is being created, and IPython contains config files for that
profile, then they will be staged into the new directory. Otherwise,
default config files will be automatically generated.
Default: False
--IPKernelApp.displayhook_class=<DottedObjectName>
The importstring for the DisplayHook factory
Default: 'ipykernel.displayhook.ZMQDisplayHook'
--IPKernelApp.exec_PYTHONSTARTUP=<Bool>
Run the file referenced by the PYTHONSTARTUP environment
variable at IPython startup.
Default: True
--IPKernelApp.exec_files=<list-item-1>...
List of files to run at IPython startup.
Default: []
--IPKernelApp.exec_lines=<list-item-1>...
lines of code to run at IPython startup.
Default: []
--IPKernelApp.extensions=<list-item-1>...
A list of dotted module names of IPython extensions to load.
Default: []
--IPKernelApp.extra_config_file=<Unicode>
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython
config.
Default: ''
--IPKernelApp.extra_extensions=<list-item-1>...
Dotted module name(s) of one or more IPython extensions to load.
For specifying extra extensions to load on the command-line.
.. versionadded:: 7.10
Default: []
--IPKernelApp.file_to_run=<Unicode>
A file to be run
Default: ''
--IPKernelApp.gui=<CaselessStrEnum>
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
'gtk2', 'qt4').
Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
Default: None
--IPKernelApp.hb_port=<Int>
set the heartbeat port [default: random]
Default: 0
--IPKernelApp.hide_initial_ns=<Bool>
Should variables loaded at startup (by startup files, exec_lines, etc.)
be hidden from tools like %who?
Default: True
--IPKernelApp.ignore_cwd=<Bool>
If True, IPython will not add the current working directory to sys.path.
When False, the current working directory is added to sys.path, allowing imports
of modules defined in the current directory.
Default: False
--IPKernelApp.interrupt=<Int>
ONLY USED ON WINDOWS
Interrupt this process when the parent is signaled.
Default: 0
--IPKernelApp.iopub_port=<Int>
set the iopub (PUB) port [default: random]
Default: 0
--IPKernelApp.ip=<Unicode>
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!
Default: ''
--IPKernelApp.ipython_dir=<Unicode>
The name of the IPython directory. This directory is used for logging
configuration (through profiles), history storage, etc. The default is
usually $HOME/.ipython. This option can also be specified through the
environment variable IPYTHONDIR.
Default: ''
--IPKernelApp.kernel_class=<Type>
The Kernel subclass to be used.
This should allow easy re-use of the IPKernelApp entry point
to configure and launch kernels other than IPython's own.
Default: 'ipykernel.ipkernel.IPythonKernel'
--IPKernelApp.log_datefmt=<Unicode>
The date format used by logging formatters for %(asctime)s
Default: '%Y-%m-%d %H:%M:%S'
--IPKernelApp.log_format=<Unicode>
The Logging format template
Default: '[%(name)s]%(highlevel)s %(message)s'
--IPKernelApp.log_level=<Enum>
Set the log level by value or name.
Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
Default: 30
--IPKernelApp.logging_config=<key-1>=<value-1>...
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:
.. code-block:: python
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'],
},
}
}
Default: {
}
--IPKernelApp.matplotlib=<CaselessStrEnum>
Configure matplotlib for interactive use with
the default matplotlib backend.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
--IPKernelApp.module_to_run=<Unicode>
Run the module as a script.
Default: ''
--IPKernelApp.no_stderr=<Bool>
redirect stderr to the null device
Default: False
--IPKernelApp.no_stdout=<Bool>
redirect stdout to the null device
Default: False
--IPKernelApp.outstream_class=<DottedObjectName>
The importstring for the OutStream factory
Default: 'ipykernel.iostream.OutStream'
--IPKernelApp.overwrite=<Bool>
Whether to overwrite existing config files when copying
Default: False
--IPKernelApp.parent_handle=<Int>
kill this process if its parent dies. On Windows, the argument
specifies the HANDLE of the parent process, otherwise it is simply boolean.
Default: 0
--IPKernelApp.profile=<Unicode>
The IPython profile to use.
Default: 'default'
--IPKernelApp.pylab=<CaselessStrEnum>
Pre-load matplotlib and numpy for interactive use,
selecting a particular matplotlib backend and loop integration.
Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
Default: None
--IPKernelApp.pylab_import_all=<Bool>
If true, IPython will populate the user namespace with numpy, pylab, etc.
and an ``import *`` is done from numpy and pylab, when using pylab mode.
When False, pylab mode should not import any names into the user
namespace.
Default: True
--IPKernelApp.quiet=<Bool>
Only send stdout/stderr to output stream
Default: True
--IPKernelApp.reraise_ipython_extension_failures=<Bool>
Reraise exceptions encountered loading IPython extensions?
Default: False
--IPKernelApp.shell_port=<Int>
set the shell (ROUTER) port [default: random]
Default: 0
--IPKernelApp.show_config=<Bool>
Instead of starting the Application, dump configuration to stdout
Default: False
--IPKernelApp.show_config_json=<Bool>
Instead of starting the Application, dump configuration to stdout (as JSON)
Default: False
--IPKernelApp.stdin_port=<Int>
set the stdin (ROUTER) port [default: random]
Default: 0
--IPKernelApp.transport=<CaselessStrEnum>
Choices: any of ['tcp', 'ipc'] (case-insensitive)
Default: 'tcp'
--IPKernelApp.trio_loop=<Bool>
Set main event loop.
Default: False
--IPKernelApp.verbose_crash=<Bool>
Create a massive crash report when IPython encounters what may be an
internal error. The default is to append a short message to the
usual traceback
Default: False
Kernel(SingletonConfigurable) options
-------------------------------------
--Kernel._darwin_app_nap=<Bool>
Whether to use appnope for compatibility with OS X App Nap.
Only affects OS X >= 10.9.
Default: True
--Kernel._execute_sleep=<Float>
Default: 0.0005
--Kernel._poll_interval=<Float>
Default: 0.01
--Kernel.debug_just_my_code=<Bool>
Set to False if you want to debug python standard and dependent libraries.
Default: True
--Kernel.stop_on_error_timeout=<Float>
time (in seconds) to wait for messages to arrive
when aborting queued requests after an error.
Requests that arrive within this window after an error
will be cancelled.
Increase in the event of unusually slow network
causing significant delays,
which can manifest as e.g. "Run all" in a notebook
aborting some, but not all, messages after an error.
Default: 0.0
IPythonKernel(Kernel) options
-----------------------------
--IPythonKernel._darwin_app_nap=<Bool>
Whether to use appnope for compatibility with OS X App Nap.
Only affects OS X >= 10.9.
Default: True
--IPythonKernel._execute_sleep=<Float>
Default: 0.0005
--IPythonKernel._poll_interval=<Float>
Default: 0.01
--IPythonKernel.debug_just_my_code=<Bool>
Set to False if you want to debug python standard and dependent libraries.
Default: True
--IPythonKernel.help_links=<list-item-1>...
Default: [{
'text': 'Python Reference', 'url': 'https://docs.python.org...
--IPythonKernel.stop_on_error_timeout=<Float>
time (in seconds) to wait for messages to arrive
when aborting queued requests after an error.
Requests that arrive within this window after an error
will be cancelled.
Increase in the event of unusually slow network
causing significant delays,
which can manifest as e.g. "Run all" in a notebook
aborting some, but not all, messages after an error.
Default: 0.0
--IPythonKernel.use_experimental_completions=<Bool>
Set this flag to False to deactivate the use of experimental IPython
completion APIs.
Default: True
InteractiveShell(SingletonConfigurable) options
-----------------------------------------------
--InteractiveShell.ast_node_interactivity=<Enum>
'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which
nodes should be run interactively (displaying output from expressions).
Choices: any of ['all', 'last', 'last_expr', 'none', 'last_expr_or_assign']
Default: 'last_expr'
--InteractiveShell.ast_transformers=<list-item-1>...
A list of ast.NodeTransformer subclass instances, which will be applied to
user input before code is run.
Default: []
--InteractiveShell.autoawait=<Bool>
Automatically run await statement in the top level repl.
Default: True
--InteractiveShell.autocall=<Enum>
Make IPython automatically call any callable object even if you didn't type
explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
The value can be '0' to disable the feature, '1' for 'smart' autocall, where
it is not applied if there are no more arguments on the line, and '2' for
'full' autocall, where all callable objects are automatically called (even
if no arguments are present).
Choices: any of [0, 1, 2]
Default: 0
--InteractiveShell.autoindent=<Bool>
Autoindent IPython code entered interactively.
Default: True
--InteractiveShell.automagic=<Bool>
Enable magic commands to be called without the leading %.
Default: True
--InteractiveShell.banner1=<Unicode>
The part of the banner to be printed before the profile
Default: "Python 3.8.17 (default, Jul 5 2023, 21:04:15) \nType 'copyr...
--InteractiveShell.banner2=<Unicode>
The part of the banner to be printed after the profile
Default: ''
--InteractiveShell.cache_size=<Int>
Set the size of the output cache. The default is 1000, you can change it
permanently in your config file. Setting it to 0 completely disables the
caching system, and the minimum value accepted is 3 (if you provide a value
less than 3, it is reset to 0 and a warning is issued). This limit is
defined because otherwise you'll spend more time re-flushing a too small
cache than working
Default: 1000
--InteractiveShell.color_info=<Bool>
Use colors for displaying information about objects. Because this
information is passed through a pager (like 'less'), and some pagers get
confused with color codes, this capability can be turned off.
Default: True
--InteractiveShell.colors=<CaselessStrEnum>
Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
Default: 'Neutral'
--InteractiveShell.debug=<Bool>
Default: False
--InteractiveShell.disable_failing_post_execute=<Bool>
Don't call post-execute functions that have failed in the past.
Default: False
--InteractiveShell.display_page=<Bool>
If True, anything that would be passed to the pager
will be displayed as regular output instead.
Default: False
--InteractiveShell.enable_html_pager=<Bool>
(Provisional API) enables html representation in mime bundles sent to
pagers.
Default: False
--InteractiveShell.history_length=<Int>
Total length of command history
Default: 10000
--InteractiveShell.history_load_length=<Int>
The number of saved history entries to be loaded into the history buffer at
startup.
Default: 1000
--InteractiveShell.inspector_class=<Type>
Class to use to instantiate the shell inspector
Default: 'IPython.core.oinspect.Inspector'
--InteractiveShell.ipython_dir=<Unicode>
Default: ''
--InteractiveShell.logappend=<Unicode>
Start logging to the given file in append mode. Use `logfile` to specify a
log file to **overwrite** logs to.
Default: ''
--InteractiveShell.logfile=<Unicode>
The name of the logfile to use.
Default: ''
--InteractiveShell.logstart=<Bool>
Start logging to the default log file in overwrite mode. Use `logappend` to
specify a log file to **append** logs to.
Default: False
--InteractiveShell.loop_runner=<Any>
Select the loop runner that will be used to execute top-level asynchronous
code
Default: 'IPython.core.interactiveshell._asyncio_runner'
--InteractiveShell.object_info_string_level=<Enum>
Choices: any of [0, 1, 2]
Default: 0
--InteractiveShell.pdb=<Bool>
Automatically call the pdb debugger after every exception.
Default: False
--InteractiveShell.quiet=<Bool>
Default: False
--InteractiveShell.separate_in=<SeparateUnicode>
Default: '\n'
--InteractiveShell.separate_out=<SeparateUnicode>
Default: ''
--InteractiveShell.separate_out2=<SeparateUnicode>
Default: ''
--InteractiveShell.show_rewritten_input=<Bool>
Show rewritten input, e.g. for autocall.
Default: True
--InteractiveShell.sphinxify_docstring=<Bool>
Enables rich html representation of docstrings. (This requires the docrepr
module).
Default: False
--InteractiveShell.warn_venv=<Bool>
Warn if running in a virtual environment with no IPython installed (so
IPython from the global environment is used).
Default: True
--InteractiveShell.wildcards_case_sensitive=<Bool>
Default: True
--InteractiveShell.xmode=<CaselessStrEnum>
Switch modes for the IPython exception handlers.
Choices: any of ['Context', 'Plain', 'Verbose', 'Minimal'] (case-insensitive)
Default: 'Context'
ZMQInteractiveShell(InteractiveShell) options
---------------------------------------------
--ZMQInteractiveShell.ast_node_interactivity=<Enum>
'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which
nodes should be run interactively (displaying output from expressions).
Choices: any of ['all', 'last', 'last_expr', 'none', 'last_expr_or_assign']
Default: 'last_expr'
--ZMQInteractiveShell.ast_transformers=<list-item-1>...
A list of ast.NodeTransformer subclass instances, which will be applied to
user input before code is run.
Default: []
--ZMQInteractiveShell.autoawait=<Bool>
Automatically run await statement in the top level repl.
Default: True
--ZMQInteractiveShell.autocall=<Enum>
Make IPython automatically call any callable object even if you didn't type
explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
The value can be '0' to disable the feature, '1' for 'smart' autocall, where
it is not applied if there are no more arguments on the line, and '2' for
'full' autocall, where all callable objects are automatically called (even
if no arguments are present).
Choices: any of [0, 1, 2]
Default: 0
--ZMQInteractiveShell.automagic=<Bool>
Enable magic commands to be called without the leading %.
Default: True
--ZMQInteractiveShell.banner1=<Unicode>
The part of the banner to be printed before the profile
Default: "Python 3.8.17 (default, Jul 5 2023, 21:04:15) \nType 'copyr...
--ZMQInteractiveShell.banner2=<Unicode>
The part of the banner to be printed after the profile
Default: ''
--ZMQInteractiveShell.cache_size=<Int>
Set the size of the output cache. The default is 1000, you can change it
permanently in your config file. Setting it to 0 completely disables the
caching system, and the minimum value accepted is 3 (if you provide a value
less than 3, it is reset to 0 and a warning is issued). This limit is
defined because otherwise you'll spend more time re-flushing a too small
cache than working
Default: 1000
--ZMQInteractiveShell.color_info=<Bool>
Use colors for displaying information about objects. Because this
information is passed through a pager (like 'less'), and some pagers get
confused with color codes, this capability can be turned off.
Default: True
--ZMQInteractiveShell.colors=<CaselessStrEnum>
Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
Default: 'Neutral'
--ZMQInteractiveShell.debug=<Bool>
Default: False
--ZMQInteractiveShell.disable_failing_post_execute=<Bool>
Don't call post-execute functions that have failed in the past.
Default: False
--ZMQInteractiveShell.display_page=<Bool>
If True, anything that would be passed to the pager
will be displayed as regular output instead.
Default: False
--ZMQInteractiveShell.enable_html_pager=<Bool>
(Provisional API) enables html representation in mime bundles sent to
pagers.
Default: False
--ZMQInteractiveShell.history_length=<Int>
Total length of command history
Default: 10000
--ZMQInteractiveShell.history_load_length=<Int>
The number of saved history entries to be loaded into the history buffer at
startup.
Default: 1000
--ZMQInteractiveShell.inspector_class=<Type>
Class to use to instantiate the shell inspector
Default: 'IPython.core.oinspect.Inspector'
--ZMQInteractiveShell.ipython_dir=<Unicode>
Default: ''
--ZMQInteractiveShell.logappend=<Unicode>
Start logging to the given file in append mode. Use `logfile` to specify a
log file to **overwrite** logs to.
Default: ''
--ZMQInteractiveShell.logfile=<Unicode>
The name of the logfile to use.
Default: ''
--ZMQInteractiveShell.logstart=<Bool>
Start logging to the default log file in overwrite mode. Use `logappend` to
specify a log file to **append** logs to.
Default: False
--ZMQInteractiveShell.loop_runner=<Any>
Select the loop runner that will be used to execute top-level asynchronous
code
Default: 'IPython.core.interactiveshell._asyncio_runner'
--ZMQInteractiveShell.object_info_string_level=<Enum>
Choices: any of [0, 1, 2]
Default: 0
--ZMQInteractiveShell.pdb=<Bool>
Automatically call the pdb debugger after every exception.
Default: False
--ZMQInteractiveShell.quiet=<Bool>
Default: False
--ZMQInteractiveShell.separate_in=<SeparateUnicode>
Default: '\n'
--ZMQInteractiveShell.separate_out=<SeparateUnicode>
Default: ''
--ZMQInteractiveShell.separate_out2=<SeparateUnicode>
Default: ''
--ZMQInteractiveShell.show_rewritten_input=<Bool>
Show rewritten input, e.g. for autocall.
Default: True
--ZMQInteractiveShell.sphinxify_docstring=<Bool>
Enables rich html representation of docstrings. (This requires the docrepr
module).
Default: False
--ZMQInteractiveShell.warn_venv=<Bool>
Warn if running in a virtual environment with no IPython installed (so
IPython from the global environment is used).
Default: True
--ZMQInteractiveShell.wildcards_case_sensitive=<Bool>
Default: True
--ZMQInteractiveShell.xmode=<CaselessStrEnum>
Switch modes for the IPython exception handlers.
Choices: any of ['Context', 'Plain', 'Verbose', 'Minimal'] (case-insensitive)
Default: 'Context'
ProfileDir(LoggingConfigurable) options
---------------------------------------
--ProfileDir.location=<Unicode>
Set the profile location directly. This overrides the logic used by the
`profile` option.
Default: ''
Session(Configurable) options
-----------------------------
--Session.buffer_threshold=<Int>
Threshold (in bytes) beyond which an object's buffer should be extracted to
avoid pickling.
Default: 1024
--Session.check_pid=<Bool>
Whether to check PID to protect against calls after fork.
This check can be disabled if fork-safety is handled elsewhere.
Default: True
--Session.copy_threshold=<Int>
Threshold (in bytes) beyond which a buffer should be sent without copying.
Default: 65536
--Session.debug=<Bool>
Debug output in the Session
Default: False
--Session.digest_history_size=<Int>
The maximum number of digests to remember.
The digest history will be culled when it exceeds this value.
Default: 65536
--Session.item_threshold=<Int>
The maximum number of items for a container to be introspected for custom serialization.
Containers larger than this are pickled outright.
Default: 64
--Session.key=<CBytes>
execution key, for signing messages.
Default: b''
--Session.keyfile=<Unicode>
path to file containing execution key.
Default: ''
--Session.metadata=<key-1>=<value-1>...
Metadata dictionary, which serves as the default top-level metadata dict for
each message.
Default: {
}
--Session.packer=<DottedObjectName>
The name of the packer for serializing messages.
Should be one of 'json', 'pickle', or an import name
for a custom callable serializer.
Default: 'json'
--Session.session=<CUnicode>
The UUID identifying this session.
Default: ''
--Session.signature_scheme=<Unicode>
The digest scheme used to construct the message signatures.
Must have the form 'hmac-HASH'.
Default: 'hmac-sha256'
--Session.unpacker=<DottedObjectName>
The name of the unpacker for unserializing messages.
Only used with custom functions for `packer`.
Default: 'json'
--Session.username=<Unicode>
Username for the Session. Default is your system username.
Default: 'musk'
ipykernel help information
Guess you like
Origin blog.csdn.net/orDream/article/details/131677066
Ranking