Update Matplotlib docs

IPython/core/pylabtools.py

@@ -1,518 +1,522 b''
 # -*- coding: utf-8 -*-
 """Pylab (matplotlib) support utilities."""
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 from io import BytesIO
 from binascii import b2a_base64
 from functools import partial
 import warnings
 
 from IPython.core.display import _pngxy
 from IPython.utils.decorators import flag_calls
 
 
 # Matplotlib backend resolution functionality moved from IPython to Matplotlib
-# in IPython 8.24 and Matplotlib 3.9.1. Need to keep `backends` and `backend2gui`
+# in IPython 8.24 and Matplotlib 3.9.0. Need to keep `backends` and `backend2gui`
 # here for earlier Matplotlib and for external backend libraries such as
 # mplcairo that might rely upon it.
 _deprecated_backends = {
     "tk": "TkAgg",
     "gtk": "GTKAgg",
     "gtk3": "GTK3Agg",
     "gtk4": "GTK4Agg",
     "wx": "WXAgg",
     "qt4": "Qt4Agg",
     "qt5": "Qt5Agg",
     "qt6": "QtAgg",
     "qt": "QtAgg",
     "osx": "MacOSX",
     "nbagg": "nbAgg",
     "webagg": "WebAgg",
     "notebook": "nbAgg",
     "agg": "agg",
     "svg": "svg",
     "pdf": "pdf",
     "ps": "ps",
     "inline": "module://matplotlib_inline.backend_inline",
     "ipympl": "module://ipympl.backend_nbagg",
     "widget": "module://ipympl.backend_nbagg",
 }
 
 # We also need a reverse backends2guis mapping that will properly choose which
 # GUI support to activate based on the desired matplotlib backend.  For the
 # most part it's just a reverse of the above dict, but we also need to add a
 # few others that map to the same GUI manually:
 _deprecated_backend2gui = dict(
     zip(_deprecated_backends.values(), _deprecated_backends.keys())
 )
 # In the reverse mapping, there are a few extra valid matplotlib backends that
 # map to the same GUI support
 _deprecated_backend2gui["GTK"] = _deprecated_backend2gui["GTKCairo"] = "gtk"
 _deprecated_backend2gui["GTK3Cairo"] = "gtk3"
 _deprecated_backend2gui["GTK4Cairo"] = "gtk4"
 _deprecated_backend2gui["WX"] = "wx"
 _deprecated_backend2gui["CocoaAgg"] = "osx"
 # There needs to be a hysteresis here as the new QtAgg Matplotlib backend
 # supports either Qt5 or Qt6 and the IPython qt event loop support Qt4, Qt5,
 # and Qt6.
 _deprecated_backend2gui["QtAgg"] = "qt"
 _deprecated_backend2gui["Qt4Agg"] = "qt4"
 _deprecated_backend2gui["Qt5Agg"] = "qt5"
 
 # And some backends that don't need GUI integration
 del _deprecated_backend2gui["nbAgg"]
 del _deprecated_backend2gui["agg"]
 del _deprecated_backend2gui["svg"]
 del _deprecated_backend2gui["pdf"]
 del _deprecated_backend2gui["ps"]
 del _deprecated_backend2gui["module://matplotlib_inline.backend_inline"]
 del _deprecated_backend2gui["module://ipympl.backend_nbagg"]
 
 
 # Deprecated attributes backends and backend2gui mostly following PEP 562.
 def __getattr__(name):
     if name in ("backends", "backend2gui"):
         warnings.warn(
             f"{name} is deprecated since IPython 8.24, backends are managed "
             "in matplotlib and can be externally registered.",
             DeprecationWarning,
         )
         return globals()[f"_deprecated_{name}"]
     raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
 
 
 #-----------------------------------------------------------------------------
 # Matplotlib utilities
 #-----------------------------------------------------------------------------
 
 
 def getfigs(*fig_nums):
     """Get a list of matplotlib figures by figure numbers.
 
     If no arguments are given, all available figures are returned.  If the
     argument list contains references to invalid figures, a warning is printed
     but the function continues pasting further figures.
 
     Parameters
     ----------
     figs : tuple
         A tuple of ints giving the figure numbers of the figures to return.
     """
     from matplotlib._pylab_helpers import Gcf
     if not fig_nums:
         fig_managers = Gcf.get_all_fig_managers()
         return [fm.canvas.figure for fm in fig_managers]
     else:
         figs = []
         for num in fig_nums:
             f = Gcf.figs.get(num)
             if f is None:
                 print('Warning: figure %s not available.' % num)
             else:
                 figs.append(f.canvas.figure)
         return figs
 
 
 def figsize(sizex, sizey):
     """Set the default figure size to be [sizex, sizey].
 
     This is just an easy to remember, convenience wrapper that sets::
 
       matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
     """
     import matplotlib
     matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
 
 
 def print_figure(fig, fmt="png", bbox_inches="tight", base64=False, **kwargs):
     """Print a figure to an image, and return the resulting file data
 
     Returned data will be bytes unless ``fmt='svg'``,
     in which case it will be unicode.
 
     Any keyword args are passed to fig.canvas.print_figure,
     such as ``quality`` or ``bbox_inches``.
 
     If `base64` is True, return base64-encoded str instead of raw bytes
     for binary-encoded image formats
 
     .. versionadded:: 7.29
         base64 argument
     """
     # When there's an empty figure, we shouldn't return anything, otherwise we
     # get big blank areas in the qt console.
     if not fig.axes and not fig.lines:
         return
 
     dpi = fig.dpi
     if fmt == 'retina':
         dpi = dpi * 2
         fmt = 'png'
 
     # build keyword args
     kw = {
         "format":fmt,
         "facecolor":fig.get_facecolor(),
         "edgecolor":fig.get_edgecolor(),
         "dpi":dpi,
         "bbox_inches":bbox_inches,
     }
     # **kwargs get higher priority
     kw.update(kwargs)
 
     bytes_io = BytesIO()
     if fig.canvas is None:
         from matplotlib.backend_bases import FigureCanvasBase
         FigureCanvasBase(fig)
 
     fig.canvas.print_figure(bytes_io, **kw)
     data = bytes_io.getvalue()
     if fmt == 'svg':
         data = data.decode('utf-8')
     elif base64:
         data = b2a_base64(data, newline=False).decode("ascii")
     return data
 
 def retina_figure(fig, base64=False, **kwargs):
     """format a figure as a pixel-doubled (retina) PNG
 
     If `base64` is True, return base64-encoded str instead of raw bytes
     for binary-encoded image formats
 
     .. versionadded:: 7.29
         base64 argument
     """
     pngdata = print_figure(fig, fmt="retina", base64=False, **kwargs)
     # Make sure that retina_figure acts just like print_figure and returns
     # None when the figure is empty.
     if pngdata is None:
         return
     w, h = _pngxy(pngdata)
     metadata = {"width": w//2, "height":h//2}
     if base64:
         pngdata = b2a_base64(pngdata, newline=False).decode("ascii")
     return pngdata, metadata
 
 
 # We need a little factory function here to create the closure where
 # safe_execfile can live.
 def mpl_runner(safe_execfile):
     """Factory to return a matplotlib-enabled runner for %run.
 
     Parameters
     ----------
     safe_execfile : function
         This must be a function with the same interface as the
         :meth:`safe_execfile` method of IPython.
 
     Returns
     -------
     A function suitable for use as the ``runner`` argument of the %run magic
     function.
     """
 
     def mpl_execfile(fname,*where,**kw):
         """matplotlib-aware wrapper around safe_execfile.
 
         Its interface is identical to that of the :func:`execfile` builtin.
 
         This is ultimately a call to execfile(), but wrapped in safeties to
         properly handle interactive rendering."""
 
         import matplotlib
         import matplotlib.pyplot as plt
 
         #print '*** Matplotlib runner ***' # dbg
         # turn off rendering until end of script
         with matplotlib.rc_context({"interactive": False}):
             safe_execfile(fname, *where, **kw)
 
         if matplotlib.is_interactive():
             plt.show()
 
         # make rendering call now, if the user tried to do it
         if plt.draw_if_interactive.called:
             plt.draw()
             plt.draw_if_interactive.called = False
 
         # re-draw everything that is stale
         try:
             da = plt.draw_all
         except AttributeError:
             pass
         else:
             da()
 
     return mpl_execfile
 
 
 def _reshow_nbagg_figure(fig):
     """reshow an nbagg figure"""
     try:
         reshow = fig.canvas.manager.reshow
     except AttributeError as e:
         raise NotImplementedError() from e
     else:
         reshow()
 
 
 def select_figure_formats(shell, formats, **kwargs):
     """Select figure formats for the inline backend.
 
     Parameters
     ----------
     shell : InteractiveShell
         The main IPython instance.
     formats : str or set
         One or a set of figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'.
     **kwargs : any
         Extra keyword arguments to be passed to fig.canvas.print_figure.
     """
     import matplotlib
     from matplotlib.figure import Figure
 
     svg_formatter = shell.display_formatter.formatters['image/svg+xml']
     png_formatter = shell.display_formatter.formatters['image/png']
     jpg_formatter = shell.display_formatter.formatters['image/jpeg']
     pdf_formatter = shell.display_formatter.formatters['application/pdf']
 
     if isinstance(formats, str):
         formats = {formats}
     # cast in case of list / tuple
     formats = set(formats)
 
     [ f.pop(Figure, None) for f in shell.display_formatter.formatters.values() ]
     mplbackend = matplotlib.get_backend().lower()
     if mplbackend in ("nbagg", "ipympl", "widget", "module://ipympl.backend_nbagg"):
         formatter = shell.display_formatter.ipython_display_formatter
         formatter.for_type(Figure, _reshow_nbagg_figure)
 
     supported = {'png', 'png2x', 'retina', 'jpg', 'jpeg', 'svg', 'pdf'}
     bad = formats.difference(supported)
     if bad:
         bs = "%s" % ','.join([repr(f) for f in bad])
         gs = "%s" % ','.join([repr(f) for f in supported])
         raise ValueError("supported formats are: %s not %s" % (gs, bs))
 
     if "png" in formats:
         png_formatter.for_type(
             Figure, partial(print_figure, fmt="png", base64=True, **kwargs)
         )
     if "retina" in formats or "png2x" in formats:
         png_formatter.for_type(Figure, partial(retina_figure, base64=True, **kwargs))
     if "jpg" in formats or "jpeg" in formats:
         jpg_formatter.for_type(
             Figure, partial(print_figure, fmt="jpg", base64=True, **kwargs)
         )
     if "svg" in formats:
         svg_formatter.for_type(Figure, partial(print_figure, fmt="svg", **kwargs))
     if "pdf" in formats:
         pdf_formatter.for_type(
             Figure, partial(print_figure, fmt="pdf", base64=True, **kwargs)
         )
 
 #-----------------------------------------------------------------------------
 # Code for initializing matplotlib and importing pylab
 #-----------------------------------------------------------------------------
 
 
 def find_gui_and_backend(gui=None, gui_select=None):
     """Given a gui string return the gui and mpl backend.
 
     Parameters
     ----------
     gui : str
         Can be one of ('tk','gtk','wx','qt','qt4','inline','agg').
     gui_select : str
         Can be one of ('tk','gtk','wx','qt','qt4','inline').
         This is any gui already selected by the shell.
 
     Returns
     -------
     A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg',
     'WXAgg','Qt4Agg','module://matplotlib_inline.backend_inline','agg').
     """
 
     import matplotlib
 
     if _matplotlib_manages_backends():
         backend_registry = matplotlib.backends.registry.backend_registry
 
         # gui argument may be a gui event loop or may be a backend name.
         if gui in ("auto", None):
             backend = matplotlib.rcParamsOrig["backend"]
             backend, gui = backend_registry.resolve_backend(backend)
         else:
             backend, gui = backend_registry.resolve_gui_or_backend(gui)
 
         return gui, backend
 
     # Fallback to previous behaviour (Matplotlib < 3.9)
     mpl_version_info = getattr(matplotlib, "__version_info__", (0, 0))
     has_unified_qt_backend = mpl_version_info >= (3, 5)
 
     from IPython.core.pylabtools import backends
 
     backends_ = dict(backends)
     if not has_unified_qt_backend:
         backends_["qt"] = "qt5agg"
 
     if gui and gui != 'auto':
         # select backend based on requested gui
         backend = backends_[gui]
         if gui == 'agg':
             gui = None
     else:
         # We need to read the backend from the original data structure, *not*
         # from mpl.rcParams, since a prior invocation of %matplotlib may have
         # overwritten that.
         # WARNING: this assumes matplotlib 1.1 or newer!!
         backend = matplotlib.rcParamsOrig['backend']
         # In this case, we need to find what the appropriate gui selection call
         # should be for IPython, so we can activate inputhook accordingly
         from IPython.core.pylabtools import backend2gui
         gui = backend2gui.get(backend, None)
 
         # If we have already had a gui active, we need it and inline are the
         # ones allowed.
         if gui_select and gui != gui_select:
             gui = gui_select
             backend = backends_[gui]
 
     # Matplotlib before _matplotlib_manages_backends() can return "inline" for
     # no gui event loop rather than the None that IPython >= 8.24.0 expects.
     if gui == "inline":
         gui = None
 
     return gui, backend
 
 
 def activate_matplotlib(backend):
     """Activate the given backend and set interactive to True."""
 
     import matplotlib
     matplotlib.interactive(True)
 
     # Matplotlib had a bug where even switch_backend could not force
     # the rcParam to update. This needs to be set *before* the module
     # magic of switch_backend().
     matplotlib.rcParams['backend'] = backend
 
     # Due to circular imports, pyplot may be only partially initialised
     # when this function runs.
     # So avoid needing matplotlib attribute-lookup to access pyplot.
     from matplotlib import pyplot as plt
 
     plt.switch_backend(backend)
 
     plt.show._needmain = False
     # We need to detect at runtime whether show() is called by the user.
     # For this, we wrap it into a decorator which adds a 'called' flag.
     plt.draw_if_interactive = flag_calls(plt.draw_if_interactive)
 
 
 def import_pylab(user_ns, import_all=True):
     """Populate the namespace with pylab-related values.
 
     Imports matplotlib, pylab, numpy, and everything from pylab and numpy.
 
     Also imports a few names from IPython (figsize, display, getfigs)
 
     """
 
     # Import numpy as np/pyplot as plt are conventions we're trying to
     # somewhat standardize on.  Making them available to users by default
     # will greatly help this.
     s = ("import numpy\n"
           "import matplotlib\n"
           "from matplotlib import pylab, mlab, pyplot\n"
           "np = numpy\n"
           "plt = pyplot\n"
           )
     exec(s, user_ns)
 
     if import_all:
         s = ("from matplotlib.pylab import *\n"
              "from numpy import *\n")
         exec(s, user_ns)
 
     # IPython symbols to add
     user_ns['figsize'] = figsize
     from IPython.display import display
     # Add display and getfigs to the user's namespace
     user_ns['display'] = display
     user_ns['getfigs'] = getfigs
 
 
 def configure_inline_support(shell, backend):
     """
     .. deprecated:: 7.23
 
         use `matplotlib_inline.backend_inline.configure_inline_support()`
 
     Configure an IPython shell object for matplotlib use.
 
     Parameters
     ----------
     shell : InteractiveShell instance
     backend : matplotlib backend
     """
     warnings.warn(
         "`configure_inline_support` is deprecated since IPython 7.23, directly "
         "use `matplotlib_inline.backend_inline.configure_inline_support()`",
         DeprecationWarning,
         stacklevel=2,
     )
 
     from matplotlib_inline.backend_inline import (
         configure_inline_support as configure_inline_support_orig,
     )
 
     configure_inline_support_orig(shell, backend)
 
 
 # Determine if Matplotlib manages backends only if needed, and cache result.
 # Do not read this directly, instead use _matplotlib_manages_backends().
 _matplotlib_manages_backends_value: bool | None = None
 
 
 def _matplotlib_manages_backends() -> bool:
     """Return True if Matplotlib manages backends, False otherwise.
 
     If it returns True, the caller can be sure that
     matplotlib.backends.registry.backend_registry is available along with
     member functions resolve_gui_or_backend, resolve_backend, list_all, and
     list_gui_frameworks.
+
+    This function can be removed as it will always return True when Python
+    3.12, the latest version supported by Matplotlib < 3.9, reaches
+    end-of-life in late 2028.
     """
     global _matplotlib_manages_backends_value
     if _matplotlib_manages_backends_value is None:
         try:
             from matplotlib.backends.registry import backend_registry
 
             _matplotlib_manages_backends_value = hasattr(
                 backend_registry, "resolve_gui_or_backend"
             )
         except ImportError:
             _matplotlib_manages_backends_value = False
 
     return _matplotlib_manages_backends_value
 
 
 def _list_matplotlib_backends_and_gui_loops() -> list[str]:
     """Return list of all Matplotlib backends and GUI event loops.
 
     This is the list returned by
         %matplotlib --list
     """
     if _matplotlib_manages_backends():
         from matplotlib.backends.registry import backend_registry
 
         ret = backend_registry.list_all() + backend_registry.list_gui_frameworks()
     else:
         from IPython.core import pylabtools
 
         ret = list(pylabtools.backends.keys())
 
     return sorted(["auto"] + ret)

IPython/core/shellapp.py

@@ -1,491 +1,495 b''
 # encoding: utf-8
 """
 A mixin for :class:`~IPython.core.application.Application` classes that
 launch InteractiveShell instances, load extensions, etc.
 """
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import glob
 from itertools import chain
 import os
 import sys
 import typing as t
 
 from traitlets.config.application import boolean_flag
 from traitlets.config.configurable import Configurable
 from traitlets.config.loader import Config
 from IPython.core.application import SYSTEM_CONFIG_DIRS, ENV_CONFIG_DIRS
 from IPython.utils.contexts import preserve_keys
 from IPython.utils.path import filefind
 from traitlets import (
     Unicode,
     Instance,
     List,
     Bool,
     CaselessStrEnum,
     observe,
     DottedObjectName,
     Undefined,
 )
 from IPython.terminal import pt_inputhooks
 
 # -----------------------------------------------------------------------------
 # Aliases and Flags
 # -----------------------------------------------------------------------------
 
 gui_keys = tuple(sorted(pt_inputhooks.backends) + sorted(pt_inputhooks.aliases))
 
 shell_flags = {}
 
 addflag = lambda *args: shell_flags.update(boolean_flag(*args))
 addflag(
     "autoindent",
     "InteractiveShell.autoindent",
     "Turn on autoindenting.",
     "Turn off autoindenting.",
 )
 addflag(
     "automagic",
     "InteractiveShell.automagic",
     """Turn on the auto calling of magic commands. Type %%magic at the
         IPython  prompt  for  more information.""",
         'Turn off the auto calling of magic commands.'
 )
 addflag('pdb', 'InteractiveShell.pdb',
     "Enable auto calling the pdb debugger after every exception.",
     "Disable auto calling the pdb debugger after every exception."
 )
 addflag('pprint', 'PlainTextFormatter.pprint',
     "Enable auto pretty printing of results.",
     "Disable auto pretty printing of results."
 )
 addflag('color-info', 'InteractiveShell.color_info',
     """IPython can display information about objects via a set of functions,
     and optionally can use colors for this, syntax highlighting
     source code and various other elements. This is on by default, but can cause
     problems with some pagers. If you see such problems, you can disable the
     colours.""",
     "Disable using colors for info related things."
 )
 addflag('ignore-cwd', 'InteractiveShellApp.ignore_cwd',
         "Exclude the current working directory from sys.path",
         "Include the current working directory in sys.path",
 )
 nosep_config = Config()
 nosep_config.InteractiveShell.separate_in = ''
 nosep_config.InteractiveShell.separate_out = ''
 nosep_config.InteractiveShell.separate_out2 = ''
 
 shell_flags['nosep']=(nosep_config, "Eliminate all spacing between prompts.")
 shell_flags['pylab'] = (
     {'InteractiveShellApp' : {'pylab' : 'auto'}},
     """Pre-load matplotlib and numpy for interactive use with
-    the default matplotlib backend."""
+    the default matplotlib backend. The exact options available
+    depend on what Matplotlib provides at runtime.""",
 )
 shell_flags['matplotlib'] = (
     {'InteractiveShellApp' : {'matplotlib' : 'auto'}},
     """Configure matplotlib for interactive use with
-    the default matplotlib backend."""
+    the default matplotlib backend. The exact options available
+    depend on what Matplotlib provides at runtime.""",
 )
 
 # it's possible we don't want short aliases for *all* of these:
 shell_aliases = dict(
     autocall='InteractiveShell.autocall',
     colors='InteractiveShell.colors',
     logfile='InteractiveShell.logfile',
     logappend='InteractiveShell.logappend',
     c='InteractiveShellApp.code_to_run',
     m='InteractiveShellApp.module_to_run',
     ext="InteractiveShellApp.extra_extensions",
     gui='InteractiveShellApp.gui',
     pylab='InteractiveShellApp.pylab',
     matplotlib='InteractiveShellApp.matplotlib',
 )
 shell_aliases['cache-size'] = 'InteractiveShell.cache_size'
 
 
 # -----------------------------------------------------------------------------
 # Traitlets
 # -----------------------------------------------------------------------------
 
 
 class MatplotlibBackendCaselessStrEnum(CaselessStrEnum):
     """An enum of Matplotlib backend strings where the case should be ignored.
 
-    Prior to Matplotlib 3.9.1 the list of valid backends is hardcoded in
+    Prior to Matplotlib 3.9.0 the list of valid backends is hardcoded in
     pylabtools.backends. After that, Matplotlib manages backends.
 
     The list of valid backends is determined when it is first needed to avoid
     wasting unnecessary initialisation time.
     """
 
     def __init__(
         self: CaselessStrEnum[t.Any],
         default_value: t.Any = Undefined,
         **kwargs: t.Any,
     ) -> None:
         super().__init__(None, default_value=default_value, **kwargs)
 
     def __getattribute__(self, name):
         if name == "values" and object.__getattribute__(self, name) is None:
             from IPython.core.pylabtools import _list_matplotlib_backends_and_gui_loops
 
             self.values = _list_matplotlib_backends_and_gui_loops()
         return object.__getattribute__(self, name)
 
 
 #-----------------------------------------------------------------------------
 # Main classes and functions
 #-----------------------------------------------------------------------------
 
 class InteractiveShellApp(Configurable):
     """A Mixin for applications that start InteractiveShell instances.
 
     Provides configurables for loading extensions and executing files
     as part of configuring a Shell environment.
 
     The following methods should be called by the :meth:`initialize` method
     of the subclass:
 
       - :meth:`init_path`
       - :meth:`init_shell` (to be implemented by the subclass)
       - :meth:`init_gui_pylab`
       - :meth:`init_extensions`
       - :meth:`init_code`
     """
     extensions = List(Unicode(),
         help="A list of dotted module names of IPython extensions to load."
     ).tag(config=True)
 
     extra_extensions = List(
         DottedObjectName(),
         help="""
         Dotted module name(s) of one or more IPython extensions to load.
 
         For specifying extra extensions to load on the command-line.
 
         .. versionadded:: 7.10
         """,
     ).tag(config=True)
 
     reraise_ipython_extension_failures = Bool(False,
         help="Reraise exceptions encountered loading IPython extensions?",
     ).tag(config=True)
 
     # Extensions that are always loaded (not configurable)
     default_extensions = List(Unicode(), [u'storemagic']).tag(config=False)
 
     hide_initial_ns = Bool(True,
         help="""Should variables loaded at startup (by startup files, exec_lines, etc.)
         be hidden from tools like %who?"""
     ).tag(config=True)
 
     exec_files = List(Unicode(),
         help="""List of files to run at IPython startup."""
     ).tag(config=True)
     exec_PYTHONSTARTUP = Bool(True,
         help="""Run the file referenced by the PYTHONSTARTUP environment
         variable at IPython startup."""
     ).tag(config=True)
     file_to_run = Unicode('',
         help="""A file to be run""").tag(config=True)
 
     exec_lines = List(Unicode(),
         help="""lines of code to run at IPython startup."""
     ).tag(config=True)
     code_to_run = Unicode("", help="Execute the given command string.").tag(config=True)
     module_to_run = Unicode("", help="Run the module as a script.").tag(config=True)
     gui = CaselessStrEnum(
         gui_keys,
         allow_none=True,
         help="Enable GUI event loop integration with any of {0}.".format(gui_keys),
     ).tag(config=True)
     matplotlib = MatplotlibBackendCaselessStrEnum(
         allow_none=True,
         help="""Configure matplotlib for interactive use with
-        the default matplotlib backend.""",
+        the default matplotlib backend. The exact options available
+        depend on what Matplotlib provides at runtime.""",
     ).tag(config=True)
     pylab = MatplotlibBackendCaselessStrEnum(
         allow_none=True,
         help="""Pre-load matplotlib and numpy for interactive use,
         selecting a particular matplotlib backend and loop integration.
+        The exact options available depend on what Matplotlib provides at runtime.
         """,
     ).tag(config=True)
     pylab_import_all = Bool(
         True,
         help="""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.
 
         When False, pylab mode should not import any names into the user namespace.
         """,
     ).tag(config=True)
     ignore_cwd = Bool(
         False,
         help="""If True, IPython will not add the current working directory to sys.path.
         When False, the current working directory is added to sys.path, allowing imports
         of modules defined in the current directory."""
     ).tag(config=True)
     shell = Instance('IPython.core.interactiveshell.InteractiveShellABC',
                      allow_none=True)
     # whether interact-loop should start
     interact = Bool(True)
 
     user_ns = Instance(dict, args=None, allow_none=True)
     @observe('user_ns')
     def _user_ns_changed(self, change):
         if self.shell is not None:
             self.shell.user_ns = change['new']
             self.shell.init_user_ns()
 
     def init_path(self):
         """Add current working directory, '', to sys.path
 
         Unlike Python's default, we insert before the first `site-packages`
         or `dist-packages` directory,
         so that it is after the standard library.
 
         .. versionchanged:: 7.2
             Try to insert after the standard library, instead of first.
         .. versionchanged:: 8.0
             Allow optionally not including the current directory in sys.path
         """
         if '' in sys.path or self.ignore_cwd:
             return
         for idx, path in enumerate(sys.path):
             parent, last_part = os.path.split(path)
             if last_part in {'site-packages', 'dist-packages'}:
                 break
         else:
             # no site-packages or dist-packages found (?!)
             # back to original behavior of inserting at the front
             idx = 0
         sys.path.insert(idx, '')
 
     def init_shell(self):
         raise NotImplementedError("Override in subclasses")
 
     def init_gui_pylab(self):
         """Enable GUI event loop integration, taking pylab into account."""
         enable = False
         shell = self.shell
         if self.pylab:
             enable = lambda key: shell.enable_pylab(key, import_all=self.pylab_import_all)
             key = self.pylab
         elif self.matplotlib:
             enable = shell.enable_matplotlib
             key = self.matplotlib
         elif self.gui:
             enable = shell.enable_gui
             key = self.gui
 
         if not enable:
             return
 
         try:
             r = enable(key)
         except ImportError:
             self.log.warning("Eventloop or matplotlib integration failed. Is matplotlib installed?")
             self.shell.showtraceback()
             return
         except Exception:
             self.log.warning("GUI event loop or pylab initialization failed")
             self.shell.showtraceback()
             return
 
         if isinstance(r, tuple):
             gui, backend = r[:2]
             self.log.info("Enabling GUI event loop integration, "
                       "eventloop=%s, matplotlib=%s", gui, backend)
             if key == "auto":
                 print("Using matplotlib backend: %s" % backend)
         else:
             gui = r
             self.log.info("Enabling GUI event loop integration, "
                       "eventloop=%s", gui)
 
     def init_extensions(self):
         """Load all IPython extensions in IPythonApp.extensions.
 
         This uses the :meth:`ExtensionManager.load_extensions` to load all
         the extensions listed in ``self.extensions``.
         """
         try:
             self.log.debug("Loading IPython extensions...")
             extensions = (
                 self.default_extensions + self.extensions + self.extra_extensions
             )
             for ext in extensions:
                 try:
                     self.log.info("Loading IPython extension: %s", ext)
                     self.shell.extension_manager.load_extension(ext)
                 except:
                     if self.reraise_ipython_extension_failures:
                         raise
                     msg = ("Error in loading extension: {ext}\n"
                            "Check your config files in {location}".format(
                                ext=ext,
                                location=self.profile_dir.location
                            ))
                     self.log.warning(msg, exc_info=True)
         except:
             if self.reraise_ipython_extension_failures:
                 raise
             self.log.warning("Unknown error in loading extensions:", exc_info=True)
 
     def init_code(self):
         """run the pre-flight code, specified via exec_lines"""
         self._run_startup_files()
         self._run_exec_lines()
         self._run_exec_files()
 
         # Hide variables defined here from %who etc.
         if self.hide_initial_ns:
             self.shell.user_ns_hidden.update(self.shell.user_ns)
 
         # command-line execution (ipython -i script.py, ipython -m module)
         # should *not* be excluded from %whos
         self._run_cmd_line_code()
         self._run_module()
 
         # flush output, so itwon't be attached to the first cell
         sys.stdout.flush()
         sys.stderr.flush()
         self.shell._sys_modules_keys = set(sys.modules.keys())
 
     def _run_exec_lines(self):
         """Run lines of code in IPythonApp.exec_lines in the user's namespace."""
         if not self.exec_lines:
             return
         try:
             self.log.debug("Running code from IPythonApp.exec_lines...")
             for line in self.exec_lines:
                 try:
                     self.log.info("Running code in user namespace: %s" %
                                   line)
                     self.shell.run_cell(line, store_history=False)
                 except:
                     self.log.warning("Error in executing line in user "
                                   "namespace: %s" % line)
                     self.shell.showtraceback()
         except:
             self.log.warning("Unknown error in handling IPythonApp.exec_lines:")
             self.shell.showtraceback()
 
     def _exec_file(self, fname, shell_futures=False):
         try:
             full_filename = filefind(fname, [u'.', self.ipython_dir])
         except IOError:
             self.log.warning("File not found: %r"%fname)
             return
         # Make sure that the running script gets a proper sys.argv as if it
         # were run from a system shell.
         save_argv = sys.argv
         sys.argv = [full_filename] + self.extra_args[1:]
         try:
             if os.path.isfile(full_filename):
                 self.log.info("Running file in user namespace: %s" %
                               full_filename)
                 # Ensure that __file__ is always defined to match Python
                 # behavior.
                 with preserve_keys(self.shell.user_ns, '__file__'):
                     self.shell.user_ns['__file__'] = fname
                     if full_filename.endswith('.ipy') or full_filename.endswith('.ipynb'):
                         self.shell.safe_execfile_ipy(full_filename,
                                                      shell_futures=shell_futures)
                     else:
                         # default to python, even without extension
                         self.shell.safe_execfile(full_filename,
                                                  self.shell.user_ns,
                                                  shell_futures=shell_futures,
                                                  raise_exceptions=True)
         finally:
             sys.argv = save_argv
 
     def _run_startup_files(self):
         """Run files from profile startup directory"""
         startup_dirs = [self.profile_dir.startup_dir] + [
             os.path.join(p, 'startup') for p in chain(ENV_CONFIG_DIRS, SYSTEM_CONFIG_DIRS)
         ]
         startup_files = []
 
         if self.exec_PYTHONSTARTUP and os.environ.get('PYTHONSTARTUP', False) and \
                 not (self.file_to_run or self.code_to_run or self.module_to_run):
             python_startup = os.environ['PYTHONSTARTUP']
             self.log.debug("Running PYTHONSTARTUP file %s...", python_startup)
             try:
                 self._exec_file(python_startup)
             except:
                 self.log.warning("Unknown error in handling PYTHONSTARTUP file %s:", python_startup)
                 self.shell.showtraceback()
         for startup_dir in startup_dirs[::-1]:
             startup_files += glob.glob(os.path.join(startup_dir, '*.py'))
             startup_files += glob.glob(os.path.join(startup_dir, '*.ipy'))
         if not startup_files:
             return
 
         self.log.debug("Running startup files from %s...", startup_dir)
         try:
             for fname in sorted(startup_files):
                 self._exec_file(fname)
         except:
             self.log.warning("Unknown error in handling startup files:")
             self.shell.showtraceback()
 
     def _run_exec_files(self):
         """Run files from IPythonApp.exec_files"""
         if not self.exec_files:
             return
 
         self.log.debug("Running files in IPythonApp.exec_files...")
         try:
             for fname in self.exec_files:
                 self._exec_file(fname)
         except:
             self.log.warning("Unknown error in handling IPythonApp.exec_files:")
             self.shell.showtraceback()
 
     def _run_cmd_line_code(self):
         """Run code or file specified at the command-line"""
         if self.code_to_run:
             line = self.code_to_run
             try:
                 self.log.info("Running code given at command line (c=): %s" %
                               line)
                 self.shell.run_cell(line, store_history=False)
             except:
                 self.log.warning("Error in executing line in user namespace: %s" %
                               line)
                 self.shell.showtraceback()
                 if not self.interact:
                     self.exit(1)
 
         # Like Python itself, ignore the second if the first of these is present
         elif self.file_to_run:
             fname = self.file_to_run
             if os.path.isdir(fname):
                 fname = os.path.join(fname, "__main__.py")
             if not os.path.exists(fname):
                 self.log.warning("File '%s' doesn't exist", fname)
                 if not self.interact:
                     self.exit(2)
             try:
                 self._exec_file(fname, shell_futures=True)
             except:
                 self.shell.showtraceback(tb_offset=4)
                 if not self.interact:
                     self.exit(1)
 
     def _run_module(self):
         """Run module specified at the command-line."""
         if self.module_to_run:
             # Make sure that the module gets a proper sys.argv as if it were
             # run using `python -m`.
             save_argv = sys.argv
             sys.argv = [sys.executable] + self.extra_args
             try:
                 self.shell.safe_run_module(self.module_to_run,
                                            self.shell.user_ns)
             finally:
                 sys.argv = save_argv

docs/source/interactive/plotting.rst

@@ -1,67 +1,81 b''
 .. _plotting:
 
 Rich Outputs
 ------------
 
 One of the main feature of IPython when used as a kernel is its ability to
 show rich output. This means that object that can be representing as image,
 sounds, animation, (etc...) can be shown this way if the frontend support it.
 
 In order for this to be possible, you need to use the ``display()`` function,
 that should be available by default on IPython 5.4+ and 6.1+, or that you can
 import with ``from IPython.display import display``. Then use ``display(<your
 object>)`` instead of ``print()``, and if possible your object will be displayed
 with a richer representation. In the terminal of course, there won't be much
 difference as object are most of the time represented by text, but in notebook
 and similar interface you will get richer outputs.
 
 
+.. _matplotlib_magic:
+
 Plotting
 --------
 
 .. note::
 
     Starting with IPython 5.0 and matplotlib 2.0 you can avoid the use of
     IPython's specific magic and use
     ``matplotlib.pyplot.ion()``/``matplotlib.pyplot.ioff()`` which have the
     advantages of working outside of IPython as well.
 
 
-One major feature of the IPython kernel is the ability to display plots that 
-are the output of running code cells. The IPython kernel is designed to work 
+One major feature of the IPython kernel is the ability to display plots that
+are the output of running code cells. The IPython kernel is designed to work
 seamlessly with the matplotlib_ plotting library to provide this functionality.
 
 To set this up, before any plotting or import of matplotlib is performed you
-must execute the ``%matplotlib``  :ref:`magic command <magics_explained>`. This
+may execute the ``%matplotlib`` :ref:`magic command <magics_explained>`. This
 performs the necessary behind-the-scenes setup for IPython to work correctly
 hand in hand with ``matplotlib``; it does *not*, however, actually execute any
 Python ``import`` commands, that is, no names are added to the namespace.
 
-If the ``%matplotlib`` magic is called without an argument, the
-output of a plotting command is displayed using the default ``matplotlib``
-backend in a separate window. Alternatively, the backend can be explicitly
-requested using, for example::
+If you do not use the ``%matplotlib`` magic or you call it without an argument,
+the output of a plotting command is displayed using the default ``matplotlib``
+backend, which may be different depending on Operating System and whether
+running within Jupyter or not.
+
+Alternatively, the backend can be explicitly requested using, for example::
 
   %matplotlib gtk
 
-A particularly interesting backend, provided by IPython, is the ``inline``
-backend.  This is available only for the Jupyter Notebook and the
-Jupyter QtConsole.  It can be invoked as follows::
+The argument passed to the ``%matplotlib`` magic command may be the name of any
+backend understood by ``matplotlib`` or it may the name of a GUI loop such as
+``qt`` or ``osx``, in which case an appropriate backend supporting that GUI
+loop will be selected. To obtain a full list of all backends and GUI loops
+understood by ``matplotlib`` use ``%matplotlib --list``.
 
-  %matplotlib inline
+There are some specific backends that are used in the Jupyter ecosystem:
 
-With this backend, the output of plotting commands is displayed *inline* within
-frontends like the Jupyter notebook, directly below the code cell that produced
-it. The resulting plots will then also be stored in the notebook document.
+- The ``inline`` backend is provided by IPython and can be used in Jupyter Lab,
+  Notebook and QtConsole; it is the default backend when using Jupyter. The
+  outputs of plotting commands are displayed *inline* within frontends like
+  Jupyter Notebook, directly below the code cells that produced them.
+  The resulting plots will then also be stored in the notebook document.
 
-.. seealso::
+- The ``notebook`` or ``nbagg`` backend is built into ``matplotlib`` and can be
+  used with Jupyter ``notebook <7`` and ``nbclassic``. Plots are interactive so
+  they can be zoomed and panned.
 
-    `Plotting with Matplotlib`_  example notebook
+- The ``ipympl`` or ``widget`` backend is for use with Jupyter ``lab`` and
+  ``notebook >=7``. It is in a separate ``ipympl`` module that must be
+  installed using ``pip`` or ``conda`` in the usual manner. Plots are
+  interactive so they can be zoomed and panned.
 
+.. seealso::
 
-The matplotlib_ library also ships with ``%matplotlib notebook`` command that
-allows interactive figures if your environment allows it.
+    `Plotting with Matplotlib`_  example notebook
 
-See the matplotlib_ documentation for more information. 
+See the matplotlib_ documentation for more information, in particular the
+section on backends.
 
 .. include:: ../links.txt

docs/source/interactive/reference.rst

@@ -1,1037 +1,1017 b''
 =================
 IPython reference
 =================
 
 .. _command_line_options:
 
 Command-line usage
 ==================
 
 You start IPython with the command::
 
     $ ipython [options] files
 
 If invoked with no options, it executes the file and exits, passing the
 remaining arguments to the script, just as if you had specified the same
 command with python. You may need to specify `--` before args to be passed
 to the script, to prevent IPython from attempting to parse them.
 If you add the ``-i`` flag, it drops you into the interpreter while still
 acknowledging any options you may have set in your ``ipython_config.py``. This
 behavior is different from standard Python, which when called as python ``-i``
 will only execute one file and ignore your configuration setup.
 
 Please note that some of the configuration options are not available at the
 command line, simply because they are not practical here. Look into your
 configuration files for details on those. There are separate configuration files
 for each profile, and the files look like :file:`ipython_config.py` or
 :file:`ipython_config_{frontendname}.py`.  Profile directories look like
 :file:`profile_{profilename}` and are typically installed in the
 :envvar:`IPYTHONDIR` directory, which defaults to :file:`$HOME/.ipython`. For
 Windows users, :envvar:`HOME` resolves to :file:`C:\\Users\\{YourUserName}` in
 most instances.
 
 Command-line Options
 --------------------
 
 To see the options IPython accepts, use ``ipython --help`` (and you probably
 should run the output through a pager such as ``ipython --help | less`` for
 more convenient reading).  This shows all the options that have a single-word
 alias to control them, but IPython lets you configure all of its objects from
 the command-line by passing the full class name and a corresponding value; type
 ``ipython --help-all`` to see this full list.  For example::
 
     $ ipython --help-all
     <...snip...>
     --matplotlib=<CaselessStrEnum> (InteractiveShellApp.matplotlib)
         Default: None
-        Choices: ['auto', 'gtk', 'gtk3', 'gtk4', 'inline', 'nbagg', 'notebook', 'osx', 'qt', 'qt5', 'qt6', 'tk', 'wx']
+        Choices: ['auto', 'gtk3', 'gtk4', 'inline', 'nbagg', 'notebook', 'osx', 'qt', 'qt5', 'qt6', 'tk', 'wx']
         Configure matplotlib for interactive use with the default matplotlib
         backend.
     <...snip...>
 
 
 Indicate that the following::
 
    $ ipython --matplotlib qt
 
 
 is equivalent to::
 
    $ ipython --InteractiveShellApp.matplotlib='qt'
 
 Note that in the second form, you *must* use the equal sign, as the expression
 is evaluated as an actual Python assignment.  While in the above example the
 short form is more convenient, only the most common options have a short form,
 while any configurable variable in IPython can be set at the command-line by
 using the long form.  This long form is the same syntax used in the
 configuration files, if you want to set these options permanently.
 
 
 Interactive use
 ===============
 
 IPython is meant to work as a drop-in replacement for the standard interactive
 interpreter. As such, any code which is valid python should execute normally
 under IPython (cases where this is not true should be reported as bugs). It
 does, however, offer many features which are not available at a standard python
 prompt. What follows is a list of these.
 
 
 Caution for Windows users
 -------------------------
 
 Windows, unfortunately, uses the ``\`` character as a path separator. This is a
 terrible choice, because ``\`` also represents the escape character in most
 modern programming languages, including Python. For this reason, using '/'
 character is recommended if you have problems with ``\``.  However, in Windows
 commands '/' flags options, so you can not use it for the root directory. This
 means that paths beginning at the root must be typed in a contrived manner
 like: ``%copy \opt/foo/bar.txt \tmp``
 
 .. _magic:
 
 Magic command system
 --------------------
 
 IPython will treat any line whose first character is a % as a special
 call to a 'magic' function. These allow you to control the behavior of
 IPython itself, plus a lot of system-type features. They are all
 prefixed with a % character, but parameters are given without
 parentheses or quotes.
 
 Lines that begin with ``%%`` signal a *cell magic*: they take as arguments not
 only the rest of the current line, but all lines below them as well, in the
 current execution block.  Cell magics can in fact make arbitrary modifications
 to the input they receive, which need not even be valid Python code at all.
 They receive the whole block as a single string.
 
 As a line magic example, the :magic:`cd` magic works just like the OS command of
 the same name::
 
       In [8]: %cd
       /home/fperez
 
 The following uses the builtin :magic:`timeit` in cell mode::
 
   In [10]: %%timeit x = range(10000)
       ...: min(x)
       ...: max(x)
       ...:
   518 µs ± 4.39 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each)
 
 In this case, ``x = range(10000)`` is called as the line argument, and the
 block with ``min(x)`` and ``max(x)`` is called as the cell body.  The
 :magic:`timeit` magic receives both.
 
 If you have 'automagic' enabled (as it is by default), you don't need to type in
 the single ``%`` explicitly for line magics; IPython will scan its internal
 list of magic functions and call one if it exists. With automagic on you can
 then just type ``cd mydir`` to go to directory 'mydir'::
 
       In [9]: cd mydir
       /home/fperez/mydir
 
 Cell magics *always* require an explicit ``%%`` prefix, automagic
 calling only works for line magics.
 
 The automagic system has the lowest possible precedence in name searches, so
 you can freely use variables with the same names as magic commands. If a magic
 command is 'shadowed' by a variable, you will need the explicit ``%`` prefix to
 use it:
 
 .. sourcecode:: ipython
 
     In [1]: cd ipython     # %cd is called by automagic
     /home/fperez/ipython
 
     In [2]: cd=1 	   # now cd is just a variable
 
     In [3]: cd .. 	   # and doesn't work as a function anymore
     File "<ipython-input-3-9fedb3aff56c>", line 1
       cd ..
           ^
     SyntaxError: invalid syntax
 
 
     In [4]: %cd .. 	   # but %cd always works
     /home/fperez
 
     In [5]: del cd     # if you remove the cd variable, automagic works again
 
     In [6]: cd ipython
 
     /home/fperez/ipython
 
 Line magics, if they return a value, can be assigned to a variable using the
 syntax ``l = %sx ls`` (which in this particular case returns the result of `ls`
 as a python list). See :ref:`below <manual_capture>` for more information.
 
 Type ``%magic`` for more information, including a list of all available magic
 functions at any time and their docstrings. You can also type
 ``%magic_function_name?`` (see :ref:`below <dynamic_object_info>` for
 information on the '?' system) to get information about any particular magic
 function you are interested in.
 
 The API documentation for the :mod:`IPython.core.magic` module contains the full
 docstrings of all currently available magic commands.
 
 .. seealso::
 
    :doc:`magics`
      A list of the line and cell magics available in IPython by default
 
    :ref:`defining_magics`
      How to define and register additional magic functions
 
 
 Access to the standard Python help
 ----------------------------------
 
 Simply type ``help()`` to access Python's standard help system. You can
 also type ``help(object)`` for information about a given object, or
 ``help('keyword')`` for information on a keyword. You may need to configure your
 PYTHONDOCS environment variable for this feature to work correctly.
 
 .. _dynamic_object_info:
 
 Dynamic object information
 --------------------------
 
 Typing ``?word`` or ``word?`` prints detailed information about an object. If
 certain strings in the object are too long (e.g. function signatures) they get
 snipped in the center for brevity. This system gives access variable types and
 values, docstrings, function prototypes and other useful information.
 
 If the information will not fit in the terminal, it is displayed in a pager
 (``less`` if available, otherwise a basic internal pager).
 
 Typing ``??word`` or ``word??`` gives access to the full information, including
 the source code where possible. Long strings are not snipped.
 
 The following magic functions are particularly useful for gathering
 information about your working environment:
 
     * :magic:`pdoc` **<object>**: Print (or run through a pager if too long) the
       docstring for an object. If the given object is a class, it will
       print both the class and the constructor docstrings.
     * :magic:`pdef` **<object>**: Print the call signature for any callable
       object. If the object is a class, print the constructor information.
     * :magic:`psource` **<object>**: Print (or run through a pager if too long)
       the source code for an object.
     * :magic:`pfile` **<object>**: Show the entire source file where an object was
       defined via a pager, opening it at the line where the object
       definition begins.
     * :magic:`who`/:magic:`whos`: These functions give information about identifiers
       you have defined interactively (not things you loaded or defined
       in your configuration files). %who just prints a list of
       identifiers and %whos prints a table with some basic details about
       each identifier.
 
 The dynamic object information functions (?/??, ``%pdoc``,
 ``%pfile``, ``%pdef``, ``%psource``) work on object attributes, as well as
 directly on variables. For example, after doing ``import os``, you can use
 ``os.path.abspath??``.
 
 
 Command line completion
 +++++++++++++++++++++++
 
 At any time, hitting TAB will complete any available python commands or
 variable names, and show you a list of the possible completions if
 there's no unambiguous one. It will also complete filenames in the
 current directory if no python names match what you've typed so far.
 
 
 Search command history
 ++++++++++++++++++++++
 
 IPython provides two ways for searching through previous input and thus
 reduce the need for repetitive typing:
 
    1. Start typing, and then use the up and down arrow keys (or :kbd:`Ctrl-p`
       and :kbd:`Ctrl-n`) to search through only the history items that match
       what you've typed so far.
    2. Hit :kbd:`Ctrl-r`: to open a search prompt. Begin typing and the system
       searches your history for lines that contain what you've typed so
       far, completing as much as it can.
 
 IPython will save your input history when it leaves and reload it next
 time you restart it. By default, the history file is named
 :file:`.ipython/profile_{name}/history.sqlite`.
 
 Autoindent
 ++++++++++
 
 Starting with 5.0, IPython uses `prompt_toolkit` in place of ``readline``,
 it thus can recognize lines ending in ':' and indent the next line,
 while also un-indenting automatically after 'raise' or 'return',
 and support real multi-line editing as well as syntactic coloration
 during edition.
 
 This feature does not use the ``readline`` library anymore, so it will
 not honor your :file:`~/.inputrc` configuration (or whatever
 file your :envvar:`INPUTRC` environment variable points to).
 
 In particular if you want to change the input mode to ``vi``, you will need to
 set the ``TerminalInteractiveShell.editing_mode`` configuration  option of IPython.
 
 Session logging and restoring
 -----------------------------
 
 You can log all input from a session either by starting IPython with the
 command line switch ``--logfile=foo.py`` (see :ref:`here <command_line_options>`)
 or by activating the logging at any moment with the magic function :magic:`logstart`.
 
 Log files can later be reloaded by running them as scripts and IPython
 will attempt to 'replay' the log by executing all the lines in it, thus
 restoring the state of a previous session. This feature is not quite
 perfect, but can still be useful in many cases.
 
 The log files can also be used as a way to have a permanent record of
 any code you wrote while experimenting. Log files are regular text files
 which you can later open in your favorite text editor to extract code or
 to 'clean them up' before using them to replay a session.
 
 The :magic:`logstart` function for activating logging in mid-session is used as
 follows::
 
     %logstart [log_name [log_mode]]
 
 If no name is given, it defaults to a file named 'ipython_log.py' in your
 current working directory, in 'rotate' mode (see below).
 
 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
 history up to that point and then continues logging.
 
 %logstart takes a second optional parameter: logging mode. This can be
 one of (note that the modes are given unquoted):
 
     * [over:] overwrite existing log_name.
     * [backup:] rename (if exists) to log_name~ and start log_name.
     * [append:] well, that says it.
     * [rotate:] create rotating logs log_name.1~, log_name.2~, etc.
 
 Adding the '-o' flag to '%logstart' magic (as in '%logstart -o [log_name [log_mode]]')
 will also include output from iPython in the log file.
 
 The :magic:`logoff` and :magic:`logon` functions allow you to temporarily stop and
 resume logging to a file which had previously been started with
 %logstart. They will fail (with an explanation) if you try to use them
 before logging has been started.
 
 .. _system_shell_access:
 
 System shell access
 -------------------
 
 Any input line beginning with a ``!`` character is passed verbatim (minus
 the ``!``, of course) to the underlying operating system. For example,
 typing ``!ls`` will run 'ls' in the current directory.
 
 .. _manual_capture:
 
 Manual capture of command output and magic output
 -------------------------------------------------
 
 You can assign the result of a system command to a Python variable with the
 syntax ``myfiles = !ls``. Similarly, the result of a magic (as long as it returns
 a value) can be assigned to a variable.  For example, the syntax ``myfiles = %sx ls``
 is equivalent to the above system command example (the :magic:`sx` magic runs a shell command
 and captures the output).  Each of these gets machine
 readable output from stdout (e.g. without colours), and splits on newlines. To
 explicitly get this sort of output without assigning to a variable, use two
 exclamation marks (``!!ls``) or the :magic:`sx` magic command without an assignment.
 (However, ``!!`` commands cannot be assigned to a variable.)
 
 The captured list in this example has some convenience features. ``myfiles.n`` or ``myfiles.s``
 returns a string delimited by newlines or spaces, respectively. ``myfiles.p``
 produces `path objects <http://pypi.python.org/pypi/path.py>`_ from the list items.
 See :ref:`string_lists` for details.
 
 IPython also allows you to expand the value of python variables when
 making system calls. Wrap variables or expressions in {braces}::
 
     In [1]: pyvar = 'Hello world'
     In [2]: !echo "A python variable: {pyvar}"
     A python variable: Hello world
     In [3]: import math
     In [4]: x = 8
     In [5]: !echo {math.factorial(x)}
     40320
 
 For simple cases, you can alternatively prepend $ to a variable name::
 
     In [6]: !echo $sys.argv
     [/home/fperez/usr/bin/ipython]
     In [7]: !echo "A system variable: $$HOME"  # Use $$ for literal $
     A system variable: /home/fperez
 
 Note that `$$` is used to represent a literal `$`.
 
 System command aliases
 ----------------------
 
 The :magic:`alias` magic function allows you to define magic functions which are in fact
 system shell commands. These aliases can have parameters.
 
 ``%alias alias_name cmd`` defines 'alias_name' as an alias for 'cmd'
 
 Then, typing ``alias_name params`` will execute the system command 'cmd
 params' (from your underlying operating system).
 
 You can also define aliases with parameters using ``%s`` specifiers (one per
 parameter). The following example defines the parts function as an
 alias to the command ``echo first %s second %s`` where each ``%s`` will be
 replaced by a positional parameter to the call to %parts::
 
     In [1]: %alias parts echo first %s second %s
     In [2]: parts A B
     first A second B
     In [3]: parts A
     ERROR: Alias <parts> requires 2 arguments, 1 given.
 
 If called with no parameters, :magic:`alias` prints the table of currently
 defined aliases.
 
 The :magic:`rehashx` magic allows you to load your entire $PATH as
 ipython aliases. See its docstring for further details.
 
 
 .. _dreload:
 
 Recursive reload
 ----------------
 
 The :mod:`IPython.lib.deepreload` module allows you to recursively reload a
 module: changes made to any of its dependencies will be reloaded without
 having to exit. To start using it, do::
 
     from IPython.lib.deepreload import reload as dreload
 
 
 Verbose and colored exception traceback printouts
 -------------------------------------------------
 
 IPython provides the option to see very detailed exception tracebacks,
 which can be especially useful when debugging large programs. You can
 run any Python file with the %run function to benefit from these
 detailed tracebacks. Furthermore, both normal and verbose tracebacks can
 be colored (if your terminal supports it) which makes them much easier
 to parse visually.
 
 See the magic :magic:`xmode` and :magic:`colors` functions for details.
 
 These features are basically a terminal version of Ka-Ping Yee's cgitb
 module, now part of the standard Python library.
 
 
 .. _input_caching:
 
 Input caching system
 --------------------
 
 IPython offers numbered prompts (In/Out) with input and output caching
 (also referred to as 'input history'). All input is saved and can be
 retrieved as variables (besides the usual arrow key recall), in
 addition to the :magic:`rep` magic command that brings a history entry
 up for editing on the next command line.
 
 The following variables always exist:
 
 * ``_i``, ``_ii``, ``_iii``: store previous, next previous and next-next
   previous inputs.
 
 * ``In``, ``_ih`` : a list of all inputs; ``_ih[n]`` is the input from line
   ``n``. If you overwrite In with a variable of your own, you can remake the
   assignment to the internal list with a simple ``In=_ih``.
 
 Additionally, global variables named ``_i<n>`` are dynamically created (``<n>``
 being the prompt counter), so ``_i<n> == _ih[<n>] == In[<n>]``.
 
 For example, what you typed at prompt 14 is available as ``_i14``, ``_ih[14]``
 and ``In[14]``.
 
 This allows you to easily cut and paste multi line interactive prompts
 by printing them out: they print like a clean string, without prompt
 characters. You can also manipulate them like regular variables (they
 are strings), modify or exec them.
 
 You can also re-execute multiple lines of input easily by using the magic
 :magic:`rerun` or :magic:`macro` functions. The macro system also allows you to
 re-execute previous lines which include magic function calls (which require
 special processing). Type %macro? for more details on the macro system.
 
 A history function :magic:`history` allows you to see any part of your input
 history by printing a range of the _i variables.
 
 You can also search ('grep') through your history by typing
 ``%hist -g somestring``. This is handy for searching for URLs, IP addresses,
 etc. You can bring history entries listed by '%hist -g' up for editing
 with the %recall command, or run them immediately with :magic:`rerun`.
 
 .. _output_caching:
 
 Output caching system
 ---------------------
 
 For output that is returned from actions, a system similar to the input
 cache exists but using _ instead of _i. Only actions that produce a
 result (NOT assignments, for example) are cached. If you are familiar
 with Mathematica, IPython's _ variables behave exactly like
 Mathematica's % variables.
 
 The following variables always exist:
 
     * [_] (a single underscore): stores previous output, like Python's
       default interpreter.
     * [__] (two underscores): next previous.
     * [___] (three underscores): next-next previous.
 
 Additionally, global variables named _<n> are dynamically created (<n>
 being the prompt counter), such that the result of output <n> is always
 available as _<n> (don't use the angle brackets, just the number, e.g.
 ``_21``).
 
 These variables are also stored in a global dictionary (not a
 list, since it only has entries for lines which returned a result)
 available under the names _oh and Out (similar to _ih and In). So the
 output from line 12 can be obtained as ``_12``, ``Out[12]`` or ``_oh[12]``. If you
 accidentally overwrite the Out variable you can recover it by typing
 ``Out=_oh`` at the prompt.
 
 This system obviously can potentially put heavy memory demands on your
 system, since it prevents Python's garbage collector from removing any
 previously computed results. You can control how many results are kept
 in memory with the configuration option ``InteractiveShell.cache_size``.
 If you set it to 0, output caching is disabled. You can also use the :magic:`reset`
 and :magic:`xdel` magics to clear large items from memory.
 
 Directory history
 -----------------
 
 Your history of visited directories is kept in the global list _dh, and
 the magic :magic:`cd` command can be used to go to any entry in that list. The
 :magic:`dhist` command allows you to view this history. Do ``cd -<TAB>`` to
 conveniently view the directory history.
 
 
 Automatic parentheses and quotes
 --------------------------------
 
 These features were adapted from Nathan Gray's LazyPython. They are
 meant to allow less typing for common situations.
 
 Callable objects (i.e. functions, methods, etc) can be invoked like this
 (notice the commas between the arguments)::
 
     In [1]: callable_ob arg1, arg2, arg3
     ------> callable_ob(arg1, arg2, arg3)
 
 .. note::
    This feature is disabled by default. To enable it, use the ``%autocall``
    magic command. The commands below with special prefixes will always work,
    however.
 
 You can force automatic parentheses by using '/' as the first character
 of a line. For example::
 
     In [2]: /globals # becomes 'globals()'
 
 Note that the '/' MUST be the first character on the line! This won't work::
 
     In [3]: print /globals # syntax error
 
 In most cases the automatic algorithm should work, so you should rarely
 need to explicitly invoke /. One notable exception is if you are trying
 to call a function with a list of tuples as arguments (the parenthesis
 will confuse IPython)::
 
     In [4]: zip (1,2,3),(4,5,6) # won't work
 
 but this will work::
 
     In [5]: /zip (1,2,3),(4,5,6)
     ------> zip ((1,2,3),(4,5,6))
     Out[5]: [(1, 4), (2, 5), (3, 6)]
 
 IPython tells you that it has altered your command line by displaying
 the new command line preceded by ``--->``.
 
 You can force automatic quoting of a function's arguments by using ``,``
 or ``;`` as the first character of a line. For example::
 
     In [1]: ,my_function /home/me  # becomes my_function("/home/me")
 
 If you use ';' the whole argument is quoted as a single string, while ',' splits
 on whitespace::
 
     In [2]: ,my_function a b c    # becomes my_function("a","b","c")
 
     In [3]: ;my_function a b c    # becomes my_function("a b c")
 
 Note that the ',' or ';' MUST be the first character on the line! This
 won't work::
 
     In [4]: x = ,my_function /home/me # syntax error
 
 IPython as your default Python environment
 ==========================================
 
 Python honors the environment variable :envvar:`PYTHONSTARTUP` and will
 execute at startup the file referenced by this variable. If you put the
 following code at the end of that file, then IPython will be your working
 environment anytime you start Python::
 
     import os, IPython
     os.environ['PYTHONSTARTUP'] = ''  # Prevent running this again
     IPython.start_ipython()
     raise SystemExit
 
 The ``raise SystemExit`` is needed to exit Python when
 it finishes, otherwise you'll be back at the normal Python ``>>>``
 prompt.
 
 This is probably useful to developers who manage multiple Python
 versions and don't want to have correspondingly multiple IPython
 versions. Note that in this mode, there is no way to pass IPython any
 command-line options, as those are trapped first by Python itself.
 
 .. _Embedding:
 
 Embedding IPython
 =================
 
 You can start a regular IPython session with
 
 .. sourcecode:: python
 
     import IPython
     IPython.start_ipython(argv=[])
 
 at any point in your program.  This will load IPython configuration,
 startup files, and everything, just as if it were a normal IPython session.
 For information on setting configuration options when running IPython from
 python, see :ref:`configure_start_ipython`.
 
 It is also possible to embed an IPython shell in a namespace in your Python
 code. This allows you to evaluate dynamically the state of your code, operate
 with your variables, analyze them, etc. For example, if you run the following
 code snippet::
 
   import IPython
 
   a = 42
   IPython.embed()
 
-and within the IPython shell, you reassign `a` to `23` to do further testing of 
+and within the IPython shell, you reassign `a` to `23` to do further testing of
 some sort, you can then exit::
 
   >>> IPython.embed()
-  Python 3.6.2 (default, Jul 17 2017, 16:44:45) 
+  Python 3.6.2 (default, Jul 17 2017, 16:44:45)
   Type 'copyright', 'credits' or 'license' for more information
   IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help.
 
   In [1]: a = 23
 
   In [2]: exit()
 
 Once you exit and print `a`, the value 23 will be shown::
 
 
   In: print(a)
   23
 
-It's important to note that the code run in the embedded IPython shell will 
-*not* change the state of your code and variables, **unless** the shell is 
-contained within the global namespace. In the above example, `a` is changed 
+It's important to note that the code run in the embedded IPython shell will
+*not* change the state of your code and variables, **unless** the shell is
+contained within the global namespace. In the above example, `a` is changed
 because this is true.
 
 To further exemplify this, consider the following example::
 
   import IPython
   def do():
       a = 42
       print(a)
       IPython.embed()
       print(a)
 
 Now if call the function and complete the state changes as we did above, the
 value `42` will be printed. Again, this is because it's not in the global
-namespace:: 
+namespace::
 
   do()
 
 Running a file with the above code can lead to the following session::
 
   >>> do()
   42
-  Python 3.6.2 (default, Jul 17 2017, 16:44:45) 
+  Python 3.6.2 (default, Jul 17 2017, 16:44:45)
   Type 'copyright', 'credits' or 'license' for more information
   IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help.
 
   In [1]: a = 23
 
   In [2]: exit()
   42
 
 .. note::
 
   At present, embedding IPython cannot be done from inside IPython.
   Run the code samples below outside IPython.
 
 This feature allows you to easily have a fully functional python
 environment for doing object introspection anywhere in your code with a
 simple function call. In some cases a simple print statement is enough,
 but if you need to do more detailed analysis of a code fragment this
 feature can be very valuable.
 
 It can also be useful in scientific computing situations where it is
 common to need to do some automatic, computationally intensive part and
 then stop to look at data, plots, etc.
 Opening an IPython instance will give you full access to your data and
 functions, and you can resume program execution once you are done with
 the interactive part (perhaps to stop again later, as many times as
 needed).
 
 The following code snippet is the bare minimum you need to include in
 your Python programs for this to work (detailed examples follow later)::
 
     from IPython import embed
 
     embed() # this call anywhere in your program will start IPython
 
 You can also embed an IPython *kernel*, for use with qtconsole, etc. via
 ``IPython.embed_kernel()``. This should work the same way, but you can
 connect an external frontend (``ipython qtconsole`` or ``ipython console``),
 rather than interacting with it in the terminal.
 
 You can run embedded instances even in code which is itself being run at
 the IPython interactive prompt with '%run <filename>'. Since it's easy
 to get lost as to where you are (in your top-level IPython or in your
 embedded one), it's a good idea in such cases to set the in/out prompts
 to something different for the embedded instances. The code examples
 below illustrate this.
 
 You can also have multiple IPython instances in your program and open
 them separately, for example with different options for data
 presentation. If you close and open the same instance multiple times,
 its prompt counters simply continue from each execution to the next.
 
 Please look at the docstrings in the :mod:`~IPython.frontend.terminal.embed`
 module for more details on the use of this system.
 
 The following sample file illustrating how to use the embedding
 functionality is provided in the examples directory as embed_class_long.py.
 It should be fairly self-explanatory:
 
 .. literalinclude:: ../../../examples/Embedding/embed_class_long.py
     :language: python
 
 Once you understand how the system functions, you can use the following
 code fragments in your programs which are ready for cut and paste:
 
 .. literalinclude:: ../../../examples/Embedding/embed_class_short.py
     :language: python
 
 Using the Python debugger (pdb)
 ===============================
 
 Running entire programs via pdb
 -------------------------------
 
 pdb, the Python debugger, is a powerful interactive debugger which
 allows you to step through code, set breakpoints, watch variables,
 etc.  IPython makes it very easy to start any script under the control
 of pdb, regardless of whether you have wrapped it into a 'main()'
 function or not. For this, simply type ``%run -d myscript`` at an
 IPython prompt. See the :magic:`run` command's documentation for more details, including
 how to control where pdb will stop execution first.
 
 For more information on the use of the pdb debugger, see :ref:`debugger-commands`
 in the Python documentation.
 
 IPython extends the debugger with a few useful additions, like coloring of
 tracebacks. The debugger will adopt the color scheme selected for IPython.
 
 The ``where`` command has also been extended to take as argument the number of
 context line to show. This allows to a many line of context on shallow stack trace:
 
 .. code::
 
     In [5]: def foo(x):
     ...:     1
     ...:     2
     ...:     3
     ...:     return 1/x+foo(x-1)
     ...:     5
     ...:     6
     ...:     7
     ...:
 
     In[6]: foo(1)
     # ...
     ipdb> where 8
     <ipython-input-6-9e45007b2b59>(1)<module>
     ----> 1 foo(1)
 
     <ipython-input-5-7baadc3d1465>(5)foo()
         1 def foo(x):
         2     1
         3     2
         4     3
     ----> 5     return 1/x+foo(x-1)
         6     5
         7     6
         8     7
 
     > <ipython-input-5-7baadc3d1465>(5)foo()
         1 def foo(x):
         2     1
         3     2
         4     3
     ----> 5     return 1/x+foo(x-1)
         6     5
         7     6
         8     7
 
 
 And less context on shallower Stack Trace:
 
 .. code::
 
     ipdb> where 1
     <ipython-input-13-afa180a57233>(1)<module>
     ----> 1 foo(7)
 
     <ipython-input-5-7baadc3d1465>(5)foo()
     ----> 5     return 1/x+foo(x-1)
 
     <ipython-input-5-7baadc3d1465>(5)foo()
     ----> 5     return 1/x+foo(x-1)
 
     <ipython-input-5-7baadc3d1465>(5)foo()
     ----> 5     return 1/x+foo(x-1)
 
     <ipython-input-5-7baadc3d1465>(5)foo()
     ----> 5     return 1/x+foo(x-1)
 
 
 Post-mortem debugging
 ---------------------
 
 Going into a debugger when an exception occurs can be
 extremely useful in order to find the origin of subtle bugs, because pdb
 opens up at the point in your code which triggered the exception, and
 while your program is at this point 'dead', all the data is still
 available and you can walk up and down the stack frame and understand
 the origin of the problem.
 
 You can use the :magic:`debug` magic after an exception has occurred to start
 post-mortem debugging. IPython can also call debugger every time your code
 triggers an uncaught exception. This feature can be toggled with the :magic:`pdb` magic
 command, or you can start IPython with the ``--pdb`` option.
 
 For a post-mortem debugger in your programs outside IPython,
 put the following lines toward the top of your 'main' routine::
 
     import sys
     from IPython.core import ultratb
     sys.excepthook = ultratb.FormattedTB(mode='Verbose',
     color_scheme='Linux', call_pdb=1)
 
 The mode keyword can be either 'Verbose' or 'Plain', giving either very
 detailed or normal tracebacks respectively. The color_scheme keyword can
 be one of 'NoColor', 'Linux' (default) or 'LightBG'. These are the same
 options which can be set in IPython with ``--colors`` and ``--xmode``.
 
 This will give any of your programs detailed, colored tracebacks with
 automatic invocation of pdb.
 
 .. _pasting_with_prompts:
 
 Pasting of code starting with Python or IPython prompts
 =======================================================
 
 IPython is smart enough to filter out input prompts, be they plain Python ones
 (``>>>`` and ``...``) or IPython ones (``In [N]:`` and ``...:``).  You can
 therefore copy and paste from existing interactive sessions without worry.
 
 The following is a 'screenshot' of how things work, copying an example from the
 standard Python tutorial::
 
     In [1]: >>> # Fibonacci series:
 
     In [2]: ... # the sum of two elements defines the next
 
     In [3]: ... a, b = 0, 1
 
     In [4]: >>> while b < 10:
        ...:     ...     print(b)
        ...:     ...     a, b = b, a+b
        ...:
     1
     1
     2
     3
     5
     8
 
 And pasting from IPython sessions works equally well::
 
     In [1]: In [5]: def f(x):
        ...:        ...:     "A simple function"
        ...:        ...:     return x**2
        ...:    ...:
 
     In [2]: f(3)
     Out[2]: 9
 
 .. _gui_support:
 
 GUI event loop support
 ======================
 
 IPython has excellent support for working interactively with Graphical User
 Interface (GUI) toolkits, such as wxPython, PyQt/PySide, PyGTK and Tk. This is
 implemented by running the toolkit's event loop while IPython is waiting for
 input.
 
 For users, enabling GUI event loop integration is simple.  You simple use the
 :magic:`gui` magic as follows::
 
     %gui [GUINAME]
 
 With no arguments, ``%gui`` removes all GUI support.  Valid ``GUINAME``
-arguments include ``wx``, ``qt``, ``qt5``, ``qt6``, ``gtk``, ``gtk3`` ``gtk4``, and
+arguments include ``wx``, ``qt``, ``qt5``, ``qt6``, ``gtk3`` ``gtk4``, and
 ``tk``.
 
 Thus, to use wxPython interactively and create a running :class:`wx.App`
 object, do::
 
     %gui wx
 
 You can also start IPython with an event loop set up using the `--gui`
 flag::
 
     $ ipython --gui=qt
 
 For information on IPython's matplotlib_ integration (and the ``matplotlib``
 mode) see :ref:`this section <matplotlib_support>`.
 
 For developers that want to integrate additional event loops with IPython, see
 :doc:`/config/eventloops`.
 
 When running inside IPython with an integrated event loop, a GUI application
 should *not* start its own event loop. This means that applications that are
 meant to be used both
 in IPython and as standalone apps need to have special code to detects how the
 application is being run. We highly recommend using IPython's support for this.
 Since the details vary slightly between toolkits, we point you to the various
 examples in our source directory :file:`examples/IPython Kernel/gui/` that
 demonstrate these capabilities.
 
 PyQt and PySide
 ---------------
 
 .. attempt at explanation of the complete mess that is Qt support
 
 When you use ``--gui=qt`` or ``--matplotlib=qt``, IPython can work with either
 PyQt or PySide.  ``qt`` implies "use the latest version available", and it favors
