Merge pull request #13388 from Carreau/reformat-docstring

Reformat docstring and v8 what's new.

IPython/core/completer.py

@@ -462,7 +462,7 b' def _deduplicate_completions(text: str, completions: _IC)-> _IC:'
             seen.add(new_text)
 
 
-def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:
+def rectify_completions(text: str, completions: _IC, *, _debug: bool = False) -> _IC:
     """
     Rectify a set of completions to all have the same ``start`` and ``end``
 
@@ -479,6 +479,8 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:'
         text that should be completed.
     completions : Iterator[Completion]
         iterator over the completions to rectify
+    _debug : bool
+        Log failed completion
 
     Notes
     -----
@@ -1128,16 +1130,22 b' class IPCompleter(Completer):'
             secondary optional dict for completions, to
             handle cases (such as IPython embedded inside functions) where
             both Python scopes are visible.
-        use_readline : bool, optional
-            DEPRECATED, ignored since IPython 6.0, will have no effects
+        config : Config
+            traitlet's config object
+        **kwargs
+            passed to super class unmodified.
         """
 
         self.magic_escape = ESC_MAGIC
         self.splitter = CompletionSplitter()
 
         # _greedy_changed() depends on splitter and readline being defined:
-        Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
-                            config=config, **kwargs)
+        super().__init__(
+            namespace=namespace,
+            global_namespace=global_namespace,
+            config=config,
+            **kwargs
+        )
 
         # List where completion matches will be stored
         self.matches = []
@@ -2055,9 +2063,9 b' class IPCompleter(Completer):'
 
         Parameters
         ----------
-        cursor_line :
+        cursor_line
             Index of the line the cursor is on. 0 indexed.
-        cursor_pos :
+        cursor_pos
             Position of the cursor in the current line/line_buffer/text. 0
             indexed.
         line_buffer : optional, str

IPython/core/crashhandler.py

@@ -32,6 +32,8 b' from IPython.utils.py3compat import input'
 
 from IPython.core.release import __version__ as version
 
+from typing import Optional
+
 #-----------------------------------------------------------------------------
 # Code
 #-----------------------------------------------------------------------------
@@ -95,8 +97,15 b' class CrashHandler(object):'
     message_template = _default_message_template
     section_sep = '\n\n'+'*'*75+'\n\n'
 
-    def __init__(self, app, contact_name=None, contact_email=None,
-                 bug_tracker=None, show_crash_traceback=True, call_pdb=False):
+    def __init__(
+        self,
+        app,
+        contact_name: Optional[str] = None,
+        contact_email: Optional[str] = None,
+        bug_tracker: Optional[str] = None,
+        show_crash_traceback: bool = True,
+        call_pdb: bool = False,
+    ):
         """Create a new crash handler
 
         Parameters
@@ -113,10 +122,15 b' class CrashHandler(object):'
         show_crash_traceback : bool
             If false, don't print the crash traceback on stderr, only generate
             the on-disk report
-        Non-argument instance attributes
+        call_pdb
+            Whether to call pdb on crash
+
+        Attributes
+        ----------
         These instances contain some non-argument attributes which allow for
         further customization of the crash handler's behavior. Please see the
         source for further details.
+
         """
         self.crash_report_fname = "Crash_report_%s.txt" % app.name
         self.app = app

IPython/core/debugger.py

@@ -798,7 +798,6 b' class Pdb(OldPdb):'
 
     def break_anywhere(self, frame):
         """
-
         _stop_in_decorator_internals is overly restrictive, as we may still want
         to trace function calls, so we need to also update break_anywhere so
         that is we don't `stop_here`, because of debugger skip, we may still
@@ -820,8 +819,6 b' class Pdb(OldPdb):'
         """
         Utility to tell us whether we are in a decorator internal and should stop.
 
