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_file : Unicode
    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_port : Int
    Default: ``0``

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

ConnectionFileMixin.hb_port : Int
    Default: ``0``

    set the heartbeat port [default: random]

ConnectionFileMixin.iopub_port : Int
    Default: ``0``

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

ConnectionFileMixin.ip : Unicode
    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_port : Int
    Default: ``0``

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

ConnectionFileMixin.stdin_port : Int
    Default: ``0``

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

ConnectionFileMixin.transport : any of ``'tcp'``|``'ipc'`` (case-insensitive)
    Default: ``'tcp'``

    No description

JupyterConsoleApp.confirm_exit : CBool
    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.connection_file : Unicode
    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.


JupyterConsoleApp.control_port : Int
    Default: ``0``

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

JupyterConsoleApp.existing : CUnicode
    Default: ``''``

    Connect to an already running kernel

JupyterConsoleApp.hb_port : Int
    Default: ``0``

    set the heartbeat port [default: random]

JupyterConsoleApp.iopub_port : Int
    Default: ``0``

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

JupyterConsoleApp.ip : Unicode
    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!

JupyterConsoleApp.kernel_manager_class : Type
    Default: ``'jupyter_client.manager.KernelManager'``

    The kernel manager class to use.

JupyterConsoleApp.kernel_name : Unicode
    Default: ``'python'``

    The name of the default kernel to start.

JupyterConsoleApp.shell_port : Int
    Default: ``0``

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

JupyterConsoleApp.sshkey : Unicode
    Default: ``''``

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

JupyterConsoleApp.sshserver : Unicode
    Default: ``''``

    The SSH server to use to connect to the kernel.

JupyterConsoleApp.stdin_port : Int
    Default: ``0``

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

JupyterConsoleApp.transport : any of ``'tcp'``|``'ipc'`` (case-insensitive)
    Default: ``'tcp'``

    No description


Application.log_datefmt : Unicode
    Default: ``'%Y-%m-%d %H:%M:%S'``

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

Application.log_format : Unicode
    Default: ``'[%(name)s]%(highlevel)s %(message)s'``

    The Logging format template

Application.log_level : any of ``0``|``10``|``20``|``30``|``40``|``50``|``'DEBUG'``|``'INFO'``|``'WARN'``|``'ERROR'``|``'CRITICAL'``
    Default: ``30``

    Set the log level by value or name.

Application.logging_config : Dict
    Default: ``{}``


    Configure additional log handlers.

    The default stderr logs handler is configured by the
    log_level, log_datefmt and log_format settings.

    This configuration can be used to configure additional handlers
    (e.g. to output the log to a file) or for finer control over the
    default handlers.

    If provided this should be a logging configuration dictionary, for
    more information see:
    https://docs.python.org/3/library/logging.config.html#logging-config-dictschema

    This dictionary is merged with the base logging configuration which
    defines the following:

    * A logging formatter intended for interactive use called
      ``console``.
    * A logging handler that writes to stderr called
      ``console`` which uses the formatter ``console``.
    * A logger with the name of this application set to ``DEBUG``
      level.

    This example adds a new handler that writes to a file:

    .. code-block:: python

       c.Application.logging_config = {
           "handlers": {
               "file": {
                   "class": "logging.FileHandler",
                   "level": "DEBUG",
                   "filename": "<path/to/file>",
               }
           },
           "loggers": {
               "<application-name>": {
                   "level": "DEBUG",
                   # NOTE: if you don't list the default "console"
                   # handler here then it will be disabled
                   "handlers": ["console", "file"],
               },
           },
       }



Application.show_config : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout

Application.show_config_json : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout (as JSON)

JupyterApp.answer_yes : Bool
    Default: ``False``

    Answer yes to any prompts.

JupyterApp.config_file : Unicode
    Default: ``''``

    Full path of a config file.

JupyterApp.config_file_name : Unicode
    Default: ``''``

    Specify a config file to load.

JupyterApp.generate_config : Bool
    Default: ``False``

    Generate default config file.

JupyterApp.log_datefmt : Unicode
    Default: ``'%Y-%m-%d %H:%M:%S'``

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

JupyterApp.log_format : Unicode
    Default: ``'[%(name)s]%(highlevel)s %(message)s'``

    The Logging format template

