Configuration options

These options can be set in the configuration file, ~/.jupyter/jupyter_qtconsole_config.py, or at the command line when you start Qt console.

You may enter jupyter qtconsole --help-all to get information about all available configuration options.

Options

ConnectionFileMixin.connection_fileUnicode

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.

ConnectionFileMixin.control_portInt

Default: 0

set the control (ROUTER) port [default: random]

ConnectionFileMixin.hb_portInt

Default: 0

set the heartbeat port [default: random]

ConnectionFileMixin.iopub_portInt

Default: 0

set the iopub (PUB) port [default: random]

ConnectionFileMixin.ipUnicode

Default: ''

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!

ConnectionFileMixin.shell_portInt

Default: 0

set the shell (ROUTER) port [default: random]

ConnectionFileMixin.stdin_portInt

Default: 0

set the stdin (ROUTER) port [default: random]

ConnectionFileMixin.transport‘tcp’|’ipc’

Default: 'tcp'

No description

JupyterConsoleApp.confirm_exitCBool

Default: True

Set to display confirmation dialog on exit. You can always use ‘exit’ or ‘quit’, to force a direct exit without any confirmation.

JupyterConsoleApp.existingCUnicode

Default: ''

Connect to an already running kernel

JupyterConsoleApp.kernel_manager_classType

Default: 'jupyter_client.manager.KernelManager'

The kernel manager class to use.

JupyterConsoleApp.kernel_nameUnicode

Default: 'python'

The name of the default kernel to start.

JupyterConsoleApp.sshkeyUnicode

Default: ''

Path to the ssh key to use for logging in to the ssh server.

JupyterConsoleApp.sshserverUnicode

Default: ''

The SSH server to use to connect to the kernel.

Application.log_datefmtUnicode

Default: '%Y-%m-%d %H:%M:%S'

The date format used by logging formatters for %(asctime)s

Application.log_formatUnicode

Default: '[%(name)s]%(highlevel)s %(message)s'

The Logging format template

Application.log_level0|10|20|30|40|50|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’

Default: 30

Set the log level by value or name.

JupyterApp.answer_yesBool

Default: False

Answer yes to any prompts.

JupyterApp.config_fileUnicode

Default: ''

Full path of a config file.

JupyterApp.config_file_nameUnicode

Default: ''

Specify a config file to load.

JupyterApp.generate_configBool

Default: False

Generate default config file.

JupyterQtConsoleApp.display_bannerCBool

Default: True

Whether to display a banner upon starting the QtConsole.

JupyterQtConsoleApp.hide_menubarCBool

Default: False

Start the console window with the menu bar hidden.

JupyterQtConsoleApp.maximizeCBool

Default: False

Start the console window maximized.

JupyterQtConsoleApp.plainCBool

Default: False

Use a plaintext widget instead of rich text (plain can’t print/save).

JupyterQtConsoleApp.stylesheetUnicode

Default: ''

path to a custom CSS stylesheet

ConsoleWidget.ansi_codesBool

Default: True

Whether to process ANSI escape codes.

ConsoleWidget.buffer_sizeInt

Default: 500

The maximum number of lines of text before truncation. Specifying a non-positive number disables text truncation (not recommended).

ConsoleWidget.console_heightInt

Default: 25

The height of the console at start time in number of characters (will double with vsplit paging)

ConsoleWidget.console_widthInt

Default: 81

The width of the console at start time in number of characters (will double with hsplit paging)

ConsoleWidget.execute_on_complete_inputBool

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.

ConsoleWidget.font_familyUnicode

Default: ''

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.

ConsoleWidget.font_sizeInt

Default: 0

The font size. If unconfigured, Qt will be entrusted with the size of the font.

ConsoleWidget.gui_completion‘plain’|’droplist’|’ncurses’

Default: 'ncurses'

The type of completer to use. Valid values are:

‘plain’Show the available completion as a text list

Below the editing area.

‘droplist’: Show the completion in a drop down list navigable

by the arrow keys, and from which you can select completion by pressing Return.

‘ncurses’Show the completion as a text list which is navigable by

tab and arrow keys.

ConsoleWidget.include_other_outputBool

Default: False

Whether to include output from clients other than this one sharing the same kernel.

Outputs are not displayed until enter is pressed.

ConsoleWidget.kind‘plain’|’rich’

Default: 'plain'

The type of underlying text widget to use. Valid values are ‘plain’, which specifies a QPlainTextEdit, and ‘rich’, which specifies a QTextEdit.

ConsoleWidget.other_output_prefixUnicode

Default: '[remote] '

Prefix to add to outputs coming from clients other than this one.

Only relevant if include_other_output is True.

ConsoleWidget.paging‘inside’|’hsplit’|’vsplit’|’custom’|’none’

Default: 'inside'

The type of paging to use. Valid values are:

‘inside’

The widget pages like a traditional terminal.