-
-
         """
 
         # if we are disabled don't skip

IPython/core/display.py

@@ -826,15 +826,19 b' class Image(DisplayObject):'
         data : unicode, str or bytes
             The raw image data or a URL or filename to load the data from.
             This always results in embedded image data.
+
         url : unicode
             A URL to download the data from. If you specify `url=`,
             the image data will not be embedded unless you also specify `embed=True`.
+
         filename : unicode
             Path to a local file to load the data from.
             Images from a file are always embedded.
+
         format : unicode
             The format of the image data (png/jpeg/jpg/gif). If a filename or URL is given
             for format will be inferred from the filename extension.
+
         embed : bool
             Should the image data be embedded using a data URI (True) or be
             loaded using an <img> tag. Set this to True if you want the image
@@ -844,10 +848,13 b' class Image(DisplayObject):'
             default value is `False`.
 
             Note that QtConsole is not able to display images if `embed` is set to `False`
+
         width : int
             Width in pixels to which to constrain the image in html
+
         height : int
             Height in pixels to which to constrain the image in html
+
         retina : bool
             Automatically set the width and height to half of the measured
             width and height.
@@ -855,10 +862,13 b' class Image(DisplayObject):'
             from image data.
             For non-embedded images, you can just set the desired display width
             and height directly.
+
         unconfined : bool
             Set unconfined=True to disable max-width confinement of the image.
+
         metadata : dict
             Specify extra metadata to attach to the image.
+
         alt : unicode
             Alternative text for the image, for use by screen readers.
 
@@ -1067,12 +1077,15 b' class Video(DisplayObject):'
         data : unicode, str or bytes
             The raw video data or a URL or filename to load the data from.
             Raw data will require passing ``embed=True``.
+
         url : unicode
             A URL for the video. If you specify ``url=``,
             the image data will not be embedded.
+
         filename : unicode
             Path to a local file containing the video.
             Will be interpreted as a local URL unless ``embed=True``.
+
         embed : bool
             Should the video be embedded using a data URI (True) or be
             loaded using a <video> tag (False).
@@ -1083,15 +1096,19 b' class Video(DisplayObject):'
             Local files can be displayed with URLs without embedding the content, via::
 
                 Video('./video.mp4')
+
         mimetype : unicode
             Specify the mimetype for embedded videos.
             Default will be guessed from file extension, if available.
+
         width : int
             Width in pixels to which to constrain the video in HTML.
             If not supplied, defaults to the width of the video.
+
         height : int
             Height in pixels to which to constrain the video in html.
             If not supplied, defaults to the height of the video.
+
         html_attributes : str
             Attributes for the HTML ``<video>`` block.
             Default: ``"controls"`` to get video controls.
@@ -1221,7 +1238,6 b' def set_matplotlib_close(close=True):'
 
         use `matplotlib_inline.backend_inline.set_matplotlib_close()`
 
-
     Set whether the inline backend closes all figures automatically or not.
 
     By default, the inline backend used in the IPython Notebook will close all

IPython/core/formatters.py

@@ -433,6 +433,7 b' class BaseFormatter(Configurable):'
         ----------
         typ : type or '__module__.__name__' string for a type
             The class of the object that will be formatted using `func`.
+
         func : callable
             A callable for computing the format data.
             `func` will be called with the object to be formatted,
@@ -474,8 +475,10 b' class BaseFormatter(Configurable):'
         type_module : str
             The full dotted name of the module the type is defined in, like
             ``numpy``.
+
         type_name : str
             The name of the type (the class name), like ``dtype``
+
         func : callable
             A callable for computing the format data.
             `func` will be called with the object to be formatted,

IPython/core/history.py

@@ -305,13 +305,11 b' class HistoryAccessor(HistoryAccessorBase):'
 
         Parameters
         ----------
-
         session : int
             Session number to retrieve.
 
         Returns
         -------
-
         session_id : int
            Session ID number
         start : datetime
@@ -605,14 +603,12 b' class HistoryManager(HistoryAccessor):'
 
         Parameters
         ----------
-
         session : int
             Session number to retrieve. The current session is 0, and negative
             numbers count back from current session, so -1 is the previous session.
 
         Returns
         -------
-
         session_id : int
            Session ID number
         start : datetime
@@ -695,10 +691,8 b' class HistoryManager(HistoryAccessor):'
         ----------
         line_num : int
           The prompt number of this input.
-
         source : str
           Python input.
-
         source_raw : str, optional
           If given, this is the raw input without any IPython transformations
           applied to it.  If not given, ``source`` is used.

IPython/core/inputtransformer.py

@@ -407,7 +407,6 b' def _strip_prompts(prompt_re, initial_re=None, turnoff_re=None):'
         If no initial expression is given, prompt_re will be used everywhere.
         Used mainly for plain Python prompts, where the continuation prompt
         ``...`` is a valid Python expression in Python 3, so shouldn't be stripped.
-    
     If initial_re and prompt_re differ,
     only initial_re will be tested against the first line.
     If any prompt is found on the first two lines,

IPython/core/inputtransformer2.py

@@ -640,7 +640,7 b' class TransformerManager:'
 
         Parameters
         ----------
-        source : string
+        cell : string
           Python input code, which can be multiline.
 
         Returns

IPython/core/interactiveshell.py

@@ -1730,7 +1730,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-
         exc_tuple : tuple of exception classes
             A *tuple* of exception classes, for which to call the defined
             handler.  It is very important that you use a tuple, and NOT A
@@ -1760,7 +1759,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Notes
         -----
-
         WARNING: by putting in your own exception handler into IPython's main
         execution loop, you run a very good chance of nasty crashes.  This
         facility should only be used if you really know what you are doing.
@@ -2056,15 +2054,12 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-
            text : string
              A string of text to be completed on.  It can be given as empty and
              instead a line/position pair are given.  In this case, the
              completer itself will split the line like readline does.
-
            line : string, optional
              The complete line that text is part of.
-
            cursor_pos : int, optional
              The position of the cursor on the input line.
 
@@ -2072,11 +2067,9 b' class InteractiveShell(SingletonConfigurable):'
         -------
         text : string
           The actual text that was completed.
-
         matches : list
           A sorted list with all possible completions.
 
-
         Notes
         -----
         The optional arguments allow the completion to take more context into
@@ -2089,7 +2082,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Examples
         --------
-
         In [1]: x = 'hello'
 
         In [2]: _ip.complete('x.l')
@@ -2606,7 +2598,7 b' class InteractiveShell(SingletonConfigurable):'
         ----------
         fname : string
             The name of the file to be executed.
-        where : tuple
+        *where : tuple
             One or two namespaces, passed to execfile() as (globals,locals).
             If only one is given, it is passed as both.
         exit_ignore : bool (False)
@@ -2843,7 +2835,6 b' class InteractiveShell(SingletonConfigurable):'
         -------
         result: bool
             Whether the code needs to be run with a coroutine runner or not
-
         .. versionadded:: 7.0
         """
         if not self.autoawait:
