All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
1 # Configuration file for ipython.
3 c = get_config() # noqa
5 #------------------------------------------------------------------------------
6 # InteractiveShellApp(Configurable) configuration
7 #------------------------------------------------------------------------------
8 ## A Mixin for applications that start InteractiveShell instances.
10 # Provides configurables for loading extensions and executing files
11 # as part of configuring a Shell environment.
13 # The following methods should be called by the :meth:`initialize` method
17 # - :meth:`init_shell` (to be implemented by the subclass)
18 # - :meth:`init_gui_pylab`
19 # - :meth:`init_extensions`
22 ## Execute the given command string.
24 # c.InteractiveShellApp.code_to_run = ''
26 ## Run the file referenced by the PYTHONSTARTUP environment
27 # variable at IPython startup.
29 # c.InteractiveShellApp.exec_PYTHONSTARTUP = True
31 ## List of files to run at IPython startup.
33 # c.InteractiveShellApp.exec_files = []
35 ## lines of code to run at IPython startup.
37 # c.InteractiveShellApp.exec_lines = []
39 ## A list of dotted module names of IPython extensions to load.
41 # c.InteractiveShellApp.extensions = []
43 ## Dotted module name(s) of one or more IPython extensions to load.
45 # For specifying extra extensions to load on the command-line.
47 # .. versionadded:: 7.10
49 # c.InteractiveShellApp.extra_extensions = []
53 # c.InteractiveShellApp.file_to_run = ''
55 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
56 # 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
58 # Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
60 # c.InteractiveShellApp.gui = None
62 ## Should variables loaded at startup (by startup files, exec_lines, etc.)
63 # be hidden from tools like %who?
65 # c.InteractiveShellApp.hide_initial_ns = True
67 ## If True, IPython will not add the current working directory to sys.path.
68 # When False, the current working directory is added to sys.path, allowing imports
69 # of modules defined in the current directory.
71 # c.InteractiveShellApp.ignore_cwd = False
73 ## Configure matplotlib for interactive use with
74 # the default matplotlib backend.
75 # Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
77 # c.InteractiveShellApp.matplotlib = None
79 ## Run the module as a script.
81 # c.InteractiveShellApp.module_to_run = ''
83 ## Pre-load matplotlib and numpy for interactive use,
84 # selecting a particular matplotlib backend and loop integration.
85 # Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'gtk4', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'qt6', 'svg', 'tk', 'webagg', 'widget', 'wx'] (case-insensitive) or None
87 # c.InteractiveShellApp.pylab = None
89 ## If true, IPython will populate the user namespace with numpy, pylab, etc.
90 # and an ``import *`` is done from numpy and pylab, when using pylab mode.
92 # When False, pylab mode should not import any names into the user
95 # c.InteractiveShellApp.pylab_import_all = True
97 ## Reraise exceptions encountered loading IPython extensions?
99 # c.InteractiveShellApp.reraise_ipython_extension_failures = False
101 #------------------------------------------------------------------------------
102 # Application(SingletonConfigurable) configuration
103 #------------------------------------------------------------------------------
104 ## This is an application.
106 ## The date format used by logging formatters for %(asctime)s
107 # Default: '%Y-%m-%d %H:%M:%S'
108 # c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
110 ## The Logging format template
111 # Default: '[%(name)s]%(highlevel)s %(message)s'
112 # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
114 ## Set the log level by value or name.
115 # Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
117 # c.Application.log_level = 30
119 ## Configure additional log handlers.
121 # The default stderr logs handler is configured by the log_level, log_datefmt
122 # and log_format settings.
124 # This configuration can be used to configure additional handlers (e.g. to
125 # output the log to a file) or for finer control over the default handlers.
127 # If provided this should be a logging configuration dictionary, for more
129 # https://docs.python.org/3/library/logging.config.html#logging-config-
132 # This dictionary is merged with the base logging configuration which defines
135 # * A logging formatter intended for interactive use called
137 # * A logging handler that writes to stderr called
138 # ``console`` which uses the formatter ``console``.
139 # * A logger with the name of this application set to ``DEBUG``
142 # This example adds a new handler that writes to a file:
144 # .. code-block:: python
146 # c.Application.logging_config = {
149 # 'class': 'logging.FileHandler',
151 # 'filename': '<path/to/file>',
155 # '<application-name>': {
157 # # NOTE: if you don't list the default "console"
158 # # handler here then it will be disabled
159 # 'handlers': ['console', 'file'],
164 # c.Application.logging_config = {}
166 ## Instead of starting the Application, dump configuration to stdout
168 # c.Application.show_config = False
170 ## Instead of starting the Application, dump configuration to stdout (as JSON)
172 # c.Application.show_config_json = False
174 #------------------------------------------------------------------------------
175 # BaseIPythonApplication(Application) configuration
176 #------------------------------------------------------------------------------
178 # c.BaseIPythonApplication.add_ipython_dir_to_sys_path = False
180 ## Whether to create profile dir if it doesn't exist
182 # c.BaseIPythonApplication.auto_create = False
184 ## Whether to install the default config files into the profile dir.
185 # If a new profile is being created, and IPython contains config files for that
186 # profile, then they will be staged into the new directory. Otherwise,
187 # default config files will be automatically generated.
189 # c.BaseIPythonApplication.copy_config_files = False
191 ## Path to an extra config file to load.
193 # If specified, load this config file in addition to any other IPython
196 # c.BaseIPythonApplication.extra_config_file = ''
198 ## The name of the IPython directory. This directory is used for logging
199 # configuration (through profiles), history storage, etc. The default is usually
200 # $HOME/.ipython. This option can also be specified through the environment
201 # variable IPYTHONDIR.
203 # c.BaseIPythonApplication.ipython_dir = ''
205 ## The date format used by logging formatters for %(asctime)s
206 # See also: Application.log_datefmt
207 # c.BaseIPythonApplication.log_datefmt = '%Y-%m-%d %H:%M:%S'
209 ## The Logging format template
210 # See also: Application.log_format
211 # c.BaseIPythonApplication.log_format = '[%(name)s]%(highlevel)s %(message)s'
213 ## Set the log level by value or name.
214 # See also: Application.log_level
215 # c.BaseIPythonApplication.log_level = 30
218 # See also: Application.logging_config
219 # c.BaseIPythonApplication.logging_config = {}
221 ## Whether to overwrite existing config files when copying
223 # c.BaseIPythonApplication.overwrite = False
225 ## The IPython profile to use.
227 # c.BaseIPythonApplication.profile = 'default'
229 ## Instead of starting the Application, dump configuration to stdout
230 # See also: Application.show_config
231 # c.BaseIPythonApplication.show_config = False
233 ## Instead of starting the Application, dump configuration to stdout (as JSON)
234 # See also: Application.show_config_json
235 # c.BaseIPythonApplication.show_config_json = False
237 ## Create a massive crash report when IPython encounters what may be an
238 # internal error. The default is to append a short message to the
241 # c.BaseIPythonApplication.verbose_crash = False
243 #------------------------------------------------------------------------------
244 # TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp) configuration
245 #------------------------------------------------------------------------------
246 # See also: BaseIPythonApplication.add_ipython_dir_to_sys_path
247 # c.TerminalIPythonApp.add_ipython_dir_to_sys_path = False
249 ## Execute the given command string.
250 # See also: InteractiveShellApp.code_to_run
251 # c.TerminalIPythonApp.code_to_run = ''
253 ## Whether to install the default config files into the profile dir.
254 # See also: BaseIPythonApplication.copy_config_files
255 # c.TerminalIPythonApp.copy_config_files = False
257 ## Whether to display a banner upon starting IPython.
259 # c.TerminalIPythonApp.display_banner = True
261 ## Run the file referenced by the PYTHONSTARTUP environment
262 # See also: InteractiveShellApp.exec_PYTHONSTARTUP
263 # c.TerminalIPythonApp.exec_PYTHONSTARTUP = True
265 ## List of files to run at IPython startup.
266 # See also: InteractiveShellApp.exec_files
267 # c.TerminalIPythonApp.exec_files = []
269 ## lines of code to run at IPython startup.
270 # See also: InteractiveShellApp.exec_lines
271 # c.TerminalIPythonApp.exec_lines = []
273 ## A list of dotted module names of IPython extensions to load.
274 # See also: InteractiveShellApp.extensions
275 # c.TerminalIPythonApp.extensions = []
277 ## Path to an extra config file to load.
278 # See also: BaseIPythonApplication.extra_config_file
279 # c.TerminalIPythonApp.extra_config_file = ''
282 # See also: InteractiveShellApp.extra_extensions
283 # c.TerminalIPythonApp.extra_extensions = []
286 # See also: InteractiveShellApp.file_to_run
287 # c.TerminalIPythonApp.file_to_run = ''
289 ## If a command or file is given via the command-line,
290 # e.g. 'ipython foo.py', start an interactive shell after executing the
293 # c.TerminalIPythonApp.force_interact = False
295 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
296 # 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
298 # See also: InteractiveShellApp.gui
299 # c.TerminalIPythonApp.gui = None
301 ## Should variables loaded at startup (by startup files, exec_lines, etc.)
302 # See also: InteractiveShellApp.hide_initial_ns
303 # c.TerminalIPythonApp.hide_initial_ns = True
305 ## If True, IPython will not add the current working directory to sys.path.
306 # See also: InteractiveShellApp.ignore_cwd
307 # c.TerminalIPythonApp.ignore_cwd = False
309 ## Class to use to instantiate the TerminalInteractiveShell object. Useful for
311 # Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
312 # c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
315 # See also: BaseIPythonApplication.ipython_dir
316 # c.TerminalIPythonApp.ipython_dir = ''
318 ## The date format used by logging formatters for %(asctime)s
319 # See also: Application.log_datefmt
320 # c.TerminalIPythonApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
322 ## The Logging format template
323 # See also: Application.log_format
324 # c.TerminalIPythonApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
326 ## Set the log level by value or name.
327 # See also: Application.log_level
328 # c.TerminalIPythonApp.log_level = 30
331 # See also: Application.logging_config
332 # c.TerminalIPythonApp.logging_config = {}
334 ## Configure matplotlib for interactive use with
335 # See also: InteractiveShellApp.matplotlib
336 # c.TerminalIPythonApp.matplotlib = None
338 ## Run the module as a script.
339 # See also: InteractiveShellApp.module_to_run
340 # c.TerminalIPythonApp.module_to_run = ''
342 ## Whether to overwrite existing config files when copying
343 # See also: BaseIPythonApplication.overwrite
344 # c.TerminalIPythonApp.overwrite = False
346 ## The IPython profile to use.
347 # See also: BaseIPythonApplication.profile
348 # c.TerminalIPythonApp.profile = 'default'
350 ## Pre-load matplotlib and numpy for interactive use,
351 # See also: InteractiveShellApp.pylab
352 # c.TerminalIPythonApp.pylab = None
354 ## If true, IPython will populate the user namespace with numpy, pylab, etc.
355 # See also: InteractiveShellApp.pylab_import_all
356 # c.TerminalIPythonApp.pylab_import_all = True
358 ## Start IPython quickly by skipping the loading of config files.
360 # c.TerminalIPythonApp.quick = False
362 ## Reraise exceptions encountered loading IPython extensions?
363 # See also: InteractiveShellApp.reraise_ipython_extension_failures
364 # c.TerminalIPythonApp.reraise_ipython_extension_failures = False
366 ## Instead of starting the Application, dump configuration to stdout
367 # See also: Application.show_config
368 # c.TerminalIPythonApp.show_config = False
370 ## Instead of starting the Application, dump configuration to stdout (as JSON)
371 # See also: Application.show_config_json
372 # c.TerminalIPythonApp.show_config_json = False
374 ## Create a massive crash report when IPython encounters what may be an
375 # See also: BaseIPythonApplication.verbose_crash
376 # c.TerminalIPythonApp.verbose_crash = False
378 #------------------------------------------------------------------------------
379 # InteractiveShell(SingletonConfigurable) configuration
380 #------------------------------------------------------------------------------
381 ## An enhanced, interactive shell for Python.
383 ## 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which
384 # nodes should be run interactively (displaying output from expressions).
385 # Choices: any of ['all', 'last', 'last_expr', 'none', 'last_expr_or_assign']
386 # Default: 'last_expr'
387 # c.InteractiveShell.ast_node_interactivity = 'last_expr'
389 ## A list of ast.NodeTransformer subclass instances, which will be applied to
390 # user input before code is run.
392 # c.InteractiveShell.ast_transformers = []
394 ## Automatically run await statement in the top level repl.
396 # c.InteractiveShell.autoawait = True
398 ## Make IPython automatically call any callable object even if you didn't type
399 # explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
400 # The value can be '0' to disable the feature, '1' for 'smart' autocall, where
401 # it is not applied if there are no more arguments on the line, and '2' for
402 # 'full' autocall, where all callable objects are automatically called (even if
403 # no arguments are present).
404 # Choices: any of [0, 1, 2]
406 # c.InteractiveShell.autocall = 0
408 ## Autoindent IPython code entered interactively.
410 # c.InteractiveShell.autoindent = True
412 ## Enable magic commands to be called without the leading %.
414 # c.InteractiveShell.automagic = True
416 ## The part of the banner to be printed before the profile
417 # Default: "Python 3.11.4 (main, Jun 7 2023, 10:13:09) [GCC 12.2.0]\nType 'copyright', 'credits' or 'license' for more information\nIPython 8.14.0 -- An enhanced Interactive Python. Type '?' for help.\n"
418 # c.InteractiveShell.banner1 = "Python 3.11.4 (main, Jun 7 2023, 10:13:09) [GCC 12.2.0]\nType 'copyright', 'credits' or 'license' for more information\nIPython 8.14.0 -- An enhanced Interactive Python. Type '?' for help.\n"
420 ## The part of the banner to be printed after the profile
422 # c.InteractiveShell.banner2 = ''
424 ## Set the size of the output cache. The default is 1000, you can change it
425 # permanently in your config file. Setting it to 0 completely disables the
426 # caching system, and the minimum value accepted is 3 (if you provide a value
427 # less than 3, it is reset to 0 and a warning is issued). This limit is defined
428 # because otherwise you'll spend more time re-flushing a too small cache than
431 # c.InteractiveShell.cache_size = 1000
433 ## Use colors for displaying information about objects. Because this information
434 # is passed through a pager (like 'less'), and some pagers get confused with
435 # color codes, this capability can be turned off.
437 # c.InteractiveShell.color_info = True
439 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
440 # Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
442 # c.InteractiveShell.colors = 'Neutral'
445 # c.InteractiveShell.debug = False
447 ## Don't call post-execute functions that have failed in the past.
449 # c.InteractiveShell.disable_failing_post_execute = False
451 ## If True, anything that would be passed to the pager
452 # will be displayed as regular output instead.
454 # c.InteractiveShell.display_page = False
456 ## (Provisional API) enables html representation in mime bundles sent to pagers.
458 # c.InteractiveShell.enable_html_pager = False
460 ## Total length of command history
462 # c.InteractiveShell.history_length = 10000
464 ## The number of saved history entries to be loaded into the history buffer at
467 # c.InteractiveShell.history_load_length = 1000
469 ## Class to use to instantiate the shell inspector
470 # Default: 'IPython.core.oinspect.Inspector'
471 # c.InteractiveShell.inspector_class = 'IPython.core.oinspect.Inspector'
474 # c.InteractiveShell.ipython_dir = ''
476 ## Start logging to the given file in append mode. Use `logfile` to specify a log
477 # file to **overwrite** logs to.
479 # c.InteractiveShell.logappend = ''
481 ## The name of the logfile to use.
483 # c.InteractiveShell.logfile = ''
485 ## Start logging to the default log file in overwrite mode. Use `logappend` to
486 # specify a log file to **append** logs to.
488 # c.InteractiveShell.logstart = False
490 ## Select the loop runner that will be used to execute top-level asynchronous
492 # Default: 'IPython.core.interactiveshell._asyncio_runner'
493 # c.InteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
495 # Choices: any of [0, 1, 2]
497 # c.InteractiveShell.object_info_string_level = 0
499 ## Automatically call the pdb debugger after every exception.
501 # c.InteractiveShell.pdb = False
504 # c.InteractiveShell.quiet = False
507 # c.InteractiveShell.separate_in = '\n'
510 # c.InteractiveShell.separate_out = ''
513 # c.InteractiveShell.separate_out2 = ''
515 ## Show rewritten input, e.g. for autocall.
517 # c.InteractiveShell.show_rewritten_input = True
519 ## Enables rich html representation of docstrings. (This requires the docrepr
522 # c.InteractiveShell.sphinxify_docstring = False
524 ## Warn if running in a virtual environment with no IPython installed (so IPython
525 # from the global environment is used).
527 # c.InteractiveShell.warn_venv = True
530 # c.InteractiveShell.wildcards_case_sensitive = True
532 ## Switch modes for the IPython exception handlers.
533 # Choices: any of ['Context', 'Plain', 'Verbose', 'Minimal'] (case-insensitive)
535 # c.InteractiveShell.xmode = 'Context'
537 #------------------------------------------------------------------------------
538 # TerminalInteractiveShell(InteractiveShell) configuration
539 #------------------------------------------------------------------------------
541 # See also: InteractiveShell.ast_node_interactivity
542 # c.TerminalInteractiveShell.ast_node_interactivity = 'last_expr'
545 # See also: InteractiveShell.ast_transformers
546 # c.TerminalInteractiveShell.ast_transformers = []
548 ## Automatically add/delete closing bracket or quote when opening bracket or
549 # quote is entered/deleted. Brackets: (), [], {} Quotes: '', ""
551 # c.TerminalInteractiveShell.auto_match = False
554 # See also: InteractiveShell.autoawait
555 # c.TerminalInteractiveShell.autoawait = True
558 # See also: InteractiveShell.autocall
559 # c.TerminalInteractiveShell.autocall = 0
561 ## Autoformatter to reformat Terminal code. Can be `'black'`, `'yapf'` or `None`
563 # c.TerminalInteractiveShell.autoformatter = None
566 # See also: InteractiveShell.autoindent
567 # c.TerminalInteractiveShell.autoindent = True
570 # See also: InteractiveShell.automagic
571 # c.TerminalInteractiveShell.automagic = True
573 ## Specifies from which source automatic suggestions are provided. Can be set to
574 # ``'NavigableAutoSuggestFromHistory'`` (:kbd:`up` and :kbd:`down` swap
575 # suggestions), ``'AutoSuggestFromHistory'``, or ``None`` to disable automatic
576 # suggestions. Default is `'NavigableAutoSuggestFromHistory`'.
577 # Default: 'NavigableAutoSuggestFromHistory'
578 # c.TerminalInteractiveShell.autosuggestions_provider = 'NavigableAutoSuggestFromHistory'
580 ## The part of the banner to be printed before the profile
581 # See also: InteractiveShell.banner1
582 # c.TerminalInteractiveShell.banner1 = "Python 3.11.4 (main, Jun 7 2023, 10:13:09) [GCC 12.2.0]\nType 'copyright', 'credits' or 'license' for more information\nIPython 8.14.0 -- An enhanced Interactive Python. Type '?' for help.\n"
584 ## The part of the banner to be printed after the profile
585 # See also: InteractiveShell.banner2
586 # c.TerminalInteractiveShell.banner2 = ''
589 # See also: InteractiveShell.cache_size
590 # c.TerminalInteractiveShell.cache_size = 1000
593 # See also: InteractiveShell.color_info
594 # c.TerminalInteractiveShell.color_info = True
596 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
597 # See also: InteractiveShell.colors
598 # c.TerminalInteractiveShell.colors = 'Neutral'
600 ## Set to confirm when you try to exit IPython with an EOF (Control-D in Unix,
601 # Control-Z/Enter in Windows). By typing 'exit' or 'quit', you can force a
602 # direct exit without any confirmation.
604 # c.TerminalInteractiveShell.confirm_exit = True
606 # See also: InteractiveShell.debug
607 # c.TerminalInteractiveShell.debug = False
609 ## File in which to store and read history
610 # Default: '~/.pdbhistory'
611 # c.TerminalInteractiveShell.debugger_history_file = '~/.pdbhistory'
613 ## Don't call post-execute functions that have failed in the past.
614 # See also: InteractiveShell.disable_failing_post_execute
615 # c.TerminalInteractiveShell.disable_failing_post_execute = False
617 ## Options for displaying tab completions, 'column', 'multicolumn', and
618 # 'readlinelike'. These options are for `prompt_toolkit`, see `prompt_toolkit`
619 # documentation for more information.
620 # Choices: any of ['column', 'multicolumn', 'readlinelike']
621 # Default: 'multicolumn'
622 # c.TerminalInteractiveShell.display_completions = 'multicolumn'
624 ## If True, anything that would be passed to the pager
625 # See also: InteractiveShell.display_page
626 # c.TerminalInteractiveShell.display_page = False
628 ## Shortcut style to use at the prompt. 'vi' or 'emacs'.
630 # c.TerminalInteractiveShell.editing_mode = 'emacs'
632 ## Set the editor used by IPython (default to $EDITOR/vi/notepad).
633 # Default: '/usr/bin/vim'
634 # c.TerminalInteractiveShell.editor = '/usr/bin/vim'
636 ## Add shortcuts from 'emacs' insert mode to 'vi' insert mode.
638 # c.TerminalInteractiveShell.emacs_bindings_in_vi_insert_mode = True
640 ## Allows to enable/disable the prompt toolkit history search
642 # c.TerminalInteractiveShell.enable_history_search = True
645 # See also: InteractiveShell.enable_html_pager
646 # c.TerminalInteractiveShell.enable_html_pager = False
648 ## Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. This is
649 # in addition to the F2 binding, which is always enabled.
651 # c.TerminalInteractiveShell.extra_open_editor_shortcuts = False
653 ## Provide an alternative handler to be called when the user presses Return. This
654 # is an advanced option intended for debugging, which may be changed or removed
657 # c.TerminalInteractiveShell.handle_return = None
659 ## Highlight matching brackets.
661 # c.TerminalInteractiveShell.highlight_matching_brackets = True
663 ## The name or class of a Pygments style to use for syntax
664 # highlighting. To see available styles, run `pygmentize -L styles`.
665 # Default: traitlets.Undefined
666 # c.TerminalInteractiveShell.highlighting_style = traitlets.Undefined
668 ## Override highlighting format for specific tokens
670 # c.TerminalInteractiveShell.highlighting_style_overrides = {}
672 ## Total length of command history
673 # See also: InteractiveShell.history_length
674 # c.TerminalInteractiveShell.history_length = 10000
677 # See also: InteractiveShell.history_load_length
678 # c.TerminalInteractiveShell.history_load_length = 1000
680 ## Class to use to instantiate the shell inspector
681 # See also: InteractiveShell.inspector_class
682 # c.TerminalInteractiveShell.inspector_class = 'IPython.core.oinspect.Inspector'
684 # See also: InteractiveShell.ipython_dir
685 # c.TerminalInteractiveShell.ipython_dir = ''
688 # See also: InteractiveShell.logappend
689 # c.TerminalInteractiveShell.logappend = ''
692 # See also: InteractiveShell.logfile
693 # c.TerminalInteractiveShell.logfile = ''
696 # See also: InteractiveShell.logstart
697 # c.TerminalInteractiveShell.logstart = False
699 ## Select the loop runner that will be used to execute top-level asynchronous
701 # See also: InteractiveShell.loop_runner
702 # c.TerminalInteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
705 # c.TerminalInteractiveShell.mime_renderers = {}
707 ## Cursor shape changes depending on vi mode: beam in vi insert mode, block in
708 # nav mode, underscore in replace mode.
710 # c.TerminalInteractiveShell.modal_cursor = True
712 ## Enable mouse support in the prompt (Note: prevents selecting text with the
715 # c.TerminalInteractiveShell.mouse_support = False
717 # See also: InteractiveShell.object_info_string_level
718 # c.TerminalInteractiveShell.object_info_string_level = 0
721 # See also: InteractiveShell.pdb
722 # c.TerminalInteractiveShell.pdb = False
724 ## Display the current vi mode (when using vi editing mode).
726 # c.TerminalInteractiveShell.prompt_includes_vi_mode = True
728 ## Class used to generate Prompt token for prompt_toolkit
729 # Default: 'IPython.terminal.prompts.Prompts'
730 # c.TerminalInteractiveShell.prompts_class = 'IPython.terminal.prompts.Prompts'
732 # See also: InteractiveShell.quiet
733 # c.TerminalInteractiveShell.quiet = False
735 # See also: InteractiveShell.separate_in
736 # c.TerminalInteractiveShell.separate_in = '\n'
738 # See also: InteractiveShell.separate_out
739 # c.TerminalInteractiveShell.separate_out = ''
741 # See also: InteractiveShell.separate_out2
742 # c.TerminalInteractiveShell.separate_out2 = ''
744 ## Add, disable or modifying shortcuts.
746 # Each entry on the list should be a dictionary with ``command`` key
747 # identifying the target function executed by the shortcut and at least
748 # one of the following:
750 # - ``match_keys``: list of keys used to match an existing shortcut,
751 # - ``match_filter``: shortcut filter used to match an existing shortcut,
752 # - ``new_keys``: list of keys to set,
753 # - ``new_filter``: a new shortcut filter to set
755 # The filters have to be composed of pre-defined verbs and joined by one
756 # of the following conjunctions: ``&`` (and), ``|`` (or), ``~`` (not).
757 # The pre-defined verbs are:
763 # - `is_cursor_at_the_end_of_line`
768 # - `emacs_insert_mode`
769 # - `emacs_like_insert_mode`
770 # - `has_completions`
772 # - `default_buffer_focused`
773 # - `search_buffer_focused`
775 # - `supports_suspend`
779 # - `not_inside_unclosed_string`
780 # - `readline_like_completions`
781 # - `preceded_by_paired_double_quotes`
782 # - `preceded_by_paired_single_quotes`
783 # - `preceded_by_raw_str_prefix`
784 # - `preceded_by_two_double_quotes`
785 # - `preceded_by_two_single_quotes`
786 # - `followed_by_closing_paren_or_end`
787 # - `preceded_by_opening_round_paren`
788 # - `preceded_by_opening_bracket`
789 # - `preceded_by_opening_brace`
790 # - `preceded_by_double_quote`
791 # - `preceded_by_single_quote`
792 # - `followed_by_closing_round_paren`
793 # - `followed_by_closing_bracket`
794 # - `followed_by_closing_brace`
795 # - `followed_by_double_quote`
796 # - `followed_by_single_quote`
797 # - `navigable_suggestions`
798 # - `cursor_in_leading_ws`
801 # To disable a shortcut set ``new_keys`` to an empty list.
802 # To add a shortcut add key ``create`` with value ``True``.
804 # When modifying/disabling shortcuts, ``match_keys``/``match_filter`` can
805 # be omitted if the provided specification uniquely identifies a shortcut
806 # to be modified/disabled. When modifying a shortcut ``new_filter`` or
807 # ``new_keys`` can be omitted which will result in reuse of the existing
810 # Only shortcuts defined in IPython (and not default prompt-toolkit
811 # shortcuts) can be modified or disabled. The full list of shortcuts,
812 # command identifiers and filters is available under
813 # :ref:`terminal-shortcuts-list`.
815 # c.TerminalInteractiveShell.shortcuts = []
817 ## Show rewritten input, e.g. for autocall.
818 # See also: InteractiveShell.show_rewritten_input
819 # c.TerminalInteractiveShell.show_rewritten_input = True
821 ## Use `raw_input` for the REPL, without completion and prompt colors.
823 # Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are:
824 # IPython own testing machinery, and emacs inferior-shell integration through elpy.
826 # This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
827 # environment variable is set, or the current terminal is not a tty.
829 # c.TerminalInteractiveShell.simple_prompt = False
831 ## Number of line at the bottom of the screen to reserve for the tab completion
832 # menu, search history, ...etc, the height of these menus will at most this
833 # value. Increase it is you prefer long and skinny menus, decrease for short and
836 # c.TerminalInteractiveShell.space_for_menu = 6
839 # See also: InteractiveShell.sphinxify_docstring
840 # c.TerminalInteractiveShell.sphinxify_docstring = False
842 ## Automatically set the terminal title
844 # c.TerminalInteractiveShell.term_title = True
846 ## Customize the terminal title format. This is a python format string.
847 # Available substitutions are: {cwd}.
848 # Default: 'IPython: {cwd}'
849 # c.TerminalInteractiveShell.term_title_format = 'IPython: {cwd}'
851 ## The time in milliseconds that is waited for a mapped key
852 # sequence to complete.
854 # c.TerminalInteractiveShell.timeoutlen = 0.5
856 ## Use 24bit colors instead of 256 colors in prompt highlighting.
857 # If your terminal supports true color, the following command should
858 # print ``TRUECOLOR`` in orange::
860 # printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
862 # c.TerminalInteractiveShell.true_color = False
864 ## The time in milliseconds that is waited for a key code
867 # c.TerminalInteractiveShell.ttimeoutlen = 0.01
869 ## Warn if running in a virtual environment with no IPython installed (so IPython
870 # from the global environment is used).
871 # See also: InteractiveShell.warn_venv
872 # c.TerminalInteractiveShell.warn_venv = True
874 # See also: InteractiveShell.wildcards_case_sensitive
875 # c.TerminalInteractiveShell.wildcards_case_sensitive = True
877 ## Switch modes for the IPython exception handlers.
878 # See also: InteractiveShell.xmode
879 # c.TerminalInteractiveShell.xmode = 'Context'
881 #------------------------------------------------------------------------------
882 # HistoryAccessor(HistoryAccessorBase) configuration
883 #------------------------------------------------------------------------------
884 ## Access the history database without adding to it.
886 # This is intended for use by standalone history tools. IPython shells use
887 # HistoryManager, below, which is a subclass of this.
889 ## Options for configuring the SQLite connection
891 # These options are passed as keyword args to sqlite3.connect
892 # when establishing database connections.
894 # c.HistoryAccessor.connection_options = {}
896 ## enable the SQLite history
898 # set enabled=False to disable the SQLite history,
899 # in which case there will be no stored history, no SQLite connection,
900 # and no background saving thread. This may be necessary in some
901 # threaded environments where IPython is embedded.
903 # c.HistoryAccessor.enabled = True
905 ## Path to file to use for SQLite history database.
907 # By default, IPython will put the history database in the IPython
908 # profile directory. If you would rather share one history among
909 # profiles, you can set this value in each, so that they are consistent.
911 # Due to an issue with fcntl, SQLite is known to misbehave on some NFS
912 # mounts. If you see IPython hanging, try setting this to something on a
915 # ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
917 # you can also use the specific value `:memory:` (including the colon
918 # at both end but not the back ticks), to avoid creating an history file.
919 # Default: traitlets.Undefined
920 # c.HistoryAccessor.hist_file = traitlets.Undefined
922 #------------------------------------------------------------------------------
923 # HistoryManager(HistoryAccessor) configuration
924 #------------------------------------------------------------------------------
925 ## A class to organize all history-related functionality in one place.
927 ## Options for configuring the SQLite connection
928 # See also: HistoryAccessor.connection_options
929 # c.HistoryManager.connection_options = {}
931 ## Write to database every x commands (higher values save disk access & power).
932 # Values of 1 or less effectively disable caching.
934 # c.HistoryManager.db_cache_size = 0
936 ## Should the history database include output? (default: no)
938 # c.HistoryManager.db_log_output = False
940 ## enable the SQLite history
941 # See also: HistoryAccessor.enabled
942 # c.HistoryManager.enabled = True
944 ## Path to file to use for SQLite history database.
945 # See also: HistoryAccessor.hist_file
946 # c.HistoryManager.hist_file = traitlets.Undefined
948 #------------------------------------------------------------------------------
949 # MagicsManager(Configurable) configuration
950 #------------------------------------------------------------------------------
951 ## Object that handles all magic-related functionality for IPython.
953 ## Automatically call line magics without requiring explicit % prefix
955 # c.MagicsManager.auto_magic = True
957 ## Mapping from magic names to modules to load.
959 # This can be used in IPython/IPykernel configuration to declare lazy magics
960 # that will only be imported/registered on first use.
964 # c.MagicsManager.lazy_magics = {
965 # "my_magic": "slow.to.import",
966 # "my_other_magic": "also.slow",
969 # On first invocation of `%my_magic`, `%%my_magic`, `%%my_other_magic` or
970 # `%%my_other_magic`, the corresponding module will be loaded as an ipython
971 # extensions as if you had previously done `%load_ext ipython`.
973 # Magics names should be without percent(s) as magics can be both cell and line
976 # Lazy loading happen relatively late in execution process, and complex
977 # extensions that manipulate Python/IPython internal state or global state might
978 # not support lazy loading.
980 # c.MagicsManager.lazy_magics = {}
982 #------------------------------------------------------------------------------
983 # ProfileDir(LoggingConfigurable) configuration
984 #------------------------------------------------------------------------------
985 ## An object to manage the profile directory and its resources.
987 # The profile directory is used by all IPython applications, to manage
988 # configuration, logging and security.
990 # This object knows how to find, create and manage these directories. This
991 # should be used by any code that wants to handle profiles.
993 ## Set the profile location directly. This overrides the logic used by the
996 # c.ProfileDir.location = ''
998 #------------------------------------------------------------------------------
999 # BaseFormatter(Configurable) configuration
1000 #------------------------------------------------------------------------------
1001 ## A base formatter class that is configurable.
1003 # This formatter should usually be used as the base class of all formatters.
1004 # It is a traited :class:`Configurable` class and includes an extensible
1005 # API for users to determine how their objects are formatted. The following
1006 # logic is used to find a function to format an given object.
1008 # 1. The object is introspected to see if it has a method with the name
1009 # :attr:`print_method`. If is does, that object is passed to that method
1011 # 2. If no print method is found, three internal dictionaries are consulted
1012 # to find print method: :attr:`singleton_printers`, :attr:`type_printers`
1013 # and :attr:`deferred_printers`.
1015 # Users should use these dictionaries to register functions that will be
1016 # used to compute the format data for their objects (if those objects don't
1017 # have the special print methods). The easiest way of using these
1018 # dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name`
1021 # If no function/callable is found to compute the format data, ``None`` is
1022 # returned and this format type is not used.
1025 # c.BaseFormatter.deferred_printers = {}
1028 # c.BaseFormatter.enabled = True
1031 # c.BaseFormatter.singleton_printers = {}
1034 # c.BaseFormatter.type_printers = {}
1036 #------------------------------------------------------------------------------
1037 # PlainTextFormatter(BaseFormatter) configuration
1038 #------------------------------------------------------------------------------
1039 ## The default pretty-printer.
1041 # This uses :mod:`IPython.lib.pretty` to compute the format data of
1042 # the object. If the object cannot be pretty printed, :func:`repr` is used.
1043 # See the documentation of :mod:`IPython.lib.pretty` for details on
1044 # how to write pretty printers. Here is a simple example::
1046 # def dtype_pprinter(obj, p, cycle):
1048 # return p.text('dtype(...)')
1049 # if hasattr(obj, 'fields'):
1050 # if obj.fields is None:
1053 # p.begin_group(7, 'dtype([')
1054 # for i, field in enumerate(obj.descr):
1059 # p.end_group(7, '])')
1061 # See also: BaseFormatter.deferred_printers
1062 # c.PlainTextFormatter.deferred_printers = {}
1065 # c.PlainTextFormatter.float_precision = ''
1067 ## Truncate large collections (lists, dicts, tuples, sets) to this size.
1069 # Set to 0 to disable truncation.
1071 # c.PlainTextFormatter.max_seq_length = 1000
1074 # c.PlainTextFormatter.max_width = 79
1077 # c.PlainTextFormatter.newline = '\n'
1080 # c.PlainTextFormatter.pprint = True
1082 # See also: BaseFormatter.singleton_printers
1083 # c.PlainTextFormatter.singleton_printers = {}
1085 # See also: BaseFormatter.type_printers
1086 # c.PlainTextFormatter.type_printers = {}
1089 # c.PlainTextFormatter.verbose = False
1091 #------------------------------------------------------------------------------
1092 # Completer(Configurable) configuration
1093 #------------------------------------------------------------------------------
1094 ## Enable auto-closing dictionary keys.
1096 # When enabled string keys will be suffixed with a final quote (matching the
1097 # opening quote), tuple keys will also receive a separating comma if needed, and
1098 # keys which are final will receive a closing bracket (``]``).
1100 # c.Completer.auto_close_dict_keys = False
1102 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
1103 # commands, unicode names, and expanding unicode characters back to latex
1106 # c.Completer.backslash_combining_completions = True
1108 ## Enable debug for the Completer. Mostly print extra information for
1109 # experimental jedi integration.
1111 # c.Completer.debug = False
1113 ## Policy for code evaluation under completion.
1115 # Successive options allow to enable more eager evaluation for better
1116 # completion suggestions, including for nested dictionaries, nested lists,
1117 # or even results of function calls.
1118 # Setting ``unsafe`` or higher can lead to evaluation of arbitrary user
1119 # code on :kbd:`Tab` with potentially unwanted or dangerous side effects.
1121 # Allowed values are:
1123 # - ``forbidden``: no evaluation of code is permitted,
1124 # - ``minimal``: evaluation of literals and access to built-in namespace;
1125 # no item/attribute evaluationm no access to locals/globals,
1126 # no evaluation of any operations or comparisons.
1127 # - ``limited``: access to all namespaces, evaluation of hard-coded methods
1128 # (for example: :any:`dict.keys`, :any:`object.__getattr__`,
1129 # :any:`object.__getitem__`) on allow-listed objects (for example:
1130 # :any:`dict`, :any:`list`, :any:`tuple`, ``pandas.Series``),
1131 # - ``unsafe``: evaluation of all methods and function calls but not of
1132 # syntax with side-effects like `del x`,
1133 # - ``dangerous``: completely arbitrary evaluation.
1134 # Choices: any of ['forbidden', 'minimal', 'limited', 'unsafe', 'dangerous']
1135 # Default: 'limited'
1136 # c.Completer.evaluation = 'limited'
1138 ## Activate greedy completion.
1140 # .. deprecated:: 8.8
1141 # Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead.
1143 # When enabled in IPython 8.8 or newer, changes configuration as
1146 # - ``Completer.evaluation = 'unsafe'``
1147 # - ``Completer.auto_close_dict_keys = True``
1149 # c.Completer.greedy = False
1151 ## Experimental: restrict time (in milliseconds) during which Jedi can compute types.
1152 # Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt
1153 # performance by preventing jedi to build its cache.
1155 # c.Completer.jedi_compute_type_timeout = 400
1157 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
1160 # c.Completer.use_jedi = True
1162 #------------------------------------------------------------------------------
1163 # IPCompleter(Completer) configuration
1164 #------------------------------------------------------------------------------
1165 ## Extension of the completer class with IPython-specific features
1168 # See also: Completer.auto_close_dict_keys
1169 # c.IPCompleter.auto_close_dict_keys = False
1171 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
1172 # commands, unicode names, and expanding unicode characters back to latex
1174 # See also: Completer.backslash_combining_completions
1175 # c.IPCompleter.backslash_combining_completions = True
1177 ## Enable debug for the Completer. Mostly print extra information for
1178 # experimental jedi integration.
1179 # See also: Completer.debug
1180 # c.IPCompleter.debug = False
1182 ## List of matchers to disable.
1184 # The list should contain matcher identifiers (see
1185 # :any:`completion_matcher`).
1187 # c.IPCompleter.disable_matchers = []
1189 ## Policy for code evaluation under completion.
1190 # See also: Completer.evaluation
1191 # c.IPCompleter.evaluation = 'limited'
1193 ## Activate greedy completion.
1194 # See also: Completer.greedy
1195 # c.IPCompleter.greedy = False
1197 ## Experimental: restrict time (in milliseconds) during which Jedi can compute
1199 # See also: Completer.jedi_compute_type_timeout
1200 # c.IPCompleter.jedi_compute_type_timeout = 400
1202 ## DEPRECATED as of version 5.0.
1204 # Instruct the completer to use __all__ for the completion
1206 # Specifically, when completing on ``object.<tab>``.
1208 # When True: only those names in obj.__all__ will be included.
1210 # When False [default]: the __all__ attribute is ignored
1212 # c.IPCompleter.limit_to__all__ = False
1214 ## Whether to merge completion results into a single list
1216 # If False, only the completion results from the first non-empty
1217 # completer will be returned.
1219 # As of version 8.6.0, setting the value to ``False`` is an alias for:
1220 # ``IPCompleter.suppress_competing_matchers = True.``.
1222 # c.IPCompleter.merge_completions = True
1224 ## Instruct the completer to omit private method names
1226 # Specifically, when completing on ``object.<tab>``.
1228 # When 2 [default]: all names that start with '_' will be excluded.
1230 # When 1: all 'magic' names (``__foo__``) will be excluded.
1232 # When 0: nothing will be excluded.
1233 # Choices: any of [0, 1, 2]
1235 # c.IPCompleter.omit__names = 2
1237 ## If True, emit profiling data for completion subsystem using cProfile.
1239 # c.IPCompleter.profile_completions = False
1241 ## Template for path at which to output profile data for completions.
1242 # Default: '.completion_profiles'
1243 # c.IPCompleter.profiler_output_dir = '.completion_profiles'
1245 ## Whether to suppress completions from other *Matchers*.
1247 # When set to ``None`` (default) the matchers will attempt to auto-detect
1248 # whether suppression of other matchers is desirable. For example, at the
1249 # beginning of a line followed by `%` we expect a magic completion to be the
1250 # only applicable option, and after ``my_dict['`` we usually expect a completion
1251 # with an existing dictionary key.
1253 # If you want to disable this heuristic and see completions from all matchers,
1254 # set ``IPCompleter.suppress_competing_matchers = False``. To disable the
1255 # heuristic for specific matchers provide a dictionary mapping:
1256 # ``IPCompleter.suppress_competing_matchers = {'IPCompleter.dict_key_matcher':
1259 # Set ``IPCompleter.suppress_competing_matchers = True`` to limit completions to
1260 # the set of matchers with the highest priority; this is equivalent to
1261 # ``IPCompleter.merge_completions`` and can be beneficial for performance, but
1262 # will sometimes omit relevant candidates from matchers further down the
1265 # c.IPCompleter.suppress_competing_matchers = None
1267 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
1269 # See also: Completer.use_jedi
1270 # c.IPCompleter.use_jedi = True
1272 #------------------------------------------------------------------------------
1273 # ScriptMagics(Magics) configuration
1274 #------------------------------------------------------------------------------
1275 ## Magics for talking to scripts
1277 # This defines a base `%%script` cell magic for running a cell
1278 # with a program in a subprocess, and registers a few top-level
1279 # magics that call %%script with common interpreters.
1281 ## Extra script cell magics to define
1283 # This generates simple wrappers of `%%script foo` as `%%foo`.
1285 # If you want to add script magics that aren't on your path,
1286 # specify them in script_paths
1288 # c.ScriptMagics.script_magics = []
1290 ## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby'
1292 # Only necessary for items in script_magics where the default path will not
1293 # find the right interpreter.
1295 # c.ScriptMagics.script_paths = {}
1297 #------------------------------------------------------------------------------
1298 # LoggingMagics(Magics) configuration
1299 #------------------------------------------------------------------------------
1300 ## Magics related to all logging machinery.
1302 ## Suppress output of log state when logging is enabled
1304 # c.LoggingMagics.quiet = False
1306 #------------------------------------------------------------------------------
1307 # StoreMagics(Magics) configuration
1308 #------------------------------------------------------------------------------
1309 ## Lightweight persistence for python variables.
1311 # Provides the %store magic.
1313 ## If True, any %store-d variables will be automatically restored
1314 # when IPython starts.
1316 # c.StoreMagics.autorestore = False