JupyterApp.log_level : any of ``0``|``10``|``20``|``30``|``40``|``50``|``'DEBUG'``|``'INFO'``|``'WARN'``|``'ERROR'``|``'CRITICAL'``
    Default: ``30``

    Set the log level by value or name.

JupyterApp.logging_config : Dict
    Default: ``{}``


    Configure additional log handlers.

    The default stderr logs handler is configured by the
    log_level, log_datefmt and log_format settings.

    This configuration can be used to configure additional handlers
    (e.g. to output the log to a file) or for finer control over the
    default handlers.

    If provided this should be a logging configuration dictionary, for
    more information see:
    https://docs.python.org/3/library/logging.config.html#logging-config-dictschema

    This dictionary is merged with the base logging configuration which
    defines the following:

    * A logging formatter intended for interactive use called
      ``console``.
    * A logging handler that writes to stderr called
      ``console`` which uses the formatter ``console``.
    * A logger with the name of this application set to ``DEBUG``
      level.

    This example adds a new handler that writes to a file:

    .. code-block:: python

       c.Application.logging_config = {
           "handlers": {
               "file": {
                   "class": "logging.FileHandler",
                   "level": "DEBUG",
                   "filename": "<path/to/file>",
               }
           },
           "loggers": {
               "<application-name>": {
                   "level": "DEBUG",
                   # NOTE: if you don't list the default "console"
                   # handler here then it will be disabled
                   "handlers": ["console", "file"],
               },
           },
       }



JupyterApp.show_config : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout

JupyterApp.show_config_json : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout (as JSON)

JupyterQtConsoleApp.answer_yes : Bool
    Default: ``False``

    Answer yes to any prompts.

JupyterQtConsoleApp.config_file : Unicode
    Default: ``''``

    Full path of a config file.

JupyterQtConsoleApp.config_file_name : Unicode
    Default: ``''``

    Specify a config file to load.

JupyterQtConsoleApp.confirm_exit : CBool
    Default: ``True``


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

JupyterQtConsoleApp.connection_file : Unicode
    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.


JupyterQtConsoleApp.control_port : Int
    Default: ``0``

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

JupyterQtConsoleApp.display_banner : CBool
    Default: ``True``

    Whether to display a banner upon starting the QtConsole.

JupyterQtConsoleApp.existing : CUnicode
    Default: ``''``

    Connect to an already running kernel

JupyterQtConsoleApp.generate_config : Bool
    Default: ``False``

    Generate default config file.

JupyterQtConsoleApp.hb_port : Int
    Default: ``0``

    set the heartbeat port [default: random]

JupyterQtConsoleApp.hide_menubar : CBool
    Default: ``False``

    Start the console window with the menu bar hidden.

JupyterQtConsoleApp.iopub_port : Int
    Default: ``0``

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

JupyterQtConsoleApp.ip : Unicode
    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!

JupyterQtConsoleApp.kernel_name : Unicode
    Default: ``'python'``

    The name of the default kernel to start.

JupyterQtConsoleApp.log_datefmt : Unicode
    Default: ``'%Y-%m-%d %H:%M:%S'``

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

JupyterQtConsoleApp.log_format : Unicode
    Default: ``'[%(name)s]%(highlevel)s %(message)s'``

    The Logging format template

JupyterQtConsoleApp.log_level : any of ``0``|``10``|``20``|``30``|``40``|``50``|``'DEBUG'``|``'INFO'``|``'WARN'``|``'ERROR'``|``'CRITICAL'``
    Default: ``30``

    Set the log level by value or name.

JupyterQtConsoleApp.logging_config : Dict
    Default: ``{}``


    Configure additional log handlers.

    The default stderr logs handler is configured by the
    log_level, log_datefmt and log_format settings.

    This configuration can be used to configure additional handlers
    (e.g. to output the log to a file) or for finer control over the
    default handlers.

    If provided this should be a logging configuration dictionary, for
    more information see:
    https://docs.python.org/3/library/logging.config.html#logging-config-dictschema

    This dictionary is merged with the base logging configuration which
    defines the following:

    * A logging formatter intended for interactive use called
      ``console``.
    * A logging handler that writes to stderr called
      ``console`` which uses the formatter ``console``.
    * A logger with the name of this application set to ``DEBUG``
      level.

    This example adds a new handler that writes to a file:

    .. code-block:: python

       c.Application.logging_config = {
           "handlers": {
               "file": {
                   "class": "logging.FileHandler",
                   "level": "DEBUG",
                   "filename": "<path/to/file>",
               }
           },
           "loggers": {
               "<application-name>": {
                   "level": "DEBUG",
                   # NOTE: if you don't list the default "console"
                   # handler here then it will be disabled
                   "handlers": ["console", "file"],
               },
           },
       }