-PyQt over PySide. To request a specific version, use ``qt5`` or ``qt6``. Note that
-Qt4 is not supported with the ``--gui`` switch (and has not been for some time now).
+PyQt over PySide. To request a specific version, use ``qt5`` or ``qt6``.
 
-If specified, IPython will respect the environment variable ``QT_API`` used
-by ETS.  ETS 4.0 also works with both PyQt4 and PySide, but it requires
-PyQt4 to use its v2 API.  So if ``QT_API=pyside`` PySide will be used,
-and if ``QT_API=pyqt`` then PyQt4 will be used *with the v2 API* for
-QString and QVariant, so ETS codes like MayaVi will also work with IPython.
-
-If you launch IPython in matplotlib mode with ``ipython --matplotlib=qt``,
-then IPython will ask matplotlib which Qt library to use (only if QT_API is
-*not set*), via the 'backend.qt4' rcParam.  If matplotlib is version 1.0.1 or
-older, then IPython will always use PyQt4 without setting the v2 APIs, since
-neither v2 PyQt nor PySide work.
-
-.. warning::
-
-    Note that this means for ETS 4 to work with PyQt4, ``QT_API`` *must* be set
-    to work with IPython's qt integration, because otherwise PyQt4 will be
-    loaded in an incompatible mode.
-
-    It also means that you must *not* have ``QT_API`` set if you want to
-    use ``--gui=qt`` with code that requires PyQt4 API v1.
+If specified, IPython will respect the environment variable ``QT_API``. If
+``QT_API`` is not specified and you launch IPython in matplotlib mode with
+``ipython --matplotlib=qt`` then IPython will ask matplotlib which Qt library
+to use. See the matplotlib_ documentation on ``QT_API`` for further details.
 
 
 .. _matplotlib_support:
 
 Plotting with matplotlib
 ========================
 
 matplotlib_ provides high quality 2D and 3D plotting for Python. matplotlib_
 can produce plots on screen using a variety of GUI toolkits, including Tk,