@@ -3290,7 +3281,7 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-        source : string
+        code : string
           Python input code, which can be multiline.
 
         Returns
@@ -3491,7 +3482,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Notes
         -----
-
         Slices can be described with two notations:
 
         * ``N:M`` -> standard python form, means including items N...(M-1).
@@ -3536,7 +3526,6 b' class InteractiveShell(SingletonConfigurable):'
         Returns
         -------
         A string of code.
-
         ValueError is raised if nothing is found, and TypeError if it evaluates
         to an object of another type. In each case, .args[0] is a printable
         message.

IPython/core/magic.py

@@ -115,13 +115,10 b' def record_magic(dct, magic_kind, magic_name, func):'
     ----------
     dct : dict
       A dictionary with 'line' and 'cell' subdicts.
-
     magic_kind : str
       Kind of magic to be stored.
-
     magic_name : str
       Key to store the magic as.
-
     func : function
       Callable object to store.
     """
@@ -387,7 +384,7 b' class MagicsManager(Configurable):'
 
         Parameters
         ----------
-        magic_objects : one or more classes or instances
+        *magic_objects : one or more classes or instances
         """
         # Start by validating them to ensure they have all had their magic
         # methods registered at the instance level
@@ -423,10 +420,8 b' class MagicsManager(Configurable):'
         ----------
         func : callable
           Function to be registered as a magic.