JupyterQtConsoleApp.maximize : CBool
    Default: ``False``

    Start the console window maximized.

JupyterQtConsoleApp.plain : CBool
    Default: ``False``

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

JupyterQtConsoleApp.shell_port : Int
    Default: ``0``

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

JupyterQtConsoleApp.show_config : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout

JupyterQtConsoleApp.show_config_json : Bool
    Default: ``False``

    Instead of starting the Application, dump configuration to stdout (as JSON)

JupyterQtConsoleApp.sshkey : Unicode
    Default: ``''``

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

JupyterQtConsoleApp.sshserver : Unicode
    Default: ``''``

    The SSH server to use to connect to the kernel.

JupyterQtConsoleApp.stdin_port : Int
    Default: ``0``

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

JupyterQtConsoleApp.stylesheet : Unicode
    Default: ``''``

    path to a custom CSS stylesheet

JupyterQtConsoleApp.transport : any of ``'tcp'``|``'ipc'`` (case-insensitive)
    Default: ``'tcp'``

    No description


ConsoleWidget.ansi_codes : Bool
    Default: ``True``

    Whether to process ANSI escape codes.

ConsoleWidget.buffer_size : Int
    Default: ``500``


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


ConsoleWidget.console_height : Int
    Default: ``25``

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


ConsoleWidget.console_width : Int
    Default: ``81``

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


ConsoleWidget.execute_on_complete_input : Bool
    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_family : Unicode
    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_size : Int
    Default: ``0``

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


ConsoleWidget.gui_completion : any of ``'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.gui_completion_height : Int
    Default: ``0``


    Set Height for completion.

    'droplist'
        Height in pixels.
    'ncurses'
        Maximum number of rows.


ConsoleWidget.include_other_output : Bool
    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 : any of ``'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_prefix : Unicode
    Default: ``'[remote] '``

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

            Only relevant if include_other_output is True.


ConsoleWidget.paging : any of ``'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_visibility : Bool
    Default: ``True``

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

HistoryConsoleWidget.ansi_codes : Bool
    Default: ``True``

    Whether to process ANSI escape codes.

HistoryConsoleWidget.buffer_size : Int
    Default: ``500``


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


HistoryConsoleWidget.console_height : Int
    Default: ``25``

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


HistoryConsoleWidget.console_width : Int
    Default: ``81``

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


HistoryConsoleWidget.execute_on_complete_input : Bool
    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.


HistoryConsoleWidget.font_family : Unicode
    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.


HistoryConsoleWidget.font_size : Int
    Default: ``0``

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


HistoryConsoleWidget.gui_completion : any of ``'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.


HistoryConsoleWidget.gui_completion_height : Int
    Default: ``0``


    Set Height for completion.

    'droplist'
        Height in pixels.
    'ncurses'
        Maximum number of rows.


HistoryConsoleWidget.history_lock : Bool
    Default: ``False``

    No description

HistoryConsoleWidget.include_other_output : Bool
    Default: ``False``

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

            Outputs are not displayed until enter is pressed.


HistoryConsoleWidget.kind : any of ``'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.


HistoryConsoleWidget.other_output_prefix : Unicode
    Default: ``'[remote] '``

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

            Only relevant if include_other_output is True.


HistoryConsoleWidget.paging : any of ``'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.


HistoryConsoleWidget.scrollbar_visibility : Bool
    Default: ``True``

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

FrontendWidget.ansi_codes : Bool
    Default: ``True``

    Whether to process ANSI escape codes.

FrontendWidget.banner : Unicode
    Default: ``''``

    No description

FrontendWidget.buffer_size : Int
    Default: ``500``


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


FrontendWidget.clear_on_kernel_restart : Bool
    Default: ``True``

    Whether to clear the console when the kernel is restarted

