Warning
This documentation covers a development version of IPython. The development version may differ significantly from the latest stable release.
Important
This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.
If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).
IPython kernel options¶
These options can be used in ipython_kernel_config.py
. The kernel also respects any options in ipython_config.py
-
ConnectionFileMixin.connection_file
¶ 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.
Trait type: Unicode
-
ConnectionFileMixin.control_port
¶ set the control (ROUTER) port [default: random]
Trait type: Int Default: 0
-
ConnectionFileMixin.hb_port
¶ set the heartbeat port [default: random]
Trait type: Int Default: 0
-
ConnectionFileMixin.iopub_port
¶ set the iopub (PUB) port [default: random]
Trait type: Int Default: 0
-
ConnectionFileMixin.ip
¶ 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!
Trait type: Unicode
-
ConnectionFileMixin.shell_port
¶ set the shell (ROUTER) port [default: random]
Trait type: Int Default: 0
-
ConnectionFileMixin.stdin_port
¶ set the stdin (ROUTER) port [default: random]
Trait type: Int Default: 0
-
ConnectionFileMixin.transport
¶ No description
Options: 'tcp'
,'ipc'
Default: 'tcp'
-
InteractiveShellApp.code_to_run
¶ Execute the given command string.
Trait type: Unicode CLI option: -c
-
InteractiveShellApp.exec_PYTHONSTARTUP
¶ Run the file referenced by the PYTHONSTARTUP environment variable at IPython startup.
Trait type: Bool Default: True
-
InteractiveShellApp.exec_files
¶ List of files to run at IPython startup.
Trait type: List
-
InteractiveShellApp.exec_lines
¶ lines of code to run at IPython startup.
Trait type: List
-
InteractiveShellApp.extensions
¶ A list of dotted module names of IPython extensions to load.
Trait type: List
-
InteractiveShellApp.extra_extension
¶ dotted module name of an IPython extension to load.
Trait type: Unicode CLI option: --ext
-
InteractiveShellApp.file_to_run
¶ A file to be run
Trait type: Unicode
-
InteractiveShellApp.gui
¶ Enable GUI event loop integration with any of (‘glut’, ‘gtk’, ‘gtk2’, ‘gtk3’, ‘osx’, ‘pyglet’, ‘qt’, ‘qt4’, ‘qt5’, ‘tk’, ‘wx’, ‘gtk2’, ‘qt4’).
Options: 'glut'
,'gtk'
,'gtk2'
,'gtk3'
,'osx'
,'pyglet'
,'qt'
,'qt4'
,'qt5'
,'tk'
,'wx'
,'gtk2'
,'qt4'
CLI option: --gui
-
InteractiveShellApp.hide_initial_ns
¶ Should variables loaded at startup (by startup files, exec_lines, etc.) be hidden from tools like %who?
Trait type: Bool Default: True
-
InteractiveShellApp.matplotlib
¶ Configure matplotlib for interactive use with the default matplotlib backend.
Options: 'auto'
,'agg'
,'gtk'
,'gtk3'
,'inline'
,'ipympl'
,'nbagg'
,'notebook'
,'osx'
,'pdf'
,'ps'
,'qt'
,'qt4'
,'qt5'
,'svg'
,'tk'
,'widget'
,'wx'
CLI option: --matplotlib
-
InteractiveShellApp.module_to_run
¶ Run the module as a script.
Trait type: Unicode CLI option: -m
-
InteractiveShellApp.pylab
¶ Pre-load matplotlib and numpy for interactive use, selecting a particular matplotlib backend and loop integration.
Options: 'auto'
,'agg'
,'gtk'
,'gtk3'
,'inline'
,'ipympl'
,'nbagg'
,'notebook'
,'osx'
,'pdf'
,'ps'
,'qt'
,'qt4'
,'qt5'
,'svg'
,'tk'
,'widget'
,'wx'
CLI option: --pylab
-
InteractiveShellApp.pylab_import_all
¶ 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.
Trait type: Bool Default: True
-
InteractiveShellApp.reraise_ipython_extension_failures
¶ Reraise exceptions encountered loading IPython extensions?
Trait type: Bool Default: False
-
Application.log_datefmt
¶ The date format used by logging formatters for %(asctime)s
Trait type: Unicode Default: '%Y-%m-%d %H:%M:%S'
-
Application.log_format
¶ The Logging format template
Trait type: Unicode Default: '[%(name)s]%(highlevel)s %(message)s'
-
Application.log_level
¶ Set the log level by value or name.
Options: 0
,10
,20
,30
,40
,50
,'DEBUG'
,'INFO'
,'WARN'
,'ERROR'
,'CRITICAL'
Default: 30
CLI option: --log-level
-
BaseIPythonApplication.auto_create
¶ Whether to create profile dir if it doesn’t exist
Trait type: Bool Default: False
-
BaseIPythonApplication.copy_config_files
¶ 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.
Trait type: Bool Default: False
-
BaseIPythonApplication.extra_config_file
¶ Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
Trait type: Unicode CLI option: --config
-
BaseIPythonApplication.ipython_dir
¶ 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.
Trait type: Unicode CLI option: --ipython-dir
-
BaseIPythonApplication.log_datefmt
¶ The date format used by logging formatters for %(asctime)s
Trait type: Unicode Default: '%Y-%m-%d %H:%M:%S'
-
BaseIPythonApplication.log_format
¶ The Logging format template
Trait type: Unicode Default: '[%(name)s]%(highlevel)s %(message)s'
-
BaseIPythonApplication.log_level
¶ Set the log level by value or name.
Options: 0
,10
,20
,30
,40
,50
,'DEBUG'
,'INFO'
,'WARN'
,'ERROR'
,'CRITICAL'
Default: 30
-
BaseIPythonApplication.overwrite
¶ Whether to overwrite existing config files when copying
Trait type: Bool Default: False
-
BaseIPythonApplication.profile
¶ The IPython profile to use.
Trait type: Unicode Default: 'default'
CLI option: --profile
-
BaseIPythonApplication.verbose_crash
¶ 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
Trait type: Bool Default: False
-
IPKernelApp.auto_create
¶ Whether to create profile dir if it doesn’t exist
Trait type: Bool Default: False
-
IPKernelApp.code_to_run
¶ Execute the given command string.
Trait type: Unicode
-
IPKernelApp.connection_file
¶ 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.
Trait type: Unicode CLI option: -f
-
IPKernelApp.control_port
¶ set the control (ROUTER) port [default: random]
Trait type: Int Default: 0
CLI option: --control
-
IPKernelApp.copy_config_files
¶ 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.
Trait type: Bool Default: False
-
IPKernelApp.displayhook_class
¶ The importstring for the DisplayHook factory
Trait type: DottedObjectName Default: 'ipykernel.displayhook.ZMQDisplayHook'
-
IPKernelApp.exec_PYTHONSTARTUP
¶ Run the file referenced by the PYTHONSTARTUP environment variable at IPython startup.
Trait type: Bool Default: True
-
IPKernelApp.exec_files
¶ List of files to run at IPython startup.
Trait type: List
-
IPKernelApp.exec_lines
¶ lines of code to run at IPython startup.
Trait type: List
-
IPKernelApp.extensions
¶ A list of dotted module names of IPython extensions to load.
Trait type: List
-
IPKernelApp.extra_config_file
¶ Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
Trait type: Unicode
-
IPKernelApp.extra_extension
¶ dotted module name of an IPython extension to load.
Trait type: Unicode
-
IPKernelApp.file_to_run
¶ A file to be run
Trait type: Unicode
-
IPKernelApp.gui
¶ Enable GUI event loop integration with any of (‘glut’, ‘gtk’, ‘gtk2’, ‘gtk3’, ‘osx’, ‘pyglet’, ‘qt’, ‘qt4’, ‘qt5’, ‘tk’, ‘wx’, ‘gtk2’, ‘qt4’).
Options: 'glut'
,'gtk'
,'gtk2'
,'gtk3'
,'osx'
,'pyglet'
,'qt'
,'qt4'
,'qt5'
,'tk'
,'wx'
,'gtk2'
,'qt4'
-
IPKernelApp.hb_port
¶ set the heartbeat port [default: random]
Trait type: Int Default: 0
CLI option: --hb
-
IPKernelApp.hide_initial_ns
¶ Should variables loaded at startup (by startup files, exec_lines, etc.) be hidden from tools like %who?
Trait type: Bool Default: True
-
IPKernelApp.interrupt
¶ ONLY USED ON WINDOWS Interrupt this process when the parent is signaled.
Trait type: Int Default: 0
-
IPKernelApp.iopub_port
¶ set the iopub (PUB) port [default: random]
Trait type: Int Default: 0
CLI option: --iopub
-
IPKernelApp.ip
¶ 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!
Trait type: Unicode CLI option: --ip
-
IPKernelApp.ipython_dir
¶ 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.
Trait type: Unicode
-
IPKernelApp.kernel_class
¶ 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.
Trait type: Type Default: 'ipykernel.ipkernel.IPythonKernel'
-
IPKernelApp.log_datefmt
¶ The date format used by logging formatters for %(asctime)s
Trait type: Unicode Default: '%Y-%m-%d %H:%M:%S'
-
IPKernelApp.log_format
¶ The Logging format template
Trait type: Unicode Default: '[%(name)s]%(highlevel)s %(message)s'
-
IPKernelApp.log_level
¶ Set the log level by value or name.
Options: 0
,10
,20
,30
,40
,50
,'DEBUG'
,'INFO'
,'WARN'
,'ERROR'
,'CRITICAL'
Default: 30
-
IPKernelApp.matplotlib
¶ Configure matplotlib for interactive use with the default matplotlib backend.
Options: 'auto'
,'agg'
,'gtk'
,'gtk3'
,'inline'
,'ipympl'
,'nbagg'
,'notebook'
,'osx'
,'pdf'
,'ps'
,'qt'
,'qt4'
,'qt5'
,'svg'
,'tk'
,'widget'
,'wx'
-
IPKernelApp.module_to_run
¶ Run the module as a script.
Trait type: Unicode
-
IPKernelApp.no_stderr
¶ redirect stderr to the null device
Trait type: Bool Default: False
CLI option: --no-stderr
-
IPKernelApp.no_stdout
¶ redirect stdout to the null device
Trait type: Bool Default: False
CLI option: --no-stdout
-
IPKernelApp.outstream_class
¶ The importstring for the OutStream factory
Trait type: DottedObjectName Default: 'ipykernel.iostream.OutStream'
-
IPKernelApp.overwrite
¶ Whether to overwrite existing config files when copying
Trait type: Bool Default: False
-
IPKernelApp.parent_handle
¶ kill this process if its parent dies. On Windows, the argument specifies the HANDLE of the parent process, otherwise it is simply boolean.
Trait type: Int Default: 0
-
IPKernelApp.profile
¶ The IPython profile to use.
Trait type: Unicode Default: 'default'
-
IPKernelApp.pylab
¶ Pre-load matplotlib and numpy for interactive use, selecting a particular matplotlib backend and loop integration.
Options: 'auto'
,'agg'
,'gtk'
,'gtk3'
,'inline'
,'ipympl'
,'nbagg'
,'notebook'
,'osx'
,'pdf'
,'ps'
,'qt'
,'qt4'
,'qt5'
,'svg'
,'tk'
,'widget'
,'wx'
-
IPKernelApp.pylab_import_all
¶ 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.
Trait type: Bool Default: True
-
IPKernelApp.quiet
¶ Only send stdout/stderr to output stream
Trait type: Bool Default: True
-
IPKernelApp.reraise_ipython_extension_failures
¶ Reraise exceptions encountered loading IPython extensions?
Trait type: Bool Default: False
-
IPKernelApp.shell_port
¶ set the shell (ROUTER) port [default: random]
Trait type: Int Default: 0
CLI option: --shell
-
IPKernelApp.stdin_port
¶ set the stdin (ROUTER) port [default: random]
Trait type: Int Default: 0
CLI option: --stdin
-
IPKernelApp.transport
¶ No description
Options: 'tcp'
,'ipc'
Default: 'tcp'
CLI option: --transport
-
IPKernelApp.verbose_crash
¶ 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
Trait type: Bool Default: False
-
Kernel._darwin_app_nap
¶ Whether to use appnope for compatibility with OS X App Nap.
Only affects OS X >= 10.9.
Trait type: Bool Default: True
-
Kernel._execute_sleep
¶ No description
Trait type: Float Default: 0.0005
-
Kernel._poll_interval
¶ No description
Trait type: Float Default: 0.01
-
Kernel.stop_on_error_timeout
¶ 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.
Trait type: Float Default: 0.1
-
IPythonKernel._darwin_app_nap
¶ Whether to use appnope for compatibility with OS X App Nap.
Only affects OS X >= 10.9.
Trait type: Bool Default: True
-
IPythonKernel._execute_sleep
¶ No description
Trait type: Float Default: 0.0005
-
IPythonKernel._poll_interval
¶ No description
Trait type: Float Default: 0.01
-
IPythonKernel.help_links
¶ No description
Trait type: List
-
IPythonKernel.stop_on_error_timeout
¶ 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.
Trait type: Float Default: 0.1
-
IPythonKernel.use_experimental_completions
¶ Set this flag to False to deactivate the use of experimental IPython completion APIs.
Trait type: Bool Default: True
-
InteractiveShell.ast_node_interactivity
¶ ‘all’, ‘last’, ‘last_expr’ or ‘none’, ‘last_expr_or_assign’ specifying which nodes should be run interactively (displaying output from expressions).
Options: 'all'
,'last'
,'last_expr'
,'none'
,'last_expr_or_assign'
Default: 'last_expr'
-
InteractiveShell.ast_transformers
¶ A list of ast.NodeTransformer subclass instances, which will be applied to user input before code is run.
Trait type: List
-
InteractiveShell.autocall
¶ 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).
Options: 0
,1
,2
Default: 0
CLI option: --autocall
-
InteractiveShell.autoindent
¶ Autoindent IPython code entered interactively.
Trait type: Bool Default: True
CLI option: --autoindent
-
InteractiveShell.automagic
¶ Enable magic commands to be called without the leading %.
Trait type: Bool Default: True
CLI option: --automagic
The part of the banner to be printed before the profile
Trait type: Unicode Default: "Python 3.5.2 (default, Sep 14 2017, 22:51:06) \\nType 'copyri...
The part of the banner to be printed after the profile
Trait type: Unicode
-
InteractiveShell.cache_size
¶ 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
Trait type: Int Default: 1000
CLI option: --cache-size
-
InteractiveShell.color_info
¶ 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.
Trait type: Bool Default: True
CLI option: --color-info
-
InteractiveShell.colors
¶ Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Options: 'Neutral'
,'NoColor'
,'LightBG'
,'Linux'
Default: 'Neutral'
CLI option: --colors
-
InteractiveShell.debug
¶ No description
Trait type: Bool Default: False
-
InteractiveShell.disable_failing_post_execute
¶ Don’t call post-execute functions that have failed in the past.
Trait type: Bool Default: False
-
InteractiveShell.display_page
¶ If True, anything that would be passed to the pager will be displayed as regular output instead.
Trait type: Bool Default: False
-
InteractiveShell.enable_html_pager
¶ (Provisional API) enables html representation in mime bundles sent to pagers.
Trait type: Bool Default: False
-
InteractiveShell.history_length
¶ Total length of command history
Trait type: Int Default: 10000
-
InteractiveShell.history_load_length
¶ The number of saved history entries to be loaded into the history buffer at startup.
Trait type: Int Default: 1000
-
InteractiveShell.ipython_dir
¶ No description
Trait type: Unicode
-
InteractiveShell.logappend
¶ Start logging to the given file in append mode. Use
logfile
to specify a log file to overwrite logs to.Trait type: Unicode CLI option: --logappend
-
InteractiveShell.logfile
¶ The name of the logfile to use.
Trait type: Unicode CLI option: --logfile
-
InteractiveShell.logstart
¶ Start logging to the default log file in overwrite mode. Use
logappend
to specify a log file to append logs to.Trait type: Bool Default: False
-
InteractiveShell.object_info_string_level
¶ No description
Options: 0
,1
,2
Default: 0
-
InteractiveShell.pdb
¶ Automatically call the pdb debugger after every exception.
Trait type: Bool Default: False
CLI option: --pdb
-
InteractiveShell.prompt_in1
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'In [\\#]: '
-
InteractiveShell.prompt_in2
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: ' .\\D.: '
-
InteractiveShell.prompt_out
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'Out[\\#]: '
-
InteractiveShell.prompts_pad_left
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Bool Default: True
-
InteractiveShell.quiet
¶ No description
Trait type: Bool Default: False
-
InteractiveShell.separate_in
¶ No description
Trait type: SeparateUnicode Default: '\\n'
-
InteractiveShell.separate_out
¶ No description
Trait type: SeparateUnicode
-
InteractiveShell.separate_out2
¶ No description
Trait type: SeparateUnicode
-
InteractiveShell.show_rewritten_input
¶ Show rewritten input, e.g. for autocall.
Trait type: Bool Default: True
-
InteractiveShell.sphinxify_docstring
¶ Enables rich html representation of docstrings. (This requires the docrepr module).
Trait type: Bool Default: False
-
InteractiveShell.wildcards_case_sensitive
¶ No description
Trait type: Bool Default: True
-
InteractiveShell.xmode
¶ Switch modes for the IPython exception handlers.
Options: 'Context'
,'Plain'
,'Verbose'
Default: 'Context'
-
ZMQInteractiveShell.ast_node_interactivity
¶ ‘all’, ‘last’, ‘last_expr’ or ‘none’, ‘last_expr_or_assign’ specifying which nodes should be run interactively (displaying output from expressions).
Options: 'all'
,'last'
,'last_expr'
,'none'
,'last_expr_or_assign'
Default: 'last_expr'
-
ZMQInteractiveShell.ast_transformers
¶ A list of ast.NodeTransformer subclass instances, which will be applied to user input before code is run.
Trait type: List
-
ZMQInteractiveShell.autocall
¶ 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).
Options: 0
,1
,2
Default: 0
-
ZMQInteractiveShell.automagic
¶ Enable magic commands to be called without the leading %.
Trait type: Bool Default: True
The part of the banner to be printed before the profile
Trait type: Unicode Default: "Python 3.5.2 (default, Sep 14 2017, 22:51:06) \\nType 'copyri...
The part of the banner to be printed after the profile
Trait type: Unicode
-
ZMQInteractiveShell.cache_size
¶ 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
Trait type: Int Default: 1000
-
ZMQInteractiveShell.color_info
¶ 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.
Trait type: Bool Default: True
-
ZMQInteractiveShell.colors
¶ Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Options: 'Neutral'
,'NoColor'
,'LightBG'
,'Linux'
Default: 'Neutral'
-
ZMQInteractiveShell.debug
¶ No description
Trait type: Bool Default: False
-
ZMQInteractiveShell.disable_failing_post_execute
¶ Don’t call post-execute functions that have failed in the past.
Trait type: Bool Default: False
-
ZMQInteractiveShell.display_page
¶ If True, anything that would be passed to the pager will be displayed as regular output instead.
Trait type: Bool Default: False
-
ZMQInteractiveShell.enable_html_pager
¶ (Provisional API) enables html representation in mime bundles sent to pagers.
Trait type: Bool Default: False
-
ZMQInteractiveShell.history_length
¶ Total length of command history
Trait type: Int Default: 10000
-
ZMQInteractiveShell.history_load_length
¶ The number of saved history entries to be loaded into the history buffer at startup.
Trait type: Int Default: 1000
-
ZMQInteractiveShell.ipython_dir
¶ No description
Trait type: Unicode
-
ZMQInteractiveShell.logappend
¶ Start logging to the given file in append mode. Use
logfile
to specify a log file to overwrite logs to.Trait type: Unicode
-
ZMQInteractiveShell.logfile
¶ The name of the logfile to use.
Trait type: Unicode
-
ZMQInteractiveShell.logstart
¶ Start logging to the default log file in overwrite mode. Use
logappend
to specify a log file to append logs to.Trait type: Bool Default: False
-
ZMQInteractiveShell.object_info_string_level
¶ No description
Options: 0
,1
,2
Default: 0
-
ZMQInteractiveShell.pdb
¶ Automatically call the pdb debugger after every exception.
Trait type: Bool Default: False
-
ZMQInteractiveShell.prompt_in1
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'In [\\#]: '
-
ZMQInteractiveShell.prompt_in2
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: ' .\\D.: '
-
ZMQInteractiveShell.prompt_out
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'Out[\\#]: '
-
ZMQInteractiveShell.prompts_pad_left
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Bool Default: True
-
ZMQInteractiveShell.quiet
¶ No description
Trait type: Bool Default: False
-
ZMQInteractiveShell.separate_in
¶ No description
Trait type: SeparateUnicode Default: '\\n'
-
ZMQInteractiveShell.separate_out
¶ No description
Trait type: SeparateUnicode
-
ZMQInteractiveShell.separate_out2
¶ No description
Trait type: SeparateUnicode
-
ZMQInteractiveShell.show_rewritten_input
¶ Show rewritten input, e.g. for autocall.
Trait type: Bool Default: True
-
ZMQInteractiveShell.sphinxify_docstring
¶ Enables rich html representation of docstrings. (This requires the docrepr module).
Trait type: Bool Default: False
-
ZMQInteractiveShell.wildcards_case_sensitive
¶ No description
Trait type: Bool Default: True
-
ZMQInteractiveShell.xmode
¶ Switch modes for the IPython exception handlers.
Options: 'Context'
,'Plain'
,'Verbose'
Default: 'Context'
-
ProfileDir.location
¶ Set the profile location directly. This overrides the logic used by the
profile
option.Trait type: Unicode CLI option: --profile-dir
-
Session.buffer_threshold
¶ Threshold (in bytes) beyond which an object’s buffer should be extracted to avoid pickling.
Trait type: Int Default: 1024
-
Session.check_pid
¶ Whether to check PID to protect against calls after fork.
This check can be disabled if fork-safety is handled elsewhere.
Trait type: Bool Default: True
-
Session.copy_threshold
¶ Threshold (in bytes) beyond which a buffer should be sent without copying.
Trait type: Int Default: 65536
-
Session.debug
¶ Debug output in the Session
Trait type: Bool Default: False
-
Session.digest_history_size
¶ The maximum number of digests to remember.
The digest history will be culled when it exceeds this value.
Trait type: Int Default: 65536
-
Session.item_threshold
¶ The maximum number of items for a container to be introspected for custom serialization. Containers larger than this are pickled outright.
Trait type: Int Default: 64
-
Session.key
¶ execution key, for signing messages.
Trait type: CBytes Default: b''
-
Session.keyfile
¶ path to file containing execution key.
Trait type: Unicode CLI option: --keyfile
-
Session.metadata
¶ Metadata dictionary, which serves as the default top-level metadata dict for each message.
Trait type: Dict
-
Session.packer
¶ The name of the packer for serializing messages. Should be one of ‘json’, ‘pickle’, or an import name for a custom callable serializer.
Trait type: DottedObjectName Default: 'json'
-
Session.session
¶ The UUID identifying this session.
Trait type: CUnicode CLI option: --ident
-
Session.signature_scheme
¶ The digest scheme used to construct the message signatures. Must have the form ‘hmac-HASH’.
Trait type: Unicode Default: 'hmac-sha256'
-
Session.unpacker
¶ The name of the unpacker for unserializing messages. Only used with custom functions for
packer
.Trait type: DottedObjectName Default: 'json'
-
Session.username
¶ Username for the Session. Default is your system username.
Trait type: Unicode Default: 'username'
CLI option: --user