-
         magic_kind : str
           Kind of magic, one of 'line', 'cell' or 'line_cell'
-
         magic_name : optional str
           If given, the name the magic will have in the IPython namespace.  By
           default, the name of the function itself is used.
@@ -451,10 +446,8 b' class MagicsManager(Configurable):'
         ----------
         alias_name : str
           The name of the magic to be registered.
-
         magic_name : str
           The name of an existing magic.
-
         magic_kind : str
           Kind of magic, one of 'line' or 'cell'
         """
@@ -580,21 +573,16 b' class Magics(Configurable):'
 
         Parameters
         ----------
-
         arg_str : str
           The arguments to parse.
-
         opt_str : str
           The options specification.
-
         mode : str, default 'string'
           If given as 'list', the argument string is returned as a list (split
           on whitespace) instead of a string.
-
         list_all : bool, default False
           Put all option values in lists. Normally only options
           appearing more than once are put in a list.
-
         posix : bool, default True
           Whether to split the input line in POSIX mode or not, as per the
           conventions outlined in the :mod:`shlex` module from the standard

IPython/core/magics/basic.py

@@ -623,7 +623,6 b' class AsyncMagics(BasicMagics):'
         If the object is a fully qualified object name, attempt to import it and
         set it as the runner, and activate autoawait.
         
-        
         The exact behavior of autoawait is experimental and subject to change
         across version of IPython and Python.
         """

IPython/core/magics/execution.py

@@ -1067,7 +1067,6 b' class ExecutionMagics(Magics):'
 
           In [6]: %timeit -n1 time.sleep(2)
 
-
         The times reported by %timeit will be slightly higher than those
         reported by the timeit.py script when variables are accessed. This is
         due to the fact that %timeit executes the statement in the namespace
@@ -1238,7 +1237,6 b' class ExecutionMagics(Magics):'
           CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
           Wall time: 0.00
 
-
         .. note::
             The time needed by Python to compile the given expression will be
             reported if it is more than 0.1s.

IPython/core/magics/namespace.py

@@ -252,7 +252,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         Define two variables and list them with who_ls::
 
           In [1]: alpha = 123
@@ -367,7 +366,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         Define two variables and list them with whos::
 
           In [1]: alpha = 123
@@ -484,23 +482,21 b' class NamespaceMagics(Magics):'
 
         Parameters
         ----------
-        -f : force reset without asking for confirmation.
-
-        -s : 'Soft' reset: Only clears your namespace, leaving history intact.
+        -f
+           force reset without asking for confirmation.
+        -s
+           'Soft' reset: Only clears your namespace, leaving history intact.
             References to objects may be kept. By default (without this option),
             we do a 'hard' reset, giving you a new session and removing all
             references to objects from the current session.
-
-        --aggressive: Try to aggressively remove modules from sys.modules ; this
+        --aggressive
+            Try to aggressively remove modules from sys.modules ; this
             may allow you to reimport Python modules that have been updated and
             pick up changes, but can have unattended consequences.
 
         in : reset input history
-
         out : reset output history
-
         dhist : reset directory history
-
         array : reset only variables that are NumPy arrays
 
         See Also
@@ -624,7 +620,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         We first fully reset the namespace so your output looks identical to
         this example for pedagogical reasons; in practice you do not need a
         full reset::

IPython/core/magics/osm.py

@@ -316,7 +316,6 b' class OSMagics(Magics):'
             ``cd <bookmark_name>`` is enough if there is no directory
             ``<bookmark_name>``, but a bookmark with the name exists.
 
