Note
This documentation is for a development version of IPython. There may be significant differences from the latest stable release (1.2.1).
These options can be used in ipython_notebook_config.py or in ipython_qtconsole_config.py
Default: False
Whether to create profile dir if it doesn’t exist
Default: ‘’
Execute the given command string.
Default: ‘’
JSON file in which to store connection info [default: kernel-<pid>.json]
This file will contain the IP, ports, and authentication key needed to connect clients to this kernel. By default, this file will be created in the security dir of the current profile, but can be specified by absolute path.
Default: 0
set the control (ROUTER) port [default: random]
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: ‘IPython.kernel.zmq.displayhook.ZMQDisplayHook’
The importstring for the DisplayHook factory
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: 0
set the heartbeat port [default: random]
Default: True
Should variables loaded at startup (by startup files, exec_lines, etc.) be hidden from tools like %who?
Default: 0
ONLY USED ON WINDOWS Interrupt this process when the parent is signaled.
Default: 0
set the iopub (PUB) port [default: random]
Default: u’‘
Set the IP or interface on which the kernel will listen.
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: ‘IPython.kernel.zmq.ipkernel.Kernel’
The Kernel subclass to be used.
This should allow easy re-use of the IPKernelApp entry point to configure and launch kernels other than IPython’s own.
Default: ‘%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
redirect stderr to the null device
Default: False
redirect stdout to the null device
Default: ‘IPython.kernel.zmq.iostream.OutStream’
The importstring for the OutStream factory
Default: False
Whether to overwrite existing config files when copying
Default: u’‘
No description
Default: 0
kill this process if its parent dies. On Windows, the argument specifies the HANDLE of the parent process, otherwise it is simply boolean.
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: 0
set the shell (ROUTER) port [default: random]
Default: 0
set the stdin (ROUTER) port [default: random]
Default: ‘tcp’
No description
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: True
Whether to use appnope for compatiblity with OS X App Nap.
Only affects OS X >= 10.9.
Default: 0.0005
No description
Default: 0.05
No description
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: True
Enable magic commands to be called without the leading %.
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: 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: 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: 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: ‘\n’
No description
Default: ‘’
No description
Default: ‘’
No description
Default: True
Show rewritten input, e.g. for autocall.
Default: True
No description
Default: ‘Context’
No description
Default: u’‘
Set the profile location directly. This overrides the logic used by the profile option.
Default: 1024
Threshold (in bytes) beyond which an object’s buffer should be extracted to avoid pickling.
Default: 65536
Threshold (in bytes) beyond which a buffer should be sent without copying.
Default: False
Debug output in the Session
Default: 65536
The maximum number of digests to remember.
The digest history will be culled when it exceeds this value.
Default: 64
The maximum number of items for a container to be introspected for custom serialization. Containers larger than this are pickled outright.
Default: ‘’
execution key, for extra authentication.
Default: ‘’
path to file containing execution key.
Default: {}
Metadata dictionary, which serves as the default top-level metadata dict for each message.
Default: ‘json’
The name of the packer for serializing messages. Should be one of ‘json’, ‘pickle’, or an import name for a custom callable serializer.
Default: u’‘
The UUID identifying this session.
Default: ‘hmac-sha256’
The digest scheme used to construct the message signatures. Must have the form ‘hmac-HASH’.
Default: ‘json’
The name of the unpacker for unserializing messages. Only used with custom functions for packer.
Default: u’minrk’
Username for the Session. Default is your system username.