-PyGTK, PyQt4 and wxPython. It also provides a number of commands useful for
+PyGTK, PyQt6 and wxPython. It also provides a number of commands useful for
 scientific computing, all with a syntax compatible with that of the popular
 Matlab program.
 
 To start IPython with matplotlib support, use the ``--matplotlib`` switch. If
 IPython is already running, you can run the :magic:`matplotlib` magic.  If no
 arguments are given, IPython will automatically detect your choice of
-matplotlib backend.  You can also request a specific backend with
-``%matplotlib backend``, where ``backend`` must be one of: 'tk', 'qt', 'wx',
-'gtk', 'osx'.  In the web notebook and Qt console, 'inline' is also a valid
-backend value, which produces static figures inlined inside the application
-window instead of matplotlib's interactive figures that live in separate
-windows.
+matplotlib backend. For information on matplotlib backends see
+:ref:`matplotlib_magic`.
+
 
 .. _interactive_demos:
 
 Interactive demos with IPython
 ==============================
 
 IPython ships with a basic system for running scripts interactively in
 sections, useful when presenting code to audiences. A few tags embedded
 in comments (so that the script remains valid Python code) divide a file
 into separate blocks, and the demo can be run one block at a time, with
 IPython printing (with syntax highlighting) the block before executing
 it, and returning to the interactive prompt after each block. The
 interactive namespace is updated after each block is run with the
 contents of the demo's namespace.
 
 This allows you to show a piece of code, run it and then execute
 interactively commands based on the variables just created. Once you
 want to continue, you simply execute the next block of the demo. The
 following listing shows the markup necessary for dividing a script into
 sections for execution as a demo:
 
 .. literalinclude:: ../../../examples/IPython Kernel/example-demo.py
     :language: python
 
 In order to run a file as a demo, you must first make a Demo object out
 of it. If the file is named myscript.py, the following code will make a
 demo::
 
     from IPython.lib.demo import Demo
 
     mydemo = Demo('myscript.py')
 
 This creates the mydemo object, whose blocks you run one at a time by
 simply calling the object with no arguments. Then call it to run each step
 of the demo::
 
     mydemo()
 
 Demo objects can be
 restarted, you can move forward or back skipping blocks, re-execute the
 last block, etc. See the :mod:`IPython.lib.demo` module and the
 :class:`~IPython.lib.demo.Demo` class for details.
 
 Limitations: These demos are limited to
 fairly simple uses. In particular, you cannot break up sections within
 indented code (loops, if statements, function definitions, etc.)
 Supporting something like this would basically require tracking the
 internal execution state of the Python interpreter, so only top-level
 divisions are allowed. If you want to be able to open an IPython
 instance at an arbitrary point in a program, you can use IPython's
 :ref:`embedding facilities <Embedding>`.
 
 .. include:: ../links.txt

