.ipython/profile_default/ipython_config.py

   1 # Configuration file for ipython.
   2
   3 #------------------------------------------------------------------------------
   4 # InteractiveShellApp(Configurable) configuration
   5 #------------------------------------------------------------------------------
   6 ## A Mixin for applications that start InteractiveShell instances.
   7 #
   8 #      Provides configurables for loading extensions and executing files
   9 #      as part of configuring a Shell environment.
  10 #
  11 #      The following methods should be called by the :meth:`initialize` method
  12 #      of the subclass:
  13 #
  14 #        - :meth:`init_path`
  15 #        - :meth:`init_shell` (to be implemented by the subclass)
  16 #        - :meth:`init_gui_pylab`
  17 #        - :meth:`init_extensions`
  18 #        - :meth:`init_code`
  19
  20 ## Execute the given command string.
  21 #  Default: ''
  22 # c.InteractiveShellApp.code_to_run = ''
  23
  24 ## Run the file referenced by the PYTHONSTARTUP environment
  25 #          variable at IPython startup.
  26 #  Default: True
  27 # c.InteractiveShellApp.exec_PYTHONSTARTUP = True
  28
  29 ## List of files to run at IPython startup.
  30 #  Default: []
  31 # c.InteractiveShellApp.exec_files = []
  32
  33 ## lines of code to run at IPython startup.
  34 #  Default: []
  35 # c.InteractiveShellApp.exec_lines = []
  36
  37 ## A list of dotted module names of IPython extensions to load.
  38 #  Default: []
  39 # c.InteractiveShellApp.extensions = []
  40
  41 ## DEPRECATED. Dotted module name of a single extra IPython extension to load.
  42 #
  43 #  Only one extension can be added this way.
  44 #
  45 #  Only used with traitlets < 5.0, plural extra_extensions list is used in
  46 #  traitlets 5.
  47 #  Default: ''
  48 # c.InteractiveShellApp.extra_extension = ''
  49
  50 ## Dotted module name(s) of one or more IPython extensions to load.
  51 #
  52 #  For specifying extra extensions to load on the command-line.
  53 #
  54 #  .. versionadded:: 7.10
  55 #  Default: []
  56 # c.InteractiveShellApp.extra_extensions = []
  57
  58 ## A file to be run
  59 #  Default: ''
  60 # c.InteractiveShellApp.file_to_run = ''
  61
  62 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
  63 #  'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2',
  64 #  'qt4').
  65 #  Choices: any of ['asyncio', 'glut', 'gtk', 'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', 'qt4'] (case-insensitive) or None
  66 #  Default: None
  67 # c.InteractiveShellApp.gui = None
  68
  69 ## Should variables loaded at startup (by startup files, exec_lines, etc.)
  70 #          be hidden from tools like %who?
  71 #  Default: True
  72 # c.InteractiveShellApp.hide_initial_ns = True
  73
  74 ## If True, IPython will not add the current working directory to sys.path.
  75 #          When False, the current working directory is added to sys.path, allowing imports
  76 #          of modules defined in the current directory.
  77 #  Default: False
  78 # c.InteractiveShellApp.ignore_cwd = False
  79
  80 ## Configure matplotlib for interactive use with
  81 #          the default matplotlib backend.
  82 #  Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx'] (case-insensitive) or None
  83 #  Default: None
  84 # c.InteractiveShellApp.matplotlib = None
  85
  86 ## Run the module as a script.
  87 #  Default: ''
  88 # c.InteractiveShellApp.module_to_run = ''
  89
  90 ## Pre-load matplotlib and numpy for interactive use,
  91 #          selecting a particular matplotlib backend and loop integration.
  92 #  Choices: any of ['auto', 'agg', 'gtk', 'gtk3', 'inline', 'ipympl', 'nbagg', 'notebook', 'osx', 'pdf', 'ps', 'qt', 'qt4', 'qt5', 'svg', 'tk', 'widget', 'wx'] (case-insensitive) or None
  93 #  Default: None
  94 # c.InteractiveShellApp.pylab = None
  95
  96 ## If true, IPython will populate the user namespace with numpy, pylab, etc.
  97 #          and an ``import *`` is done from numpy and pylab, when using pylab mode.
  98 #
  99 #          When False, pylab mode should not import any names into the user
 100 #  namespace.
 101 #  Default: True
 102 # c.InteractiveShellApp.pylab_import_all = True
 103
 104 ## Reraise exceptions encountered loading IPython extensions?
 105 #  Default: False
 106 # c.InteractiveShellApp.reraise_ipython_extension_failures = False
 107
 108 #------------------------------------------------------------------------------
 109 # Application(SingletonConfigurable) configuration
 110 #------------------------------------------------------------------------------
 111 ## This is an application.
 112
 113 ## The date format used by logging formatters for %(asctime)s
 114 #  Default: '%Y-%m-%d %H:%M:%S'
 115 # c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
 116
 117 ## The Logging format template
 118 #  Default: '[%(name)s]%(highlevel)s %(message)s'
 119 # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
 120
 121 ## Set the log level by value or name.
 122 #  Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
 123 #  Default: 30
 124 # c.Application.log_level = 30
 125
 126 ## Instead of starting the Application, dump configuration to stdout
 127 #  Default: False
 128 # c.Application.show_config = False
 129
 130 ## Instead of starting the Application, dump configuration to stdout (as JSON)
 131 #  Default: False
 132 # c.Application.show_config_json = False
 133
 134 #------------------------------------------------------------------------------
 135 # BaseIPythonApplication(Application) configuration
 136 #------------------------------------------------------------------------------
 137 ## IPython: an enhanced interactive Python shell.
 138
 139 ## Whether to create profile dir if it doesn't exist
 140 #  Default: False
 141 # c.BaseIPythonApplication.auto_create = False
 142
 143 ## Whether to install the default config files into the profile dir.
 144 #          If a new profile is being created, and IPython contains config files for that
 145 #          profile, then they will be staged into the new directory.  Otherwise,
 146 #          default config files will be automatically generated.
 147 #  Default: False
 148 # c.BaseIPythonApplication.copy_config_files = False
 149
 150 ## Path to an extra config file to load.
 151 #
 152 #      If specified, load this config file in addition to any other IPython
 153 #  config.
 154 #  Default: ''
 155 # c.BaseIPythonApplication.extra_config_file = ''
 156
 157 ## The name of the IPython directory. This directory is used for logging
 158 #  configuration (through profiles), history storage, etc. The default is usually
 159 #  $HOME/.ipython. This option can also be specified through the environment
 160 #  variable IPYTHONDIR.
 161 #  Default: ''
 162 # c.BaseIPythonApplication.ipython_dir = ''
 163
 164 ## The date format used by logging formatters for %(asctime)s
 165 #  See also: Application.log_datefmt
 166 # c.BaseIPythonApplication.log_datefmt = '%Y-%m-%d %H:%M:%S'
 167
 168 ## The Logging format template
 169 #  See also: Application.log_format
 170 # c.BaseIPythonApplication.log_format = '[%(name)s]%(highlevel)s %(message)s'
 171
 172 ## Set the log level by value or name.
 173 #  See also: Application.log_level
 174 # c.BaseIPythonApplication.log_level = 30
 175
 176 ## Whether to overwrite existing config files when copying
 177 #  Default: False
 178 # c.BaseIPythonApplication.overwrite = False
 179
 180 ## The IPython profile to use.
 181 #  Default: 'default'
 182 # c.BaseIPythonApplication.profile = 'default'
 183
 184 ## Instead of starting the Application, dump configuration to stdout
 185 #  See also: Application.show_config
 186 # c.BaseIPythonApplication.show_config = False
 187
 188 ## Instead of starting the Application, dump configuration to stdout (as JSON)
 189 #  See also: Application.show_config_json
 190 # c.BaseIPythonApplication.show_config_json = False
 191
 192 ## Create a massive crash report when IPython encounters what may be an
 193 #          internal error.  The default is to append a short message to the
 194 #          usual traceback
 195 #  Default: False
 196 # c.BaseIPythonApplication.verbose_crash = False
 197
 198 #------------------------------------------------------------------------------
 199 # TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp) configuration
 200 #------------------------------------------------------------------------------
 201 ## Execute the given command string.
 202 #  See also: InteractiveShellApp.code_to_run
 203 # c.TerminalIPythonApp.code_to_run = ''
 204
 205 ## Whether to install the default config files into the profile dir.
 206 #  See also: BaseIPythonApplication.copy_config_files
 207 # c.TerminalIPythonApp.copy_config_files = False
 208
 209 ## Whether to display a banner upon starting IPython.
 210 #  Default: True
 211 # c.TerminalIPythonApp.display_banner = True
 212
 213 ## Run the file referenced by the PYTHONSTARTUP environment
 214 #  See also: InteractiveShellApp.exec_PYTHONSTARTUP
 215 # c.TerminalIPythonApp.exec_PYTHONSTARTUP = True
 216
 217 ## List of files to run at IPython startup.
 218 #  See also: InteractiveShellApp.exec_files
 219 # c.TerminalIPythonApp.exec_files = []
 220
 221 ## lines of code to run at IPython startup.
 222 #  See also: InteractiveShellApp.exec_lines
 223 # c.TerminalIPythonApp.exec_lines = []
 224
 225 ## A list of dotted module names of IPython extensions to load.
 226 #  See also: InteractiveShellApp.extensions
 227 # c.TerminalIPythonApp.extensions = []
 228
 229 ## Path to an extra config file to load.
 230 #  See also: BaseIPythonApplication.extra_config_file
 231 # c.TerminalIPythonApp.extra_config_file = ''
 232
 233 ##
 234 #  See also: InteractiveShellApp.extra_extension
 235 # c.TerminalIPythonApp.extra_extension = ''
 236
 237 ##
 238 #  See also: InteractiveShellApp.extra_extensions
 239 # c.TerminalIPythonApp.extra_extensions = []
 240
 241 ## A file to be run
 242 #  See also: InteractiveShellApp.file_to_run
 243 # c.TerminalIPythonApp.file_to_run = ''
 244
 245 ## If a command or file is given via the command-line,
 246 #          e.g. 'ipython foo.py', start an interactive shell after executing the
 247 #          file or command.
 248 #  Default: False
 249 # c.TerminalIPythonApp.force_interact = False
 250
 251 ## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk',
 252 #  'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2',
 253 #  'qt4').
 254 #  See also: InteractiveShellApp.gui
 255 # c.TerminalIPythonApp.gui = None
 256
 257 ## Should variables loaded at startup (by startup files, exec_lines, etc.)
 258 #  See also: InteractiveShellApp.hide_initial_ns
 259 # c.TerminalIPythonApp.hide_initial_ns = True
 260
 261 ## If True, IPython will not add the current working directory to sys.path.
 262 #  See also: InteractiveShellApp.ignore_cwd
 263 # c.TerminalIPythonApp.ignore_cwd = False
 264
 265 ## Class to use to instantiate the TerminalInteractiveShell object. Useful for
 266 #  custom Frontends
 267 #  Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
 268 # c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
 269
 270 ##
 271 #  See also: BaseIPythonApplication.ipython_dir
 272 # c.TerminalIPythonApp.ipython_dir = ''
 273
 274 ## The date format used by logging formatters for %(asctime)s
 275 #  See also: Application.log_datefmt
 276 # c.TerminalIPythonApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
 277
 278 ## The Logging format template
 279 #  See also: Application.log_format
 280 # c.TerminalIPythonApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
 281
 282 ## Set the log level by value or name.
 283 #  See also: Application.log_level
 284 # c.TerminalIPythonApp.log_level = 30
 285
 286 ## Configure matplotlib for interactive use with
 287 #  See also: InteractiveShellApp.matplotlib
 288 # c.TerminalIPythonApp.matplotlib = None
 289
 290 ## Run the module as a script.
 291 #  See also: InteractiveShellApp.module_to_run
 292 # c.TerminalIPythonApp.module_to_run = ''
 293
 294 ## Whether to overwrite existing config files when copying
 295 #  See also: BaseIPythonApplication.overwrite
 296 # c.TerminalIPythonApp.overwrite = False
 297
 298 ## The IPython profile to use.
 299 #  See also: BaseIPythonApplication.profile
 300 # c.TerminalIPythonApp.profile = 'default'
 301
 302 ## Pre-load matplotlib and numpy for interactive use,
 303 #  See also: InteractiveShellApp.pylab
 304 # c.TerminalIPythonApp.pylab = None
 305
 306 ## If true, IPython will populate the user namespace with numpy, pylab, etc.
 307 #  See also: InteractiveShellApp.pylab_import_all
 308 # c.TerminalIPythonApp.pylab_import_all = True
 309
 310 ## Start IPython quickly by skipping the loading of config files.
 311 #  Default: False
 312 # c.TerminalIPythonApp.quick = False
 313
 314 ## Reraise exceptions encountered loading IPython extensions?
 315 #  See also: InteractiveShellApp.reraise_ipython_extension_failures
 316 # c.TerminalIPythonApp.reraise_ipython_extension_failures = False
 317
 318 ## Instead of starting the Application, dump configuration to stdout
 319 #  See also: Application.show_config
 320 # c.TerminalIPythonApp.show_config = False
 321
 322 ## Instead of starting the Application, dump configuration to stdout (as JSON)
 323 #  See also: Application.show_config_json
 324 # c.TerminalIPythonApp.show_config_json = False
 325
 326 ## Create a massive crash report when IPython encounters what may be an
 327 #  See also: BaseIPythonApplication.verbose_crash
 328 # c.TerminalIPythonApp.verbose_crash = False
 329
 330 #------------------------------------------------------------------------------
 331 # InteractiveShell(SingletonConfigurable) configuration
 332 #------------------------------------------------------------------------------
 333 ## An enhanced, interactive shell for Python.
 334
 335 ## 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which
 336 #  nodes should be run interactively (displaying output from expressions).
 337 #  Choices: any of ['all', 'last', 'last_expr', 'none', 'last_expr_or_assign']
 338 #  Default: 'last_expr'
 339 # c.InteractiveShell.ast_node_interactivity = 'last_expr'
 340
 341 ## A list of ast.NodeTransformer subclass instances, which will be applied to
 342 #  user input before code is run.
 343 #  Default: []
 344 # c.InteractiveShell.ast_transformers = []
 345
 346 ## Automatically run await statement in the top level repl.
 347 #  Default: True
 348 # c.InteractiveShell.autoawait = True
 349
 350 ## Make IPython automatically call any callable object even if you didn't type
 351 #  explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
 352 #  The value can be '0' to disable the feature, '1' for 'smart' autocall, where
 353 #  it is not applied if there are no more arguments on the line, and '2' for
 354 #  'full' autocall, where all callable objects are automatically called (even if
 355 #  no arguments are present).
 356 #  Choices: any of [0, 1, 2]
 357 #  Default: 0
 358 # c.InteractiveShell.autocall = 0
 359
 360 ## Autoindent IPython code entered interactively.
 361 #  Default: True
 362 # c.InteractiveShell.autoindent = True
 363
 364 ## Enable magic commands to be called without the leading %.
 365 #  Default: True
 366 # c.InteractiveShell.automagic = True
 367
 368 ## The part of the banner to be printed before the profile
 369 #  Default: "Python 3.9.7 (default, Sep  3 2021, 06:18:44) \nType 'copyright', 'credits' or 'license' for more information\nIPython 7.22.0 -- An enhanced Interactive Python. Type '?' for help.\n"
 370 # c.InteractiveShell.banner1 = "Python 3.9.7 (default, Sep  3 2021, 06:18:44) \nType 'copyright', 'credits' or 'license' for more information\nIPython 7.22.0 -- An enhanced Interactive Python. Type '?' for help.\n"
 371
 372 ## The part of the banner to be printed after the profile
 373 #  Default: ''
 374 # c.InteractiveShell.banner2 = ''
 375
 376 ## Set the size of the output cache.  The default is 1000, you can change it
 377 #  permanently in your config file.  Setting it to 0 completely disables the
 378 #  caching system, and the minimum value accepted is 3 (if you provide a value
 379 #  less than 3, it is reset to 0 and a warning is issued).  This limit is defined
 380 #  because otherwise you'll spend more time re-flushing a too small cache than
 381 #  working
 382 #  Default: 1000
 383 # c.InteractiveShell.cache_size = 1000
 384
 385 ## Use colors for displaying information about objects. Because this information
 386 #  is passed through a pager (like 'less'), and some pagers get confused with
 387 #  color codes, this capability can be turned off.
 388 #  Default: True
 389 # c.InteractiveShell.color_info = True
 390
 391 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
 392 #  Choices: any of ['Neutral', 'NoColor', 'LightBG', 'Linux'] (case-insensitive)
 393 #  Default: 'Neutral'
 394 # c.InteractiveShell.colors = 'Neutral'
 395
 396 #  Default: False
 397 # c.InteractiveShell.debug = False
 398
 399 ## Don't call post-execute functions that have failed in the past.
 400 #  Default: False
 401 # c.InteractiveShell.disable_failing_post_execute = False
 402
 403 ## If True, anything that would be passed to the pager
 404 #          will be displayed as regular output instead.
 405 #  Default: False
 406 # c.InteractiveShell.display_page = False
 407
 408 ## (Provisional API) enables html representation in mime bundles sent to pagers.
 409 #  Default: False
 410 # c.InteractiveShell.enable_html_pager = False
 411
 412 ## Total length of command history
 413 #  Default: 10000
 414 # c.InteractiveShell.history_length = 10000
 415
 416 ## The number of saved history entries to be loaded into the history buffer at
 417 #  startup.
 418 #  Default: 1000
 419 # c.InteractiveShell.history_load_length = 1000
 420
 421 #  Default: ''
 422 # c.InteractiveShell.ipython_dir = ''
 423
 424 ## Start logging to the given file in append mode. Use `logfile` to specify a log
 425 #  file to **overwrite** logs to.
 426 #  Default: ''
 427 # c.InteractiveShell.logappend = ''
 428
 429 ## The name of the logfile to use.
 430 #  Default: ''
 431 # c.InteractiveShell.logfile = ''
 432
 433 ## Start logging to the default log file in overwrite mode. Use `logappend` to
 434 #  specify a log file to **append** logs to.
 435 #  Default: False
 436 # c.InteractiveShell.logstart = False
 437
 438 ## Select the loop runner that will be used to execute top-level asynchronous
 439 #  code
 440 #  Default: 'IPython.core.interactiveshell._asyncio_runner'
 441 # c.InteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
 442
 443 #  Choices: any of [0, 1, 2]
 444 #  Default: 0
 445 # c.InteractiveShell.object_info_string_level = 0
 446
 447 ## Automatically call the pdb debugger after every exception.
 448 #  Default: False
 449 # c.InteractiveShell.pdb = False
 450
 451 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 452 #  TerminalInteractiveShell.prompts object directly.
 453 #  Default: 'In [\\#]: '
 454 # c.InteractiveShell.prompt_in1 = 'In [\\#]: '
 455
 456 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 457 #  TerminalInteractiveShell.prompts object directly.
 458 #  Default: '   .\\D.: '
 459 # c.InteractiveShell.prompt_in2 = '   .\\D.: '
 460
 461 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 462 #  TerminalInteractiveShell.prompts object directly.
 463 #  Default: 'Out[\\#]: '
 464 # c.InteractiveShell.prompt_out = 'Out[\\#]: '
 465
 466 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 467 #  TerminalInteractiveShell.prompts object directly.
 468 #  Default: True
 469 # c.InteractiveShell.prompts_pad_left = True
 470
 471 #  Default: False
 472 # c.InteractiveShell.quiet = False
 473
 474 #  Default: '\n'
 475 # c.InteractiveShell.separate_in = '\n'
 476
 477 #  Default: ''
 478 # c.InteractiveShell.separate_out = ''
 479
 480 #  Default: ''
 481 # c.InteractiveShell.separate_out2 = ''
 482
 483 ## Show rewritten input, e.g. for autocall.
 484 #  Default: True
 485 # c.InteractiveShell.show_rewritten_input = True
 486
 487 ## Enables rich html representation of docstrings. (This requires the docrepr
 488 #  module).
 489 #  Default: False
 490 # c.InteractiveShell.sphinxify_docstring = False
 491
 492 #  Default: True
 493 # c.InteractiveShell.wildcards_case_sensitive = True
 494
 495 ## Switch modes for the IPython exception handlers.
 496 #  Choices: any of ['Context', 'Plain', 'Verbose', 'Minimal'] (case-insensitive)
 497 #  Default: 'Context'
 498 # c.InteractiveShell.xmode = 'Context'
 499
 500 #------------------------------------------------------------------------------
 501 # TerminalInteractiveShell(InteractiveShell) configuration
 502 #------------------------------------------------------------------------------
 503 ##
 504 #  See also: InteractiveShell.ast_node_interactivity
 505 # c.TerminalInteractiveShell.ast_node_interactivity = 'last_expr'
 506
 507 ##
 508 #  See also: InteractiveShell.ast_transformers
 509 # c.TerminalInteractiveShell.ast_transformers = []
 510
 511 ##
 512 #  See also: InteractiveShell.autoawait
 513 # c.TerminalInteractiveShell.autoawait = True
 514
 515 ##
 516 #  See also: InteractiveShell.autocall
 517 # c.TerminalInteractiveShell.autocall = 0
 518
 519 ## Autoformatter to reformat Terminal code. Can be `'black'` or `None`
 520 #  Default: None
 521 # c.TerminalInteractiveShell.autoformatter = None
 522
 523 ##
 524 #  See also: InteractiveShell.autoindent
 525 # c.TerminalInteractiveShell.autoindent = True
 526
 527 ##
 528 #  See also: InteractiveShell.automagic
 529 # c.TerminalInteractiveShell.automagic = True
 530
 531 ## The part of the banner to be printed before the profile
 532 #  See also: InteractiveShell.banner1
 533 # c.TerminalInteractiveShell.banner1 = "Python 3.9.7 (default, Sep  3 2021, 06:18:44) \nType 'copyright', 'credits' or 'license' for more information\nIPython 7.22.0 -- An enhanced Interactive Python. Type '?' for help.\n"
 534
 535 ## The part of the banner to be printed after the profile
 536 #  See also: InteractiveShell.banner2
 537 # c.TerminalInteractiveShell.banner2 = ''
 538
 539 ##
 540 #  See also: InteractiveShell.cache_size
 541 # c.TerminalInteractiveShell.cache_size = 1000
 542
 543 ##
 544 #  See also: InteractiveShell.color_info
 545 # c.TerminalInteractiveShell.color_info = True
 546
 547 ## Set the color scheme (NoColor, Neutral, Linux, or LightBG).
 548 #  See also: InteractiveShell.colors
 549 # c.TerminalInteractiveShell.colors = 'Neutral'
 550
 551 ## Set to confirm when you try to exit IPython with an EOF (Control-D in Unix,
 552 #  Control-Z/Enter in Windows). By typing 'exit' or 'quit', you can force a
 553 #  direct exit without any confirmation.
 554 #  Default: True
 555 # c.TerminalInteractiveShell.confirm_exit = True
 556
 557 #  See also: InteractiveShell.debug
 558 # c.TerminalInteractiveShell.debug = False
 559
 560 ## Don't call post-execute functions that have failed in the past.
 561 #  See also: InteractiveShell.disable_failing_post_execute
 562 # c.TerminalInteractiveShell.disable_failing_post_execute = False
 563
 564 ## Options for displaying tab completions, 'column', 'multicolumn', and
 565 #  'readlinelike'. These options are for `prompt_toolkit`, see `prompt_toolkit`
 566 #  documentation for more information.
 567 #  Choices: any of ['column', 'multicolumn', 'readlinelike']
 568 #  Default: 'multicolumn'
 569 # c.TerminalInteractiveShell.display_completions = 'multicolumn'
 570
 571 ## If True, anything that would be passed to the pager
 572 #  See also: InteractiveShell.display_page
 573 # c.TerminalInteractiveShell.display_page = False
 574
 575 ## Shortcut style to use at the prompt. 'vi' or 'emacs'.
 576 #  Default: 'emacs'
 577 # c.TerminalInteractiveShell.editing_mode = 'emacs'
 578
 579 ## Set the editor used by IPython (default to $EDITOR/vi/notepad).
 580 #  Default: '/usr/bin/vim'
 581 # c.TerminalInteractiveShell.editor = '/usr/bin/vim'
 582
 583 ## Allows to enable/disable the prompt toolkit history search
 584 #  Default: True
 585 # c.TerminalInteractiveShell.enable_history_search = True
 586
 587 ##
 588 #  See also: InteractiveShell.enable_html_pager
 589 # c.TerminalInteractiveShell.enable_html_pager = False
 590
 591 ## Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. This is
 592 #  in addition to the F2 binding, which is always enabled.
 593 #  Default: False
 594 # c.TerminalInteractiveShell.extra_open_editor_shortcuts = False
 595
 596 ## Provide an alternative handler to be called when the user presses Return. This
 597 #  is an advanced option intended for debugging, which may be changed or removed
 598 #  in later releases.
 599 #  Default: None
 600 # c.TerminalInteractiveShell.handle_return = None
 601
 602 ## Highlight matching brackets.
 603 #  Default: True
 604 # c.TerminalInteractiveShell.highlight_matching_brackets = True
 605
 606 ## The name or class of a Pygments style to use for syntax
 607 #          highlighting. To see available styles, run `pygmentize -L styles`.
 608 #  Default: traitlets.Undefined
 609 # c.TerminalInteractiveShell.highlighting_style = traitlets.Undefined
 610
 611 ## Override highlighting format for specific tokens
 612 #  Default: {}
 613 # c.TerminalInteractiveShell.highlighting_style_overrides = {}
 614
 615 ## Total length of command history
 616 #  See also: InteractiveShell.history_length
 617 # c.TerminalInteractiveShell.history_length = 10000
 618
 619 ##
 620 #  See also: InteractiveShell.history_load_length
 621 # c.TerminalInteractiveShell.history_load_length = 1000
 622
 623 #  See also: InteractiveShell.ipython_dir
 624 # c.TerminalInteractiveShell.ipython_dir = ''
 625
 626 ##
 627 #  See also: InteractiveShell.logappend
 628 # c.TerminalInteractiveShell.logappend = ''
 629
 630 ##
 631 #  See also: InteractiveShell.logfile
 632 # c.TerminalInteractiveShell.logfile = ''
 633
 634 ##
 635 #  See also: InteractiveShell.logstart
 636 # c.TerminalInteractiveShell.logstart = False
 637
 638 ## Select the loop runner that will be used to execute top-level asynchronous
 639 #  code
 640 #  See also: InteractiveShell.loop_runner
 641 # c.TerminalInteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner'
 642
 643 #  Default: {}
 644 # c.TerminalInteractiveShell.mime_renderers = {}
 645
 646 ## Enable mouse support in the prompt (Note: prevents selecting text with the
 647 #  mouse)
 648 #  Default: False
 649 # c.TerminalInteractiveShell.mouse_support = False
 650
 651 #  See also: InteractiveShell.object_info_string_level
 652 # c.TerminalInteractiveShell.object_info_string_level = 0
 653
 654 ##
 655 #  See also: InteractiveShell.pdb
 656 # c.TerminalInteractiveShell.pdb = False
 657
 658 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 659 #  TerminalInteractiveShell.prompts object directly.
 660 #  See also: InteractiveShell.prompt_in1
 661 # c.TerminalInteractiveShell.prompt_in1 = 'In [\\#]: '
 662
 663 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 664 #  TerminalInteractiveShell.prompts object directly.
 665 #  See also: InteractiveShell.prompt_in2
 666 # c.TerminalInteractiveShell.prompt_in2 = '   .\\D.: '
 667
 668 ## Display the current vi mode (when using vi editing mode).
 669 #  Default: True
 670 # c.TerminalInteractiveShell.prompt_includes_vi_mode = True
 671
 672 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 673 #  TerminalInteractiveShell.prompts object directly.
 674 #  See also: InteractiveShell.prompt_out
 675 # c.TerminalInteractiveShell.prompt_out = 'Out[\\#]: '
 676
 677 ## Class used to generate Prompt token for prompt_toolkit
 678 #  Default: 'IPython.terminal.prompts.Prompts'
 679 # c.TerminalInteractiveShell.prompts_class = 'IPython.terminal.prompts.Prompts'
 680
 681 ## Deprecated since IPython 4.0 and ignored since 5.0, set
 682 #  TerminalInteractiveShell.prompts object directly.
 683 #  See also: InteractiveShell.prompts_pad_left
 684 # c.TerminalInteractiveShell.prompts_pad_left = True
 685
 686 #  See also: InteractiveShell.quiet
 687 # c.TerminalInteractiveShell.quiet = False
 688
 689 #  See also: InteractiveShell.separate_in
 690 # c.TerminalInteractiveShell.separate_in = '\n'
 691
 692 #  See also: InteractiveShell.separate_out
 693 # c.TerminalInteractiveShell.separate_out = ''
 694
 695 #  See also: InteractiveShell.separate_out2
 696 # c.TerminalInteractiveShell.separate_out2 = ''
 697
 698 ## Show rewritten input, e.g. for autocall.
 699 #  See also: InteractiveShell.show_rewritten_input
 700 # c.TerminalInteractiveShell.show_rewritten_input = True
 701
 702 ## Use `raw_input` for the REPL, without completion and prompt colors.
 703 #
 704 #              Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are:
 705 #              IPython own testing machinery, and emacs inferior-shell integration through elpy.
 706 #
 707 #              This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
 708 #              environment variable is set, or the current terminal is not a tty.
 709 #  Default: False
 710 # c.TerminalInteractiveShell.simple_prompt = False
 711
 712 ## Number of line at the bottom of the screen to reserve for the tab completion
 713 #  menu, search history, ...etc, the height of these menus will at most this
 714 #  value. Increase it is you prefer long and skinny menus, decrease for short and
 715 #  wide.
 716 #  Default: 6
 717 # c.TerminalInteractiveShell.space_for_menu = 6
 718
 719 ##
 720 #  See also: InteractiveShell.sphinxify_docstring
 721 # c.TerminalInteractiveShell.sphinxify_docstring = False
 722
 723 ## Automatically set the terminal title
 724 #  Default: True
 725 # c.TerminalInteractiveShell.term_title = True
 726
 727 ## Customize the terminal title format.  This is a python format string.
 728 #  Available substitutions are: {cwd}.
 729 #  Default: 'IPython: {cwd}'
 730 # c.TerminalInteractiveShell.term_title_format = 'IPython: {cwd}'
 731
 732 ## Use 24bit colors instead of 256 colors in prompt highlighting. If your
 733 #  terminal supports true color, the following command should print 'TRUECOLOR'
 734 #  in orange: printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
 735 #  Default: False
 736 # c.TerminalInteractiveShell.true_color = False
 737
 738 #  See also: InteractiveShell.wildcards_case_sensitive
 739 # c.TerminalInteractiveShell.wildcards_case_sensitive = True
 740
 741 ## Switch modes for the IPython exception handlers.
 742 #  See also: InteractiveShell.xmode
 743 # c.TerminalInteractiveShell.xmode = 'Context'
 744
 745 #------------------------------------------------------------------------------
 746 # HistoryAccessor(HistoryAccessorBase) configuration
 747 #------------------------------------------------------------------------------
 748 ## Access the history database without adding to it.
 749 #
 750 #      This is intended for use by standalone history tools. IPython shells use
 751 #      HistoryManager, below, which is a subclass of this.
 752
 753 ## Options for configuring the SQLite connection
 754 #
 755 #          These options are passed as keyword args to sqlite3.connect
 756 #          when establishing database connections.
 757 #  Default: {}
 758 # c.HistoryAccessor.connection_options = {}
 759
 760 ## enable the SQLite history
 761 #
 762 #          set enabled=False to disable the SQLite history,
 763 #          in which case there will be no stored history, no SQLite connection,
 764 #          and no background saving thread.  This may be necessary in some
 765 #          threaded environments where IPython is embedded.
 766 #  Default: True
 767 # c.HistoryAccessor.enabled = True
 768
 769 ## Path to file to use for SQLite history database.
 770 #
 771 #          By default, IPython will put the history database in the IPython
 772 #          profile directory.  If you would rather share one history among
 773 #          profiles, you can set this value in each, so that they are consistent.
 774 #
 775 #          Due to an issue with fcntl, SQLite is known to misbehave on some NFS
 776 #          mounts.  If you see IPython hanging, try setting this to something on a
 777 #          local disk, e.g::
 778 #
 779 #              ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
 780 #
 781 #          you can also use the specific value `:memory:` (including the colon
 782 #          at both end but not the back ticks), to avoid creating an history file.
 783 #  Default: ''
 784 # c.HistoryAccessor.hist_file = ''
 785
 786 #------------------------------------------------------------------------------
 787 # HistoryManager(HistoryAccessor) configuration
 788 #------------------------------------------------------------------------------
 789 ## A class to organize all history-related functionality in one place.
 790
 791 ## Options for configuring the SQLite connection
 792 #  See also: HistoryAccessor.connection_options
 793 # c.HistoryManager.connection_options = {}
 794
 795 ## Write to database every x commands (higher values save disk access & power).
 796 #  Values of 1 or less effectively disable caching.
 797 #  Default: 0
 798 # c.HistoryManager.db_cache_size = 0
 799
 800 ## Should the history database include output? (default: no)
 801 #  Default: False
 802 # c.HistoryManager.db_log_output = False
 803
 804 ## enable the SQLite history
 805 #  See also: HistoryAccessor.enabled
 806 # c.HistoryManager.enabled = True
 807
 808 ## Path to file to use for SQLite history database.
 809 #  See also: HistoryAccessor.hist_file
 810 # c.HistoryManager.hist_file = ''
 811
 812 #------------------------------------------------------------------------------
 813 # ProfileDir(LoggingConfigurable) configuration
 814 #------------------------------------------------------------------------------
 815 ## An object to manage the profile directory and its resources.
 816 #
 817 #      The profile directory is used by all IPython applications, to manage
 818 #      configuration, logging and security.
 819 #
 820 #      This object knows how to find, create and manage these directories. This
 821 #      should be used by any code that wants to handle profiles.
 822
 823 ## Set the profile location directly. This overrides the logic used by the
 824 #          `profile` option.
 825 #  Default: ''
 826 # c.ProfileDir.location = ''
 827
 828 #------------------------------------------------------------------------------
 829 # BaseFormatter(Configurable) configuration
 830 #------------------------------------------------------------------------------
 831 ## A base formatter class that is configurable.
 832 #
 833 #      This formatter should usually be used as the base class of all formatters.
 834 #      It is a traited :class:`Configurable` class and includes an extensible
 835 #      API for users to determine how their objects are formatted. The following
 836 #      logic is used to find a function to format an given object.
 837 #
 838 #      1. The object is introspected to see if it has a method with the name
 839 #         :attr:`print_method`. If is does, that object is passed to that method
 840 #         for formatting.
 841 #      2. If no print method is found, three internal dictionaries are consulted
 842 #         to find print method: :attr:`singleton_printers`, :attr:`type_printers`
 843 #         and :attr:`deferred_printers`.
 844 #
 845 #      Users should use these dictionaries to register functions that will be
 846 #      used to compute the format data for their objects (if those objects don't
 847 #      have the special print methods). The easiest way of using these
 848 #      dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name`
 849 #      methods.
 850 #
 851 #      If no function/callable is found to compute the format data, ``None`` is
 852 #      returned and this format type is not used.
 853
 854 #  Default: {}
 855 # c.BaseFormatter.deferred_printers = {}
 856
 857 #  Default: True
 858 # c.BaseFormatter.enabled = True
 859
 860 #  Default: {}
 861 # c.BaseFormatter.singleton_printers = {}
 862
 863 #  Default: {}
 864 # c.BaseFormatter.type_printers = {}
 865
 866 #------------------------------------------------------------------------------
 867 # PlainTextFormatter(BaseFormatter) configuration
 868 #------------------------------------------------------------------------------
 869 ## The default pretty-printer.
 870 #
 871 #      This uses :mod:`IPython.lib.pretty` to compute the format data of
 872 #      the object. If the object cannot be pretty printed, :func:`repr` is used.
 873 #      See the documentation of :mod:`IPython.lib.pretty` for details on
 874 #      how to write pretty printers.  Here is a simple example::
 875 #
 876 #          def dtype_pprinter(obj, p, cycle):
 877 #              if cycle:
 878 #                  return p.text('dtype(...)')
 879 #              if hasattr(obj, 'fields'):
 880 #                  if obj.fields is None:
 881 #                      p.text(repr(obj))
 882 #                  else:
 883 #                      p.begin_group(7, 'dtype([')
 884 #                      for i, field in enumerate(obj.descr):
 885 #                          if i > 0:
 886 #                              p.text(',')
 887 #                              p.breakable()
 888 #                          p.pretty(field)
 889 #                      p.end_group(7, '])')
 890
 891 #  See also: BaseFormatter.deferred_printers
 892 # c.PlainTextFormatter.deferred_printers = {}
 893
 894 #  Default: ''
 895 # c.PlainTextFormatter.float_precision = ''
 896
 897 ## Truncate large collections (lists, dicts, tuples, sets) to this size.
 898 #
 899 #          Set to 0 to disable truncation.
 900 #  Default: 1000
 901 # c.PlainTextFormatter.max_seq_length = 1000
 902
 903 #  Default: 79
 904 # c.PlainTextFormatter.max_width = 79
 905
 906 #  Default: '\n'
 907 # c.PlainTextFormatter.newline = '\n'
 908
 909 #  Default: True
 910 # c.PlainTextFormatter.pprint = True
 911
 912 #  See also: BaseFormatter.singleton_printers
 913 # c.PlainTextFormatter.singleton_printers = {}
 914
 915 #  See also: BaseFormatter.type_printers
 916 # c.PlainTextFormatter.type_printers = {}
 917
 918 #  Default: False
 919 # c.PlainTextFormatter.verbose = False
 920
 921 #------------------------------------------------------------------------------
 922 # Completer(Configurable) configuration
 923 #------------------------------------------------------------------------------
 924 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
 925 #  commands, unicode names, and expanding unicode characters back to latex
 926 #  commands.
 927 #  Default: True
 928 # c.Completer.backslash_combining_completions = True
 929
 930 ## Enable debug for the Completer. Mostly print extra information for
 931 #  experimental jedi integration.
 932 #  Default: False
 933 # c.Completer.debug = False
 934
 935 ## Activate greedy completion
 936 #          PENDING DEPRECTION. this is now mostly taken care of with Jedi.
 937 #
 938 #          This will enable completion on elements of lists, results of function calls, etc.,
 939 #          but can be unsafe because the code is actually evaluated on TAB.
 940 #  Default: False
 941 # c.Completer.greedy = False
 942
 943 ## Experimental: restrict time (in milliseconds) during which Jedi can compute types.
 944 #          Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt
 945 #          performance by preventing jedi to build its cache.
 946 #  Default: 400
 947 # c.Completer.jedi_compute_type_timeout = 400
 948
 949 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
 950 #  installed.
 951 #  Default: True
 952 # c.Completer.use_jedi = True
 953
 954 #------------------------------------------------------------------------------
 955 # IPCompleter(Completer) configuration
 956 #------------------------------------------------------------------------------
 957 ## Extension of the completer class with IPython-specific features
 958
 959 ## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex
 960 #  commands, unicode names, and expanding unicode characters back to latex
 961 #  commands.
 962 #  See also: Completer.backslash_combining_completions
 963 # c.IPCompleter.backslash_combining_completions = True
 964
 965 ## Enable debug for the Completer. Mostly print extra information for
 966 #  experimental jedi integration.
 967 #  See also: Completer.debug
 968 # c.IPCompleter.debug = False
 969
 970 ## Activate greedy completion
 971 #  See also: Completer.greedy
 972 # c.IPCompleter.greedy = False
 973
 974 ## Experimental: restrict time (in milliseconds) during which Jedi can compute
 975 #  types.
 976 #  See also: Completer.jedi_compute_type_timeout
 977 # c.IPCompleter.jedi_compute_type_timeout = 400
 978
 979 ## DEPRECATED as of version 5.0.
 980 #
 981 #  Instruct the completer to use __all__ for the completion
 982 #
 983 #  Specifically, when completing on ``object.<tab>``.
 984 #
 985 #  When True: only those names in obj.__all__ will be included.
 986 #
 987 #  When False [default]: the __all__ attribute is ignored
 988 #  Default: False
 989 # c.IPCompleter.limit_to__all__ = False
 990
 991 ## Whether to merge completion results into a single list
 992 #
 993 #          If False, only the completion results from the first non-empty
 994 #          completer will be returned.
 995 #  Default: True
 996 # c.IPCompleter.merge_completions = True
 997
 998 ## Instruct the completer to omit private method names
 999 #