-
         Options:
 
         -q               Be quiet. Do not print the working directory after the
@@ -329,7 +328,6 b' class OSMagics(Magics):'
            where ``!command`` runs is immediately discarded after executing
            'command'.
 
-
         Examples
         --------
         ::

IPython/core/oinspect.py

@@ -428,7 +428,6 b' class Inspector(Colorable):'
 
         Examples
         --------
-
         In [1]: class NoInit:
            ...:     pass
 
@@ -575,8 +574,7 b' class Inspector(Colorable):'
         """Retrieve an info dict and format it.
 
         Parameters
-        ==========
-
+        ----------
         obj: any
             Object to inspect and return info from
         oname: str (default: ''):
@@ -716,11 +714,10 b' class Inspector(Colorable):'
         """Compute a dict with detailed information about an object.
 
         Parameters
-        ==========
-
+        ----------
         obj: any
             An object to find information about
-        oname: str (default: ''):
+        oname : str (default: '')
             Name of the variable pointing to `obj`.
         info: (default: None)
             A struct (dict like with attr access) with some information fields
@@ -729,8 +726,7 b' class Inspector(Colorable):'
             If set to 1, more information is given.
 
         Returns
-        =======
-
+        -------
         An object info dict with known fields from `info_fields`. Keys are
         strings, values are string or None.
         """

IPython/core/payloadpage.py

@@ -18,7 +18,6 b' def page(strng, start=0, screen_lines=0, pager_cmd=None):'
     ----------
     strng : str or mime-dict
       Text to page, or a mime-type keyed dict of already formatted data.
-
     start : int
       Starting line at which to place the display.
     """

IPython/core/pylabtools.py

@@ -241,7 +241,7 b' 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
@@ -408,7 +408,6 b' def configure_inline_support(shell, backend):'
     Parameters
     ----------
     shell : InteractiveShell instance
-
     backend : matplotlib backend
     """
     warnings.warn(

IPython/core/ultratb.py

@@ -556,7 +556,7 b' class ListTB(TBTools):'
         Parameters
         ----------
         etype : exception type
-        evalue : exception value
+        value : exception value
         """
         return ListTB.structured_traceback(self, etype, value)
 

IPython/external/qt_loaders.py

@@ -195,7 +195,6 b' def import_pyqt4(version=2):'
     version : 1, 2, or None
       Which QString/QVariant API to use. Set to None to use the system
       default
-
     ImportErrors raised within this function are non-recoverable
     """
     # The new-style string API (version=2) automatically
@@ -325,7 +324,6 b' def load_qt(api_options):'
 
     Returns
     -------
-
     A tuple of QtCore, QtGui, QtSvg, QT_API
     The first three are the Qt modules. The last is the
     string indicating which module was loaded.

IPython/lib/latextools.py

@@ -77,7 +77,6 b" def latex_to_png(s, encode=False, backend=None, wrap=False, color='Black',"
         format, e.g. '#AA20FA'.
     scale : float
         Scale factor for the resulting PNG.
-
     None is returned when the backend cannot be used.
 
     """

IPython/terminal/embed.py

@@ -49,7 +49,6 b' class EmbeddedMagics(Magics):'
         you may then kill it and the program will then continue to run without
         the interactive shell interfering again.
 
-
         Kill Instance Option:
 
             If for some reasons you need to kill the location where the instance
@@ -266,20 +265,16 b' class InteractiveShellEmbed(TerminalInteractiveShell):'
 
         Parameters
         ----------
-
-
         local_ns, module
           Working local namespace (a dict) and module (a module or similar
           object). If given as None, they are automatically taken from the scope
           where the shell was called, so that program variables become visible.
-
         stack_depth : int
           How many levels in the stack to go to looking for namespaces (when
           local_ns or module is None). This allows an intermediate caller to
           make sure that this function gets the namespace from the intended
           level in the stack. By default (0) it will get its locals and globals
           from the immediate caller.
