Note
This documentation is for a development version of IPython. There may be significant differences from the latest stable release (1.2.1).
Any of the IPython kernel options can also be used.
Default: True
Whether to process ANSI escape codes.
Default: u’‘
No description
Default: 500
The maximum number of lines of text before truncation. Specifying a non- positive number disables text truncation (not recommended).
Default: True
Whether to clear the console when the kernel is restarted
Default: True
Whether to ask for user confirmation when restarting kernel
Default: ‘’
A command for invoking a system text editor. If the string contains a {filename} format specifier, it will be used. Otherwise, the filename will be appended to the end the command.
Default: u’‘
The editor command to use when a specific line number is requested. The string should contain two format specifiers: {line} and {filename}. If this parameter is not specified, the line number option to the %edit magic will be ignored.
Default: True
Whether to draw information calltips on open-parentheses.
Default: True
Whether to automatically execute on syntactically complete input.
If False, Shift-Enter is required to submit each execution. Disabling this is mainly useful for non-Python kernels, where the completion check would be wrong.
Default: u’‘
The font family to use for the console. On OSX this defaults to Monaco, on Windows the default is Consolas with fallback of Courier, and on other platforms the default is Monospace.
Default: 0
The font size. If unconfigured, Qt will be entrusted with the size of the font.
Default: ‘ncurses’
The type of completer to use. Valid values are:
Default: 25
The height of the console at start time in number of characters (will double with vsplit paging)
Default: False
No description
Default: ‘In [<span class=”in-prompt-number”>%i</span>]: ‘
No description
Default: ‘\n’
No description
Default: ‘plain’
The type of underlying text widget to use. Valid values are ‘plain’, which specifies a QPlainTextEdit, and ‘rich’, which specifies a QTextEdit.
Default: <IPython.utils.traitlets.Undefined object at 0x109eab8d0>
The pygments lexer class to use.
Default: ‘Out[<span class=”out-prompt-number”>%i</span>]: ‘
No description
Default: ‘’
No description
Default: ‘’
No description
Default: ‘inside’
The type of paging to use. Valid values are:
Default: u’‘
Default: u’‘
If not empty, use this Pygments style for syntax highlighting. Otherwise, the style sheet is queried for Pygments style information.
Default: 81
The width of the console at start time in number of characters (will double with hsplit paging)
Default: False
Should we autorestart the kernel if it dies.
Default: u’‘
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!
Default: []
The Popen Command to launch the kernel. Override this if you have a custom
Default: ‘tcp’
No description
Default: False
Whether to create profile dir if it doesn’t exist
Default: True
Set to display confirmation dialog on exit. You can always use ‘exit’ or ‘quit’, to force a direct exit without any confirmation.
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: 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: ‘’
Connect to an already running kernel
Default: u’‘
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
Default: 0
set the heartbeat port [default: random]
Default: False
Start the console window with the menu bar hidden.
Default: 0
set the iopub (PUB) port [default: random]
Default: u’‘
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!
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: False
Start the console window maximized.
Default: False
Whether to overwrite existing config files when copying
Default: False
Use a plaintext widget instead of rich text (plain can’t print/save).
Default: u’default’
The IPython profile to use.
Default: 0
set the shell (ROUTER) port [default: random]
Default: ‘’
Path to the ssh key to use for logging in to the ssh server.
Default: ‘’
The SSH server to use to connect to the kernel.
Default: 0
set the stdin (DEALER) port [default: random]
Default: ‘’
path to a custom CSS stylesheet
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
Close all figures at the end of each cell.
When True, ensures that each cell starts with no active figures, but it also means that one must keep track of references in order to edit or redraw figures in subsequent cells. This mode is ideal for the notebook, where residual plots from other cells might be surprising.
When False, one must call figure() to create new figures. This means that gcf() and getfigs() can reference figures created in other cells, and the active figure can continue to be edited with pylab/pyplot methods that reference the current active figure. This mode facilitates iterative editing of figures, and behaves most consistently with other matplotlib backends, but figure barriers between cells must be explicit.
Default: ‘png’
The image format for figures with the inline backend.
Default: {‘font.size’: 10, ‘figure.figsize’: (6.0, 4.0), ‘figure.facec...
Subset of matplotlib rcParams that should be different for the inline backend.