Note
This documentation is for a development version of IPython. There may be significant differences from the latest stable release (1.2.1).
Default: ‘’
Execute the given command string.
Default: True
Run the file referenced by the PYTHONSTARTUP environment variable at IPython startup.
Default: []
List of files to run at IPython startup.
Default: []
lines of code to run at IPython startup.
Default: []
A list of dotted module names of IPython extensions to load.
Default: ‘’
dotted module name of an IPython extension to load.
Default: ‘’
A file to be run
Default: True
Should variables loaded at startup (by startup files, exec_lines, etc.) be hidden from tools like %who?
Default: ‘’
Run the module as a script.
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.
Default: ‘’
Execute the given command string.
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.
Default: True
Whether to display a banner upon starting IPython.
Default: True
Run the file referenced by the PYTHONSTARTUP environment variable at IPython startup.
Default: []
List of files to run at IPython startup.
Default: []
lines of code to run at IPython startup.
Default: []
A list of dotted module names of IPython extensions to load.
Default: u’‘
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
Default: ‘’
dotted module name of an IPython extension to load.
Default: ‘’
A file to be run
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.
Default: True
Should variables loaded at startup (by startup files, exec_lines, etc.) be hidden from tools like %who?
Default: False
Suppress warning messages about legacy config files
Default: u’‘
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 options can also be specified through the environment variable IPYTHONDIR.
Default: ‘%Y-%m-%d %H:%M:%S’
The date format used by logging formatters for %(asctime)s
Default: ‘[%(name)s]%(highlevel)s %(message)s’
The Logging format template
Default: 30
Set the log level by value or name.
Default: ‘’
Run the module as a script.
Default: False
Whether to overwrite existing config files when copying
Default: u’default’
The IPython profile to use.
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.
Default: False
Start IPython quickly by skipping the loading of config files.
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
Default: ‘last_expr’
‘all’, ‘last’, ‘last_expr’ or ‘none’, specifying which nodes should be run interactively (displaying output from expressions).
Default: []
A list of ast.NodeTransformer subclass instances, which will be applied to user input before code is run.
Default: 0
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).
Default: False
auto editing of files with syntax errors.
Default: True
Autoindent IPython code entered interactively.
Default: True
Enable magic commands to be called without the leading %.
Default: ‘Python 2.7.5 (default, Aug 25 2013, 00:04:04) \nType “copyri...
The part of the banner to be printed before the profile
Default: ‘’
The part of the banner to be printed after the profile
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 20 (if you provide a value less than 20, 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: 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.
Default: ‘LightBG’
Set the color scheme (NoColor, Linux, or LightBG).
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.
Default: False
No description
Default: False
Enable deep (recursive) reloading by default. IPython can use the deep_reload module which reloads changes in modules recursively (it replaces the reload() function, so you don’t need to change anything to use it). deep_reload() forces a full reload of modules whose code may have changed, which the default reload() function does not. When deep_reload is off, IPython will use the normal reload(), but deep_reload will still be available as dreload().
Default: False
Don’t call post-execute functions that have failed in the past.
Default: u’mate -w’
Set the editor used by IPython (default to $EDITOR/vi/notepad).
Default: 10000
No description
Default: ‘’
No description
Default: ‘’
Start logging to the given file in append mode.
Default: ‘’
The name of the logfile to use.
Default: False
Start logging to the default log file.
Default: True
Save multi-line entries as one entry in readline history
Default: 0
No description
Default: ‘less’
The shell program to be used for paging.
Default: False
Automatically call the pdb debugger after every exception.
Default: ‘In [\#]: ‘
Deprecated, use PromptManager.in_template
Default: ‘ .\D.: ‘
Deprecated, use PromptManager.in2_template
Default: ‘Out[\#]: ‘
Deprecated, use PromptManager.out_template
Default: True
Deprecated, use PromptManager.justify
Default: False
No description
Default: [‘tab: complete’, ‘”\C-l”: clear-screen’, ‘set show-all-if-a...
No description
Default: ‘-/~’
No description
Default: True
No description
Default: 0
Number of lines of your screen, used to control printing of very long strings. Strings longer than this number of lines will be sent through a pager instead of directly printed. The default value for this is 0, which means IPython will auto-detect your screen size every time it needs to print certain potentially long strings (this doesn’t change the behavior of the ‘print’ keyword, it’s only triggered internally). If for some reason this isn’t working well (it needs curses support), specify it yourself. Otherwise don’t change the default.
Default: ‘\n’
No description
Default: ‘’
No description
Default: ‘’
No description
Default: True
Show rewritten input, e.g. for autocall.
Default: False
Enable auto setting the terminal title.
Default: True
No description
Default: ‘Context’
No description
Default: ‘Linux’
No description
Default: ‘ .\D.: ‘
Continuation prompt.
Default: ‘In [\#]: ‘
Input prompt. ‘#’ will be transformed to the prompt number
Default: True
If True (default), each prompt will be right-aligned with the preceding one.
Default: ‘Out[\#]: ‘
Output prompt. ‘#’ will be transformed to the prompt number
Default: {}
Options for configuring the SQLite connection
These options are passed as keyword args to sqlite3.connect when establishing database conenctions.
Default: 0
Write to database every x commands (higher values save disk access & power). Values of 1 or less effectively disable caching.
Default: False
Should the history database include output? (default: no)
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.
Default: u’‘
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
Default: u’‘
Set the profile location directly. This overrides the logic used by the profile option.
Default: {}
No description
Default: ‘’
No description
Default: 79
No description
Default: ‘\n’
No description
Default: True
No description
Default: {}
No description
Default: {}
No description
Default: False
No description
Default: False
Activate greedy completion
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.
Default: False
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
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.
Default: 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.
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
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.
Default: False
If True, any %store-d variables will be automatically restored when IPython starts.