-
         compile_flags
           A bit field identifying the __future__ features
           that are enabled, as passed to the builtin :func:`compile` function.

IPython/terminal/magics.py

@@ -113,7 +113,7 b' class TerminalMagics(Magics):'
 
         Shell escapes are not supported (yet).
 
-        See also
+        See Also
         --------
         paste: automatically pull code from clipboard.
 
@@ -176,7 +176,7 b' class TerminalMagics(Magics):'
 
         IPython statements (magics, shell escapes) are not supported (yet).
 
-        See also
+        See Also
         --------
         cpaste: manually paste code into terminal until you mark its end.
         """

docs/source/whatsnew/development.rst

@@ -22,12 +22,24 b' Need to be updated:'
 
    pr/*
 
-IPython 8.0 is bringing a number of new features and improvements to both the
+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 older version of Python is also the opportunity to do a couple of
 performance improvement in particular with respect to startup time.
 
-The main change in IPython 8.0 is the integration of the ``stack_data`` package;
+This release contains 250+ Pull requests, in addition to many of the features
+and backports that have made it to the 7.x branch.
+
+We removed almost all features, arguments, functions, and modules that were
+marked as deprecated between IPython 1.0 and 5.0 and before. As 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 have better deprecation warnings
+or errors.
+
+There are many change in IPython 8.0 will will try to describe subsequently,
+
+
+The first on is the integration of the ``stack_data`` package;
 which provide smarter information in traceback; in particular it will highlight
 the AST node where an error occurs which can help to quickly narrow down errors.
 
@@ -50,13 +62,34 b' IPython 8.0 is capable of telling you, where the index error occurs::'
     return x[0][i][0]
                 ^
 
+
+Numfocus Small Developer Grant
+------------------------------
+
 To prepare for Python 3.10 we have also started working on removing reliance and
 any dependency that is not Python 3.10 compatible; that include migrating our
-test suite to Pytest, and starting to remove nose.
+test suite to pytest, and starting to remove nose. This also mean that the
+``iptest`` command is now gone, and all testing is via pytest.
+
+This was in bog part thanks the NumFOCUS Small Developer grant, we were able 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
 
-We are also removing support for Python 3.6 allowing internal code to use more
+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
+---------------------------------
+
+
+We are also removing support for Python up to 3.7 allowing internal code to use more
 efficient ``pathlib``, and make better use of type annotations.
 
+IMAGE : Pathlib, pathlib everywhere.
+
 The completer has also seen significant updates and make use of newer Jedi API
 offering faster and more reliable tab completion.
 
@@ -168,7 +201,154 b' Try ``%autoreload 3`` in an IPython session after running ``%load_ext autoreload'
 For more information please see unit test -
     extensions/tests/test_autoreload.py : 'test_autoload_newly_added_objects'
 
-=======
+
+Miscelanious
+------------
+
+Minimum supported
+
+
+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``
+
+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 simple
+``%save <filename>``, load and edit it using ``%load`` (makes for a nice usage
+when followed with :kbd:`F2`), send it to dpaste.org using ``%pastebin``, or
+view the whole thing syntax-highlighted with a single ``%pycat``.
+
+Traceback improvements
+======================
+
+
+UPDATE THIS IN INPUT.
+
+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
+    ...:
+
+    In [2]: foo()
+    ---------------------------------------------------------------------------
+    ZeroDivisionError                         Traceback (most recent call last)
+    In [2], in <module>
+    ----> 1 foo()
+
+    In [1], in foo()
+        1 def foo():
+    ----> 2     return 3 / 0
+
+    ZeroDivisionError: division by zero
+
+Remove Deprecated Stuff
+=======================
+
+
+We no longer need to add `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.
 
 .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT.
 

setup.cfg

@@ -101,7 +101,7 b' pygments.lexers ='
 
 [velin]
 ignore_patterns = 
-   IPython/core/tests,
+   IPython/core/tests
    IPython/testing
 
 [tool.black]