Add stuff I like to ipython profile

This commit is contained in:
Dan Buch 2024-10-05 17:06:59 -04:00
parent b6c3430e20
commit 068dd457d8
Signed by: meatballhat
GPG Key ID: A12F782281063434

View File

@ -6,13 +6,13 @@ c = get_config() #noqa
# InteractiveShellApp(Configurable) configuration # InteractiveShellApp(Configurable) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## A Mixin for applications that start InteractiveShell instances. ## A Mixin for applications that start InteractiveShell instances.
# #
# Provides configurables for loading extensions and executing files # Provides configurables for loading extensions and executing files
# as part of configuring a Shell environment. # as part of configuring a Shell environment.
# #
# The following methods should be called by the :meth:`initialize` method # The following methods should be called by the :meth:`initialize` method
# of the subclass: # of the subclass:
# #
# - :meth:`init_path` # - :meth:`init_path`
# - :meth:`init_shell` (to be implemented by the subclass) # - :meth:`init_shell` (to be implemented by the subclass)
# - :meth:`init_gui_pylab` # - :meth:`init_gui_pylab`
@ -41,9 +41,9 @@ c = get_config() #noqa
# c.InteractiveShellApp.extensions = [] # c.InteractiveShellApp.extensions = []
## Dotted module name(s) of one or more IPython extensions to load. ## Dotted module name(s) of one or more IPython extensions to load.
# #
# For specifying extra extensions to load on the command-line. # For specifying extra extensions to load on the command-line.
# #
# .. versionadded:: 7.10 # .. versionadded:: 7.10
# Default: [] # Default: []
# c.InteractiveShellApp.extra_extensions = [] # c.InteractiveShellApp.extra_extensions = []
@ -90,7 +90,7 @@ c = get_config() #noqa
## If true, IPython will populate the user namespace with numpy, pylab, etc. ## If true, IPython will populate the user namespace with numpy, pylab, etc.
# and an ``import *`` is done from numpy and pylab, when using pylab mode. # and an ``import *`` is done from numpy and pylab, when using pylab mode.
# #
# When False, pylab mode should not import any names into the user # When False, pylab mode should not import any names into the user
# namespace. # namespace.
# Default: True # Default: True
@ -119,32 +119,32 @@ c = get_config() #noqa
# c.Application.log_level = 30 # c.Application.log_level = 30
## Configure additional log handlers. ## Configure additional log handlers.
# #
# The default stderr logs handler is configured by the log_level, log_datefmt # The default stderr logs handler is configured by the log_level, log_datefmt
# and log_format settings. # and log_format settings.
# #
# This configuration can be used to configure additional handlers (e.g. to # This configuration can be used to configure additional handlers (e.g. to
# output the log to a file) or for finer control over the default handlers. # output the log to a file) or for finer control over the default handlers.
# #
# If provided this should be a logging configuration dictionary, for more # If provided this should be a logging configuration dictionary, for more
# information see: # information see:
# https://docs.python.org/3/library/logging.config.html#logging-config- # https://docs.python.org/3/library/logging.config.html#logging-config-
# dictschema # dictschema
# #
# This dictionary is merged with the base logging configuration which defines # This dictionary is merged with the base logging configuration which defines
# the following: # the following:
# #
# * A logging formatter intended for interactive use called # * A logging formatter intended for interactive use called
# ``console``. # ``console``.
# * A logging handler that writes to stderr called # * A logging handler that writes to stderr called
# ``console`` which uses the formatter ``console``. # ``console`` which uses the formatter ``console``.
# * A logger with the name of this application set to ``DEBUG`` # * A logger with the name of this application set to ``DEBUG``
# level. # level.
# #
# This example adds a new handler that writes to a file: # This example adds a new handler that writes to a file:
# #
# .. code-block:: python # .. code-block:: python
# #
# c.Application.logging_config = { # c.Application.logging_config = {
# "handlers": { # "handlers": {
# "file": { # "file": {
@ -191,7 +191,7 @@ c = get_config() #noqa
# c.BaseIPythonApplication.copy_config_files = False # c.BaseIPythonApplication.copy_config_files = False
## Path to an extra config file to load. ## Path to an extra config file to load.
# #
# If specified, load this config file in addition to any other IPython # If specified, load this config file in addition to any other IPython
# config. # config.
# Default: '' # Default: ''
@ -216,7 +216,7 @@ c = get_config() #noqa
# See also: Application.log_level # See also: Application.log_level
# c.BaseIPythonApplication.log_level = 30 # c.BaseIPythonApplication.log_level = 30
## ##
# See also: Application.logging_config # See also: Application.logging_config
# c.BaseIPythonApplication.logging_config = {} # c.BaseIPythonApplication.logging_config = {}
@ -283,7 +283,7 @@ c = get_config() #noqa
# See also: BaseIPythonApplication.extra_config_file # See also: BaseIPythonApplication.extra_config_file
# c.TerminalIPythonApp.extra_config_file = '' # c.TerminalIPythonApp.extra_config_file = ''
## ##
# See also: InteractiveShellApp.extra_extensions # See also: InteractiveShellApp.extra_extensions
# c.TerminalIPythonApp.extra_extensions = [] # c.TerminalIPythonApp.extra_extensions = []
@ -316,7 +316,7 @@ c = get_config() #noqa
# Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell' # Default: 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
# c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell' # c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell'
## ##
# See also: BaseIPythonApplication.ipython_dir # See also: BaseIPythonApplication.ipython_dir
# c.TerminalIPythonApp.ipython_dir = '' # c.TerminalIPythonApp.ipython_dir = ''
@ -332,7 +332,7 @@ c = get_config() #noqa
# See also: Application.log_level # See also: Application.log_level
# c.TerminalIPythonApp.log_level = 30 # c.TerminalIPythonApp.log_level = 30
## ##
# See also: Application.logging_config # See also: Application.logging_config
# c.TerminalIPythonApp.logging_config = {} # c.TerminalIPythonApp.logging_config = {}
@ -542,11 +542,11 @@ c = get_config() #noqa
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
# TerminalInteractiveShell(InteractiveShell) configuration # TerminalInteractiveShell(InteractiveShell) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## ##
# See also: InteractiveShell.ast_node_interactivity # See also: InteractiveShell.ast_node_interactivity
# c.TerminalInteractiveShell.ast_node_interactivity = 'last_expr' # c.TerminalInteractiveShell.ast_node_interactivity = 'last_expr'
## ##
# See also: InteractiveShell.ast_transformers # See also: InteractiveShell.ast_transformers
# c.TerminalInteractiveShell.ast_transformers = [] # c.TerminalInteractiveShell.ast_transformers = []
@ -555,11 +555,11 @@ c = get_config() #noqa
# Default: False # Default: False
# c.TerminalInteractiveShell.auto_match = False # c.TerminalInteractiveShell.auto_match = False
## ##
# See also: InteractiveShell.autoawait # See also: InteractiveShell.autoawait
# c.TerminalInteractiveShell.autoawait = True # c.TerminalInteractiveShell.autoawait = True
## ##
# See also: InteractiveShell.autocall # See also: InteractiveShell.autocall
# c.TerminalInteractiveShell.autocall = 0 # c.TerminalInteractiveShell.autocall = 0
@ -567,11 +567,11 @@ c = get_config() #noqa
# Default: None # Default: None
# c.TerminalInteractiveShell.autoformatter = None # c.TerminalInteractiveShell.autoformatter = None
## ##
# See also: InteractiveShell.autoindent # See also: InteractiveShell.autoindent
# c.TerminalInteractiveShell.autoindent = True # c.TerminalInteractiveShell.autoindent = True
## ##
# See also: InteractiveShell.automagic # See also: InteractiveShell.automagic
# c.TerminalInteractiveShell.automagic = True # c.TerminalInteractiveShell.automagic = True
@ -590,11 +590,11 @@ c = get_config() #noqa
# See also: InteractiveShell.banner2 # See also: InteractiveShell.banner2
# c.TerminalInteractiveShell.banner2 = '' # c.TerminalInteractiveShell.banner2 = ''
## ##
# See also: InteractiveShell.cache_size # See also: InteractiveShell.cache_size
# c.TerminalInteractiveShell.cache_size = 1000 # c.TerminalInteractiveShell.cache_size = 1000
## ##
# See also: InteractiveShell.color_info # See also: InteractiveShell.color_info
# c.TerminalInteractiveShell.color_info = True # c.TerminalInteractiveShell.color_info = True
@ -606,7 +606,7 @@ c = get_config() #noqa
# Control-Z/Enter in Windows). By typing 'exit' or 'quit', you can force a # Control-Z/Enter in Windows). By typing 'exit' or 'quit', you can force a
# direct exit without any confirmation. # direct exit without any confirmation.
# Default: True # Default: True
# c.TerminalInteractiveShell.confirm_exit = True c.TerminalInteractiveShell.confirm_exit = False
# See also: InteractiveShell.debug # See also: InteractiveShell.debug
# c.TerminalInteractiveShell.debug = False # c.TerminalInteractiveShell.debug = False
@ -632,7 +632,7 @@ c = get_config() #noqa
## Shortcut style to use at the prompt. 'vi' or 'emacs'. ## Shortcut style to use at the prompt. 'vi' or 'emacs'.
# Default: 'emacs' # Default: 'emacs'
# c.TerminalInteractiveShell.editing_mode = 'emacs' c.TerminalInteractiveShell.editing_mode = 'vi'
## Set the editor used by IPython (default to $EDITOR/vi/notepad). ## Set the editor used by IPython (default to $EDITOR/vi/notepad).
# Default: 'vim' # Default: 'vim'
@ -646,7 +646,7 @@ c = get_config() #noqa
# Default: True # Default: True
# c.TerminalInteractiveShell.enable_history_search = True # c.TerminalInteractiveShell.enable_history_search = True
## ##
# See also: InteractiveShell.enable_html_pager # See also: InteractiveShell.enable_html_pager
# c.TerminalInteractiveShell.enable_html_pager = False # c.TerminalInteractiveShell.enable_html_pager = False
@ -678,7 +678,7 @@ c = get_config() #noqa
# See also: InteractiveShell.history_length # See also: InteractiveShell.history_length
# c.TerminalInteractiveShell.history_length = 10000 # c.TerminalInteractiveShell.history_length = 10000
## ##
# See also: InteractiveShell.history_load_length # See also: InteractiveShell.history_load_length
# c.TerminalInteractiveShell.history_load_length = 1000 # c.TerminalInteractiveShell.history_load_length = 1000
@ -689,15 +689,15 @@ c = get_config() #noqa
# See also: InteractiveShell.ipython_dir # See also: InteractiveShell.ipython_dir
# c.TerminalInteractiveShell.ipython_dir = '' # c.TerminalInteractiveShell.ipython_dir = ''
## ##
# See also: InteractiveShell.logappend # See also: InteractiveShell.logappend
# c.TerminalInteractiveShell.logappend = '' # c.TerminalInteractiveShell.logappend = ''
## ##
# See also: InteractiveShell.logfile # See also: InteractiveShell.logfile
# c.TerminalInteractiveShell.logfile = '' # c.TerminalInteractiveShell.logfile = ''
## ##
# See also: InteractiveShell.logstart # See also: InteractiveShell.logstart
# c.TerminalInteractiveShell.logstart = False # c.TerminalInteractiveShell.logstart = False
@ -712,7 +712,7 @@ c = get_config() #noqa
## Cursor shape changes depending on vi mode: beam in vi insert mode, block in ## Cursor shape changes depending on vi mode: beam in vi insert mode, block in
# nav mode, underscore in replace mode. # nav mode, underscore in replace mode.
# Default: True # Default: True
# c.TerminalInteractiveShell.modal_cursor = True c.TerminalInteractiveShell.modal_cursor = True
## Enable mouse support in the prompt (Note: prevents selecting text with the ## Enable mouse support in the prompt (Note: prevents selecting text with the
# mouse) # mouse)
@ -722,13 +722,13 @@ c = get_config() #noqa
# See also: InteractiveShell.object_info_string_level # See also: InteractiveShell.object_info_string_level
# c.TerminalInteractiveShell.object_info_string_level = 0 # c.TerminalInteractiveShell.object_info_string_level = 0
## ##
# See also: InteractiveShell.pdb # See also: InteractiveShell.pdb
# c.TerminalInteractiveShell.pdb = False # c.TerminalInteractiveShell.pdb = False
## Display the current vi mode (when using vi editing mode). ## Display the current vi mode (when using vi editing mode).
# Default: True # Default: True
# c.TerminalInteractiveShell.prompt_includes_vi_mode = True c.TerminalInteractiveShell.prompt_includes_vi_mode = True
## The format for line numbering, will be passed `line` (int, 1 based) the ## The format for line numbering, will be passed `line` (int, 1 based) the
# current line number and `rel_line` the relative line number. for example to # current line number and `rel_line` the relative line number. for example to
@ -758,20 +758,20 @@ c = get_config() #noqa
# c.TerminalInteractiveShell.separate_out2 = '' # c.TerminalInteractiveShell.separate_out2 = ''
## Add, disable or modifying shortcuts. ## Add, disable or modifying shortcuts.
# #
# Each entry on the list should be a dictionary with ``command`` key # Each entry on the list should be a dictionary with ``command`` key
# identifying the target function executed by the shortcut and at least # identifying the target function executed by the shortcut and at least
# one of the following: # one of the following:
# #
# - ``match_keys``: list of keys used to match an existing shortcut, # - ``match_keys``: list of keys used to match an existing shortcut,
# - ``match_filter``: shortcut filter used to match an existing shortcut, # - ``match_filter``: shortcut filter used to match an existing shortcut,
# - ``new_keys``: list of keys to set, # - ``new_keys``: list of keys to set,
# - ``new_filter``: a new shortcut filter to set # - ``new_filter``: a new shortcut filter to set
# #
# The filters have to be composed of pre-defined verbs and joined by one # The filters have to be composed of pre-defined verbs and joined by one
# of the following conjunctions: ``&`` (and), ``|`` (or), ``~`` (not). # of the following conjunctions: ``&`` (and), ``|`` (or), ``~`` (not).
# The pre-defined verbs are: # The pre-defined verbs are:
# #
# - `always` # - `always`
# - `never` # - `never`
# - `has_line_below` # - `has_line_below`
@ -813,16 +813,16 @@ c = get_config() #noqa
# - `navigable_suggestions` # - `navigable_suggestions`
# - `cursor_in_leading_ws` # - `cursor_in_leading_ws`
# - `pass_through` # - `pass_through`
# #
# To disable a shortcut set ``new_keys`` to an empty list. # To disable a shortcut set ``new_keys`` to an empty list.
# To add a shortcut add key ``create`` with value ``True``. # To add a shortcut add key ``create`` with value ``True``.
# #
# When modifying/disabling shortcuts, ``match_keys``/``match_filter`` can # When modifying/disabling shortcuts, ``match_keys``/``match_filter`` can
# be omitted if the provided specification uniquely identifies a shortcut # be omitted if the provided specification uniquely identifies a shortcut
# to be modified/disabled. When modifying a shortcut ``new_filter`` or # to be modified/disabled. When modifying a shortcut ``new_filter`` or
# ``new_keys`` can be omitted which will result in reuse of the existing # ``new_keys`` can be omitted which will result in reuse of the existing
# filter/keys. # filter/keys.
# #
# Only shortcuts defined in IPython (and not default prompt-toolkit # Only shortcuts defined in IPython (and not default prompt-toolkit
# shortcuts) can be modified or disabled. The full list of shortcuts, # shortcuts) can be modified or disabled. The full list of shortcuts,
# command identifiers and filters is available under # command identifiers and filters is available under
@ -835,13 +835,13 @@ c = get_config() #noqa
# c.TerminalInteractiveShell.show_rewritten_input = True # c.TerminalInteractiveShell.show_rewritten_input = True
## Use `raw_input` for the REPL, without completion and prompt colors. ## Use `raw_input` for the REPL, without completion and prompt colors.
# #
# Useful when controlling IPython as a subprocess, and piping # Useful when controlling IPython as a subprocess, and piping
# STDIN/OUT/ERR. Known usage are: IPython's own testing machinery, # STDIN/OUT/ERR. Known usage are: IPython's own testing machinery,
# and emacs' inferior-python subprocess (assuming you have set # and emacs' inferior-python subprocess (assuming you have set
# `python-shell-interpreter` to "ipython") available through the # `python-shell-interpreter` to "ipython") available through the
# built-in `M-x run-python` and third party packages such as elpy. # built-in `M-x run-python` and third party packages such as elpy.
# #
# This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT` # This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
# environment variable is set, or the current terminal is not a tty. # environment variable is set, or the current terminal is not a tty.
# Thus the Default value reported in --help-all, or config will often # Thus the Default value reported in --help-all, or config will often
@ -856,7 +856,7 @@ c = get_config() #noqa
# Default: 6 # Default: 6
# c.TerminalInteractiveShell.space_for_menu = 6 # c.TerminalInteractiveShell.space_for_menu = 6
## ##
# See also: InteractiveShell.sphinxify_docstring # See also: InteractiveShell.sphinxify_docstring
# c.TerminalInteractiveShell.sphinxify_docstring = False # c.TerminalInteractiveShell.sphinxify_docstring = False
@ -877,7 +877,7 @@ c = get_config() #noqa
## Use 24bit colors instead of 256 colors in prompt highlighting. ## Use 24bit colors instead of 256 colors in prompt highlighting.
# If your terminal supports true color, the following command should # If your terminal supports true color, the following command should
# print ``TRUECOLOR`` in orange:: # print ``TRUECOLOR`` in orange::
# #
# printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n" # printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
# Default: False # Default: False
# c.TerminalInteractiveShell.true_color = False # c.TerminalInteractiveShell.true_color = False
@ -903,19 +903,19 @@ c = get_config() #noqa
# HistoryAccessor(HistoryAccessorBase) configuration # HistoryAccessor(HistoryAccessorBase) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## Access the history database without adding to it. ## Access the history database without adding to it.
# #
# This is intended for use by standalone history tools. IPython shells use # This is intended for use by standalone history tools. IPython shells use
# HistoryManager, below, which is a subclass of this. # HistoryManager, below, which is a subclass of this.
## Options for configuring the SQLite connection ## Options for configuring the SQLite connection
# #
# These options are passed as keyword args to sqlite3.connect # These options are passed as keyword args to sqlite3.connect
# when establishing database connections. # when establishing database connections.
# Default: {} # Default: {}
# c.HistoryAccessor.connection_options = {} # c.HistoryAccessor.connection_options = {}
## enable the SQLite history ## enable the SQLite history
# #
# set enabled=False to disable the SQLite history, # set enabled=False to disable the SQLite history,
# in which case there will be no stored history, no SQLite connection, # in which case there will be no stored history, no SQLite connection,
# and no background saving thread. This may be necessary in some # and no background saving thread. This may be necessary in some
@ -924,17 +924,17 @@ c = get_config() #noqa
# c.HistoryAccessor.enabled = True # c.HistoryAccessor.enabled = True
## Path to file to use for SQLite history database. ## Path to file to use for SQLite history database.
# #
# By default, IPython will put the history database in the IPython # By default, IPython will put the history database in the IPython
# profile directory. If you would rather share one history among # profile directory. If you would rather share one history among
# profiles, you can set this value in each, so that they are consistent. # profiles, you can set this value in each, so that they are consistent.
# #
# Due to an issue with fcntl, SQLite is known to misbehave on some NFS # Due to an issue with fcntl, SQLite is known to misbehave on some NFS
# mounts. If you see IPython hanging, try setting this to something on a # mounts. If you see IPython hanging, try setting this to something on a
# local disk, e.g:: # local disk, e.g::
# #
# ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite # ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite
# #
# you can also use the specific value `:memory:` (including the colon # you can also use the specific value `:memory:` (including the colon
# at both end but not the back ticks), to avoid creating an history file. # at both end but not the back ticks), to avoid creating an history file.
# Default: traitlets.Undefined # Default: traitlets.Undefined
@ -976,24 +976,24 @@ c = get_config() #noqa
# c.MagicsManager.auto_magic = True # c.MagicsManager.auto_magic = True
## Mapping from magic names to modules to load. ## Mapping from magic names to modules to load.
# #
# This can be used in IPython/IPykernel configuration to declare lazy magics # This can be used in IPython/IPykernel configuration to declare lazy magics
# that will only be imported/registered on first use. # that will only be imported/registered on first use.
# #
# For example:: # For example::
# #
# c.MagicsManager.lazy_magics = { # c.MagicsManager.lazy_magics = {
# "my_magic": "slow.to.import", # "my_magic": "slow.to.import",
# "my_other_magic": "also.slow", # "my_other_magic": "also.slow",
# } # }
# #
# On first invocation of `%my_magic`, `%%my_magic`, `%%my_other_magic` or # On first invocation of `%my_magic`, `%%my_magic`, `%%my_other_magic` or
# `%%my_other_magic`, the corresponding module will be loaded as an ipython # `%%my_other_magic`, the corresponding module will be loaded as an ipython
# extensions as if you had previously done `%load_ext ipython`. # extensions as if you had previously done `%load_ext ipython`.
# #
# Magics names should be without percent(s) as magics can be both cell and line # Magics names should be without percent(s) as magics can be both cell and line
# magics. # magics.
# #
# Lazy loading happen relatively late in execution process, and complex # Lazy loading happen relatively late in execution process, and complex
# extensions that manipulate Python/IPython internal state or global state might # extensions that manipulate Python/IPython internal state or global state might
# not support lazy loading. # not support lazy loading.
@ -1004,10 +1004,10 @@ c = get_config() #noqa
# ProfileDir(LoggingConfigurable) configuration # ProfileDir(LoggingConfigurable) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## An object to manage the profile directory and its resources. ## An object to manage the profile directory and its resources.
# #
# The profile directory is used by all IPython applications, to manage # The profile directory is used by all IPython applications, to manage
# configuration, logging and security. # configuration, logging and security.
# #
# This object knows how to find, create and manage these directories. This # This object knows how to find, create and manage these directories. This
# should be used by any code that wants to handle profiles. # should be used by any code that wants to handle profiles.
@ -1020,25 +1020,25 @@ c = get_config() #noqa
# BaseFormatter(Configurable) configuration # BaseFormatter(Configurable) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## A base formatter class that is configurable. ## A base formatter class that is configurable.
# #
# This formatter should usually be used as the base class of all formatters. # This formatter should usually be used as the base class of all formatters.
# It is a traited :class:`Configurable` class and includes an extensible # It is a traited :class:`Configurable` class and includes an extensible
# API for users to determine how their objects are formatted. The following # API for users to determine how their objects are formatted. The following
# logic is used to find a function to format an given object. # logic is used to find a function to format an given object.
# #
# 1. The object is introspected to see if it has a method with the name # 1. The object is introspected to see if it has a method with the name
# :attr:`print_method`. If is does, that object is passed to that method # :attr:`print_method`. If is does, that object is passed to that method
# for formatting. # for formatting.
# 2. If no print method is found, three internal dictionaries are consulted # 2. If no print method is found, three internal dictionaries are consulted
# to find print method: :attr:`singleton_printers`, :attr:`type_printers` # to find print method: :attr:`singleton_printers`, :attr:`type_printers`
# and :attr:`deferred_printers`. # and :attr:`deferred_printers`.
# #
# Users should use these dictionaries to register functions that will be # Users should use these dictionaries to register functions that will be
# used to compute the format data for their objects (if those objects don't # used to compute the format data for their objects (if those objects don't
# have the special print methods). The easiest way of using these # have the special print methods). The easiest way of using these
# dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name` # dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name`
# methods. # methods.
# #
# If no function/callable is found to compute the format data, ``None`` is # If no function/callable is found to compute the format data, ``None`` is
# returned and this format type is not used. # returned and this format type is not used.
@ -1058,12 +1058,12 @@ c = get_config() #noqa
# PlainTextFormatter(BaseFormatter) configuration # PlainTextFormatter(BaseFormatter) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## The default pretty-printer. ## The default pretty-printer.
# #
# This uses :mod:`IPython.lib.pretty` to compute the format data of # This uses :mod:`IPython.lib.pretty` to compute the format data of
# the object. If the object cannot be pretty printed, :func:`repr` is used. # the object. If the object cannot be pretty printed, :func:`repr` is used.
# See the documentation of :mod:`IPython.lib.pretty` for details on # See the documentation of :mod:`IPython.lib.pretty` for details on
# how to write pretty printers. Here is a simple example:: # how to write pretty printers. Here is a simple example::
# #
# def dtype_pprinter(obj, p, cycle): # def dtype_pprinter(obj, p, cycle):
# if cycle: # if cycle:
# return p.text('dtype(...)') # return p.text('dtype(...)')
@ -1086,7 +1086,7 @@ c = get_config() #noqa
# c.PlainTextFormatter.float_precision = '' # c.PlainTextFormatter.float_precision = ''
## Truncate large collections (lists, dicts, tuples, sets) to this size. ## Truncate large collections (lists, dicts, tuples, sets) to this size.
# #
# Set to 0 to disable truncation. # Set to 0 to disable truncation.
# Default: 1000 # Default: 1000
# c.PlainTextFormatter.max_seq_length = 1000 # c.PlainTextFormatter.max_seq_length = 1000
@ -1113,7 +1113,7 @@ c = get_config() #noqa
# Completer(Configurable) configuration # Completer(Configurable) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## Enable auto-closing dictionary keys. ## Enable auto-closing dictionary keys.
# #
# When enabled string keys will be suffixed with a final quote (matching the # When enabled string keys will be suffixed with a final quote (matching the
# opening quote), tuple keys will also receive a separating comma if needed, and # opening quote), tuple keys will also receive a separating comma if needed, and
# keys which are final will receive a closing bracket (``]``). # keys which are final will receive a closing bracket (``]``).
@ -1132,15 +1132,15 @@ c = get_config() #noqa
# c.Completer.debug = False # c.Completer.debug = False
## Policy for code evaluation under completion. ## Policy for code evaluation under completion.
# #
# Successive options allow to enable more eager evaluation for better # Successive options allow to enable more eager evaluation for better
# completion suggestions, including for nested dictionaries, nested lists, # completion suggestions, including for nested dictionaries, nested lists,
# or even results of function calls. # or even results of function calls.
# Setting ``unsafe`` or higher can lead to evaluation of arbitrary user # Setting ``unsafe`` or higher can lead to evaluation of arbitrary user
# code on :kbd:`Tab` with potentially unwanted or dangerous side effects. # code on :kbd:`Tab` with potentially unwanted or dangerous side effects.
# #
# Allowed values are: # Allowed values are:
# #
# - ``forbidden``: no evaluation of code is permitted, # - ``forbidden``: no evaluation of code is permitted,
# - ``minimal``: evaluation of literals and access to built-in namespace; # - ``minimal``: evaluation of literals and access to built-in namespace;
# no item/attribute evaluationm no access to locals/globals, # no item/attribute evaluationm no access to locals/globals,
@ -1157,13 +1157,13 @@ c = get_config() #noqa
# c.Completer.evaluation = 'limited' # c.Completer.evaluation = 'limited'
## Activate greedy completion. ## Activate greedy completion.
# #
# .. deprecated:: 8.8 # .. deprecated:: 8.8
# Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead. # Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead.
# #
# When enabled in IPython 8.8 or newer, changes configuration as # When enabled in IPython 8.8 or newer, changes configuration as
# follows: # follows:
# #
# - ``Completer.evaluation = 'unsafe'`` # - ``Completer.evaluation = 'unsafe'``
# - ``Completer.auto_close_dict_keys = True`` # - ``Completer.auto_close_dict_keys = True``
# Default: False # Default: False
@ -1185,7 +1185,7 @@ c = get_config() #noqa
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## Extension of the completer class with IPython-specific features ## Extension of the completer class with IPython-specific features
## ##
# See also: Completer.auto_close_dict_keys # See also: Completer.auto_close_dict_keys
# c.IPCompleter.auto_close_dict_keys = False # c.IPCompleter.auto_close_dict_keys = False
@ -1201,7 +1201,7 @@ c = get_config() #noqa
# c.IPCompleter.debug = False # c.IPCompleter.debug = False
## List of matchers to disable. ## List of matchers to disable.
# #
# The list should contain matcher identifiers (see # The list should contain matcher identifiers (see
# :any:`completion_matcher`). # :any:`completion_matcher`).
# Default: [] # Default: []
@ -1221,35 +1221,35 @@ c = get_config() #noqa
# c.IPCompleter.jedi_compute_type_timeout = 400 # c.IPCompleter.jedi_compute_type_timeout = 400
## DEPRECATED as of version 5.0. ## DEPRECATED as of version 5.0.
# #
# Instruct the completer to use __all__ for the completion # Instruct the completer to use __all__ for the completion
# #
# Specifically, when completing on ``object.<tab>``. # Specifically, when completing on ``object.<tab>``.
# #
# When True: only those names in obj.__all__ will be included. # When True: only those names in obj.__all__ will be included.
# #
# When False [default]: the __all__ attribute is ignored # When False [default]: the __all__ attribute is ignored
# Default: False # Default: False
# c.IPCompleter.limit_to__all__ = False # c.IPCompleter.limit_to__all__ = False
## Whether to merge completion results into a single list ## Whether to merge completion results into a single list
# #
# If False, only the completion results from the first non-empty # If False, only the completion results from the first non-empty
# completer will be returned. # completer will be returned.
# #
# As of version 8.6.0, setting the value to ``False`` is an alias for: # As of version 8.6.0, setting the value to ``False`` is an alias for:
# ``IPCompleter.suppress_competing_matchers = True.``. # ``IPCompleter.suppress_competing_matchers = True.``.
# Default: True # Default: True
# c.IPCompleter.merge_completions = True # c.IPCompleter.merge_completions = True
## Instruct the completer to omit private method names ## Instruct the completer to omit private method names
# #
# Specifically, when completing on ``object.<tab>``. # Specifically, when completing on ``object.<tab>``.
# #
# When 2 [default]: all names that start with '_' will be excluded. # When 2 [default]: all names that start with '_' will be excluded.
# #
# When 1: all 'magic' names (``__foo__``) will be excluded. # When 1: all 'magic' names (``__foo__``) will be excluded.
# #
# When 0: nothing will be excluded. # When 0: nothing will be excluded.
# Choices: any of [0, 1, 2] # Choices: any of [0, 1, 2]
# Default: 2 # Default: 2
@ -1264,19 +1264,19 @@ c = get_config() #noqa
# c.IPCompleter.profiler_output_dir = '.completion_profiles' # c.IPCompleter.profiler_output_dir = '.completion_profiles'
## Whether to suppress completions from other *Matchers*. ## Whether to suppress completions from other *Matchers*.
# #
# When set to ``None`` (default) the matchers will attempt to auto-detect # When set to ``None`` (default) the matchers will attempt to auto-detect
# whether suppression of other matchers is desirable. For example, at the # whether suppression of other matchers is desirable. For example, at the
# beginning of a line followed by `%` we expect a magic completion to be the # beginning of a line followed by `%` we expect a magic completion to be the
# only applicable option, and after ``my_dict['`` we usually expect a completion # only applicable option, and after ``my_dict['`` we usually expect a completion
# with an existing dictionary key. # with an existing dictionary key.
# #
# If you want to disable this heuristic and see completions from all matchers, # If you want to disable this heuristic and see completions from all matchers,
# set ``IPCompleter.suppress_competing_matchers = False``. To disable the # set ``IPCompleter.suppress_competing_matchers = False``. To disable the
# heuristic for specific matchers provide a dictionary mapping: # heuristic for specific matchers provide a dictionary mapping:
# ``IPCompleter.suppress_competing_matchers = {'IPCompleter.dict_key_matcher': # ``IPCompleter.suppress_competing_matchers = {'IPCompleter.dict_key_matcher':
# False}``. # False}``.
# #
# Set ``IPCompleter.suppress_competing_matchers = True`` to limit completions to # Set ``IPCompleter.suppress_competing_matchers = True`` to limit completions to
# the set of matchers with the highest priority; this is equivalent to # the set of matchers with the highest priority; this is equivalent to
# ``IPCompleter.merge_completions`` and can be beneficial for performance, but # ``IPCompleter.merge_completions`` and can be beneficial for performance, but
@ -1294,22 +1294,22 @@ c = get_config() #noqa
# ScriptMagics(Magics) configuration # ScriptMagics(Magics) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## Magics for talking to scripts ## Magics for talking to scripts
# #
# This defines a base `%%script` cell magic for running a cell # This defines a base `%%script` cell magic for running a cell
# with a program in a subprocess, and registers a few top-level # with a program in a subprocess, and registers a few top-level
# magics that call %%script with common interpreters. # magics that call %%script with common interpreters.
## Extra script cell magics to define ## Extra script cell magics to define
# #
# This generates simple wrappers of `%%script foo` as `%%foo`. # This generates simple wrappers of `%%script foo` as `%%foo`.
# #
# If you want to add script magics that aren't on your path, # If you want to add script magics that aren't on your path,
# specify them in script_paths # specify them in script_paths
# Default: [] # Default: []
# c.ScriptMagics.script_magics = [] # c.ScriptMagics.script_magics = []
## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby' ## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby'
# #
# Only necessary for items in script_magics where the default path will not # Only necessary for items in script_magics where the default path will not
# find the right interpreter. # find the right interpreter.
# Default: {} # Default: {}
@ -1328,7 +1328,7 @@ c = get_config() #noqa
# StoreMagics(Magics) configuration # StoreMagics(Magics) configuration
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
## Lightweight persistence for python variables. ## Lightweight persistence for python variables.
# #
# Provides the %store magic. # Provides the %store magic.
## If True, any %store-d variables will be automatically restored ## If True, any %store-d variables will be automatically restored