FrontendWidget.confirm_restart : Bool
    Default: ``True``

    Whether to ask for user confirmation when restarting kernel

FrontendWidget.console_height : Int
    Default: ``25``

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


FrontendWidget.console_width : Int
    Default: ``81``

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


FrontendWidget.enable_calltips : Bool
    Default: ``True``

    Whether to draw information calltips on open-parentheses.

FrontendWidget.execute_on_complete_input : Bool
    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.


FrontendWidget.font_family : Unicode
    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.


FrontendWidget.font_size : Int
    Default: ``0``

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


FrontendWidget.gui_completion : any of ``'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.


FrontendWidget.gui_completion_height : Int
    Default: ``0``


    Set Height for completion.

    'droplist'
        Height in pixels.
    'ncurses'
        Maximum number of rows.


FrontendWidget.history_lock : Bool
    Default: ``False``

    No description

FrontendWidget.include_other_output : Bool
    Default: ``False``

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

            Outputs are not displayed until enter is pressed.


FrontendWidget.kind : any of ``'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.


FrontendWidget.lexer_class : DottedObjectName
    Default: ``traitlets.Undefined``

    The pygments lexer class to use.

FrontendWidget.other_output_prefix : Unicode
    Default: ``'[remote] '``

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

            Only relevant if include_other_output is True.


FrontendWidget.paging : any of ``'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.


FrontendWidget.scrollbar_visibility : Bool
    Default: ``True``

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

IPythonWidget.ansi_codes : Bool
    Default: ``True``

    Whether to process ANSI escape codes.

IPythonWidget.banner : Unicode
    Default: ``''``

    No description

IPythonWidget.buffer_size : Int
    Default: ``500``


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


IPythonWidget.clear_on_kernel_restart : Bool
    Default: ``True``

    Whether to clear the console when the kernel is restarted

IPythonWidget.confirm_restart : Bool
    Default: ``True``

    Whether to ask for user confirmation when restarting kernel

IPythonWidget.console_height : Int
    Default: ``25``

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


IPythonWidget.console_width : Int
    Default: ``81``

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


IPythonWidget.enable_calltips : Bool
    Default: ``True``

    Whether to draw information calltips on open-parentheses.

IPythonWidget.execute_on_complete_input : Bool
    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.


IPythonWidget.font_family : Unicode
    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.


IPythonWidget.font_size : Int
    Default: ``0``

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


IPythonWidget.gui_completion : any of ``'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.


IPythonWidget.gui_completion_height : Int
    Default: ``0``


    Set Height for completion.

    'droplist'
        Height in pixels.
    'ncurses'
        Maximum number of rows.


IPythonWidget.history_lock : Bool
    Default: ``False``

    No description

IPythonWidget.include_other_output : Bool
    Default: ``False``

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

            Outputs are not displayed until enter is pressed.


IPythonWidget.kind : any of ``'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.


IPythonWidget.lexer_class : DottedObjectName
    Default: ``traitlets.Undefined``

    The pygments lexer class to use.

IPythonWidget.other_output_prefix : Unicode
    Default: ``'[remote] '``

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

            Only relevant if include_other_output is True.


IPythonWidget.paging : any of ``'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.


IPythonWidget.scrollbar_visibility : Bool
    Default: ``True``

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

JupyterWidget.ansi_codes : Bool
    Default: ``True``

    Whether to process ANSI escape codes.

JupyterWidget.banner : Unicode
    Default: ``''``

    No description

JupyterWidget.buffer_size : Int
    Default: ``500``


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


JupyterWidget.clear_on_kernel_restart : Bool
    Default: ``True``

    Whether to clear the console when the kernel is restarted

JupyterWidget.confirm_restart : Bool
    Default: ``True``

    Whether to ask for user confirmation when restarting kernel

JupyterWidget.console_height : Int
    Default: ``25``

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


JupyterWidget.console_width : Int
    Default: ``81``

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


JupyterWidget.editor : Unicode
    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_line : Unicode
    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.enable_calltips : Bool
    Default: ``True``

    Whether to draw information calltips on open-parentheses.

JupyterWidget.execute_on_complete_input : Bool
    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.


JupyterWidget.font_family : Unicode
    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.


JupyterWidget.font_size : Int
    Default: ``0``

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