‘hsplit’

When paging is requested, the widget is split horizontally. The top pane contains the console, and the bottom pane contains the paged text.

‘vsplit’

Similar to ‘hsplit’, except that a vertical splitter is used.

‘custom’

No action is taken by the widget beyond emitting a ‘custom_page_requested(str)’ signal.

‘none’

The text is written directly to the console.

ConsoleWidget.scrollbar_visibilityBool

Default: True

The visibility of the scrollar. If False then the scrollbar will be invisible.

HistoryConsoleWidget.history_lockBool

Default: False

No description

FrontendWidget.bannerUnicode

Default: ''

No description

FrontendWidget.clear_on_kernel_restartBool

Default: True

Whether to clear the console when the kernel is restarted

FrontendWidget.confirm_restartBool

Default: True

Whether to ask for user confirmation when restarting kernel

FrontendWidget.enable_calltipsBool

Default: True

Whether to draw information calltips on open-parentheses.

FrontendWidget.lexer_classDottedObjectName

Default: traitlets.Undefined

The pygments lexer class to use.

JupyterWidget.editorUnicode

Default: ''

A command for invoking a GUI 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. To use a terminal text editor, the command should launch a new terminal, e.g. "gnome-terminal -- vim".

JupyterWidget.editor_lineUnicode

Default: ''

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.

JupyterWidget.in_promptUnicode

Default: 'In [<span class="in-prompt-number">%i</span>]: '

No description

JupyterWidget.input_sepUnicode

Default: '\\n'

No description

JupyterWidget.out_promptUnicode

Default: 'Out[<span class="out-prompt-number">%i</span>]: '

No description

JupyterWidget.output_sepUnicode

Default: ''

No description

JupyterWidget.output_sep2Unicode

Default: ''

No description

JupyterWidget.style_sheetUnicode

Default: ''

A CSS stylesheet. The stylesheet can contain classes for:

1. Qt: QPlainTextEdit, QFrame, QWidget, etc

2. Pygments: .c, .k, .o, etc. (see PygmentsHighlighter)

3. QtConsole: .error, .in-prompt, .out-prompt, etc

JupyterWidget.syntax_styleUnicode

Default: ''

If not empty, use this Pygments style for syntax highlighting. Otherwise, the style sheet is queried for Pygments style information.

KernelManager.autorestartBool

Default: True

Should we autorestart the kernel if it dies.

KernelManager.kernel_cmdList

Default: []

DEPRECATED: Use kernel_name instead.

The Popen Command to launch the kernel. Override this if you have a custom kernel. If kernel_cmd is specified in a configuration file, Jupyter does not pass any arguments to the kernel, because it cannot make any assumptions about the arguments that the kernel understands. In particular, this means that the kernel does not receive the option –debug if it given on the Jupyter command line.

KernelManager.shutdown_wait_timeFloat

Default: 5.0

Time to wait for a kernel to terminate before killing it, in seconds.

KernelRestarter.debugBool

Default: False

Whether to include every poll event in debugging output.

Has to be set explicitly, because there will be a lot of output.

KernelRestarter.random_ports_until_aliveBool

Default: True

Whether to choose new random ports when restarting before the kernel is alive.

KernelRestarter.restart_limitInt

Default: 5

The number of consecutive autorestarts before the kernel is presumed dead.

KernelRestarter.time_to_deadFloat

Default: 3.0

Kernel heartbeat interval in seconds.

Session.buffer_thresholdInt

Default: 1024

Threshold (in bytes) beyond which an object’s buffer should be extracted to avoid pickling.

Session.check_pidBool

Default: True

Whether to check PID to protect against calls after fork.

This check can be disabled if fork-safety is handled elsewhere.

Session.copy_thresholdInt

Default: 65536

Threshold (in bytes) beyond which a buffer should be sent without copying.

Session.debugBool

Default: False

Debug output in the Session

Session.digest_history_sizeInt

Default: 65536

The maximum number of digests to remember.

The digest history will be culled when it exceeds this value.

Session.item_thresholdInt

Default: 64

The maximum number of items for a container to be introspected for custom serialization. Containers larger than this are pickled outright.

Session.keyCBytes

Default: b''

execution key, for signing messages.

Session.keyfileUnicode

Default: ''

path to file containing execution key.

Session.metadataDict

Default: {}

Metadata dictionary, which serves as the default top-level metadata dict for each message.

Session.packerDottedObjectName

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.

Session.sessionCUnicode

Default: ''

The UUID identifying this session.

Session.signature_schemeUnicode

Default: 'hmac-sha256'

The digest scheme used to construct the message signatures. Must have the form ‘hmac-HASH’.

Session.unpackerDottedObjectName

Default: 'json'

The name of the unpacker for unserializing messages. Only used with custom functions for packer.

Session.usernameUnicode

Default: 'buildd'

Username for the Session. Default is your system username.