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).
Terminal IPython options¶
-
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
-
TerminalIPythonApp.code_to_run
¶ Execute the given command string.
Trait type: Unicode
-
TerminalIPythonApp.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
Whether to display a banner upon starting IPython.
Trait type: Bool Default: True
CLI option: --banner
-
TerminalIPythonApp.exec_PYTHONSTARTUP
¶ Run the file referenced by the PYTHONSTARTUP environment variable at IPython startup.
Trait type: Bool Default: True
-
TerminalIPythonApp.exec_files
¶ List of files to run at IPython startup.
Trait type: List
-
TerminalIPythonApp.exec_lines
¶ lines of code to run at IPython startup.
Trait type: List
-
TerminalIPythonApp.extensions
¶ A list of dotted module names of IPython extensions to load.
Trait type: List
-
TerminalIPythonApp.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
-
TerminalIPythonApp.extra_extension
¶ dotted module name of an IPython extension to load.
Trait type: Unicode
-
TerminalIPythonApp.file_to_run
¶ A file to be run
Trait type: Unicode
-
TerminalIPythonApp.force_interact
¶ If a command or file is given via the command-line, e.g. ‘ipython foo.py’, start an interactive shell after executing the file or command.
Trait type: Bool Default: False
CLI option: -i
-
TerminalIPythonApp.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'
-
TerminalIPythonApp.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
-
TerminalIPythonApp.interactive_shell_class
¶ Class to use to instantiate the TerminalInteractiveShell object. Useful for custom Frontends
Trait type: Type Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
-
TerminalIPythonApp.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
-
TerminalIPythonApp.log_datefmt
¶ The date format used by logging formatters for %(asctime)s
Trait type: Unicode Default: '%Y-%m-%d %H:%M:%S'
-
TerminalIPythonApp.log_format
¶ The Logging format template
Trait type: Unicode Default: '[%(name)s]%(highlevel)s %(message)s'
-
TerminalIPythonApp.log_level
¶ Set the log level by value or name.
Options: 0
,10
,20
,30
,40
,50
,'DEBUG'
,'INFO'
,'WARN'
,'ERROR'
,'CRITICAL'
Default: 30
-
TerminalIPythonApp.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'
-
TerminalIPythonApp.module_to_run
¶ Run the module as a script.
Trait type: Unicode
-
TerminalIPythonApp.overwrite
¶ Whether to overwrite existing config files when copying
Trait type: Bool Default: False
-
TerminalIPythonApp.profile
¶ The IPython profile to use.
Trait type: Unicode Default: 'default'
-
TerminalIPythonApp.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'
-
TerminalIPythonApp.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
-
TerminalIPythonApp.quick
¶ Start IPython quickly by skipping the loading of config files.
Trait type: Bool Default: False
CLI option: --quick
-
TerminalIPythonApp.reraise_ipython_extension_failures
¶ Reraise exceptions encountered loading IPython extensions?
Trait type: Bool Default: False
-
TerminalIPythonApp.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
-
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.autoawait
¶ Automatically run await statement in the top level repl.
Trait type: Bool Default: True
-
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.6.7 | packaged by conda-forge | (default, Nov 21 20...
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.loop_runner
¶ Select the loop runner that will be used to execute top-level asynchronous code
Trait type: Any Default: 'IPython.core.interactiveshell._asyncio_runner'
-
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'
,'Minimal'
Default: 'Context'
-
TerminalInteractiveShell.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'
-
TerminalInteractiveShell.ast_transformers
¶ A list of ast.NodeTransformer subclass instances, which will be applied to user input before code is run.
Trait type: List
-
TerminalInteractiveShell.autoawait
¶ Automatically run await statement in the top level repl.
Trait type: Bool Default: True
-
TerminalInteractiveShell.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
-
TerminalInteractiveShell.autoindent
¶ Autoindent IPython code entered interactively.
Trait type: Bool Default: True
-
TerminalInteractiveShell.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.6.7 | packaged by conda-forge | (default, Nov 21 20...
The part of the banner to be printed after the profile
Trait type: Unicode
-
TerminalInteractiveShell.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
-
TerminalInteractiveShell.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
-
TerminalInteractiveShell.colors
¶ Set the color scheme (NoColor, Neutral, Linux, or LightBG).
Options: 'Neutral'
,'NoColor'
,'LightBG'
,'Linux'
Default: 'Neutral'
-
TerminalInteractiveShell.confirm_exit
¶ Set to confirm when you try to exit IPython with an EOF (Control-D in Unix, Control-Z/Enter in Windows). By typing ‘exit’ or ‘quit’, you can force a direct exit without any confirmation.
Trait type: Bool Default: True
CLI option: --confirm-exit
-
TerminalInteractiveShell.debug
¶ No description
Trait type: Bool Default: False
-
TerminalInteractiveShell.disable_failing_post_execute
¶ Don’t call post-execute functions that have failed in the past.
Trait type: Bool Default: False
-
TerminalInteractiveShell.display_completions
¶ Options for displaying tab completions, ‘column’, ‘multicolumn’, and ‘readlinelike’. These options are for
prompt_toolkit
, seeprompt_toolkit
documentation for more information.Options: 'column'
,'multicolumn'
,'readlinelike'
Default: 'multicolumn'
-
TerminalInteractiveShell.display_page
¶ If True, anything that would be passed to the pager will be displayed as regular output instead.
Trait type: Bool Default: False
-
TerminalInteractiveShell.editing_mode
¶ Shortcut style to use at the prompt. ‘vi’ or ‘emacs’.
Trait type: Unicode Default: 'emacs'
-
TerminalInteractiveShell.editor
¶ Set the editor used by IPython (default to $EDITOR/vi/notepad).
Trait type: Unicode Default: 'vi'
-
TerminalInteractiveShell.enable_history_search
¶ Allows to enable/disable the prompt toolkit history search
Trait type: Bool Default: True
-
TerminalInteractiveShell.enable_html_pager
¶ (Provisional API) enables html representation in mime bundles sent to pagers.
Trait type: Bool Default: False
-
TerminalInteractiveShell.extra_open_editor_shortcuts
¶ Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. This is in addition to the F2 binding, which is always enabled.
Trait type: Bool Default: False
-
TerminalInteractiveShell.handle_return
¶ Provide an alternative handler to be called when the user presses Return. This is an advanced option intended for debugging, which may be changed or removed in later releases.
Trait type: Any
-
TerminalInteractiveShell.highlight_matching_brackets
¶ Highlight matching brackets.
Trait type: Bool Default: True
-
TerminalInteractiveShell.highlighting_style
¶ The name or class of a Pygments style to use for syntax highlighting. To see available styles, run
pygmentize -L styles
.Trait type: Union
-
TerminalInteractiveShell.highlighting_style_overrides
¶ Override highlighting format for specific tokens
Trait type: Dict
-
TerminalInteractiveShell.history_length
¶ Total length of command history
Trait type: Int Default: 10000
-
TerminalInteractiveShell.history_load_length
¶ The number of saved history entries to be loaded into the history buffer at startup.
Trait type: Int Default: 1000
-
TerminalInteractiveShell.ipython_dir
¶ No description
Trait type: Unicode
-
TerminalInteractiveShell.logappend
¶ Start logging to the given file in append mode. Use
logfile
to specify a log file to overwrite logs to.Trait type: Unicode
-
TerminalInteractiveShell.logfile
¶ The name of the logfile to use.
Trait type: Unicode
-
TerminalInteractiveShell.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
-
TerminalInteractiveShell.loop_runner
¶ Select the loop runner that will be used to execute top-level asynchronous code
Trait type: Any Default: 'IPython.core.interactiveshell._asyncio_runner'
-
TerminalInteractiveShell.mouse_support
¶ Enable mouse support in the prompt (Note: prevents selecting text with the mouse)
Trait type: Bool Default: False
-
TerminalInteractiveShell.object_info_string_level
¶ No description
Options: 0
,1
,2
Default: 0
-
TerminalInteractiveShell.pdb
¶ Automatically call the pdb debugger after every exception.
Trait type: Bool Default: False
-
TerminalInteractiveShell.prompt_in1
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'In [\\#]: '
-
TerminalInteractiveShell.prompt_in2
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: ' .\\D.: '
-
TerminalInteractiveShell.prompt_includes_vi_mode
¶ Display the current vi mode (when using vi editing mode).
Trait type: Bool Default: True
-
TerminalInteractiveShell.prompt_out
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Unicode Default: 'Out[\\#]: '
-
TerminalInteractiveShell.prompts_class
¶ Class used to generate Prompt token for prompt_toolkit
Trait type: Type Default: 'IPython.terminal.prompts.Prompts'
-
TerminalInteractiveShell.prompts_pad_left
¶ Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly.
Trait type: Bool Default: True
-
TerminalInteractiveShell.quiet
¶ No description
Trait type: Bool Default: False
-
TerminalInteractiveShell.separate_in
¶ No description
Trait type: SeparateUnicode Default: '\\n'
-
TerminalInteractiveShell.separate_out
¶ No description
Trait type: SeparateUnicode
-
TerminalInteractiveShell.separate_out2
¶ No description
Trait type: SeparateUnicode
-
TerminalInteractiveShell.show_rewritten_input
¶ Show rewritten input, e.g. for autocall.
Trait type: Bool Default: True
-
TerminalInteractiveShell.simple_prompt
¶ Use
raw_input
for the REPL, without completion and prompt colors.Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are: IPython own testing machinery, and emacs inferior-shell integration through elpy.
This mode default to
True
if theIPY_TEST_SIMPLE_PROMPT
environment variable is set, or the current terminal is not a tty.Trait type: Bool Default: True
CLI option: --simple-prompt
Number of line at the bottom of the screen to reserve for the completion menu
Trait type: Int Default: 6
-
TerminalInteractiveShell.sphinxify_docstring
¶ Enables rich html representation of docstrings. (This requires the docrepr module).
Trait type: Bool Default: False
-
TerminalInteractiveShell.term_title
¶ Automatically set the terminal title
Trait type: Bool Default: True
CLI option: --term-title
-
TerminalInteractiveShell.term_title_format
¶ Customize the terminal title format. This is a python format string. Available substitutions are: {cwd}.
Trait type: Unicode Default: 'IPython: {cwd}'
-
TerminalInteractiveShell.true_color
¶ Use 24bit colors instead of 256 colors in prompt highlighting. If your terminal supports true color, the following command should print ‘TRUECOLOR’ in orange: printf “x1b[38;2;255;100;0mTRUECOLORx1b[0mn”
Trait type: Bool Default: False
-
TerminalInteractiveShell.wildcards_case_sensitive
¶ No description
Trait type: Bool Default: True
-
TerminalInteractiveShell.xmode
¶ Switch modes for the IPython exception handlers.
Options: 'Context'
,'Plain'
,'Verbose'
,'Minimal'
Default: 'Context'
-
HistoryAccessor.connection_options
¶ Options for configuring the SQLite connection
These options are passed as keyword args to sqlite3.connect when establishing database connections.
Trait type: Dict
-
HistoryAccessor.enabled
¶ enable the SQLite history
set enabled=False to disable the SQLite history, in which case there will be no stored history, no SQLite connection, and no background saving thread. This may be necessary in some threaded environments where IPython is embedded.
Trait type: Bool Default: True
-
HistoryAccessor.hist_file
¶ Path to file to use for SQLite history database.
By default, IPython will put the history database in the IPython profile directory. If you would rather share one history among profiles, you can set this value in each, so that they are consistent.
Due to an issue with fcntl, SQLite is known to misbehave on some NFS mounts. If you see IPython hanging, try setting this to something on a local disk, e.g:
ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
you can also use the specific value
:memory:
(including the colon at both end but not the back ticks), to avoid creating an history file.Trait type: Unicode
-
HistoryManager.connection_options
¶ Options for configuring the SQLite connection
These options are passed as keyword args to sqlite3.connect when establishing database connections.
Trait type: Dict
-
HistoryManager.db_cache_size
¶ Write to database every x commands (higher values save disk access & power). Values of 1 or less effectively disable caching.
Trait type: Int Default: 0
-
HistoryManager.db_log_output
¶ Should the history database include output? (default: no)
Trait type: Bool Default: False
-
HistoryManager.enabled
¶ enable the SQLite history
set enabled=False to disable the SQLite history, in which case there will be no stored history, no SQLite connection, and no background saving thread. This may be necessary in some threaded environments where IPython is embedded.
Trait type: Bool Default: True
-
HistoryManager.hist_file
¶ Path to file to use for SQLite history database.
By default, IPython will put the history database in the IPython profile directory. If you would rather share one history among profiles, you can set this value in each, so that they are consistent.
Due to an issue with fcntl, SQLite is known to misbehave on some NFS mounts. If you see IPython hanging, try setting this to something on a local disk, e.g:
ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
you can also use the specific value
:memory:
(including the colon at both end but not the back ticks), to avoid creating an history file.Trait type: Unicode
-
ProfileDir.location
¶ Set the profile location directly. This overrides the logic used by the
profile
option.Trait type: Unicode CLI option: --profile-dir
-
BaseFormatter.deferred_printers
¶ No description
Trait type: Dict
-
BaseFormatter.enabled
¶ No description
Trait type: Bool Default: True
-
BaseFormatter.singleton_printers
¶ No description
Trait type: Dict
-
BaseFormatter.type_printers
¶ No description
Trait type: Dict
-
PlainTextFormatter.deferred_printers
¶ No description
Trait type: Dict
-
PlainTextFormatter.float_precision
¶ No description
Trait type: CUnicode
-
PlainTextFormatter.max_seq_length
¶ Truncate large collections (lists, dicts, tuples, sets) to this size.
Set to 0 to disable truncation.
Trait type: Int Default: 1000
-
PlainTextFormatter.max_width
¶ No description
Trait type: Int Default: 79
-
PlainTextFormatter.newline
¶ No description
Trait type: Unicode Default: '\\n'
-
PlainTextFormatter.pprint
¶ No description
Trait type: Bool Default: True
CLI option: --pprint
-
PlainTextFormatter.singleton_printers
¶ No description
Trait type: Dict
-
PlainTextFormatter.type_printers
¶ No description
Trait type: Dict
-
PlainTextFormatter.verbose
¶ No description
Trait type: Bool Default: False
-
Completer.backslash_combining_completions
¶ Enable unicode completions, e.g. alpha<tab> . Includes completion of latex commands, unicode names, and expanding unicode characters back to latex commands.
Trait type: Bool Default: True
-
Completer.debug
¶ Enable debug for the Completer. Mostly print extra information for experimental jedi integration.
Trait type: Bool Default: False
-
Completer.greedy
¶ Activate greedy completion PENDING DEPRECTION. this is now mostly taken care of with Jedi.
This will enable completion on elements of lists, results of function calls, etc., but can be unsafe because the code is actually evaluated on TAB.
Trait type: Bool Default: False
-
Completer.jedi_compute_type_timeout
¶ Experimental: restrict time (in milliseconds) during which Jedi can compute types. Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt performance by preventing jedi to build its cache.
Trait type: Int Default: 400
-
Completer.use_jedi
¶ Experimental: Use Jedi to generate autocompletions. Default to True if jedi is installed.
Trait type: Bool Default: True
-
IPCompleter.backslash_combining_completions
¶ Enable unicode completions, e.g. alpha<tab> . Includes completion of latex commands, unicode names, and expanding unicode characters back to latex commands.
Trait type: Bool Default: True
-
IPCompleter.debug
¶ Enable debug for the Completer. Mostly print extra information for experimental jedi integration.
Trait type: Bool Default: False
-
IPCompleter.greedy
¶ Activate greedy completion PENDING DEPRECTION. this is now mostly taken care of with Jedi.
This will enable completion on elements of lists, results of function calls, etc., but can be unsafe because the code is actually evaluated on TAB.
Trait type: Bool Default: False
-
IPCompleter.jedi_compute_type_timeout
¶ Experimental: restrict time (in milliseconds) during which Jedi can compute types. Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt performance by preventing jedi to build its cache.
Trait type: Int Default: 400
-
IPCompleter.limit_to__all__
¶ DEPRECATED as of version 5.0.
Instruct the completer to use __all__ for the completion
Specifically, when completing on
object.<tab>
.When True: only those names in obj.__all__ will be included.
When False [default]: the __all__ attribute is ignored
Trait type: Bool Default: False
-
IPCompleter.merge_completions
¶ Whether to merge completion results into a single list
If False, only the completion results from the first non-empty completer will be returned.
Trait type: Bool Default: True
-
IPCompleter.omit__names
¶ Instruct the completer to omit private method names
Specifically, when completing on
object.<tab>
.When 2 [default]: all names that start with ‘_’ will be excluded.
When 1: all ‘magic’ names (
__foo__
) will be excluded.When 0: nothing will be excluded.
Options: 0
,1
,2
Default: 2
-
IPCompleter.use_jedi
¶ Experimental: Use Jedi to generate autocompletions. Default to True if jedi is installed.
Trait type: Bool Default: True
-
ScriptMagics.script_magics
¶ Extra script cell magics to define
This generates simple wrappers of
%%script foo
as%%foo
.If you want to add script magics that aren’t on your path, specify them in script_paths
Trait type: List
-
ScriptMagics.script_paths
¶ Dict mapping short ‘ruby’ names to full paths, such as ‘/opt/secret/bin/ruby’
Only necessary for items in script_magics where the default path will not find the right interpreter.
Trait type: Dict
-
LoggingMagics.quiet
¶ Suppress output of log state when logging is enabled
Trait type: Bool Default: False
-
StoreMagics.autorestore
¶ If True, any %store-d variables will be automatically restored when IPython starts.
Trait type: Bool Default: False