JupyterWidget.gui_completion : any of ``'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.


JupyterWidget.gui_completion_height : Int
    Default: ``0``


    Set Height for completion.

    'droplist'
        Height in pixels.
    'ncurses'
        Maximum number of rows.


JupyterWidget.history_lock : Bool
    Default: ``False``

    No description

JupyterWidget.in_prompt : Unicode
    Default: ``'In [<span class="in-prompt-number">%i</span>]: '``

    No description

JupyterWidget.include_other_output : Bool
    Default: ``False``

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

            Outputs are not displayed until enter is pressed.


JupyterWidget.input_sep : Unicode
    Default: ``'\\n'``

    No description

JupyterWidget.kind : any of ``'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.


JupyterWidget.lexer_class : DottedObjectName
    Default: ``traitlets.Undefined``

    The pygments lexer class to use.

JupyterWidget.other_output_prefix : Unicode
    Default: ``'[remote] '``

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

            Only relevant if include_other_output is True.


JupyterWidget.out_prompt : Unicode
    Default: ``'Out[<span class="out-prompt-number">%i</span>]: '``

    No description

JupyterWidget.output_sep : Unicode
    Default: ``''``

    No description

JupyterWidget.output_sep2 : Unicode
    Default: ``''``

    No description

JupyterWidget.paging : any of ``'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.


JupyterWidget.scrollbar_visibility : Bool
    Default: ``True``

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

JupyterWidget.style_sheet : Unicode
    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_style : Unicode
    Default: ``''``


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


KernelManager.autorestart : Bool
    Default: ``True``

    Should we autorestart the kernel if it dies.

KernelManager.cache_ports : Bool
    Default: ``False``

    True if the MultiKernelManager should cache ports for this KernelManager instance

KernelManager.connection_file : Unicode
    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.


KernelManager.control_port : Int
    Default: ``0``

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

KernelManager.hb_port : Int
    Default: ``0``

    set the heartbeat port [default: random]

KernelManager.iopub_port : Int
    Default: ``0``

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

KernelManager.ip : Unicode
    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!

KernelManager.shell_port : Int
    Default: ``0``

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

KernelManager.shutdown_wait_time : Float
    Default: ``5.0``

    Time to wait for a kernel to terminate before killing it, in seconds. When a shutdown request is initiated, the kernel will be immediately sent an interrupt (SIGINT), followedby a shutdown_request message, after 1/2 of `shutdown_wait_time`it will be sent a terminate (SIGTERM) request, and finally at the end of `shutdown_wait_time` will be killed (SIGKILL). terminate and kill may be equivalent on windows.  Note that this value can beoverridden by the in-use kernel provisioner since shutdown times mayvary by provisioned environment.

KernelManager.stdin_port : Int
    Default: ``0``

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

KernelManager.transport : any of ``'tcp'``|``'ipc'`` (case-insensitive)
    Default: ``'tcp'``

    No description

KernelRestarter.debug : Bool
    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_alive : Bool
    Default: ``True``

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

KernelRestarter.restart_limit : Int
    Default: ``5``

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

KernelRestarter.stable_start_time : Float
    Default: ``10.0``

    The time in seconds to consider the kernel to have completed a stable start up.

KernelRestarter.time_to_dead : Float
    Default: ``3.0``

    Kernel heartbeat interval in seconds.

Session.buffer_threshold : Int
    Default: ``1024``

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

Session.check_pid : Bool
    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_threshold : Int
    Default: ``65536``

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

Session.debug : Bool
    Default: ``False``

    Debug output in the Session

Session.digest_history_size : Int
    Default: ``65536``

    The maximum number of digests to remember.

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


Session.item_threshold : Int
    Default: ``64``

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


Session.key : CBytes
    Default: ``b''``

    execution key, for signing messages.

Session.keyfile : Unicode
    Default: ``''``

    path to file containing execution key.

Session.metadata : Dict
    Default: ``{}``

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

Session.packer : DottedObjectName
    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.session : CUnicode
    Default: ``''``

    The UUID identifying this session.

Session.signature_scheme : Unicode
    Default: ``'hmac-sha256'``

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

Session.unpacker : DottedObjectName
    Default: ``'json'``

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

Session.username : Unicode
    Default: ``'buildd'``

    Username for the Session. Default is your system username.
