]> git.madduck.net Git - etc/ipython.git/blob - .ipython/profile_calc/ipython_config.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

import ipython profiles
[etc/ipython.git] / .ipython / profile_calc / ipython_config.py
1 # Configuration file for ipython.
2
3 c = get_config()  # noqa
4
5 #------------------------------------------------------------------------------
6 # InteractiveShellApp(Configurable) configuration
7 #------------------------------------------------------------------------------
8 ## A Mixin for applications that start InteractiveShell instances.
9 #  
10 #      Provides configurables for loading extensions and executing files
11 #      as part of configuring a Shell environment.
12 #  
13 #      The following methods should be called by the :meth:`initialize` method
14 #      of the subclass:
15 #  
16 #        - :meth:`init_path`
17 #        - :meth:`init_shell` (to be implemented by the subclass)
18 #        - :meth:`init_gui_pylab`
19 #        - :meth:`init_extensions`
20 #        - :meth:`init_code`
21
22 ## Execute the given command string.
23 #  Default: ''
24 # c.InteractiveShellApp.code_to_run = ''
25
26 ## Run the file referenced by the PYTHONSTARTUP environment
27 #          variable at IPython startup.
28 #  Default: True
29 # c.InteractiveShellApp.exec_PYTHONSTARTUP = True
30
31 ## List of files to run at IPython startup.
32 #  Default: []
33 # c.InteractiveShellApp.exec_files = []
34
35 ## lines of code to run at IPython startup.
36 #  Default: []
37 # c.InteractiveShellApp.exec_lines = []
38
39 ## A list of dotted module names of IPython extensions to load.
40 #  Default: []
41 # c.InteractiveShellApp.extensions = []
42
43 ## Dotted module name(s) of one or more IPython extensions to load.
44 #  
45 #  For specifying extra extensions to load on the command-line.
46 #  
47 #  .. versionadded:: 7.10
48 #  Default: []
49 # c.InteractiveShellApp.extra_extensions = []
50
51 ## A file to be run
52 #  Default: ''
53 # c.InteractiveShellApp.file_to_run = ''
54
55 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
56 #  'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
57 #  'gtk2', 'qt4').
58 #  Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
59 #  Default: None
60 # c.InteractiveShellApp.gui = None
61
62 ## Should variables loaded at startup (by startup files, exec_lines, etc.)
63 #          be hidden from tools like %who?
64 #  Default: True
65 # c.InteractiveShellApp.hide_initial_ns = True
66
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.
70 #  Default: False
71 # c.InteractiveShellApp.ignore_cwd = False
72
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
76 #  Default: None
77 # c.InteractiveShellApp.matplotlib = None
78
79 ## Run the module as a script.
80 #  Default: ''
81 # c.InteractiveShellApp.module_to_run = ''
82
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
86 #  Default: None
87 # c.InteractiveShellApp.pylab = None
88
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.
91 #  
92 #          When False, pylab mode should not import any names into the user
93 #  namespace.
94 #  Default: True
95 # c.InteractiveShellApp.pylab_import_all = True
96
97 ## Reraise exceptions encountered loading IPython extensions?
98 #  Default: False
99 # c.InteractiveShellApp.reraise_ipython_extension_failures = False
100
101 #------------------------------------------------------------------------------
102 # Application(SingletonConfigurable) configuration
103 #------------------------------------------------------------------------------
104 ## This is an application.
105
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'
109
110 ## The Logging format template
111 #  Default: '[%(name)s]%(highlevel)s %(message)s'
112 # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
113
114 ## Set the log level by value or name.
115 #  Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
116 #  Default: 30
117 # c.Application.log_level = 30
118
119 ## Configure additional log handlers.
120 #  
121 #  The default stderr logs handler is configured by the log_level, log_datefmt
122 #  and log_format settings.
123 #  
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.
126 #  
127 #  If provided this should be a logging configuration dictionary, for more
128 #  information see:
129 #  https://docs.python.org/3/library/logging.config.html#logging-config-
130 #  dictschema
131 #  
132 #  This dictionary is merged with the base logging configuration which defines
133 #  the following:
134 #  
135 #  * A logging formatter intended for interactive use called
136 #    ``console``.
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``
140 #    level.
141 #  
142 #  This example adds a new handler that writes to a file:
143 #  
144 #  .. code-block:: python
145 #  
146 #     c.Application.logging_config = {
147 #         'handlers': {
148 #             'file': {
149 #                 'class': 'logging.FileHandler',
150 #                 'level': 'DEBUG',
151 #                 'filename': '<path/to/file>',
152 #             }
153 #         },
154 #         'loggers': {
155 #             '<application-name>': {
156 #                 'level': 'DEBUG',
157 #                 # NOTE: if you don't list the default "console"
158 #                 # handler here then it will be disabled
159 #                 'handlers': ['console', 'file'],
160 #             },
161 #         }
162 #     }
163 #  Default: {}
164 # c.Application.logging_config = {}
165
166 ## Instead of starting the Application, dump configuration to stdout
167 #  Default: False
168 # c.Application.show_config = False
169
170 ## Instead of starting the Application, dump configuration to stdout (as JSON)
171 #  Default: False
172 # c.Application.show_config_json = False
173
174 #------------------------------------------------------------------------------
175 # BaseIPythonApplication(Application) configuration
176 #------------------------------------------------------------------------------
177 #  Default: False
178 # c.BaseIPythonApplication.add_ipython_dir_to_sys_path = False
179
180 ## Whether to create profile dir if it doesn't exist
181 #  Default: False
182 # c.BaseIPythonApplication.auto_create = False
183
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.
188 #  Default: False
189 # c.BaseIPythonApplication.copy_config_files = False
190
191 ## Path to an extra config file to load.
192 #  
193 #      If specified, load this config file in addition to any other IPython
194 #  config.
195 #  Default: ''
196 # c.BaseIPythonApplication.extra_config_file = ''
197
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.
202 #  Default: ''
203 # c.BaseIPythonApplication.ipython_dir = ''
204
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'
208
209 ## The Logging format template
210 #  See also: Application.log_format
211 # c.BaseIPythonApplication.log_format = '[%(name)s]%(highlevel)s %(message)s'
212
213 ## Set the log level by value or name.
214 #  See also: Application.log_level
215 # c.BaseIPythonApplication.log_level = 30
216
217 ## 
218 #  See also: Application.logging_config
219 # c.BaseIPythonApplication.logging_config = {}
220
221 ## Whether to overwrite existing config files when copying
222 #  Default: False
223 # c.BaseIPythonApplication.overwrite = False
224
225 ## The IPython profile to use.
226 #  Default: 'default'
227 # c.BaseIPythonApplication.profile = 'default'
228
229 ## Instead of starting the Application, dump configuration to stdout
230 #  See also: Application.show_config
231 # c.BaseIPythonApplication.show_config = False
232
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
236
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
239 #          usual traceback
240 #  Default: False
241 # c.BaseIPythonApplication.verbose_crash = False
242
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
248
249 ## Execute the given command string.
250 #  See also: InteractiveShellApp.code_to_run
251 # c.TerminalIPythonApp.code_to_run = ''
252
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
256
257 ## Whether to display a banner upon starting IPython.
258 #  Default: True
259 # c.TerminalIPythonApp.display_banner = True
260
261 ## Run the file referenced by the PYTHONSTARTUP environment
262 #  See also: InteractiveShellApp.exec_PYTHONSTARTUP
263 # c.TerminalIPythonApp.exec_PYTHONSTARTUP = True
264
265 ## List of files to run at IPython startup.
266 #  See also: InteractiveShellApp.exec_files
267 # c.TerminalIPythonApp.exec_files = []
268
269 ## lines of code to run at IPython startup.
270 #  See also: InteractiveShellApp.exec_lines
271 # c.TerminalIPythonApp.exec_lines = []
272
273 ## A list of dotted module names of IPython extensions to load.
274 #  See also: InteractiveShellApp.extensions
275 # c.TerminalIPythonApp.extensions = []
276
277 ## Path to an extra config file to load.
278 #  See also: BaseIPythonApplication.extra_config_file
279 # c.TerminalIPythonApp.extra_config_file = ''
280
281 ## 
282 #  See also: InteractiveShellApp.extra_extensions
283 # c.TerminalIPythonApp.extra_extensions = []
284
285 ## A file to be run
286 #  See also: InteractiveShellApp.file_to_run
287 # c.TerminalIPythonApp.file_to_run = ''
288
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
291 #          file or command.
292 #  Default: False
293 # c.TerminalIPythonApp.force_interact = False
294
295 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
296 #  'gtk2', 'gtk3', 'gtk4', 'osx', 'pyglet', 'qt', 'qt5', 'qt6', 'tk', 'wx',
297 #  'gtk2', 'qt4').
298 #  See also: InteractiveShellApp.gui
299 # c.TerminalIPythonApp.gui = None
300
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
304
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
308
309 ## Class to use to instantiate the TerminalInteractiveShell object. Useful for
310 #  custom Frontends
311 #  Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
312 # c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
313
314 ## 
315 #  See also: BaseIPythonApplication.ipython_dir
316 # c.TerminalIPythonApp.ipython_dir = ''
317
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'
321
322 ## The Logging format template
323 #  See also: Application.log_format
324 # c.TerminalIPythonApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
325
326 ## Set the log level by value or name.
327 #  See also: Application.log_level
328 # c.TerminalIPythonApp.log_level = 30
329
330 ## 
331 #  See also: Application.logging_config
332 # c.TerminalIPythonApp.logging_config = {}
333
334 ## Configure matplotlib for interactive use with
335 #  See also: InteractiveShellApp.matplotlib
336 # c.TerminalIPythonApp.matplotlib = None
337
338 ## Run the module as a script.
339 #  See also: InteractiveShellApp.module_to_run
340 # c.TerminalIPythonApp.module_to_run = ''
341
342 ## Whether to overwrite existing config files when copying
343 #  See also: BaseIPythonApplication.overwrite
344 # c.TerminalIPythonApp.overwrite = False
345
346 ## The IPython profile to use.
347 #  See also: BaseIPythonApplication.profile
348 # c.TerminalIPythonApp.profile = 'default'
349
350 ## Pre-load matplotlib and numpy for interactive use,
351 #  See also: InteractiveShellApp.pylab
352 # c.TerminalIPythonApp.pylab = None
353
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
357
358 ## Start IPython quickly by skipping the loading of config files.
359 #  Default: False
360 # c.TerminalIPythonApp.quick = False
361
362 ## Reraise exceptions encountered loading IPython extensions?
363 #  See also: InteractiveShellApp.reraise_ipython_extension_failures
364 # c.TerminalIPythonApp.reraise_ipython_extension_failures = False
365
366 ## Instead of starting the Application, dump configuration to stdout
367 #  See also: Application.show_config
368 # c.TerminalIPythonApp.show_config = False
369
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
373
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
377
378 #------------------------------------------------------------------------------
379 # InteractiveShell(SingletonConfigurable) configuration
380 #------------------------------------------------------------------------------
381 ## An enhanced, interactive shell for Python.
382
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'
388
389 ## A list of ast.NodeTransformer subclass instances, which will be applied to
390 #  user input before code is run.
391 #  Default: []
392 # c.InteractiveShell.ast_transformers = []
393
394 ## Automatically run await statement in the top level repl.
395 #  Default: True
396 # c.InteractiveShell.autoawait = True
397
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]
405 #  Default: 0
406 # c.InteractiveShell.autocall = 0
407
408 ## Autoindent IPython code entered interactively.
409 #  Default: True
410 # c.InteractiveShell.autoindent = True
411
412 ## Enable magic commands to be called without the leading %.
413 #  Default: True
414 # c.InteractiveShell.automagic = True
415
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"
419
420 ## The part of the banner to be printed after the profile
421 #  Default: ''
422 # c.InteractiveShell.banner2 = ''
423
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
429 #  working
430 #  Default: 1000
431 # c.InteractiveShell.cache_size = 1000
432
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.
436 #  Default: True
437 # c.InteractiveShell.color_info = True
438
439 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
440 #  Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
441 #  Default: 'Neutral'
442 # c.InteractiveShell.colors = 'Neutral'
443
444 #  Default: False
445 # c.InteractiveShell.debug = False
446
447 ## Don't call post-execute functions that have failed in the past.
448 #  Default: False
449 # c.InteractiveShell.disable_failing_post_execute = False
450
451 ## If True, anything that would be passed to the pager
452 #          will be displayed as regular output instead.
453 #  Default: False
454 # c.InteractiveShell.display_page = False
455
456 ## (Provisional API) enables html representation in mime bundles sent to pagers.
457 #  Default: False
458 # c.InteractiveShell.enable_html_pager = False
459
460 ## Total length of command history
461 #  Default: 10000
462 # c.InteractiveShell.history_length = 10000
463
464 ## The number of saved history entries to be loaded into the history buffer at
465 #  startup.
466 #  Default: 1000
467 # c.InteractiveShell.history_load_length = 1000
468
469 ## Class to use to instantiate the shell inspector
470 #  Default: 'IPython.core.oinspect.Inspector'
471 # c.InteractiveShell.inspector_class = 'IPython.core.oinspect.Inspector'
472
473 #  Default: ''
474 # c.InteractiveShell.ipython_dir = ''
475
476 ## Start logging to the given file in append mode. Use `logfile` to specify a log
477 #  file to **overwrite** logs to.
478 #  Default: ''
479 # c.InteractiveShell.logappend = ''
480
481 ## The name of the logfile to use.
482 #  Default: ''
483 # c.InteractiveShell.logfile = ''
484
485 ## Start logging to the default log file in overwrite mode. Use `logappend` to
486 #  specify a log file to **append** logs to.
487 #  Default: False
488 # c.InteractiveShell.logstart = False
489
490 ## Select the loop runner that will be used to execute top-level asynchronous
491 #  code
492 #  Default: 'IPython.core.interactiveshell._asyncio_runner'
493 # c.InteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
494
495 #  Choices: any of [0, 1, 2]
496 #  Default: 0
497 # c.InteractiveShell.object_info_string_level = 0
498
499 ## Automatically call the pdb debugger after every exception.
500 #  Default: False
501 # c.InteractiveShell.pdb = False
502
503 #  Default: False
504 # c.InteractiveShell.quiet = False
505
506 #  Default: '\n'
507 # c.InteractiveShell.separate_in = '\n'
508
509 #  Default: ''
510 # c.InteractiveShell.separate_out = ''
511
512 #  Default: ''
513 # c.InteractiveShell.separate_out2 = ''
514
515 ## Show rewritten input, e.g. for autocall.
516 #  Default: True
517 # c.InteractiveShell.show_rewritten_input = True
518
519 ## Enables rich html representation of docstrings. (This requires the docrepr
520 #  module).
521 #  Default: False
522 # c.InteractiveShell.sphinxify_docstring = False
523
524 ## Warn if running in a virtual environment with no IPython installed (so IPython
525 #  from the global environment is used).
526 #  Default: True
527 # c.InteractiveShell.warn_venv = True
528
529 #  Default: True
530 # c.InteractiveShell.wildcards_case_sensitive = True
531
532 ## Switch modes for the IPython exception handlers.
533 #  Choices: any of ['Context', 'Plain', 'Verbose', 'Minimal'] (case-insensitive)
534 #  Default: 'Context'
535 # c.InteractiveShell.xmode = 'Context'
536
537 #------------------------------------------------------------------------------
538 # TerminalInteractiveShell(InteractiveShell) configuration
539 #------------------------------------------------------------------------------
540 ## 
541 #  See also: InteractiveShell.ast_node_interactivity
542 # c.TerminalInteractiveShell.ast_node_interactivity = 'last_expr'
543
544 ## 
545 #  See also: InteractiveShell.ast_transformers
546 # c.TerminalInteractiveShell.ast_transformers = []
547
548 ## Automatically add/delete closing bracket or quote when opening bracket or
549 #  quote is entered/deleted. Brackets: (), [], {} Quotes: '', ""
550 #  Default: False
551 # c.TerminalInteractiveShell.auto_match = False
552
553 ## 
554 #  See also: InteractiveShell.autoawait
555 # c.TerminalInteractiveShell.autoawait = True
556
557 ## 
558 #  See also: InteractiveShell.autocall
559 # c.TerminalInteractiveShell.autocall = 0
560
561 ## Autoformatter to reformat Terminal code. Can be `'black'`, `'yapf'` or `None`
562 #  Default: None
563 # c.TerminalInteractiveShell.autoformatter = None
564
565 ## 
566 #  See also: InteractiveShell.autoindent
567 # c.TerminalInteractiveShell.autoindent = True
568
569 ## 
570 #  See also: InteractiveShell.automagic
571 # c.TerminalInteractiveShell.automagic = True
572
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'
579
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"
583
584 ## The part of the banner to be printed after the profile
585 #  See also: InteractiveShell.banner2
586 # c.TerminalInteractiveShell.banner2 = ''
587
588 ## 
589 #  See also: InteractiveShell.cache_size
590 # c.TerminalInteractiveShell.cache_size = 1000
591
592 ## 
593 #  See also: InteractiveShell.color_info
594 # c.TerminalInteractiveShell.color_info = True
595
596 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
597 #  See also: InteractiveShell.colors
598 # c.TerminalInteractiveShell.colors = 'Neutral'
599
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.
603 #  Default: True
604 # c.TerminalInteractiveShell.confirm_exit = True
605
606 #  See also: InteractiveShell.debug
607 # c.TerminalInteractiveShell.debug = False
608
609 ## File in which to store and read history
610 #  Default: '~/.pdbhistory'
611 # c.TerminalInteractiveShell.debugger_history_file = '~/.pdbhistory'
612
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
616
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'
623
624 ## If True, anything that would be passed to the pager
625 #  See also: InteractiveShell.display_page
626 # c.TerminalInteractiveShell.display_page = False
627
628 ## Shortcut style to use at the prompt. 'vi' or 'emacs'.
629 #  Default: 'emacs'
630 # c.TerminalInteractiveShell.editing_mode = 'emacs'
631
632 ## Set the editor used by IPython (default to $EDITOR/vi/notepad).
633 #  Default: '/usr/bin/vim'
634 # c.TerminalInteractiveShell.editor = '/usr/bin/vim'
635
636 ## Add shortcuts from 'emacs' insert mode to 'vi' insert mode.
637 #  Default: True
638 # c.TerminalInteractiveShell.emacs_bindings_in_vi_insert_mode = True
639
640 ## Allows to enable/disable the prompt toolkit history search
641 #  Default: True
642 # c.TerminalInteractiveShell.enable_history_search = True
643
644 ## 
645 #  See also: InteractiveShell.enable_html_pager
646 # c.TerminalInteractiveShell.enable_html_pager = False
647
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.
650 #  Default: False
651 # c.TerminalInteractiveShell.extra_open_editor_shortcuts = False
652
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
655 #  in later releases.
656 #  Default: None
657 # c.TerminalInteractiveShell.handle_return = None
658
659 ## Highlight matching brackets.
660 #  Default: True
661 # c.TerminalInteractiveShell.highlight_matching_brackets = True
662
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
667
668 ## Override highlighting format for specific tokens
669 #  Default: {}
670 # c.TerminalInteractiveShell.highlighting_style_overrides = {}
671
672 ## Total length of command history
673 #  See also: InteractiveShell.history_length
674 # c.TerminalInteractiveShell.history_length = 10000
675
676 ## 
677 #  See also: InteractiveShell.history_load_length
678 # c.TerminalInteractiveShell.history_load_length = 1000
679
680 ## Class to use to instantiate the shell inspector
681 #  See also: InteractiveShell.inspector_class
682 # c.TerminalInteractiveShell.inspector_class = 'IPython.core.oinspect.Inspector'
683
684 #  See also: InteractiveShell.ipython_dir
685 # c.TerminalInteractiveShell.ipython_dir = ''
686
687 ## 
688 #  See also: InteractiveShell.logappend
689 # c.TerminalInteractiveShell.logappend = ''
690
691 ## 
692 #  See also: InteractiveShell.logfile
693 # c.TerminalInteractiveShell.logfile = ''
694
695 ## 
696 #  See also: InteractiveShell.logstart
697 # c.TerminalInteractiveShell.logstart = False
698
699 ## Select the loop runner that will be used to execute top-level asynchronous
700 #  code
701 #  See also: InteractiveShell.loop_runner
702 # c.TerminalInteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
703
704 #  Default: {}
705 # c.TerminalInteractiveShell.mime_renderers = {}
706
707 ## Cursor shape changes depending on vi mode: beam in vi insert mode, block in
708 #  nav mode, underscore in replace mode.
709 #  Default: True
710 # c.TerminalInteractiveShell.modal_cursor = True
711
712 ## Enable mouse support in the prompt (Note: prevents selecting text with the
713 #  mouse)
714 #  Default: False
715 # c.TerminalInteractiveShell.mouse_support = False
716
717 #  See also: InteractiveShell.object_info_string_level
718 # c.TerminalInteractiveShell.object_info_string_level = 0
719
720 ## 
721 #  See also: InteractiveShell.pdb
722 # c.TerminalInteractiveShell.pdb = False
723
724 ## Display the current vi mode (when using vi editing mode).
725 #  Default: True
726 # c.TerminalInteractiveShell.prompt_includes_vi_mode = True
727
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'
731
732 #  See also: InteractiveShell.quiet
733 # c.TerminalInteractiveShell.quiet = False
734
735 #  See also: InteractiveShell.separate_in
736 # c.TerminalInteractiveShell.separate_in = '\n'
737
738 #  See also: InteractiveShell.separate_out
739 # c.TerminalInteractiveShell.separate_out = ''
740
741 #  See also: InteractiveShell.separate_out2
742 # c.TerminalInteractiveShell.separate_out2 = ''
743
744 ## Add, disable or modifying shortcuts.
745 #  
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:
749 #  
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
754 #  
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:
758 #  
759 #          - `always`
760 #          - `never`
761 #          - `has_line_below`
762 #          - `has_line_above`
763 #          - `is_cursor_at_the_end_of_line`
764 #          - `has_selection`
765 #          - `has_suggestion`
766 #          - `vi_mode`
767 #          - `vi_insert_mode`
768 #          - `emacs_insert_mode`
769 #          - `emacs_like_insert_mode`
770 #          - `has_completions`
771 #          - `insert_mode`
772 #          - `default_buffer_focused`
773 #          - `search_buffer_focused`
774 #          - `ebivim`
775 #          - `supports_suspend`
776 #          - `is_windows_os`
777 #          - `auto_match`
778 #          - `focused_insert`
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`
799 #          - `pass_through`
800 #  
801 #          To disable a shortcut set ``new_keys`` to an empty list.
802 #          To add a shortcut add key ``create`` with value ``True``.
803 #  
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
808 #          filter/keys.
809 #  
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`.
814 #  Default: []
815 # c.TerminalInteractiveShell.shortcuts = []
816
817 ## Show rewritten input, e.g. for autocall.
818 #  See also: InteractiveShell.show_rewritten_input
819 # c.TerminalInteractiveShell.show_rewritten_input = True
820
821 ## Use `raw_input` for the REPL, without completion and prompt colors.
822 #  
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.
825 #  
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.
828 #  Default: False
829 # c.TerminalInteractiveShell.simple_prompt = False
830
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
834 #  wide.
835 #  Default: 6
836 # c.TerminalInteractiveShell.space_for_menu = 6
837
838 ## 
839 #  See also: InteractiveShell.sphinxify_docstring
840 # c.TerminalInteractiveShell.sphinxify_docstring = False
841
842 ## Automatically set the terminal title
843 #  Default: True
844 # c.TerminalInteractiveShell.term_title = True
845
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}'
850
851 ## The time in milliseconds that is waited for a mapped key
852 #         sequence to complete.
853 #  Default: 0.5
854 # c.TerminalInteractiveShell.timeoutlen = 0.5
855
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::
859 #  
860 #              printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
861 #  Default: False
862 # c.TerminalInteractiveShell.true_color = False
863
864 ## The time in milliseconds that is waited for a key code
865 #         to complete.
866 #  Default: 0.01
867 # c.TerminalInteractiveShell.ttimeoutlen = 0.01
868
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
873
874 #  See also: InteractiveShell.wildcards_case_sensitive
875 # c.TerminalInteractiveShell.wildcards_case_sensitive = True
876
877 ## Switch modes for the IPython exception handlers.
878 #  See also: InteractiveShell.xmode
879 # c.TerminalInteractiveShell.xmode = 'Context'
880
881 #------------------------------------------------------------------------------
882 # HistoryAccessor(HistoryAccessorBase) configuration
883 #------------------------------------------------------------------------------
884 ## Access the history database without adding to it.
885 #  
886 #      This is intended for use by standalone history tools. IPython shells use
887 #      HistoryManager, below, which is a subclass of this.
888
889 ## Options for configuring the SQLite connection
890 #  
891 #          These options are passed as keyword args to sqlite3.connect
892 #          when establishing database connections.
893 #  Default: {}
894 # c.HistoryAccessor.connection_options = {}
895
896 ## enable the SQLite history
897 #  
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.
902 #  Default: True
903 # c.HistoryAccessor.enabled = True
904
905 ## Path to file to use for SQLite history database.
906 #  
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.
910 #  
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
913 #          local disk, e.g::
914 #  
915 #              ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
916 #  
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
921
922 #------------------------------------------------------------------------------
923 # HistoryManager(HistoryAccessor) configuration
924 #------------------------------------------------------------------------------
925 ## A class to organize all history-related functionality in one place.
926
927 ## Options for configuring the SQLite connection
928 #  See also: HistoryAccessor.connection_options
929 # c.HistoryManager.connection_options = {}
930
931 ## Write to database every x commands (higher values save disk access & power).
932 #  Values of 1 or less effectively disable caching.
933 #  Default: 0
934 # c.HistoryManager.db_cache_size = 0
935
936 ## Should the history database include output? (default: no)
937 #  Default: False
938 # c.HistoryManager.db_log_output = False
939
940 ## enable the SQLite history
941 #  See also: HistoryAccessor.enabled
942 # c.HistoryManager.enabled = True
943
944 ## Path to file to use for SQLite history database.
945 #  See also: HistoryAccessor.hist_file
946 # c.HistoryManager.hist_file = traitlets.Undefined
947
948 #------------------------------------------------------------------------------
949 # MagicsManager(Configurable) configuration
950 #------------------------------------------------------------------------------
951 ## Object that handles all magic-related functionality for IPython.
952
953 ## Automatically call line magics without requiring explicit % prefix
954 #  Default: True
955 # c.MagicsManager.auto_magic = True
956
957 ## Mapping from magic names to modules to load.
958 #  
959 #  This can be used in IPython/IPykernel configuration to declare lazy magics
960 #  that will only be imported/registered on first use.
961 #  
962 #  For example::
963 #  
964 #      c.MagicsManager.lazy_magics = {
965 #        "my_magic": "slow.to.import",
966 #        "my_other_magic": "also.slow",
967 #      }
968 #  
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`.
972 #  
973 #  Magics names should be without percent(s) as magics can be both cell and line
974 #  magics.
975 #  
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.
979 #  Default: {}
980 # c.MagicsManager.lazy_magics = {}
981
982 #------------------------------------------------------------------------------
983 # ProfileDir(LoggingConfigurable) configuration
984 #------------------------------------------------------------------------------
985 ## An object to manage the profile directory and its resources.
986 #  
987 #      The profile directory is used by all IPython applications, to manage
988 #      configuration, logging and security.
989 #  
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.
992
993 ## Set the profile location directly. This overrides the logic used by the
994 #          `profile` option.
995 #  Default: ''
996 # c.ProfileDir.location = ''
997
998 #------------------------------------------------------------------------------
999 # BaseFormatter(Configurable) configuration
1000 #------------------------------------------------------------------------------
1001 ## A base formatter class that is configurable.
1002 #  
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.
1007 #  
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
1010 #         for formatting.
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`.
1014 #  
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`
1019 #      methods.
1020 #  
1021 #      If no function/callable is found to compute the format data, ``None`` is
1022 #      returned and this format type is not used.
1023
1024 #  Default: {}
1025 # c.BaseFormatter.deferred_printers = {}
1026
1027 #  Default: True
1028 # c.BaseFormatter.enabled = True
1029
1030 #  Default: {}
1031 # c.BaseFormatter.singleton_printers = {}
1032
1033 #  Default: {}
1034 # c.BaseFormatter.type_printers = {}
1035
1036 #------------------------------------------------------------------------------
1037 # PlainTextFormatter(BaseFormatter) configuration
1038 #------------------------------------------------------------------------------
1039 ## The default pretty-printer.
1040 #  
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::
1045 #  
1046 #          def dtype_pprinter(obj, p, cycle):
1047 #              if cycle:
1048 #                  return p.text('dtype(...)')
1049 #              if hasattr(obj, 'fields'):
1050 #                  if obj.fields is None:
1051 #                      p.text(repr(obj))
1052 #                  else:
1053 #                      p.begin_group(7, 'dtype([')
1054 #                      for i, field in enumerate(obj.descr):
1055 #                          if i > 0:
1056 #                              p.text(',')
1057 #                              p.breakable()
1058 #                          p.pretty(field)
1059 #                      p.end_group(7, '])')
1060
1061 #  See also: BaseFormatter.deferred_printers
1062 # c.PlainTextFormatter.deferred_printers = {}
1063
1064 #  Default: ''
1065 # c.PlainTextFormatter.float_precision = ''
1066
1067 ## Truncate large collections (lists, dicts, tuples, sets) to this size.
1068 #  
1069 #          Set to 0 to disable truncation.
1070 #  Default: 1000
1071 # c.PlainTextFormatter.max_seq_length = 1000
1072
1073 #  Default: 79
1074 # c.PlainTextFormatter.max_width = 79
1075
1076 #  Default: '\n'
1077 # c.PlainTextFormatter.newline = '\n'
1078
1079 #  Default: True
1080 # c.PlainTextFormatter.pprint = True
1081
1082 #  See also: BaseFormatter.singleton_printers
1083 # c.PlainTextFormatter.singleton_printers = {}
1084
1085 #  See also: BaseFormatter.type_printers
1086 # c.PlainTextFormatter.type_printers = {}
1087
1088 #  Default: False
1089 # c.PlainTextFormatter.verbose = False
1090
1091 #------------------------------------------------------------------------------
1092 # Completer(Configurable) configuration
1093 #------------------------------------------------------------------------------
1094 ## Enable auto-closing dictionary keys.
1095 #  
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 (``]``).
1099 #  Default: False
1100 # c.Completer.auto_close_dict_keys = False
1101
1102 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
1103 #  commands, unicode names, and expanding unicode characters back to latex
1104 #  commands.
1105 #  Default: True
1106 # c.Completer.backslash_combining_completions = True
1107
1108 ## Enable debug for the Completer. Mostly print extra information for
1109 #  experimental jedi integration.
1110 #  Default: False
1111 # c.Completer.debug = False
1112
1113 ## Policy for code evaluation under completion.
1114 #  
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.
1120 #  
1121 #          Allowed values are:
1122 #  
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'
1137
1138 ## Activate greedy completion.
1139 #  
1140 #          .. deprecated:: 8.8
1141 #              Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead.
1142 #  
1143 #          When enabled in IPython 8.8 or newer, changes configuration as
1144 #  follows:
1145 #  
1146 #          - ``Completer.evaluation = 'unsafe'``
1147 #          - ``Completer.auto_close_dict_keys = True``
1148 #  Default: False
1149 # c.Completer.greedy = False
1150
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.
1154 #  Default: 400
1155 # c.Completer.jedi_compute_type_timeout = 400
1156
1157 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
1158 #  installed.
1159 #  Default: True
1160 # c.Completer.use_jedi = True
1161
1162 #------------------------------------------------------------------------------
1163 # IPCompleter(Completer) configuration
1164 #------------------------------------------------------------------------------
1165 ## Extension of the completer class with IPython-specific features
1166
1167 ## 
1168 #  See also: Completer.auto_close_dict_keys
1169 # c.IPCompleter.auto_close_dict_keys = False
1170
1171 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
1172 #  commands, unicode names, and expanding unicode characters back to latex
1173 #  commands.
1174 #  See also: Completer.backslash_combining_completions
1175 # c.IPCompleter.backslash_combining_completions = True
1176
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
1181
1182 ## List of matchers to disable.
1183 #  
1184 #          The list should contain matcher identifiers (see
1185 #  :any:`completion_matcher`).
1186 #  Default: []
1187 # c.IPCompleter.disable_matchers = []
1188
1189 ## Policy for code evaluation under completion.
1190 #  See also: Completer.evaluation
1191 # c.IPCompleter.evaluation = 'limited'
1192
1193 ## Activate greedy completion.
1194 #  See also: Completer.greedy
1195 # c.IPCompleter.greedy = False
1196
1197 ## Experimental: restrict time (in milliseconds) during which Jedi can compute
1198 #  types.
1199 #  See also: Completer.jedi_compute_type_timeout
1200 # c.IPCompleter.jedi_compute_type_timeout = 400
1201
1202 ## DEPRECATED as of version 5.0.
1203 #  
1204 #  Instruct the completer to use __all__ for the completion
1205 #  
1206 #  Specifically, when completing on ``object.<tab>``.
1207 #  
1208 #  When True: only those names in obj.__all__ will be included.
1209 #  
1210 #  When False [default]: the __all__ attribute is ignored
1211 #  Default: False
1212 # c.IPCompleter.limit_to__all__ = False
1213
1214 ## Whether to merge completion results into a single list
1215 #  
1216 #          If False, only the completion results from the first non-empty
1217 #          completer will be returned.
1218 #  
1219 #          As of version 8.6.0, setting the value to ``False`` is an alias for:
1220 #          ``IPCompleter.suppress_competing_matchers = True.``.
1221 #  Default: True
1222 # c.IPCompleter.merge_completions = True
1223
1224 ## Instruct the completer to omit private method names
1225 #  
1226 #          Specifically, when completing on ``object.<tab>``.
1227 #  
1228 #          When 2 [default]: all names that start with '_' will be excluded.
1229 #  
1230 #          When 1: all 'magic' names (``__foo__``) will be excluded.
1231 #  
1232 #          When 0: nothing will be excluded.
1233 #  Choices: any of [0, 1, 2]
1234 #  Default: 2
1235 # c.IPCompleter.omit__names = 2
1236
1237 ## If True, emit profiling data for completion subsystem using cProfile.
1238 #  Default: False
1239 # c.IPCompleter.profile_completions = False
1240
1241 ## Template for path at which to output profile data for completions.
1242 #  Default: '.completion_profiles'
1243 # c.IPCompleter.profiler_output_dir = '.completion_profiles'
1244
1245 ## Whether to suppress completions from other *Matchers*.
1246 #  
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.
1252 #  
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':
1257 #  False}``.
1258 #  
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
1263 #  priority list.
1264 #  Default: None
1265 # c.IPCompleter.suppress_competing_matchers = None
1266
1267 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
1268 #  installed.
1269 #  See also: Completer.use_jedi
1270 # c.IPCompleter.use_jedi = True
1271
1272 #------------------------------------------------------------------------------
1273 # ScriptMagics(Magics) configuration
1274 #------------------------------------------------------------------------------
1275 ## Magics for talking to scripts
1276 #  
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.
1280
1281 ## Extra script cell magics to define
1282 #  
1283 #          This generates simple wrappers of `%%script foo` as `%%foo`.
1284 #  
1285 #          If you want to add script magics that aren't on your path,
1286 #          specify them in script_paths
1287 #  Default: []
1288 # c.ScriptMagics.script_magics = []
1289
1290 ## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby'
1291 #  
1292 #          Only necessary for items in script_magics where the default path will not
1293 #          find the right interpreter.
1294 #  Default: {}
1295 # c.ScriptMagics.script_paths = {}
1296
1297 #------------------------------------------------------------------------------
1298 # LoggingMagics(Magics) configuration
1299 #------------------------------------------------------------------------------
1300 ## Magics related to all logging machinery.
1301
1302 ## Suppress output of log state when logging is enabled
1303 #  Default: False
1304 # c.LoggingMagics.quiet = False
1305
1306 #------------------------------------------------------------------------------
1307 # StoreMagics(Magics) configuration
1308 #------------------------------------------------------------------------------
1309 ## Lightweight persistence for python variables.
1310 #  
1311 #      Provides the %store magic.
1312
1313 ## If True, any %store-d variables will be automatically restored
1314 #          when IPython starts.
1315 #  Default: False
1316 # c.StoreMagics.autorestore = False