1000 #          Specifically, when completing on ``object.<tab>``.
1001 #
1002 #          When 2 [default]: all names that start with '_' will be excluded.
1003 #
1004 #          When 1: all 'magic' names (``__foo__``) will be excluded.
1005 #
1006 #          When 0: nothing will be excluded.
1007 #  Choices: any of [0, 1, 2]
1008 #  Default: 2
1009 # c.IPCompleter.omit__names = 2
1010
1011 ## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is
1012 #  installed.
1013 #  See also: Completer.use_jedi
1014 # c.IPCompleter.use_jedi = True
1015
1016 #------------------------------------------------------------------------------
1017 # ScriptMagics(Magics) configuration
1018 #------------------------------------------------------------------------------
1019 ## Magics for talking to scripts
1020 #
1021 #      This defines a base `%%script` cell magic for running a cell
1022 #      with a program in a subprocess, and registers a few top-level
1023 #      magics that call %%script with common interpreters.
1024
1025 ## Extra script cell magics to define
1026 #
1027 #          This generates simple wrappers of `%%script foo` as `%%foo`.
1028 #
1029 #          If you want to add script magics that aren't on your path,
1030 #          specify them in script_paths
1031 #  Default: []
1032 # c.ScriptMagics.script_magics = []
1033
1034 ## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby'
1035 #
1036 #          Only necessary for items in script_magics where the default path will not
1037 #          find the right interpreter.
1038 #  Default: {}
1039 # c.ScriptMagics.script_paths = {}
1040
1041 #------------------------------------------------------------------------------
1042 # LoggingMagics(Magics) configuration
1043 #------------------------------------------------------------------------------
1044 ## Magics related to all logging machinery.
1045
1046 ## Suppress output of log state when logging is enabled
1047 #  Default: False
1048 # c.LoggingMagics.quiet = False
1049
1050 #------------------------------------------------------------------------------
1051 # StoreMagics(Magics) configuration
1052 #------------------------------------------------------------------------------
1053 ## Lightweight persistence for python variables.
1054 #
1055 #      Provides the %store magic.
1056
1057 ## If True, any %store-d variables will be automatically restored
1058 #          when IPython starts.
1059 #  Default: False
1060 # c.StoreMagics.autorestore = False