SpecialistOff.NET / Вопросы / Статьи / Фрагменты кода / Резюме / Метки / Помощь / Файлы
НазадМетки: ipython
=========
IPython
=========
Tools for Interactive Computing in Python
=========================================
A Python shell with automatic history (input and output), dynamic object
introspection, easier configuration, command completion, access to the
system shell and more. IPython can also be embedded in running programs.
Usage
ipython [subcommand] [options] [-c cmd | -m mod | file] [--] [arg] ...
If invoked with no options, it executes the file and exits, passing the
remaining arguments to the script, just as if you had specified the same
command with python. You may need to specify `--` before args to be passed
to the script, to prevent IPython from attempting to parse them. If you
specify the option `-i` before the filename, it will enter an interactive
IPython session after running the script, rather than exiting. Files ending
in .py will be treated as normal Python, but files ending in .ipy can
contain special IPython syntax (magic commands, shell expansions, etc.).
Almost all configuration in IPython is available via the command-line. Do
`ipython --help-all` to see all available options. For persistent
configuration, look into your `ipython_config.py` configuration file for
details.
This file is typically installed in the `IPYTHONDIR` directory, and there
is a separate configuration directory for each profile. The default profile
directory will be located in $IPYTHONDIR/profile_default. IPYTHONDIR
defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to
C:\Users\YourUserName in most instances.
To initialize a profile with the default configuration file, do::
$> ipython profile create
and start editing `IPYTHONDIR/profile_default/ipython_config.py`
In IPython's documentation, we will refer to this directory as
`IPYTHONDIR`, you can change its default location by creating an
environment variable with this name and setting it to the desired path.
For more information, see the manual available in HTML and PDF in your
installation, or online at https://ipython.org/documentation.html.
Subcommands
-----------
Subcommands are launched as `ipython cmd [args]`. For information on using
subcommand 'cmd', do: `ipython cmd -h`.
profile
Create and manage IPython profiles.
kernel
Start a kernel without an attached frontend.
locate
print the path to the IPython dir
history
Manage the IPython history database.
qtconsole
DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter Qt Console.
notebook
DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter HTML Notebook Server.
console
DEPRECATED, Will be removed in IPython 6.0 : Launch the Jupyter terminal-based Console.
nbconvert
DEPRECATED, Will be removed in IPython 6.0 : Convert notebooks to/from other formats.
trust
DEPRECATED, Will be removed in IPython 6.0 : Sign notebooks to trust their potentially unsafe contents at load.
kernelspec
DEPRECATED, Will be removed in IPython 6.0 : Manage Jupyter kernel specifications.
install-nbextension
DEPRECATED, Will be removed in IPython 6.0 : Install Jupyter notebook extension files
Options
-------
Arguments that take values are actually convenience aliases to full
Configurables, whose aliases are listed on the help line. For more information
on full configurables, see '--help-all'.
--debug
set log level to logging.DEBUG (maximize logging output)
--quiet
set log level to logging.CRITICAL (minimize logging output)
--init
Initialize profile with default config files. This is equivalent
to running `ipython profile create <profile>` prior to startup.
--autoindent
Turn on autoindenting.
--no-autoindent
Turn off autoindenting.
--automagic
Turn on the auto calling of magic commands. Type %%magic at the
IPython prompt for more information.
--no-automagic
Turn off the auto calling of magic commands.
--pdb
Enable auto calling the pdb debugger after every exception.
--no-pdb
Disable auto calling the pdb debugger after every exception.
--pprint
Enable auto pretty printing of results.
--no-pprint
Disable auto pretty printing of results.
--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.
--no-color-info
Disable using colors for info related things.
--ignore-cwd
Exclude the current working directory from sys.path
--no-ignore-cwd
Include the current working directory in sys.path
--nosep
Eliminate all spacing between prompts.
--pylab
Pre-load matplotlib and numpy for interactive use with
the default matplotlib backend.
--matplotlib
Configure matplotlib for interactive use with
the default matplotlib backend.
--autoedit-syntax
Turn on auto editing of files with syntax errors.
--no-autoedit-syntax
Turn off auto editing of files with syntax errors.
--simple-prompt
Force simple minimal prompt using `raw_input`
--no-simple-prompt
Use a rich interactive prompt with prompt_toolkit
--banner
Display a banner upon starting IPython.
--no-banner
Don't display a banner upon starting IPython.
--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.
--no-confirm-exit
Don't prompt the user when exiting.
--term-title
Enable auto setting the terminal title.
--no-term-title
Disable auto setting the terminal title.
--classic
Gives IPython a similar feel to the classic Python prompt.
--quick
Enable quick startup with no config files.
-i
If running code from the command line, become interactive afterwards.
It is often useful to follow this with `--` to treat remaining flags as
script arguments.
--profile-dir=<Unicode> (ProfileDir.location)
Default: ''
Set the profile location directly. This overrides the logic used by the
`profile` option.
--profile=<Unicode> (BaseIPythonApplication.profile)
Default: 'default'
The IPython profile to use.
--ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
Default: ''
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.
--log-level=<Enum> (Application.log_level)
Default: 30
Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
Set the log level by value or name.
--config=<Unicode> (BaseIPythonApplication.extra_config_file)
Default: ''
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
--autocall=<Enum> (InteractiveShell.autocall)
Default: 0
Choices: (0, 1, 2)
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).
--colors=<CaselessStrEnum> (InteractiveShell.colors)
Default: 'Neutral'
Choices: ['Neutral', 'NoColor', 'LightBG', 'Linux']
Set the color scheme (NoColor, Neutral, Linux, or LightBG).
--logfile=<Unicode> (InteractiveShell.logfile)
Default: ''
The name of the logfile to use.
--logappend=<Unicode> (InteractiveShell.logappend)
Default: ''
Start logging to the given file in append mode. Use `logfile` to specify a
log file to **overwrite** logs to.
-c <Unicode> (InteractiveShellApp.code_to_run)
Default: ''
Execute the given command string.
-m <Unicode> (InteractiveShellApp.module_to_run)
Default: ''
Run the module as a script.
--ext=<Unicode> (InteractiveShellApp.extra_extension)
Default: ''
dotted module name of an IPython extension to load.
--gui=<CaselessStrEnum> (InteractiveShellApp.gui)
Default: None
Choices: ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', 'qt4']
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2',
'qt4').
--pylab=<CaselessStrEnum> (InteractiveShellApp.pylab)
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Pre-load matplotlib and numpy for interactive use, selecting a particular
matplotlib backend and loop integration.
--matplotlib=<CaselessStrEnum> (InteractiveShellApp.matplotlib)
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Configure matplotlib for interactive use with the default matplotlib
backend.
--cache-size=<Int> (InteractiveShell.cache_size)
Default: 1000
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
Class parameters
----------------
Parameters are set from command-line arguments of the form:
`--Class.trait=value`. This line is evaluated in Python, so simple expressions
are allowed, e.g.:: `--C.a='range(3)'` For setting C.a=[0,1,2].
InteractiveShellApp options
---------------------------
--InteractiveShellApp.code_to_run=<Unicode>
Default: ''
Execute the given command string.
--InteractiveShellApp.exec_PYTHONSTARTUP=<Bool>
Default: True
Run the file referenced by the PYTHONSTARTUP environment variable at IPython
startup.
--InteractiveShellApp.exec_files=<List>
Default: []
List of files to run at IPython startup.
--InteractiveShellApp.exec_lines=<List>
Default: []
lines of code to run at IPython startup.
--InteractiveShellApp.extensions=<List>
Default: []
A list of dotted module names of IPython extensions to load.
--InteractiveShellApp.extra_extension=<Unicode>
Default: ''
dotted module name of an IPython extension to load.
--InteractiveShellApp.file_to_run=<Unicode>
Default: ''
A file to be run
--InteractiveShellApp.gui=<CaselessStrEnum>
Default: None
Choices: ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', 'qt4']
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2',
'qt4').
--InteractiveShellApp.hide_initial_ns=<Bool>
Default: True
Should variables loaded at startup (by startup files, exec_lines, etc.) be
hidden from tools like %who?
--InteractiveShellApp.ignore_cwd=<Bool>
Default: False
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.
--InteractiveShellApp.matplotlib=<CaselessStrEnum>
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Configure matplotlib for interactive use with the default matplotlib
backend.
--InteractiveShellApp.module_to_run=<Unicode>
Default: ''
Run the module as a script.
--InteractiveShellApp.pylab=<CaselessStrEnum>
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Pre-load matplotlib and numpy for interactive use, selecting a particular
matplotlib backend and loop integration.
--InteractiveShellApp.pylab_import_all=<Bool>
Default: True
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.
--InteractiveShellApp.reraise_ipython_extension_failures=<Bool>
Default: False
Reraise exceptions encountered loading IPython extensions?
TerminalIPythonApp options
--------------------------
--TerminalIPythonApp.code_to_run=<Unicode>
Default: ''
Execute the given command string.
--TerminalIPythonApp.copy_config_files=<Bool>
Default: False
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.
--TerminalIPythonApp.display_banner=<Bool>
Default: True
Whether to display a banner upon starting IPython.
--TerminalIPythonApp.exec_PYTHONSTARTUP=<Bool>
Default: True
Run the file referenced by the PYTHONSTARTUP environment variable at IPython
startup.
--TerminalIPythonApp.exec_files=<List>
Default: []
List of files to run at IPython startup.
--TerminalIPythonApp.exec_lines=<List>
Default: []
lines of code to run at IPython startup.
--TerminalIPythonApp.extensions=<List>
Default: []
A list of dotted module names of IPython extensions to load.
--TerminalIPythonApp.extra_config_file=<Unicode>
Default: ''
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
--TerminalIPythonApp.extra_extension=<Unicode>
Default: ''
dotted module name of an IPython extension to load.
--TerminalIPythonApp.file_to_run=<Unicode>
Default: ''
A file to be run
--TerminalIPythonApp.force_interact=<Bool>
Default: False
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.
--TerminalIPythonApp.gui=<CaselessStrEnum>
Default: None
Choices: ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', 'qt4']
Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2',
'qt4').
--TerminalIPythonApp.hide_initial_ns=<Bool>
Default: True
Should variables loaded at startup (by startup files, exec_lines, etc.) be
hidden from tools like %who?
--TerminalIPythonApp.ignore_cwd=<Bool>
Default: False
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.
--TerminalIPythonApp.interactive_shell_class=<Type>
Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
Class to use to instantiate the TerminalInteractiveShell object. Useful for
custom Frontends
--TerminalIPythonApp.ipython_dir=<Unicode>
Default: ''
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.
--TerminalIPythonApp.log_datefmt=<Unicode>
Default: '%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
--TerminalIPythonApp.log_format=<Unicode>
Default: '[%(name)s]%(highlevel)s %(message)s'
The Logging format template
--TerminalIPythonApp.log_level=<Enum>
Default: 30
Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
Set the log level by value or name.
--TerminalIPythonApp.matplotlib=<CaselessStrEnum>
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Configure matplotlib for interactive use with the default matplotlib
backend.
--TerminalIPythonApp.module_to_run=<Unicode>
Default: ''
Run the module as a script.
--TerminalIPythonApp.overwrite=<Bool>
Default: False
Whether to overwrite existing config files when copying
--TerminalIPythonApp.profile=<Unicode>
Default: 'default'
The IPython profile to use.
--TerminalIPythonApp.pylab=<CaselessStrEnum>
Default: None
Choices: ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx']
Pre-load matplotlib and numpy for interactive use, selecting a particular
matplotlib backend and loop integration.
--TerminalIPythonApp.pylab_import_all=<Bool>
Default: True
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.
--TerminalIPythonApp.quick=<Bool>
Default: False
Start IPython quickly by skipping the loading of config files.
--TerminalIPythonApp.reraise_ipython_extension_failures=<Bool>
Default: False
Reraise exceptions encountered loading IPython extensions?
--TerminalIPythonApp.verbose_crash=<Bool>
Default: False
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
TerminalInteractiveShell options
--------------------------------
--TerminalInteractiveShell.ast_node_interactivity=<Enum>
Default: 'last_expr'
Choices: ['all', 'last', 'last_expr', 'none', 'last_expr_or_assign']
'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which
nodes should be run interactively (displaying output from expressions).
--TerminalInteractiveShell.ast_transformers=<List>
Default: []
A list of ast.NodeTransformer subclass instances, which will be applied to
user input before code is run.
--TerminalInteractiveShell.autoawait=<Bool>
Default: True
Automatically run await statement in the top level repl.
--TerminalInteractiveShell.autocall=<Enum>
Default: 0
Choices: (0, 1, 2)
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).
--TerminalInteractiveShell.autoformatter=<Unicode>
Default: None
Autoformatter to reformat Terminal code. Can be `'black'` or `None`
--TerminalInteractiveShell.autoindent=<Bool>
Default: True
Autoindent IPython code entered interactively.
--TerminalInteractiveShell.automagic=<Bool>
Default: True
Enable magic commands to be called without the leading %.
--TerminalInteractiveShell.banner1=<Unicode>
Default: "Python 3.9.4 (default, Apr 6 2021, 00:00:00) \nType 'copyri...
The part of the banner to be printed before the profile
--TerminalInteractiveShell.banner2=<Unicode>
Default: ''
The part of the banner to be printed after the profile
--TerminalInteractiveShell.cache_size=<Int>
Default: 1000
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
--TerminalInteractiveShell.color_info=<Bool>
Default: True
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.
--TerminalInteractiveShell.colors=<CaselessStrEnum>
Default: 'Neutral'
Choices: ['Neutral', 'NoColor', 'LightBG', 'Linux']
Set the color scheme (NoColor, Neutral, Linux, or LightBG).
--TerminalInteractiveShell.confirm_exit=<Bool>
Default: True
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.
--TerminalInteractiveShell.debug=<Bool>
Default: False
--TerminalInteractiveShell.disable_failing_post_execute=<Bool>
Default: False
Don't call post-execute functions that have failed in the past.
--TerminalInteractiveShell.display_completions=<Enum>
Default: 'multicolumn'
Choices: ('column', 'multicolumn', 'readlinelike')
Options for displaying tab completions, 'column', 'multicolumn', and
'readlinelike'. These options are for `prompt_toolkit`, see `prompt_toolkit`
documentation for more information.
--TerminalInteractiveShell.display_page=<Bool>
Default: False
If True, anything that would be passed to the pager will be displayed as
regular output instead.
--TerminalInteractiveShell.editing_mode=<Unicode>
Default: 'emacs'
Shortcut style to use at the prompt. 'vi' or 'emacs'.
--TerminalInteractiveShell.editor=<Unicode>
Default: 'vi'
Set the editor used by IPython (default to $EDITOR/vi/notepad).
--TerminalInteractiveShell.enable_history_search=<Bool>
Default: True
Allows to enable/disable the prompt toolkit history search
--TerminalInteractiveShell.enable_html_pager=<Bool>
Default: False
(Provisional API) enables html representation in mime bundles sent to
pagers.
--TerminalInteractiveShell.extra_open_editor_shortcuts=<Bool>
Default: False
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.
--TerminalInteractiveShell.handle_return=<Any>
Default: None
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.
--TerminalInteractiveShell.highlight_matching_brackets=<Bool>
Default: True
Highlight matching brackets.
--TerminalInteractiveShell.highlighting_style=<Union>
Default: traitlets.Undefined
The name or class of a Pygments style to use for syntax highlighting. To see
available styles, run `pygmentize -L styles`.
--TerminalInteractiveShell.highlighting_style_overrides=<Dict>
Default: {}
Override highlighting format for specific tokens
--TerminalInteractiveShell.history_length=<Int>
Default: 10000
Total length of command history
--TerminalInteractiveShell.history_load_length=<Int>
Default: 1000
The number of saved history entries to be loaded into the history buffer at
startup.
--TerminalInteractiveShell.ipython_dir=<Unicode>
Default: ''
--TerminalInteractiveShell.logappend=<Unicode>
Default: ''
Start logging to the given file in append mode. Use `logfile` to specify a
log file to **overwrite** logs to.
--TerminalInteractiveShell.logfile=<Unicode>
Default: ''
The name of the logfile to use.
--TerminalInteractiveShell.logstart=<Bool>
Default: False
Start logging to the default log file in overwrite mode. Use `logappend` to
specify a log file to **append** logs to.
--TerminalInteractiveShell.loop_runner=<Any>
Default: 'IPython.core.interactiveshell._asyncio_runner'
Select the loop runner that will be used to execute top-level asynchronous
code
--TerminalInteractiveShell.mime_renderers=<Dict>
Default: {}
--TerminalInteractiveShell.mouse_support=<Bool>
Default: False
Enable mouse support in the prompt (Note: prevents selecting text with the
mouse)
--TerminalInteractiveShell.object_info_string_level=<Enum>
Default: 0
Choices: (0, 1, 2)
--TerminalInteractiveShell.pdb=<Bool>
Default: False
Automatically call the pdb debugger after every exception.
--TerminalInteractiveShell.prompt_in1=<Unicode>
Default: 'In [\\#]: '
Deprecated since IPython 4.0 and ignored since 5.0, set
TerminalInteractiveShell.prompts object directly.
--TerminalInteractiveShell.prompt_in2=<Unicode>
Default: ' .\\D.: '
Deprecated since IPython 4.0 and ignored since 5.0, set
TerminalInteractiveShell.prompts object directly.
--TerminalInteractiveShell.prompt_includes_vi_mode=<Bool>
Default: True
Display the current vi mode (when using vi editing mode).
--TerminalInteractiveShell.prompt_out=<Unicode>
Default: 'Out[\\#]: '
Deprecated since IPython 4.0 and ignored since 5.0, set
TerminalInteractiveShell.prompts object directly.
--TerminalInteractiveShell.prompts_class=<Type>
Default: 'IPython.terminal.prompts.Prompts'
Class used to generate Prompt token for prompt_toolkit
--TerminalInteractiveShell.prompts_pad_left=<Bool>
Default: True
Deprecated since IPython 4.0 and ignored since 5.0, set
TerminalInteractiveShell.prompts object directly.
--TerminalInteractiveShell.quiet=<Bool>
Default: False
--TerminalInteractiveShell.separate_in=<SeparateUnicode>
Default: '\n'
--TerminalInteractiveShell.separate_out=<SeparateUnicode>
Default: ''
--TerminalInteractiveShell.separate_out2=<SeparateUnicode>
Default: ''
--TerminalInteractiveShell.show_rewritten_input=<Bool>
Default: True
Show rewritten input, e.g. for autocall.
--TerminalInteractiveShell.simple_prompt=<Bool>
Default: False
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 the `IPY_TEST_SIMPLE_PROMPT` environment
variable is set, or the current terminal is not a tty.
--TerminalInteractiveShell.space_for_menu=<Int>
Default: 6
Number of line at the bottom of the screen to reserve for the tab completion
menu, search history, ...etc, the height of these menus will at most this
value. Increase it is you prefer long and skinny menus, decrease for short
and wide.
--TerminalInteractiveShell.sphinxify_docstring=<Bool>
Default: False
Enables rich html representation of docstrings. (This requires the docrepr
module).
--TerminalInteractiveShell.term_title=<Bool>
Default: True
Automatically set the terminal title
--TerminalInteractiveShell.term_title_format=<Unicode>
Default: 'IPython: {cwd}'
Customize the terminal title format. This is a python format string.
Available substitutions are: {cwd}.
--TerminalInteractiveShell.true_color=<Bool>
Default: False
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;0mTRUECOLOR\x1b[0m\n"
--TerminalInteractiveShell.wildcards_case_sensitive=<Bool>
Default: True
--TerminalInteractiveShell.xmode=<CaselessStrEnum>
Default: 'Context'
Choices: ['Context', 'Plain', 'Verbose', 'Minimal']
Switch modes for the IPython exception handlers.
HistoryManager options
----------------------
--HistoryManager.connection_options=<Dict>
Default: {}
Options for configuring the SQLite connection
These options are passed as keyword args to sqlite3.connect when
establishing database connections.
--HistoryManager.db_cache_size=<Int>
Default: 0
Write to database every x commands (higher values save disk access & power).
Values of 1 or less effectively disable caching.
--HistoryManager.db_log_output=<Bool>
Default: False
Should the history database include output? (default: no)
--HistoryManager.enabled=<Bool>
Default: True
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.
--HistoryManager.hist_file=<Unicode>
Default: ''
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.
ProfileDir options
------------------
--ProfileDir.location=<Unicode>
Default: ''
Set the profile location directly. This overrides the logic used by the
`profile` option.
PlainTextFormatter options
--------------------------
--PlainTextFormatter.deferred_printers=<Dict>
Default: {}
--PlainTextFormatter.float_precision=<CUnicode>
Default: ''
--PlainTextFormatter.max_seq_length=<Int>
Default: 1000
Truncate large collections (lists, dicts, tuples, sets) to this size.
Set to 0 to disable truncation.
--PlainTextFormatter.max_width=<Int>
Default: 79
--PlainTextFormatter.newline=<Unicode>
Default: '\n'
--PlainTextFormatter.pprint=<Bool>
Default: True
--PlainTextFormatter.singleton_printers=<Dict>
Default: {}
--PlainTextFormatter.type_printers=<Dict>
Default: {}
--PlainTextFormatter.verbose=<Bool>
Default: False
IPCompleter options
-------------------
--IPCompleter.backslash_combining_completions=<Bool>
Default: True
Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
commands, unicode names, and expanding unicode characters back to latex
commands.
--IPCompleter.debug=<Bool>
Default: False
Enable debug for the Completer. Mostly print extra information for
experimental jedi integration.
--IPCompleter.greedy=<Bool>
Default: False
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.
--IPCompleter.jedi_compute_type_timeout=<Int>
Default: 400
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.
--IPCompleter.limit_to__all__=<Bool>
Default: False
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
--IPCompleter.merge_completions=<Bool>
Default: True
Whether to merge completion results into a single list
If False, only the completion results from the first non-empty completer
will be returned.
--IPCompleter.omit__names=<Enum>
Default: 2
Choices: (0, 1, 2)
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.
--IPCompleter.use_jedi=<Bool>
Default: True
Experimental: Use Jedi to generate autocompletions. Default to True if jedi
is installed.
ScriptMagics options
--------------------
--ScriptMagics.script_magics=<List>
Default: []
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
--ScriptMagics.script_paths=<Dict>
Default: {}
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.
LoggingMagics options
---------------------
--LoggingMagics.quiet=<Bool>
Default: False
Suppress output of log state when logging is enabled
StoreMagics options
-------------------
--StoreMagics.autorestore=<Bool>
Default: False
If True, any %store-d variables will be automatically restored when IPython
starts.
Examples
--------
ipython --matplotlib # enable matplotlib integration
ipython --matplotlib=qt # enable matplotlib integration with qt4 backend
ipython --log-level=DEBUG # set logging to DEBUG
ipython --profile=foo # start with profile foo
ipython profile create foo # create profile foo w/ default config files
ipython help profile # show the help for the profile subcmd
ipython locate # print the path to the IPython directory
ipython locate profile foo # print the path to the directory for profile `foo`