docs/source/whatsnew/version8.rst

@@ -1,2268 +1,2268 b''
 ============
  8.x Series
 ============
 
 .. _version 8.24:
 
 IPython 8.24
 ============
 
 Back on regular release schedule, as usual month releases are relatively tiny.
 
 The biggest change is the move of the matplotlib backend handling from IPython
-to matplotlib. :ghpull:`14371`:ghpull:`14403`.
+to matplotlib. :ghpull:`14371` :ghpull:`14403`.
 
 We will note:
 
  - pytest 8 compatibility :ghpull:`14413`
  - ``typing-extension`` now needs 4.6 or newer. It was already the case, but not
    explicated. :ghpull:`14380`
  - Attempt to speed running code under debugger in some cases. :ghpull:`14386`
    :ghpull:`14418`.
  - Multiple fixes to documentation for ipyparallel, simple_prompt and emacs
    :ghpull:`14384` :ghpull:`14404` :ghpull:`14407`
  - Maintenance and cleanup of debugger :ghpull:`14387` :ghpull:`14393`
 
 As usual you can find the full list of PRs on GitHub under `the 8.24
 <https://github.com/ipython/ipython/milestone/131?closed=1>`__ milestone.
 
 Thanks
 ------
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.23:
 
 IPython 8.23
 ============
 
 Super tiny release of IPython on Sunday – a bit later than usual, which is also
 `🏳️‍⚧️ International Transgender Day of Visibility🏳️‍⚧️
 <https://en.wikipedia.org/wiki/International_Transgender_Day_of_Visibility>`_ –
 so a though for you on this day, you matter and you are valid [1]_.
 
 This is a minuscule release with only 5 Pull requests.
 
 Main change is :ghpull:`14357` which improve inference from return type
 annotations in completer and the introduction of the optional target
 ``ipython[matplotlib]`` to explicitly request the matplotlib optional
 dependencies.
 
 As usual you can find the full list of PRs on GitHub under `the 8.23
 <https://github.com/ipython/ipython/milestone/130?closed=1>`__ milestone.
 
 Thanks
 ------
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.22:
 
 IPython 8.22, 8.22.1 and 8.22.2
 ===============================
 
 Quick release of IPython for this short month of February, with quite a bit of
 activity with more than 15 PRs.
 
 I am not going to details all the changes, but among other we have :
 
  - More compatibility with emscripten :ghpull:`14316`, :ghpull:`14318`,
  - Test more downstream project to avoid breakage :ghpull:`14317`
  - Fix recently introduced bug with the ``store`` magic.
  - Fix issues with multiple call to ``matplotlib.pyplot.switch_backend``
  - Fix crashing IPython when some tracebacks encounter dynamically evaluated
    code.
 
 IPython 8.22.1 increase the minimal traitlets version, and 8.22.2 fix a critical
 bug on emscripten  preventing to use some magics like ``%matplotlib`` on
 jupyter-light.
 
 API changes
 -----------
 
 One of the largest change is the update the mimehooks and inspector API, see
 :ghpull:`14342`. It should be backward compatible, but many hooks now receive a
 single object with many fields allowing us flexibility to update the API later.
 
 
 Packaging changes
 -----------------
 
 Thanks to `@mkoppe <https://github.com/mkoeppe>`__, we are slowly getting rid of
 setup.py finally migrating to ``pyproject.toml``. There is still quite a bit of
 work, and please open an issue if you encounter any problem.
 
 
 Deprecation
 -----------
 
 A number of unused functions have been marked deprecated or pending deprecation.
 Please let us know if you encounter any of those deprecation messages for us to
 adjust the removal timeline.
 
 
 Thanks
 ------
 
 Many thanks to `@mkoppe <https://github.com/mkoeppe>`__ and `@krassowski
 <https://github.com/krassowski>`__ for their multiple contributions and codebase
 cleanup.
 
 As usual you can find the full list of PRs on GitHub under `the 8.22
 <https://github.com/ipython/ipython/milestone/129?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.21:
 
 IPython 8.21
 ------------
 
 More substantial release of IPython slightly out of schedule as it was not
 possible for me to make a release last Friday.
 
 Few new features are present, but the codebase has been cleaned, and a couple
 of API are _considered_ for deprecation. They are not deprecated yet, but as
 they do not seem to be quite used, they may emit a warning, in which case please
 comment on the relevant issue to inform me of _which_ project use those feature
 and how you use them. Depending on the feedback I might change the timeline for
 deprecation.
 
 This release saw 14 PRs, with more outside contribution than usual,
 I'll note in particular PRs related to making IPython work on emscripten.
 
 I also want to point that we are _trying_ to keep compatibility with Python 3.13,
 but it's a cat and mouse game. Plus I am low on time, so I would appreciate any
 help with that.
 
 Deprecations
 ~~~~~~~~~~~~
 
  - :ghpull:`14307` Pending Deprecation of
    ``ColorSchemeTable.set_active_scheme(...)``'s ``case_sensitive`` Parameter.
  - :ghpull:`14305` Pending Deprecation of constructing ``ColorScheme`` via
    ``kwargs``, in favor passing a single dict.
 
 
 Fixes
 ~~~~~
 
  - :ghpull:`14284` TerminalIPythonApp's would warn that ``auto_create`` option is not
    recognized.
  - :ghpull:`14286` Fix a crash with ``NotOneValueFound`` when rendering complex
    tracebacks.
 
  - :ghpull:`14287` Partial Python 3.13 compatibility
  - :ghpull:`14290` Docs/Typos.
 
 Changes
 ~~~~~~~
 
  - :ghpull:`14289` ``ipdb.set_trace()`` now accepts ``header=`` for better
    compatibility with ``pdb.set_trace()``
 
  - :ghpull:`14300` and :ghpull:`14301` Add hooking ability to produce
    mimebundle.
 
 We'll outline :ghpull:`14300`, it is now possible to extend the ``?/??``
 operator to return more mimetypes to render richer help in frontends that
 support it. In particular you could send a json representation of the help that
 could be displayed in a customizable way.
 
 Miscellaneous
 ~~~~~~~~~~~~~
 
  - :ghpull:`14291` Misc Refactor of Color handling
  - :ghpull:`14295` Misc test skip on problematic Pypy versions.
 
 
 Thanks
 ~~~~~~
 
 Special thanks to all our contributors, and to the Pypy team that was extremely
 reactive in helping to investigate a fixing a rare unicode+windows bug.
 
 As usual you can find the full list of PRs on GitHub under `the 8.21
 <https://github.com/ipython/ipython/milestone/128?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.20:
 
 IPython 8.20
 ------------
 
 Quick IPython release in this beginning of 2024, barely 2 weeks after the previous
 release.
 
 This is mostly to fix a backward compatibility issue, I would have done a  patch
 release earlier if I could. As a few other cleanup are also part of this
 release, this will get a minor version bump.
 
 
 The crux of this release is :ghpull:`14274` (Inspect continuation prompt
 signature and pass only viable arguments), the rest of the changes are mostly
 type annotation, and a few compatibility issues with Python 3.13 that are
 getting addressed.
 
 Python 3.13 compatibility is still not complete (help welcomed).
 
 As usual you can find the full list of PRs on GitHub under `the 8.20
 <https://github.com/ipython/ipython/milestone/127?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.19:
 
 IPython 8.19
 ------------
 
 New release of IPython a bit before the end of the month, and end of the year.
 
 Mostly cleanup and deprecation, due to upstream deprecation and removal.
 
 Remove of Python 3.9 support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A bit later than originally plan, IPython 8.19 does not support Python 3.9
 anymore, as well as the few conditional code that were executing only on Python
 3.9. :ghpull:`14254`
 
 We used the opportunity to deprecate ``IPython.utils.tz`` :ghpull:`14256`, due
 to upstream deprecation of some timezone utilities. It will be removed at a later
 date.
 
 We now also run CI on Python 3.12 (what I likely should have done before), but
 running on too many Python version uses a lot of CI time.
 
 Absolute and relative Line Numbers in Prompts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Thanks to the contribution of ``cohml``, IPython CLI now support absolute and
 relative line numbers in both vi and emacs prompt, use for example
 ``c.TerminalInteractiveShell.prompt_line_number_format='{line: 4d}/{rel_line:+03d} | '``
 configuration option to display both in a custom format.
 
 Miscellaneous
 ~~~~~~~~~~~~~
 
 In addition to various bugfixes, I unpinned pytest, let me know if there are any
 issues and we'll re-pin.
 
 See you in 2024
 ~~~~~~~~~~~~~~~
 
 As usual you can find the full list of PRs on GitHub under `the 8.19
 <https://github.com/ipython/ipython/milestone/126?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.18:
 
 IPython 8.18 and 8.18.1
 -----------------------
 
 8.18.1 is identical to 8.18 but pin ``prompt_toolkit`` to greater than ``3.0.41``
 
 Small release of IPython that fixes a small number of inconveniences.
 
  - :ghpull:`14251` Fix a memory leak in qt event loop integration by setting
    the Loop parent to None.
  - :ghpull:`14252` Pickleshare was made an optional dependency in 8.17, this
    leads to warnings in some installations when using modules completions. The
    warning has been silenced.
  - :ghpull:`14241` Update event loop code for compatibility with more recent
    ``prompt_toolkit`` due to deprecations in Python 3.12.
  - :ghpull:`14245` Fix doc example on Pygments styles
  - :ghpull:`14238` Remove dependency on app_nope, this is actually only a
    dependency of IPykernel.
 
 As usual you can find the full list of PRs on GitHub under `the 8.18
 <https://github.com/ipython/ipython/milestone/125?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.17.1:
 .. _version 8.17:
 
 IPython 8.17, 8.17.1
 --------------------
 
 Medium-sized release of IPython that includes some cleanup (backcall, python2 leftovers)
 and some refactoring improvements (typing, pathlib) and a fix on completion.
 
   - :ghpull:`14216` remove backcall dependency
   - :ghpull:`14217` make pickleshare dependency optional
   - :ghpull:`14185` support completion based on type annotations of calls
 
 Reverted in 8.17.1:
 
   - :ghpull:`14190` remove support for python 2 in lexers (reverted in 8.17.1 as it is imported by qtconsole/spyder)
 
 Mamba and Micromamba magic
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In addition to the conda command to manage conda environment, mamba and
 micromamba can now be used using the corresponding magic in IPython.
 Since these commands are compatible with conda, they are following the
 same logic.
 
 These two magic require to have the corresponding commands available
 either in the conda environment or system wide.
 
 :ghpull:`14191`
 
 ----
 
 As usual you can find the full list of PRs on GitHub under `the 8.17
 <https://github.com/ipython/ipython/milestone/123?closed=1>`__ milestone.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.16:
 .. _version 8.16.1:
 
 IPython 8.16, 8.16.1
 --------------------
 
 Small double release of IPython (with the 8.12.3 release notes just below).
 Mostly bug fixes and cleanups, and type annotations. Of interest for users:
 
  - :ghpull:`14153` Fix a bug of the new iPdb chained traceback where some
    Exception would not have any traceback. (see upstream fix in CPython for more
    details).
  - :ghpull:`14168` Fix case with spurious message about event loops when using
    matplotlib.
 
 This PR is in 8.16.0 but reverted in 8.16.1, we'll  rework the fix for 8.17
 
  - :ghpull:`14163` Fix an error where semicolon would not suppress output.
 
 As usual you can find the full list of PRs on GitHub under `the 8.16
 <https://github.com/ipython/ipython/milestone/121?closed=1>`__ and `8.16.1 milestone
 <https://github.com/ipython/ipython/milestone/124?closed=1>`__.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.12.3:
 
 IPython 8.12.3
 --------------
 
 Tiny release of 8.12.3 that backport a small number of fixes for users still
 using Python 3.8.
 
  - :ghpull:`14080` add passthrough filter shortcuts
  - :ghpull:`14169` Fix `InteractiveShellEmbed`
 
 .. _version 8.15:
 
 IPython 8.15
 ------------
 
 Medium release of IPython after a couple of month hiatus, and a bit
 off-schedule.
 
 Among other, IPython 8.15:
 
  - Improve compatibility with future version of Python 3.12/3.13
    :ghpull:`14107`, :ghpull:`14139`,
  - Improve support for ``ExceptionGroups``, :ghpull:`14108`
  - Fix hangs in ``%gui osx``, :ghpull:`14125`
  - Fix memory lead with ``%reset``, :ghpull:`14133`
  - Unstable config option to modify traceback highlighting that is sometime hard
    to read :ghpull:`14138`
  - Support ``.`` in ``ipdb`` as an argument to the ``list`` command
    :ghpull:`14121`
  - Workroud ``parso`` showing warning message when the default logger level is
    changed :ghpull:`14119`
  - Fix multiple issues with matplotlib interactive mode, qt5/qt6 :ghpull:`14128`
 
 Support for PEP-678 Exception Notes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Ultratb now shows :pep:`678` notes, improving your debugging experience on
 Python 3.11+ or with libraries such as Pytest and Hypothesis.
 
 Native fallback for displaying ExceptionGroup
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ExceptionGroups are now displayed with ``traceback.print_exc``, as a temporary fix until UltraTB properly supports displaying child exceptions.
 
 
 We have two larger features:
 
 AST-based macros
 ~~~~~~~~~~~~~~~~
 
 :ghpull:`14100` introduce a new and efficient way to modify each execution block
 (cell) using an template-ast-based transform. Unlike IPython pre and post code
 execution hooks, this actually transform the code that is execute with as
 minimal as possible overhead. While it was already technically possible to
 register ast transformers for IPython this was far from evident.
 
 This should make it trivial to hook into IPython to implement custom hooks, that
 for example time or profile your code, catch exceptions to provide error
 messages for students or do any other kind of transformations.
 
 In addition to programmatic API there is also a magic to quickly register
 hooks::
 
    In [1]: %%code_wrap before_after
       ...: print('before')
       ...: __code__
       ...: print('after')
       ...: __ret__
 
 This mean that  for any subsequent execution code will be executed.
 You can modify the above to print the date, compute the execution time,
 retry the code in a for loop....
 
 
 Allow IPdb/Pdb to move between chained exceptions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The main change is the addition of the ability to move between chained
 exceptions when using IPdb, this feature was also contributed to upstream Pdb
 and is thus native to CPython in Python 3.13+ Though ipdb should support this
 feature in older version of Python. I invite you to look at the `CPython changes
 and docs <https://github.com/python/cpython/pull/106676>`__ for more details.
 
 In short, once in post-mortem debugger (``%debug``), you can use the ipdb
 ``exceptions`` command to switch exceptions, for example:
 
 .. code-block:: ipython
 
     In [1]: def foo(x):
         ...:     try:
         ...:         bar(x)
         ...:     except Exception as e:
         ...:         raise ValueError("foo (): bar failed") from e
         ...:
         ...: def bar(x):
         ...:     1 / X
         ...:
 
     In [2]: foo(0)
     ---------------------------------------------------------------------------
     NameError                                 Traceback (most recent call last)
     Cell In[1], line 3, in foo(x)
           2 try:
     ----> 3     bar(x)
           4 except Exception as e:
 
     Cell In[1], line 9, in bar(x)
           8 def bar(x):
     ----> 9     1 / X
 
     NameError: name 'X' is not defined
 
     The above exception was the direct cause of the following exception:
 
     ValueError                                Traceback (most recent call last)
     Cell In[2], line 1
     ----> 1 foo(0)
 
     Cell In[1], line 5, in foo(x)
           3     bar(x)
           4 except Exception as e:
     ----> 5     raise ValueError("foo (): bar failed") from e
 
     ValueError: foo (): bar failed
 
     In [3]: %debug
     > <ipython-input-1-b0bbdc271ffb>(5)foo()
           3         bar(x)
           4     except Exception as e:
     ----> 5         raise ValueError("foo (): bar failed") from e
 
 In previous ipdb you could not go into the bar error, now from within pdb you
 can use ``exceptions``:
 
 .. code-block:: ipython
 
     ipdb> exceptions
         0 NameError("name 'X' is not defined")
     >   1 ValueError('foo (): bar failed')
 
     ipdb> exceptions 0
     > <ipython-input-1-b0bbdc271ffb>(9)bar()
           6
           7
           8 def bar(x):
     ----> 9     1 / X
          10
 
     ipdb>
 
 In particular I want to thank the `D.E. Shaw group <https://www.deshaw.com/>`__
 for suggesting and funding the two largest feature as well as many bug fixes of
 this release.
 
 As usual you can find the full list of PRs on GitHub under `the 8.15 milestone
 <https://github.com/ipython/ipython/milestone/120?closed=1>`__.
 
 
 
 .. _version 8.14:
 
 IPython 8.14
 ------------
 
 Small release of IPython.
 
  - :ghpull:`14080` fixes some shortcuts issues.
  - :ghpull:`14056` Add option to ``%autoreload`` to hide errors when reloading code. This will be the default for spyder
    user is my understanding.
  - :ghpull:`14039` (and :ghpull:`14040`) to show exception notes in tracebacks.
 
  - :ghpull:`14076` Add option to EventManager to prevent printing
 
 
 SPEC 0 and SPEC 4
 ~~~~~~~~~~~~~~~~~
 
 You've heard about the NEPs, (NumPy enhancement Proposal), having a NEP for something non-numpy specific was sometime confusing.
 Long live the `SPECs <https://scientific-python.org/specs/>`_.
 
 We are now trying to follow SPEC 0 (aka old NEP 29) for support of upstream libraries.
 
 We also now try to follow SPEC 4 (test and publish nightly on a centralized nightly repository).
 We encourage you to do so as well in order to report breakage, and contribute to the SPEC process !
 
 
 Python 3.12 compatibility ?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Python 3.12 changed its tokenizer to have better support for f-strings and allow arbitrary expression.
 This is a great new feature and performance improvement in Python 3.12.
 
 Unfortunately this means the new tokenizer does not support incomplete or invalid Python which will
 break many features of IPython. Thus compatibility of IPython with Python 3.12 is not guarantied.
 It is unclear to which extent IPython is affected, and whether we can/should try to still support magics, shell
 escape (``! ....``), ...,  as well as how to do it if we can.
 
 In addition even if we there is technical feasibility to do so, it is no clear we have the resources to do it.
 We are thus looking for your help if you can _test_ on Python 3.12 to see to which extent this affects users and which
 features are critical.
 
 We are not going to pin IPython to Python ``<3.12`` as otherwise on install pip would downgrade/resolve to IPython 8.13,
 so if you plan to update to Python 3.12 after its release, we encourage for extra care.
 
 
 .. _version 8.13.1:
 .. _version 8.13.2:
 .. _version 8.12.2:
 
 IPython 8.13.1, 8.13.2 and 8.12.2
 ---------------------------------
 
 3 quick in succession patch release of IPython in addition to IPython 8.13.0
 having been yanked.
 
 IPython 8.13.0 was improperly tagged as still compatible with Python 3.8, and
 still had some mention of compatibility with 3.8. IPython 8.13.1 is identical to
 8.13 but with the exception of being correctly tagged. This release and yank was
 mostly done to fix CI.
 
 IPython 8.12.2 and 8.13.2 contain UI fixes, with respect to right arrow not
 working in some case in the terminal, and 8.12.2 contain also a requested
 backport of :ghpull:`14029` (Allow safe access to the ``__getattribute__``
 method of modules) for tab completion.
 
 .. _version 8.13:
 
 IPython 8.13
 ------------
 
 As usual for the end of the month, minor release of IPython. This release is
 significant in that it not only has a number of bugfixes, but also drop support
 for Python 3.8 as per NEP 29 (:ghpull:`14023`).
 
 All the critical bugfixes have been backported onto the 8.12.1 release (see
 below). In addition to that went into 8.12.1 you'll find:
 
  - Pretty representation for ``Counter`` has been fixed to match the Python one
    and be in decreasing order. :ghpull:`14032`
  - Module completion is better when jedi is disabled :ghpull:`14029`.
  - Improvement of ``%%bash`` magic that would get stuck :ghpull:`14019`
 
 
 We hope you enjoy this release an will maybe see you at JupyterCon in less than
 two weeks.
 
 As usual you can find the full list of PRs on GitHub under `the 8.13 milestone
 <https://github.com/ipython/ipython/milestone/115?closed=1>`__.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.12.1:
 
 IPython 8.12.1
 --------------
 
 This is the twin release of IPython 8.13 that contain only critical UI and bug
 fixes. The next minor version of IPython has dropped support for Python 3.8 – as
 per Nep 29 and this IPython 8.12.x will now only receive bugfixes.
 
 
  - :ghpull:`14004` Fix a bug introduced in IPython 8.12 that crash when
    inspecting some docstrings.
  - :ghpull:`14010` Fix fast traceback code that was not working in some case.
  - :ghpull:`14014` Fix ``%page`` magic broken in some case.
  - :ghpull:`14026`, :ghpull:`14027` Tweak default shortcut with respect to
    autosuggestions.
  - :ghpull:`14033` add back the ability to use ``.get()`` on OInfo object for
    backward compatibility with h5py (this will be re-deprecated later, and h5py
    will also get a fix).
 
 As usual you can find the full list of PRs on GitHub under `the 8.12.1 milestone
 <https://github.com/ipython/ipython/milestone/116?closed=1>`__.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.12.0:
 
 IPython 8.12
 ------------
 
 Hopefully slightly early release for IPython 8.12. Last Thursday of the month,
 even if I guess it's likely already Friday somewhere in the pacific ocean.
 
 A number of PRs and bug fixes this month with close to 20 PRs merged !
 
 
 The IPython repo reached :ghpull:`14000` !! Actually the PR that create those exact release
 note is :ghpull:`14000`. Ok, more issues and PR is not always better, and I'd
 love to have more time to close issues and Pull Requests.
 
 Let's note that in less than 2 month JupyterCon is back, in Paris please visit
 `jupytercon.com <https://jupytercon.com>`__, and looking forward to see you
 there.
 
 Packagers should take note that ``typing_extension`` is now a mandatory dependency
 for Python versions ``<3.10``.
 
 
 
 Let's note also that according to `NEP29
 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__, It is soon time to
 stop support for Python 3.8 that will be release more than 3 and 1/2 years ago::
 
     On Apr 14, 2023 drop support for Python 3.8 (initially released on Oct 14, 2019)
 
 Thus I am likely to stop advertising support for Python 3.8 in the next
 release at the end of April.
 
 
 Here are some miscellaneous updates of interest:
 
  - :ghpull:`13957` brings updates to the Qt integration, particularly for Qt6.
  - :ghpull:`13960` fixes the %debug magic command to give access to the local
    scope.
  - :ghpull:`13964` fixes some crashes with the new fast traceback code. Note that
    there are still some issues with the fast traceback code, and I a, likely
    to fix and tweak behavior.
  - :ghpull:`13973` We are slowly migrating IPython internals to use proper type
    objects/dataclasses instead of dictionaries to allow static typing checks.
    These are technically public API and could lead to breakage, so please let us
    know if that's the case and I'll mitigate.
  - :ghpull:`13990`, :ghpull:`13991`, :ghpull:`13994` all improve keybinding and
    shortcut configurability.
 
 As usual you can find the full list of PRs on GitHub under `the 8.12 milestone
 <https://github.com/ipython/ipython/milestone/114?closed=1>`__.
 
 We want to thank the D.E. Shaw group for requesting and sponsoring the work on
 the following big feature. We had productive discussions on how to best expose
 this feature
 
 Dynamic documentation dispatch
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 We are experimenting with dynamic documentation dispatch for object attribute.
 See :ghissue:`13860`. The goal is to allow object to define documentation for
 their attributes, properties, even when those are dynamically defined with
 `__getattr__`.
 
 In particular when those objects are base types it can be useful to show the
 documentation
 
 
 .. code-block:: ipython
 
 
     In [1]: class User:
        ...:
        ...:     __custom_documentations__ = {
        ...:         "first": "The first name of the user.",
        ...:         "last": "The last name of the user.",
        ...:     }
        ...:
        ...:     first:str
        ...:     last:str
        ...:
        ...:     def __init__(self, first, last):
        ...:         self.first = first
        ...:         self.last = last
        ...:
        ...:     @property
        ...:     def full(self):
        ...:         """`self.first` and `self.last` joined by a space."""
        ...:         return self.first + " " + self.last
        ...:
        ...:
        ...: user = Person('Jane', 'Doe')
 
     In [2]: user.first?
     Type:            str
     String form:     Jane
     Length:          4
     Docstring:       the first name of a the person object, a str
     Class docstring:
     ....
 
     In [3]: user.last?
     Type:            str
     String form:     Doe
     Length:          3
     Docstring:       the last name, also a str
     ...
 
 
 We can see here the symmetry with IPython looking for the docstring on the
 properties:
 
 .. code-block:: ipython
 
 
     In [4]: user.full?
     HERE
     Type:        property
     String form: <property object at 0x102bb15d0>
     Docstring:   first and last join by a space
 
 
 Note that while in the above example we use a static dictionary, libraries may
 decide to use a custom object that define ``__getitem__``, we caution against
 using objects that would trigger computation to show documentation, but it is
 sometime preferable for highly dynamic code that for example export ans API as
 object.
 
 
 
 .. _version 8.11.0:
 
 IPython 8.11
 ------------
 
 Back on almost regular monthly schedule for IPython with end-of-month
 really-late-Friday release to make sure some bugs are properly fixed.
 Small addition of with a few new features, bugfix and UX improvements.
 
 This is a non-exhaustive list, but among other you will find:
 
 Faster Traceback Highlighting
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Resurrection of pre-IPython-8 traceback highlighting code.
 
 Really long and complicated files were slow to highlight in traceback with
 IPython 8 despite upstream improvement that make many case better. Therefore
 starting with IPython 8.11 when one of the highlighted file is more than 10 000
 line long by default, we'll fallback to a faster path that does not have all the
 features of highlighting failing AST nodes.
 
 This can be configures by setting the value of
 ``IPython.code.ultratb.FAST_THRESHOLD`` to an arbitrary low or large value.
 
 
 Autoreload verbosity
 ~~~~~~~~~~~~~~~~~~~~
 
 We introduce more descriptive names for the ``%autoreload`` parameter:
 
 - ``%autoreload now`` (also ``%autoreload``) - perform autoreload immediately.
 - ``%autoreload off`` (also ``%autoreload 0``) - turn off autoreload.
 - ``%autoreload explicit`` (also ``%autoreload 1``) - turn on autoreload only for modules
   whitelisted by ``%aimport`` statements.
 - ``%autoreload all`` (also ``%autoreload 2``) - turn on autoreload for all modules except those
   blacklisted by ``%aimport`` statements.
 - ``%autoreload complete`` (also ``%autoreload 3``) - all the fatures of ``all`` but also adding new
   objects from the imported modules (see
   IPython/extensions/tests/test_autoreload.py::test_autoload_newly_added_objects).
 
 The original designations (e.g. "2") still work, and these new ones are case-insensitive.
 
 Additionally, the option ``--print`` or ``-p`` can be added to the line to print the names of
 modules being reloaded. Similarly, ``--log`` or ``-l`` will output the names to the logger at INFO
 level. Both can be used simultaneously.
 
 The parsing logic for ``%aimport`` is now improved such that modules can be whitelisted and
 blacklisted in the same line, e.g. it's now possible to call ``%aimport os, -math`` to include
 ``os`` for ``%autoreload explicit`` and exclude ``math`` for modes ``all`` and ``complete``.
 
 Terminal shortcuts customization
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Previously modifying shortcuts was only possible by hooking into startup files
 and practically limited to adding new shortcuts or removing all shortcuts bound
 to a specific key. This release enables users to override existing terminal
 shortcuts, disable them or add new keybindings.
 
 For example, to set the :kbd:`right` to accept a single character of auto-suggestion
 you could use::
 
     my_shortcuts = [
         {
             "command": "IPython:auto_suggest.accept_character",
             "new_keys": ["right"]
         }
     ]
     %config TerminalInteractiveShell.shortcuts = my_shortcuts
 
 You can learn more in :std:configtrait:`TerminalInteractiveShell.shortcuts`
 configuration reference.
 
 Miscellaneous
 ~~~~~~~~~~~~~
 
  - ``%gui`` should now support PySide6. :ghpull:`13864`
  - Cli shortcuts can now be configured :ghpull:`13928`, see above.
    (note that there might be an issue with prompt_toolkit 3.0.37 and shortcut configuration).
 
  - Capture output should now respect ``;`` semicolon to suppress output.
    :ghpull:`13940`
  - Base64 encoded images (in jupyter frontend), will not have trailing newlines.
    :ghpull:`13941`
 
 As usual you can find the full list of PRs on GitHub under `the 8.11 milestone
 <https://github.com/ipython/ipython/milestone/113?closed=1>`__.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.10.0:
 
 IPython 8.10
 ------------
 
 Out of schedule release of IPython with minor fixes to patch a potential CVE-2023-24816.
 This is a really low severity CVE that you most likely are not affected by unless:
 
  - You are on windows.
  - You have a custom build of Python without ``_ctypes``
  - You cd or start IPython or Jupyter in untrusted directory which names may be
    valid shell commands.
 
 You can read more on `the advisory
 <https://github.com/ipython/ipython/security/advisories/GHSA-29gw-9793-fvw7>`__.
 
 In addition to fixing this CVE we also fix a couple of outstanding bugs and issues.
 
 As usual you can find the full list of PRs on GitHub under `the 8.10 milestone
 <https://github.com/ipython/ipython/milestone/112?closed=1>`__.
 
 In Particular:
 
  - bump minimum numpy to `>=1.21` version following NEP29. :ghpull:`13930`
  - fix for compatibility with MyPy 1.0. :ghpull:`13933`
  - fix nbgrader stalling when IPython's ``showtraceback`` function is
    monkeypatched. :ghpull:`13934`
 
 
 
 As this release also contains those minimal changes in addition to fixing the
 CVE I decided to bump the minor version anyway.
 
 This will not affect the normal release schedule, so IPython 8.11 is due in
 about 2 weeks.
 
 .. _version 8.9.0:
 
 IPython 8.9.0
 -------------
 
 Second release of IPython in 2023, last Friday of the month, we are back on
 track. This is a small release with a few bug-fixes, and improvements, mostly
 with respect to terminal shortcuts.
 
 
 The biggest improvement for 8.9 is a drastic amelioration of the
 auto-suggestions sponsored by D.E. Shaw and implemented by the more and more
 active contributor `@krassowski <https://github.com/krassowski>`.
 
 - ``right`` accepts a single character from suggestion
 - ``ctrl+right`` accepts a semantic token (macos default shortcuts take
   precedence and need to be disabled to make this work)
 - ``backspace`` deletes a character and resumes hinting autosuggestions
 - ``ctrl-left`` accepts suggestion and moves cursor left one character.
 - ``backspace`` deletes a character and resumes hinting autosuggestions
 - ``down`` moves to suggestion to later in history when no lines are present below the cursors.
 - ``up`` moves to suggestion from earlier in history when no lines are present above the cursor.
 
 This is best described by the Gif posted by `@krassowski
 <https://github.com/krassowski>`, and in the PR itself :ghpull:`13888`.
 
 .. image:: ../_images/autosuggest.gif
 
 Please report any feedback in order for us to improve the user experience.
 In particular we are also working on making the shortcuts configurable.
 
 If you are interested in better terminal shortcuts, I also invite you to
 participate in issue `13879
 <https://github.com/ipython/ipython/issues/13879>`__.
 
 
 As we follow `NEP29
 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__, next version of
 IPython will officially stop supporting numpy 1.20, and will stop supporting
 Python 3.8 after April release.
 
 As usual you can find the full list of PRs on GitHub under `the 8.9 milestone
 <https://github.com/ipython/ipython/milestone/111?closed=1>`__.
 
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.8.0:
 
 IPython 8.8.0
 -------------
 
 First release of IPython in 2023 as there was no release at the end of
 December.
 
 This is an unusually big release (relatively speaking) with more than 15 Pull
 Requests merged.
 
 Of particular interest are:
 
  - :ghpull:`13852` that replaces the greedy completer and improves
    completion, in particular for dictionary keys.
  - :ghpull:`13858` that adds ``py.typed`` to ``setup.cfg`` to make sure it is
    bundled in wheels.
  - :ghpull:`13869` that implements tab completions for IPython options in the
    shell when using `argcomplete <https://github.com/kislyuk/argcomplete>`. I
    believe this also needs a recent version of Traitlets.
  - :ghpull:`13865` makes the ``inspector`` class of `InteractiveShell`
    configurable.
  - :ghpull:`13880` that removes minor-version entrypoints as the minor version
    entry points that would be included in the wheel would be the one of the
    Python version that was used to build the ``whl`` file.
 
 In no particular order, the rest of the changes update the test suite to be
 compatible with Pygments 2.14, various docfixes, testing on more recent python
 versions and various updates.
 
 As usual you can find the full list of PRs on GitHub under `the 8.8 milestone
 <https://github.com/ipython/ipython/milestone/110>`__.
 
 Many thanks to @krassowski for the many PRs and @jasongrout for reviewing and
 merging contributions.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.7.0:
 
 IPython 8.7.0
 -------------
 
 
 Small release of IPython with a couple of bug fixes and new features for this
 month. Next month is the end of year, it is unclear if there will be a release
 close to the new year's eve, or if the next release will be at the end of January.
 
 Here are a few of the relevant fixes,
 as usual you can find the full list of PRs on GitHub under `the 8.7 milestone
 <https://github.com/ipython/ipython/pulls?q=milestone%3A8.7>`__.
 
 
    - :ghpull:`13834` bump the minimum prompt toolkit to 3.0.11.
    - IPython shipped with the ``py.typed`` marker now, and we are progressively
      adding more types. :ghpull:`13831`
    - :ghpull:`13817` add configuration of code blacks formatting.
 
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.6.0:
 
 IPython 8.6.0
 -------------
 
 Back to a more regular release schedule (at least I try), as Friday is
 already over by more than 24h hours. This is a slightly bigger release with a
 few new features that contain no less than 25 PRs.
 
 We'll notably found a couple of non negligible changes:
 
 The ``install_ext`` and related functions have been removed after being
 deprecated for years. You can use pip to install extensions. ``pip`` did not
 exist when ``install_ext`` was introduced. You can still load local extensions
 without installing them. Just set your ``sys.path`` for example. :ghpull:`13744`
 
 IPython now has extra entry points that use the major *and minor* version of
 python. For some of you this means that you can do a quick ``ipython3.10`` to
 launch IPython from the Python 3.10 interpreter, while still using Python 3.11
 as your main Python. :ghpull:`13743`
 
 The completer matcher API has been improved. See :ghpull:`13745`. This should
 improve the type inference and improve dict keys completions in many use case.
 Thanks ``@krassowski`` for all the work, and the D.E. Shaw group for sponsoring
 it.
 
 The color of error nodes in tracebacks can now be customized. See
 :ghpull:`13756`. This is a private attribute until someone finds the time to
 properly add a configuration option. Note that with Python 3.11 that also shows
 the relevant nodes in traceback, it would be good to leverage this information
 (plus the "did you mean" info added on attribute errors). But that's likely work
 I won't have time to do before long, so contributions welcome.
 
 As we follow NEP 29, we removed support for numpy 1.19 :ghpull:`13760`.
 
 
 The ``open()`` function present in the user namespace by default will now refuse
 to open the file descriptors 0,1,2 (stdin, out, err), to avoid crashing IPython.
 This mostly occurs in teaching context when incorrect values get passed around.
 
 
 The ``?``, ``??``, and corresponding ``pinfo``, ``pinfo2`` magics can now find
 objects inside arrays. That is to say, the following now works::
 
 
    >>> def my_func(*arg, **kwargs):pass
    >>> container = [my_func]
    >>> container[0]?
 
 
 If ``container`` define a custom ``getitem``, this __will__ trigger the custom
 method. So don't put side effects in your ``getitems``. Thanks to the D.E. Shaw
 group for the request and sponsoring the work.
 
 
 As usual you can find the full list of PRs on GitHub under `the 8.6 milestone
 <https://github.com/ipython/ipython/pulls?q=milestone%3A8.6>`__.
 
 Thanks to all hacktoberfest contributors, please contribute to
 `closember.org <https://closember.org/>`__.
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.5.0:
 
 IPython 8.5.0
 -------------
 
 First release since a couple of month due to various reasons and timing preventing
 me for sticking to the usual monthly release the last Friday of each month. This
 is of non negligible size as it has more than two dozen PRs with various fixes
 an bug fixes.
 
 Many thanks to everybody who contributed PRs for your patience in review and
 merges.
 
 Here is a non-exhaustive list of changes that have been implemented for IPython
 8.5.0. As usual you can find the full list of issues and PRs tagged with `the
 8.5 milestone
 <https://github.com/ipython/ipython/pulls?q=is%3Aclosed+milestone%3A8.5+>`__.
 
  - Added a shortcut for accepting auto suggestion. The End key shortcut for
    accepting auto-suggestion This binding works in Vi mode too, provided
    ``TerminalInteractiveShell.emacs_bindings_in_vi_insert_mode`` is set to be
    ``True`` :ghpull:`13566`.
 
  - No popup in window for latex generation when generating latex (e.g. via
    `_latex_repr_`) no popup window is shows under Windows. :ghpull:`13679`
 
  - Fixed error raised when attempting to tab-complete an input string with
    consecutive periods or forward slashes (such as "file:///var/log/...").
    :ghpull:`13675`
 
  - Relative filenames in Latex rendering :
    The `latex_to_png_dvipng` command internally generates input and output file
    arguments to `latex` and `dvipis`. These arguments are now generated as
    relative files to the current working directory instead of absolute file
    paths. This solves a problem where the current working directory contains
    characters that are not handled properly by `latex` and `dvips`. There are
    no changes to the user API. :ghpull:`13680`
 
  - Stripping decorators bug: Fixed bug which meant that ipython code blocks in
    restructured text documents executed with the ipython-sphinx extension
    skipped any lines of code containing python decorators. :ghpull:`13612`
 
  - Allow some modules with frozen dataclasses to be reloaded. :ghpull:`13732`
  - Fix paste magic on wayland. :ghpull:`13671`
  - show maxlen in deque's repr. :ghpull:`13648`
 
 Restore line numbers for Input
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Line number information in tracebacks from input are restored.
 Line numbers from input were removed during the transition to v8 enhanced traceback reporting.
 
 So, instead of::
 
     ---------------------------------------------------------------------------
     ZeroDivisionError                         Traceback (most recent call last)
     Input In [3], in <cell line: 1>()
     ----> 1 myfunc(2)
 
     Input In [2], in myfunc(z)
           1 def myfunc(z):
     ----> 2     foo.boo(z-1)
 
     File ~/code/python/ipython/foo.py:3, in boo(x)
           2 def boo(x):
     ----> 3     return 1/(1-x)
 
     ZeroDivisionError: division by zero
 
 The error traceback now looks like::
 
       ---------------------------------------------------------------------------
       ZeroDivisionError                         Traceback (most recent call last)
       Cell In [3], line 1
       ----> 1 myfunc(2)
 
       Cell In [2], line 2, in myfunc(z)
             1 def myfunc(z):
       ----> 2     foo.boo(z-1)
 
       File ~/code/python/ipython/foo.py:3, in boo(x)
             2 def boo(x):
       ----> 3     return 1/(1-x)
 
       ZeroDivisionError: division by zero
 
 or, with xmode=Plain::
 
     Traceback (most recent call last):
       Cell In [12], line 1
         myfunc(2)
       Cell In [6], line 2 in myfunc
         foo.boo(z-1)
       File ~/code/python/ipython/foo.py:3 in boo
         return 1/(1-x)
     ZeroDivisionError: division by zero
 
 :ghpull:`13560`
 
 New setting to silence warning if working inside a virtual environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Previously, when starting IPython in a virtual environment without IPython installed (so IPython from the global environment is used), the following warning was printed:
 
     Attempting to work in a virtualenv. If you encounter problems, please install IPython inside the virtualenv.
 
 This warning can be permanently silenced by setting ``c.InteractiveShell.warn_venv`` to ``False`` (the default is ``True``).
 
 :ghpull:`13706`
 
 -------
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.4.0:
 
 IPython 8.4.0
 -------------
 
 As for 7.34, this version contains a single fix:  fix uncaught BdbQuit exceptions on ipdb
 exit :ghpull:`13668`, and a single typo fix in documentation: :ghpull:`13682`
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 
 .. _version 8.3.0:
 
 IPython 8.3.0
 -------------
 
  - :ghpull:`13625`, using ``?``, ``??``, ``*?`` will not call
    ``set_next_input`` as most frontend allow proper multiline editing and it was
    causing issues for many users of multi-cell frontends. This has been backported to 7.33
 
 
  - :ghpull:`13600`, ``pre_run_*``-hooks will now have a ``cell_id`` attribute on
    the info object when frontend provides it. This has been backported to 7.33
 
  - :ghpull:`13624`, fixed :kbd:`End` key being broken after accepting an
    auto-suggestion.
 
  - :ghpull:`13657` fixed an issue where history from different sessions would be mixed.
 
 .. _version 8.2.0:
 
 IPython 8.2.0
 -------------
 
 IPython 8.2 mostly bring bugfixes to IPython.
 
  - Auto-suggestion can now be elected with the ``end`` key. :ghpull:`13566`
  - Some traceback issues with ``assert etb is not None`` have been fixed. :ghpull:`13588`
  - History is now pulled from the sqitel database and not from in-memory.
    In particular when using the ``%paste`` magic, the content of the pasted text will
    be part of the history and not the verbatim text ``%paste`` anymore. :ghpull:`13592`
  - Fix ``Ctrl-\\`` exit cleanup :ghpull:`13603`
  - Fixes to ``ultratb`` ipdb support when used outside of IPython. :ghpull:`13498`
 
 
 I am still trying to fix and investigate :ghissue:`13598`, which seems to be
 random, and would appreciate help if you find a reproducible minimal case. I've
 tried to make various changes to the codebase to mitigate it, but a proper fix
 will be difficult without understanding the cause.
 
 
 All the issues on pull-requests for this release can be found in the `8.2
 milestone. <https://github.com/ipython/ipython/milestone/100>`__ . And some
 documentation only PR can be found as part of the `7.33 milestone
 <https://github.com/ipython/ipython/milestone/101>`__ (currently not released).
 
 Thanks to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries.
 
 .. _version 8.1.1:
 
 IPython 8.1.1
 -------------
 
 Fix an issue with virtualenv and Python 3.8 introduced in 8.1
 
 Revert :ghpull:`13537` (fix an issue with symlinks in virtualenv) that raises an
 error in Python 3.8, and fixed in a different way in :ghpull:`13559`.
 
 .. _version 8.1:
 
 IPython 8.1.0
 -------------
 
 IPython 8.1 is the first minor release after 8.0 and fixes a number of bugs and
 updates a few behaviors that were problematic with the 8.0 as with many new major
 release.
 
 Note that beyond the changes listed here, IPython 8.1.0 also contains all the
 features listed in :ref:`version 7.32`.
 
  - Misc and multiple fixes around quotation auto-closing. It is now disabled by
    default. Run with ``TerminalInteractiveShell.auto_match=True`` to re-enabled
  - Require pygments>=2.4.0 :ghpull:`13459`, this was implicit in the code, but
    is now explicit in ``setup.cfg``/``setup.py``
  - Docs improvement of ``core.magic_arguments`` examples. :ghpull:`13433`
  - Multi-line edit executes too early with await. :ghpull:`13424`
 
  - ``black``  is back as an optional dependency, and autoformatting disabled by
    default until some fixes are implemented (black improperly reformat magics).
    :ghpull:`13471` Additionally the ability to use ``yapf`` as a code
    reformatter has been added :ghpull:`13528` . You can use
    ``TerminalInteractiveShell.autoformatter="black"``,
    ``TerminalInteractiveShell.autoformatter="yapf"`` to re-enable auto formatting
    with black, or switch to yapf.
 
  - Fix and issue where ``display`` was not defined.
 
  - Auto suggestions are now configurable. Currently only
    ``AutoSuggestFromHistory`` (default) and ``None``. new provider contribution
    welcomed. :ghpull:`13475`
 
  - multiple packaging/testing improvement to simplify downstream packaging
    (xfail with reasons, try to not access network...).
 
  - Update deprecation. ``InteractiveShell.magic`` internal method has been
    deprecated for many years but did not emit a warning until now.
 
  - internal ``appended_to_syspath`` context manager has been deprecated.
 
  - fix an issue with symlinks in virtualenv :ghpull:`13537` (Reverted in 8.1.1)
 
  - Fix an issue with vim mode, where cursor would not be reset on exit :ghpull:`13472`
 
  - ipython directive now remove only known pseudo-decorators :ghpull:`13532`
 
  - ``IPython/lib/security`` which used to be used for jupyter notebook has been
    removed.
 
  - Fix an issue where ``async with`` would execute on new lines. :ghpull:`13436`
 
 
 We want to remind users that IPython is part of the Jupyter organisations, and
 thus governed by a Code of Conduct. Some of the behavior we have seen on GitHub is not acceptable.
 Abuse and non-respectful comments on discussion will not be tolerated.
 
 Many thanks to all the contributors to this release, many of the above fixed issues and
 new features were done by first time contributors, showing there is still
 plenty of easy contribution possible in IPython
 . You can find all individual contributions
 to this milestone `on github <https://github.com/ipython/ipython/milestone/91>`__.
 
 Thanks as well to the `D. E. Shaw group <https://deshaw.com/>`__ for sponsoring
 work on IPython and related libraries. In particular the Lazy autoloading of
 magics that you will find described in the 7.32 release notes.
 
 
 .. _version 8.0.1:
 
 IPython 8.0.1 (CVE-2022-21699)
 ------------------------------
 
 IPython 8.0.1, 7.31.1 and 5.11 are security releases that change some default
 values in order to prevent potential Execution with Unnecessary Privileges.
 
 Almost all version of IPython looks for configuration and profiles in current
 working directory. Since IPython was developed before pip and environments
 existed it was used a convenient way to load code/packages in a project
 dependant way.
 
 In 2022, it is not necessary anymore, and can lead to confusing behavior where
 for example cloning a repository and starting IPython or loading a notebook from
 any Jupyter-Compatible interface that has ipython set as a kernel can lead to
 code execution.
 
 
 I did not find any standard way for packaged to advertise CVEs they fix, I'm
 thus trying to add a ``__patched_cves__`` attribute to the IPython module that
 list the CVEs that should have been fixed. This attribute is informational only
 as if a executable has a flaw, this value can always be changed by an attacker.
 
 .. code::
 
     In [1]: import IPython
 
     In [2]: IPython.__patched_cves__
     Out[2]: {'CVE-2022-21699'}
 
     In [3]: 'CVE-2022-21699' in IPython.__patched_cves__
     Out[3]: True
 
 Thus starting with this version:
 
  - The current working directory is not searched anymore for profiles or
    configurations files.
  - Added a ``__patched_cves__`` attribute (set of strings) to IPython module that contain
    the list of fixed CVE. This is informational only.
 
 Further details can be read on the `GitHub Advisory <https://github.com/ipython/ipython/security/advisories/GHSA-pq7m-3gw7-gq5x>`__
 
 
 .. _version 8.0:
 
 IPython 8.0
 -----------
 
 IPython 8.0 is bringing a large number of new features and improvements to both the
 user of the terminal and of the kernel via Jupyter. The removal of compatibility
 with an older version of Python is also the opportunity to do a couple of
 performance improvements in particular with respect to startup time.
 The 8.x branch started diverging from its predecessor around IPython 7.12
 (January 2020).
 
 This release contains 250+ pull requests, in addition to many of the features
 and backports that have made it to the 7.x branch. Please see the
 `8.0 milestone <https://github.com/ipython/ipython/milestone/73?closed=1>`__ for the full list of pull requests.
 
 Please feel free to send pull requests to update those notes after release,
 I have likely forgotten a few things reviewing 250+ PRs.
 
 Dependencies changes/downstream packaging
 -----------------------------------------
 
 Most of our building steps have been changed to be (mostly) declarative
 and follow PEP 517. We are trying to completely remove ``setup.py`` (:ghpull:`13238`) and are
 looking for help to do so.
 
  - minimum supported ``traitlets`` version is now 5+
  - we now require ``stack_data``
  - minimal Python is now 3.8
  - ``nose`` is not a testing requirement anymore
  - ``pytest`` replaces nose.
  - ``iptest``/``iptest3`` cli entrypoints do not exist anymore.
  - the minimum officially ​supported ``numpy`` version has been bumped, but this should
    not have much effect on packaging.
 
 
 Deprecation and removal
 -----------------------
 
 We removed almost all features, arguments, functions, and modules that were
 marked as deprecated between IPython 1.0 and 5.0. As a reminder, 5.0 was released
 in 2016, and 1.0 in 2013. Last release of the 5 branch was 5.10.0, in May 2020.
 The few remaining deprecated features we left have better deprecation warnings
 or have been turned into explicit errors for better error messages.
 
 I will use this occasion to add the following requests to anyone emitting a
 deprecation warning:
 
  - Please add at least ``stacklevel=2`` so that the warning is emitted into the
    caller context, and not the callee one.
  - Please add **since which version** something is deprecated.
 
 As a side note, it is much easier to conditionally compare version
 numbers rather than using ``try/except`` when functionality changes with a version.
 
 I won't list all the removed features here, but modules like ``IPython.kernel``,
 which was just a shim module around ``ipykernel`` for the past 8 years, have been
 removed, and so many other similar things that pre-date the name **Jupyter**
 itself.
 
 We no longer need to add ``IPython.extensions`` to the PYTHONPATH because that is being
 handled by ``load_extension``.
 
 We are also removing ``Cythonmagic``, ``sympyprinting`` and ``rmagic`` as they are now in
 other packages and no longer need to be inside IPython.
 
 
 Documentation
 -------------
 
 The majority of our docstrings have now been reformatted and automatically fixed by
 the experimental `Vélin <https://pypi.org/project/velin/>`_ project to conform
 to numpydoc.
 
 Type annotations
 ----------------
 
 While IPython itself is highly dynamic and can't be completely typed, many of
 the functions now have type annotations, and part of the codebase is now checked
 by mypy.
 
 
 Featured changes
 ----------------
 
 Here is a features list of changes in IPython 8.0. This is of course non-exhaustive.
 Please note as well that many features have been added in the 7.x branch as well
 (and hence why you want to read the 7.x what's new notes), in particular
 features contributed by QuantStack (with respect to debugger protocol and Xeus
 Python), as well as many debugger features that I was pleased to implement as
 part of my work at QuanSight and sponsored by DE Shaw.
 
 Traceback improvements
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Previously, error tracebacks for errors happening in code cells were showing a
 hash, the one used for compiling the Python AST::
 
     In [1]: def foo():
     ...:     return 3 / 0
     ...:
 
     In [2]: foo()
     ---------------------------------------------------------------------------
     ZeroDivisionError                         Traceback (most recent call last)
     <ipython-input-2-c19b6d9633cf> in <module>
     ----> 1 foo()
 
     <ipython-input-1-1595a74c32d5> in foo()
         1 def foo():
     ----> 2     return 3 / 0
         3
 
     ZeroDivisionError: division by zero
 
 The error traceback is now correctly formatted, showing the cell number in which the error happened::
 
     In [1]: def foo():
     ...:     return 3 / 0
     ...:
 
     Input In [2]: foo()
     ---------------------------------------------------------------------------
     ZeroDivisionError                         Traceback (most recent call last)
     input In [2], in <module>
     ----> 1 foo()
 
     Input In [1], in foo()
         1 def foo():
     ----> 2     return 3 / 0
 
     ZeroDivisionError: division by zero
 
 The ``stack_data`` package has been integrated, which provides smarter information in the traceback;
 in particular it will highlight the AST node where an error occurs which can help to quickly narrow down errors.
 
 For example in the following snippet::
 
     def foo(i):
         x = [[[0]]]
         return x[0][i][0]
 
 
     def bar():
         return foo(0) + foo(
             1
         ) + foo(2)
 
 
 calling ``bar()`` would raise an ``IndexError`` on the return line of ``foo``,
 and IPython 8.0 is capable of telling you where the index error occurs::
 
 
     IndexError
     Input In [2], in <module>
     ----> 1 bar()
             ^^^^^
 
     Input In [1], in bar()
           6 def bar():
     ----> 7     return foo(0) + foo(
                                 ^^^^
           8         1
              ^^^^^^^^
           9     ) + foo(2)
              ^^^^
 
     Input In [1], in foo(i)
           1 def foo(i):
           2     x = [[[0]]]
     ----> 3     return x[0][i][0]
                        ^^^^^^^
 
 The corresponding locations marked here with ``^`` will show up highlighted in
 the terminal and notebooks.
 
 Finally, a colon ``::`` and line number is appended after a filename in
 traceback::
 
 
     ZeroDivisionError               Traceback (most recent call last)
     File ~/error.py:4, in <module>
           1 def f():
           2     1/0
     ----> 4 f()
 
     File ~/error.py:2, in f()
           1 def f():
     ----> 2     1/0
 
 Many terminals and editors have integrations enabling you to directly jump to the
 relevant file/line when this syntax is used, so this small addition may have a high
 impact on productivity.
 
 
 Autosuggestions
 ~~~~~~~~~~~~~~~
 
 Autosuggestion is a very useful feature available in `fish <https://fishshell.com/>`__, `zsh <https://en.wikipedia.org/wiki/Z_shell>`__, and `prompt-toolkit <https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html#auto-suggestion>`__.
 
 `Ptpython <https://github.com/prompt-toolkit/ptpython#ptpython>`__ allows users to enable this feature in
 `ptpython/config.py <https://github.com/prompt-toolkit/ptpython/blob/master/examples/ptpython_config/config.py#L90>`__.
 
 This feature allows users to accept autosuggestions with ctrl e, ctrl f,
 or right arrow as described below.
 
 1. Start ipython
 
 .. image:: ../_images/8.0/auto_suggest_1_prompt_no_text.png
 
 2. Run ``print("hello")``
 
 .. image:: ../_images/8.0/auto_suggest_2_print_hello_suggest.png
 
 3. start typing ``print`` again to see the autosuggestion
 
 .. image:: ../_images/8.0/auto_suggest_3_print_hello_suggest.png
 
 4. Press ``ctrl-f``, or ``ctrl-e``, or ``right-arrow`` to accept the suggestion
 
 .. image:: ../_images/8.0/auto_suggest_4_print_hello.png
 
 You can also complete word by word:
 
 1. Run ``def say_hello(): print("hello")``
 
 .. image:: ../_images/8.0/auto_suggest_second_prompt.png
 
 2. Start typing  the first letter if ``def`` to see the autosuggestion
 
 .. image:: ../_images/8.0/auto_suggest_d_phantom.png
 
 3. Press ``alt-f`` (or ``escape`` followed by ``f``), to accept the first word of the suggestion
 
 .. image:: ../_images/8.0/auto_suggest_def_phantom.png
 
 Importantly, this feature does not interfere with tab completion:
 
 1. After running ``def say_hello(): print("hello")``, press d
 
 .. image:: ../_images/8.0/auto_suggest_d_phantom.png
 
 2. Press Tab to start tab completion
 
 .. image:: ../_images/8.0/auto_suggest_d_completions.png
 
 3A. Press Tab again to select the first option
 
 .. image:: ../_images/8.0/auto_suggest_def_completions.png
 
 3B. Press ``alt f`` (``escape``, ``f``) to accept to accept the first word of the suggestion
 
 .. image:: ../_images/8.0/auto_suggest_def_phantom.png
 
 3C. Press ``ctrl-f`` or ``ctrl-e`` to accept the entire suggestion
 
 .. image:: ../_images/8.0/auto_suggest_match_parens.png
 
 
 Currently, autosuggestions are only shown in the emacs or vi insert editing modes:
 
 - The ctrl e, ctrl f, and alt f shortcuts work by default in emacs mode.
 - To use these shortcuts in vi insert mode, you will have to create `custom keybindings in your config.py <https://github.com/mskar/setup/commit/2892fcee46f9f80ef7788f0749edc99daccc52f4/>`__.
 
 
 Show pinfo information in ipdb using "?" and "??"
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In IPDB, it is now possible to show the information about an object using "?"
 and "??", in much the same way that it can be done when using the IPython prompt::
 
     ipdb> partial?
     Init signature: partial(self, /, *args, **kwargs)
     Docstring:
     partial(func, *args, **keywords) - new function with partial application
     of the given arguments and keywords.
     File:           ~/.pyenv/versions/3.8.6/lib/python3.8/functools.py
     Type:           type
     Subclasses:
 
 Previously, ``pinfo`` or ``pinfo2`` command had to be used for this purpose.
 
 
 Autoreload 3 feature
 ~~~~~~~~~~~~~~~~~~~~
 
 Example: When an IPython session is run with the 'autoreload' extension loaded,
 you will now have the option '3' to select, which means the following:
 
     1. replicate all functionality from option 2
     2. autoload all new funcs/classes/enums/globals from the module when they are added
     3. autoload all newly imported funcs/classes/enums/globals from external modules
 
 Try ``%autoreload 3`` in an IPython session after running ``%load_ext autoreload``.
 
 For more information please see the following unit test : ``extensions/tests/test_autoreload.py:test_autoload_newly_added_objects``
 
 Auto formatting with black in the CLI
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This feature was present in 7.x, but disabled by default.
 
 In 8.0, input was automatically reformatted with Black when black was installed.
 This feature has been reverted for the time being.
 You can re-enable it by setting ``TerminalInteractiveShell.autoformatter`` to ``"black"``
 
 History Range Glob feature
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Previously, when using ``%history``, users could specify either
 a range of sessions and lines, for example:
 
 .. code-block:: python
 
    ~8/1-~6/5   # see history from the first line of 8 sessions ago,
                # to the fifth line of 6 sessions ago.``
 
 Or users could specify a glob pattern:
 
 .. code-block:: python
 
    -g <pattern>  # glob ALL history for the specified pattern.
 
 However users could *not* specify both.
 
 If a user *did* specify both a range and a glob pattern,
 then the glob pattern would be used (globbing *all* history) *and the range would be ignored*.
 
 With this enhancement, if a user specifies both a range and a glob pattern, then the glob pattern will be applied to the specified range of history.
 
 Don't start a multi-line cell with sunken parenthesis
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 From now on, IPython will not ask for the next line of input when given a single
 line with more closing than opening brackets. For example, this means that if
 you (mis)type ``]]`` instead of ``[]``, a ``SyntaxError`` will show up, instead of
 the ``...:`` prompt continuation.
 
 IPython shell for ipdb interact
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The ipdb ``interact`` starts an IPython shell instead of Python's built-in ``code.interact()``.
 
 Automatic Vi prompt stripping
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 When pasting code into IPython, it will strip the leading prompt characters if
 there are any. For example, you can paste the following code into the console -
 it will still work, even though each line is prefixed with prompts (``In``,
 ``Out``)::
 
     In [1]: 2 * 2 == 4
     Out[1]: True
 
     In [2]: print("This still works as pasted")
 
 
 Previously, this was not the case for the Vi-mode prompts::
 
     In [1]: [ins] In [13]: 2 * 2 == 4
        ...: Out[13]: True
        ...:
       File "<ipython-input-1-727bb88eaf33>", line 1
         [ins] In [13]: 2 * 2 == 4
               ^
     SyntaxError: invalid syntax
 
 This is now fixed, and Vi prompt prefixes - ``[ins]`` and ``[nav]`` -  are
 skipped just as the normal ``In`` would be.
 
 IPython shell can be started in the Vi mode using ``ipython --TerminalInteractiveShell.editing_mode=vi``,
 You should be able to change mode dynamically with ``%config TerminalInteractiveShell.editing_mode='vi'``
 
 Empty History Ranges
 ~~~~~~~~~~~~~~~~~~~~
 
 A number of magics that take history ranges can now be used with an empty
 range. These magics are:
 
  * ``%save``
  * ``%load``
  * ``%pastebin``
  * ``%pycat``
 
 Using them this way will make them take the history of the current session up
 to the point of the magic call (such that the magic itself will not be
 included).
 
 Therefore it is now possible to save the whole history to a file using
 ``%save <filename>``, load and edit it using ``%load`` (makes for a nice usage
 when followed with :kbd:`F2`), send it to `dpaste.org <http://dpast.org>`_ using
 ``%pastebin``, or view the whole thing syntax-highlighted with a single
 ``%pycat``.
 
 
 Windows timing implementation: Switch to process_time
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Timing on Windows, for example with ``%%time``,  was changed from being based on ``time.perf_counter``
 (which counted time even when the process was sleeping) to being based on ``time.process_time`` instead
 (which only counts CPU time). This brings it closer to the behavior on Linux. See :ghpull:`12984`.
 
 Miscellaneous
 ~~~~~~~~~~~~~
  - Non-text formatters are not disabled in the terminal, which should simplify
    writing extensions displaying images or other mimetypes in supporting terminals.
    :ghpull:`12315`
  - It is now possible to automatically insert matching brackets in Terminal IPython using the
    ``TerminalInteractiveShell.auto_match=True`` option. :ghpull:`12586`
  - We are thinking of deprecating the current ``%%javascript`` magic in favor of a better replacement. See :ghpull:`13376`.
  - ``~`` is now expanded when part of a path in most magics :ghpull:`13385`
  - ``%/%%timeit`` magic now adds a comma every thousands to make reading a long number easier :ghpull:`13379`
  - ``"info"`` messages can now be customised to hide some fields :ghpull:`13343`
  - ``collections.UserList`` now pretty-prints :ghpull:`13320`
  - The debugger now has a persistent history, which should make it less
    annoying to retype commands :ghpull:`13246`
  - ``!pip`` ``!conda`` ``!cd`` or ``!ls`` are likely doing the wrong thing. We
    now warn users if they use one of those commands. :ghpull:`12954`
  - Make ``%precision`` work for ``numpy.float64`` type :ghpull:`12902`
 
 Re-added support for XDG config directories
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 XDG support through the years comes and goes. There is a tension between having
 an identical location for configuration in all platforms versus having simple instructions.
 After initial failures a couple of years ago, IPython was modified to automatically migrate XDG
 config files back into ``~/.ipython``. That migration code has now been removed.
 IPython now checks the XDG locations, so if you _manually_ move your config
 files to your preferred location, IPython will not move them back.
 
 
 Preparing for Python 3.10
 -------------------------
 
 To prepare for Python 3.10, we have started working on removing reliance and
 any dependency that is not compatible with Python 3.10. This includes migrating our
 test suite to pytest and starting to remove nose. This also means that the
 ``iptest`` command is now gone and all testing is via pytest.
 
 This was in large part thanks to the NumFOCUS Small Developer grant, which enabled us to
 allocate \$4000 to hire `Nikita Kniazev (@Kojoley) <https://github.com/Kojoley>`_,
 who did a fantastic job at updating our code base, migrating to pytest, pushing
 our coverage, and fixing a large number of bugs. I highly recommend contacting
 them if you need help with C++ and Python projects.
 
 You can find all relevant issues and PRs with `the SDG 2021 tag <https://github.com/ipython/ipython/issues?q=label%3A%22Numfocus+SDG+2021%22+>`__
 
 Removing support for older Python versions
 ------------------------------------------
 
 
 We are removing support for Python up through 3.7, allowing internal code to use the more
 efficient ``pathlib`` and to make better use of type annotations.
 
 .. image:: ../_images/8.0/pathlib_pathlib_everywhere.jpg
    :alt: "Meme image of Toy Story with Woody and Buzz, with the text 'pathlib, pathlib everywhere'"
 
 
 We had about 34 PRs only to update some logic to update some functions from managing strings to
 using Pathlib.
 
 The completer has also seen significant updates and now makes use of newer Jedi APIs,
 offering faster and more reliable tab completion.
 
 Misc Statistics
 ---------------
 
 Here are some numbers::
 
     7.x: 296 files, 12561 blank lines, 20282 comments, 35142 line of code.
     8.0: 252 files, 12053 blank lines, 19232 comments, 34505 line of code.
 
     $ git diff --stat 7.x...master  | tail -1
     340 files changed, 13399 insertions(+), 12421 deletions(-)
 
 We have commits from 162 authors, who contributed 1916 commits in 23 month, excluding merges (to not bias toward
 maintainers pushing buttons).::
 
    $ git shortlog  -s --no-merges  7.x...master | sort -nr
    535	Matthias Bussonnier
     86	Nikita Kniazev
     69	Blazej Michalik
     49	Samuel Gaist
     27	Itamar Turner-Trauring
     18	Spas Kalaydzhisyki
     17	Thomas Kluyver
     17	Quentin Peter
     17	James Morris
     17	Artur Svistunov
     15	Bart Skowron
     14	Alex Hall
     13	rushabh-v
     13	Terry Davis
     13	Benjamin Ragan-Kelley
      8	martinRenou
      8	farisachugthai
      7	dswij
      7	Gal B
      7	Corentin Cadiou
      6	yuji96
      6	Martin Skarzynski
      6	Justin Palmer
      6	Daniel Goldfarb
      6	Ben Greiner
      5	Sammy Al Hashemi
      5	Paul Ivanov
      5	Inception95
      5	Eyenpi
      5	Douglas Blank
      5	Coco Mishra
      5	Bibo Hao
      5	André A. Gomes
      5	Ahmed Fasih
      4	takuya fujiwara
      4	palewire
      4	Thomas A Caswell
      4	Talley Lambert
      4	Scott Sanderson
      4	Ram Rachum
      4	Nick Muoh
      4	Nathan Goldbaum
      4	Mithil Poojary
      4	Michael T
      4	Jakub Klus
      4	Ian Castleden
      4	Eli Rykoff
      4	Ashwin Vishnu
      3	谭九鼎
      3	sleeping
      3	Sylvain Corlay
      3	Peter Corke
      3	Paul Bissex
      3	Matthew Feickert
      3	Fernando Perez
      3	Eric Wieser
      3	Daniel Mietchen
      3	Aditya Sathe
      3	007vedant
      2	rchiodo
      2	nicolaslazo
      2	luttik
      2	gorogoroumaru
      2	foobarbyte
      2	bar-hen
      2	Theo Ouzhinski
      2	Strawkage
      2	Samreen Zarroug
      2	Pete Blois
      2	Meysam Azad
      2	Matthieu Ancellin
      2	Mark Schmitz
      2	Maor Kleinberger
      2	MRCWirtz
      2	Lumir Balhar
      2	Julien Rabinow
      2	Juan Luis Cano Rodríguez
      2	Joyce Er
      2	Jakub
      2	Faris A Chugthai
      2	Ethan Madden
      2	Dimitri Papadopoulos
      2	Diego Fernandez
      2	Daniel Shimon
      2	Coco Bennett
      2	Carlos Cordoba
      2	Boyuan Liu
      2	BaoGiang HoangVu
      2	Augusto
      2	Arthur Svistunov
      2	Arthur Moreira
      2	Ali Nabipour
      2	Adam Hackbarth
      1	richard
      1	linar-jether
      1	lbennett
      1	juacrumar
      1	gpotter2
      1	digitalvirtuoso
      1	dalthviz
      1	Yonatan Goldschmidt
      1	Tomasz Kłoczko
      1	Tobias Bengfort
      1	Timur Kushukov
      1	Thomas
      1	Snir Broshi
      1	Shao Yang Hong
      1	Sanjana-03
      1	Romulo Filho
      1	Rodolfo Carvalho
      1	Richard Shadrach
      1	Reilly Tucker Siemens
      1	Rakessh Roshan
      1	Piers Titus van der Torren
      1	PhanatosZou
      1	Pavel Safronov
      1	Paulo S. Costa
      1	Paul McCarthy
      1	NotWearingPants
      1	Naelson Douglas
      1	Michael Tiemann
      1	Matt Wozniski
      1	Markus Wageringel
      1	Marcus Wirtz
      1	Marcio Mazza
      1	Lumír 'Frenzy' Balhar
      1	Lightyagami1
      1	Leon Anavi
      1	LeafyLi
      1	L0uisJ0shua
      1	Kyle Cutler
      1	Krzysztof Cybulski
      1	Kevin Kirsche
      1	KIU Shueng Chuan
      1	Jonathan Slenders
      1	Jay Qi
      1	Jake VanderPlas
      1	Iwan Briquemont
      1	Hussaina Begum Nandyala
      1	Gordon Ball
      1	Gabriel Simonetto
      1	Frank Tobia
      1	Erik
      1	Elliott Sales de Andrade
      1	Daniel Hahler
      1	Dan Green-Leipciger
      1	Dan Green
      1	Damian Yurzola
      1	Coon, Ethan T
      1	Carol Willing
      1	Brian Lee
      1	Brendan Gerrity
      1	Blake Griffin
      1	Bastian Ebeling
      1	Bartosz Telenczuk
      1	Ankitsingh6299
      1	Andrew Port
      1	Andrew J. Hesford
      1	Albert Zhang
      1	Adam Johnson
 
 This does not, of course, represent non-code contributions, for which we are also grateful.
 
 
 API Changes using Frappuccino
 -----------------------------
 
 This is an experimental exhaustive API difference using `Frappuccino <https://pypi.org/project/frappuccino/>`_
 
 
 The following items are new in IPython 8.0 ::
 
     + IPython.core.async_helpers.get_asyncio_loop()
     + IPython.core.completer.Dict
     + IPython.core.completer.Pattern
     + IPython.core.completer.Sequence
     + IPython.core.completer.__skip_doctest__
     + IPython.core.debugger.Pdb.precmd(self, line)
     + IPython.core.debugger.__skip_doctest__
     + IPython.core.display.__getattr__(name)
     + IPython.core.display.warn
     + IPython.core.display_functions
     + IPython.core.display_functions.DisplayHandle
     + IPython.core.display_functions.DisplayHandle.display(self, obj, **kwargs)
     + IPython.core.display_functions.DisplayHandle.update(self, obj, **kwargs)
     + IPython.core.display_functions.__all__
     + IPython.core.display_functions.__builtins__
     + IPython.core.display_functions.__cached__
     + IPython.core.display_functions.__doc__
     + IPython.core.display_functions.__file__
     + IPython.core.display_functions.__loader__
     + IPython.core.display_functions.__name__
     + IPython.core.display_functions.__package__
     + IPython.core.display_functions.__spec__
     + IPython.core.display_functions.b2a_hex
     + IPython.core.display_functions.clear_output(wait=False)
     + IPython.core.display_functions.display(*objs, include='None', exclude='None', metadata='None', transient='None', display_id='None', raw=False, clear=False, **kwargs)
     + IPython.core.display_functions.publish_display_data(data, metadata='None', source='<deprecated>', *, transient='None', **kwargs)
     + IPython.core.display_functions.update_display(obj, *, display_id, **kwargs)
     + IPython.core.extensions.BUILTINS_EXTS
     + IPython.core.inputtransformer2.has_sunken_brackets(tokens)
     + IPython.core.interactiveshell.Callable
     + IPython.core.interactiveshell.__annotations__
     + IPython.core.ultratb.List
     + IPython.core.ultratb.Tuple
     + IPython.lib.pretty.CallExpression
     + IPython.lib.pretty.CallExpression.factory(name)
     + IPython.lib.pretty.RawStringLiteral
     + IPython.lib.pretty.RawText
     + IPython.terminal.debugger.TerminalPdb.do_interact(self, arg)
     + IPython.terminal.embed.Set
 
 The following items have been removed (or moved to superclass)::
 
     - IPython.core.application.BaseIPythonApplication.initialize_subcommand
     - IPython.core.completer.Sentinel
     - IPython.core.completer.skip_doctest
     - IPython.core.debugger.Tracer
     - IPython.core.display.DisplayHandle
     - IPython.core.display.DisplayHandle.display
     - IPython.core.display.DisplayHandle.update
     - IPython.core.display.b2a_hex
     - IPython.core.display.clear_output
     - IPython.core.display.display
     - IPython.core.display.publish_display_data
     - IPython.core.display.update_display
     - IPython.core.excolors.Deprec
     - IPython.core.excolors.ExceptionColors
     - IPython.core.history.warn
     - IPython.core.hooks.late_startup_hook
     - IPython.core.hooks.pre_run_code_hook
     - IPython.core.hooks.shutdown_hook
     - IPython.core.interactiveshell.InteractiveShell.init_deprecation_warnings
     - IPython.core.interactiveshell.InteractiveShell.init_readline
     - IPython.core.interactiveshell.InteractiveShell.write
     - IPython.core.interactiveshell.InteractiveShell.write_err
     - IPython.core.interactiveshell.get_default_colors
     - IPython.core.interactiveshell.removed_co_newlocals
     - IPython.core.magics.execution.ExecutionMagics.profile_missing_notice
     - IPython.core.magics.script.PIPE
     - IPython.core.prefilter.PrefilterManager.init_transformers
     - IPython.core.release.classifiers
     - IPython.core.release.description
     - IPython.core.release.keywords
     - IPython.core.release.long_description
     - IPython.core.release.name
     - IPython.core.release.platforms
     - IPython.core.release.url
     - IPython.core.ultratb.VerboseTB.format_records
     - IPython.core.ultratb.find_recursion
     - IPython.core.ultratb.findsource
     - IPython.core.ultratb.fix_frame_records_filenames
     - IPython.core.ultratb.inspect_error
     - IPython.core.ultratb.is_recursion_error
     - IPython.core.ultratb.with_patch_inspect
     - IPython.external.__all__
     - IPython.external.__builtins__
     - IPython.external.__cached__
     - IPython.external.__doc__
     - IPython.external.__file__
     - IPython.external.__loader__
     - IPython.external.__name__
     - IPython.external.__package__
     - IPython.external.__path__
     - IPython.external.__spec__
     - IPython.kernel.KernelConnectionInfo
     - IPython.kernel.__builtins__
     - IPython.kernel.__cached__
     - IPython.kernel.__warningregistry__
     - IPython.kernel.pkg
     - IPython.kernel.protocol_version
     - IPython.kernel.protocol_version_info
     - IPython.kernel.src
     - IPython.kernel.version_info
     - IPython.kernel.warn
     - IPython.lib.backgroundjobs
     - IPython.lib.backgroundjobs.BackgroundJobBase
     - IPython.lib.backgroundjobs.BackgroundJobBase.run
     - IPython.lib.backgroundjobs.BackgroundJobBase.traceback
     - IPython.lib.backgroundjobs.BackgroundJobExpr
     - IPython.lib.backgroundjobs.BackgroundJobExpr.call
     - IPython.lib.backgroundjobs.BackgroundJobFunc
     - IPython.lib.backgroundjobs.BackgroundJobFunc.call
     - IPython.lib.backgroundjobs.BackgroundJobManager
     - IPython.lib.backgroundjobs.BackgroundJobManager.flush
     - IPython.lib.backgroundjobs.BackgroundJobManager.new
     - IPython.lib.backgroundjobs.BackgroundJobManager.remove
     - IPython.lib.backgroundjobs.BackgroundJobManager.result
     - IPython.lib.backgroundjobs.BackgroundJobManager.status
     - IPython.lib.backgroundjobs.BackgroundJobManager.traceback
     - IPython.lib.backgroundjobs.__builtins__
     - IPython.lib.backgroundjobs.__cached__
     - IPython.lib.backgroundjobs.__doc__
     - IPython.lib.backgroundjobs.__file__
     - IPython.lib.backgroundjobs.__loader__
     - IPython.lib.backgroundjobs.__name__
     - IPython.lib.backgroundjobs.__package__
     - IPython.lib.backgroundjobs.__spec__
     - IPython.lib.kernel.__builtins__
     - IPython.lib.kernel.__cached__
     - IPython.lib.kernel.__doc__
     - IPython.lib.kernel.__file__
     - IPython.lib.kernel.__loader__
     - IPython.lib.kernel.__name__
     - IPython.lib.kernel.__package__
     - IPython.lib.kernel.__spec__
     - IPython.lib.kernel.__warningregistry__
     - IPython.paths.fs_encoding
     - IPython.terminal.debugger.DEFAULT_BUFFER
     - IPython.terminal.debugger.cursor_in_leading_ws
     - IPython.terminal.debugger.emacs_insert_mode
     - IPython.terminal.debugger.has_selection
     - IPython.terminal.debugger.vi_insert_mode
     - IPython.terminal.interactiveshell.DISPLAY_BANNER_DEPRECATED
     - IPython.terminal.ipapp.TerminalIPythonApp.parse_command_line
     - IPython.testing.test
     - IPython.utils.contexts.NoOpContext
     - IPython.utils.io.IOStream
     - IPython.utils.io.IOStream.close
     - IPython.utils.io.IOStream.write
     - IPython.utils.io.IOStream.writelines
     - IPython.utils.io.__warningregistry__
     - IPython.utils.io.atomic_writing
     - IPython.utils.io.stderr
     - IPython.utils.io.stdin
     - IPython.utils.io.stdout
     - IPython.utils.io.unicode_std_stream
     - IPython.utils.path.get_ipython_cache_dir
     - IPython.utils.path.get_ipython_dir
     - IPython.utils.path.get_ipython_module_path
     - IPython.utils.path.get_ipython_package_dir
     - IPython.utils.path.locate_profile
     - IPython.utils.path.unquote_filename
     - IPython.utils.py3compat.PY2
     - IPython.utils.py3compat.PY3
     - IPython.utils.py3compat.buffer_to_bytes
     - IPython.utils.py3compat.builtin_mod_name
     - IPython.utils.py3compat.cast_bytes
     - IPython.utils.py3compat.getcwd
     - IPython.utils.py3compat.isidentifier
     - IPython.utils.py3compat.u_format
 
 The following signatures differ between 7.x and 8.0::
 
     - IPython.core.completer.IPCompleter.unicode_name_matches(self, text)
     + IPython.core.completer.IPCompleter.unicode_name_matches(text)
 
     - IPython.core.completer.match_dict_keys(keys, prefix, delims)
     + IPython.core.completer.match_dict_keys(keys, prefix, delims, extra_prefix='None')
 
     - IPython.core.interactiveshell.InteractiveShell.object_inspect_mime(self, oname, detail_level=0)
     + IPython.core.interactiveshell.InteractiveShell.object_inspect_mime(self, oname, detail_level=0, omit_sections='()')
 
     - IPython.core.interactiveshell.InteractiveShell.set_hook(self, name, hook, priority=50, str_key='None', re_key='None', _warn_deprecated=True)
     + IPython.core.interactiveshell.InteractiveShell.set_hook(self, name, hook, priority=50, str_key='None', re_key='None')
 
     - IPython.core.oinspect.Inspector.info(self, obj, oname='', formatter='None', info='None', detail_level=0)
     + IPython.core.oinspect.Inspector.info(self, obj, oname='', info='None', detail_level=0)
 
     - IPython.core.oinspect.Inspector.pinfo(self, obj, oname='', formatter='None', info='None', detail_level=0, enable_html_pager=True)
     + IPython.core.oinspect.Inspector.pinfo(self, obj, oname='', formatter='None', info='None', detail_level=0, enable_html_pager=True, omit_sections='()')
 
     - IPython.core.profiledir.ProfileDir.copy_config_file(self, config_file, path='None', overwrite=False)
     + IPython.core.profiledir.ProfileDir.copy_config_file(self, config_file, path, overwrite=False)
 
     - IPython.core.ultratb.VerboseTB.format_record(self, frame, file, lnum, func, lines, index)
     + IPython.core.ultratb.VerboseTB.format_record(self, frame_info)
 
     - IPython.terminal.embed.InteractiveShellEmbed.mainloop(self, local_ns='None', module='None', stack_depth=0, display_banner='None', global_ns='None', compile_flags='None')
     + IPython.terminal.embed.InteractiveShellEmbed.mainloop(self, local_ns='None', module='None', stack_depth=0, compile_flags='None')
 
     - IPython.terminal.embed.embed(**kwargs)
     + IPython.terminal.embed.embed(*, header='', compile_flags='None', **kwargs)
 
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.interact(self, display_banner='<object object at 0xffffff>')
     + IPython.terminal.interactiveshell.TerminalInteractiveShell.interact(self)
 
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.mainloop(self, display_banner='<object object at 0xffffff>')
     + IPython.terminal.interactiveshell.TerminalInteractiveShell.mainloop(self)
 
     - IPython.utils.path.get_py_filename(name, force_win32='None')
     + IPython.utils.path.get_py_filename(name)
 
 The following are new attributes (that might be inherited)::
 
     + IPython.core.completer.IPCompleter.unicode_names
     + IPython.core.debugger.InterruptiblePdb.precmd
     + IPython.core.debugger.Pdb.precmd
     + IPython.core.ultratb.AutoFormattedTB.has_colors
     + IPython.core.ultratb.ColorTB.has_colors
     + IPython.core.ultratb.FormattedTB.has_colors
     + IPython.core.ultratb.ListTB.has_colors
     + IPython.core.ultratb.SyntaxTB.has_colors
     + IPython.core.ultratb.TBTools.has_colors
     + IPython.core.ultratb.VerboseTB.has_colors
     + IPython.terminal.debugger.TerminalPdb.do_interact
     + IPython.terminal.debugger.TerminalPdb.precmd
 
 The following attribute/methods have been removed::
 
     - IPython.core.application.BaseIPythonApplication.deprecated_subcommands
     - IPython.core.ultratb.AutoFormattedTB.format_records
     - IPython.core.ultratb.ColorTB.format_records
     - IPython.core.ultratb.FormattedTB.format_records
     - IPython.terminal.embed.InteractiveShellEmbed.init_deprecation_warnings
     - IPython.terminal.embed.InteractiveShellEmbed.init_readline
     - IPython.terminal.embed.InteractiveShellEmbed.write
     - IPython.terminal.embed.InteractiveShellEmbed.write_err
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.init_deprecation_warnings
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.init_readline
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.write
     - IPython.terminal.interactiveshell.TerminalInteractiveShell.write_err
     - IPython.terminal.ipapp.LocateIPythonApp.deprecated_subcommands
     - IPython.terminal.ipapp.LocateIPythonApp.initialize_subcommand
     - IPython.terminal.ipapp.TerminalIPythonApp.deprecated_subcommands
     - IPython.terminal.ipapp.TerminalIPythonApp.initialize_subcommand
 
 ------
 
 .. [1] If this make you incomfortable feel free to not use IPython 8.23.