Remove set-next input when triggering help.

This was a long standing feature from when the main way to edit code was
readline. Now that we have proper history and editing frontend,
including prompt toolkit this is not necessary, especially since it
creates issue like in JupyterLab.

Should close  #13602

IPython/core/inputtransformer.py

@@ -1,538 +1,536 b''
 """DEPRECATED: Input transformer classes to support IPython special syntax.
 
 This module was deprecated in IPython 7.0, in favour of inputtransformer2.
 
 This includes the machinery to recognise and transform ``%magic`` commands,
 ``!system`` commands, ``help?`` querying, prompt stripping, and so forth.
 """
 import abc
 import functools
 import re
 import tokenize
 from tokenize import generate_tokens, untokenize, TokenError
 from io import StringIO
 
 from IPython.core.splitinput import LineInfo
 
 #-----------------------------------------------------------------------------
 # Globals
 #-----------------------------------------------------------------------------
 
 # The escape sequences that define the syntax transformations IPython will
 # apply to user input.  These can NOT be just changed here: many regular
 # expressions and other parts of the code may use their hardcoded values, and
 # for all intents and purposes they constitute the 'IPython syntax', so they
 # should be considered fixed.
 
 ESC_SHELL  = '!'     # Send line to underlying system shell
 ESC_SH_CAP = '!!'    # Send line to system shell and capture output
 ESC_HELP   = '?'     # Find information about object
 ESC_HELP2  = '??'    # Find extra-detailed information about object
 ESC_MAGIC  = '%'     # Call magic function
 ESC_MAGIC2 = '%%'    # Call cell-magic function
 ESC_QUOTE  = ','     # Split args on whitespace, quote each as string and call
 ESC_QUOTE2 = ';'     # Quote all args as a single string, call
 ESC_PAREN  = '/'     # Call first argument with rest of line as arguments
 
 ESC_SEQUENCES = [ESC_SHELL, ESC_SH_CAP, ESC_HELP ,\
                  ESC_HELP2, ESC_MAGIC, ESC_MAGIC2,\
                  ESC_QUOTE, ESC_QUOTE2, ESC_PAREN ]
 
 
 class InputTransformer(metaclass=abc.ABCMeta):
     """Abstract base class for line-based input transformers."""
     
     @abc.abstractmethod
     def push(self, line):
         """Send a line of input to the transformer, returning the transformed
         input or None if the transformer is waiting for more input.
 
         Must be overridden by subclasses.
 
         Implementations may raise ``SyntaxError`` if the input is invalid. No
         other exceptions may be raised.
         """
         pass
     
     @abc.abstractmethod
     def reset(self):
         """Return, transformed any lines that the transformer has accumulated,
         and reset its internal state.
 
         Must be overridden by subclasses.
         """
         pass
     
     @classmethod
     def wrap(cls, func):
         """Can be used by subclasses as a decorator, to return a factory that
         will allow instantiation with the decorated object.
         """
         @functools.wraps(func)
         def transformer_factory(**kwargs):
             return cls(func, **kwargs)
         
         return transformer_factory
 
 class StatelessInputTransformer(InputTransformer):
     """Wrapper for a stateless input transformer implemented as a function."""
     def __init__(self, func):
         self.func = func
     
     def __repr__(self):
         return "StatelessInputTransformer(func={0!r})".format(self.func)
     
     def push(self, line):
         """Send a line of input to the transformer, returning the
         transformed input."""
         return self.func(line)
     
     def reset(self):
         """No-op - exists for compatibility."""
         pass
 
 class CoroutineInputTransformer(InputTransformer):
     """Wrapper for an input transformer implemented as a coroutine."""
     def __init__(self, coro, **kwargs):
         # Prime it
         self.coro = coro(**kwargs)
         next(self.coro)
     
     def __repr__(self):
         return "CoroutineInputTransformer(coro={0!r})".format(self.coro)
     
     def push(self, line):
         """Send a line of input to the transformer, returning the
         transformed input or None if the transformer is waiting for more
         input.
         """
         return self.coro.send(line)
     
     def reset(self):
         """Return, transformed any lines that the transformer has
         accumulated, and reset its internal state.
         """
         return self.coro.send(None)
 
 class TokenInputTransformer(InputTransformer):
     """Wrapper for a token-based input transformer.
     
     func should accept a list of tokens (5-tuples, see tokenize docs), and
     return an iterable which can be passed to tokenize.untokenize().
     """
     def __init__(self, func):
         self.func = func
         self.buf = []
         self.reset_tokenizer()
 
     def reset_tokenizer(self):
         it = iter(self.buf)
         self.tokenizer = generate_tokens(it.__next__)
 
     def push(self, line):
         self.buf.append(line + '\n')
         if all(l.isspace() for l in self.buf):
             return self.reset()
 
         tokens = []
         stop_at_NL = False
         try:
             for intok in self.tokenizer:
                 tokens.append(intok)
                 t = intok[0]
                 if t == tokenize.NEWLINE or (stop_at_NL and t == tokenize.NL):
                     # Stop before we try to pull a line we don't have yet
                     break
                 elif t == tokenize.ERRORTOKEN:
                     stop_at_NL = True
         except TokenError:
             # Multi-line statement - stop and try again with the next line
             self.reset_tokenizer()
             return None
         
         return self.output(tokens)
     
     def output(self, tokens):
         self.buf.clear()
         self.reset_tokenizer()
         return untokenize(self.func(tokens)).rstrip('\n')
     
     def reset(self):
         l = ''.join(self.buf)
         self.buf.clear()
         self.reset_tokenizer()
         if l:
             return l.rstrip('\n')
 
 class assemble_python_lines(TokenInputTransformer):
     def __init__(self):
         super(assemble_python_lines, self).__init__(None)
     
     def output(self, tokens):
         return self.reset()
 
 @CoroutineInputTransformer.wrap
 def assemble_logical_lines():
     r"""Join lines following explicit line continuations (\)"""
     line = ''
     while True:
         line = (yield line)
         if not line or line.isspace():
             continue
         
         parts = []
         while line is not None:
             if line.endswith('\\') and (not has_comment(line)):
                 parts.append(line[:-1])
                 line = (yield None) # Get another line
             else:
                 parts.append(line)
                 break
         
         # Output
         line = ''.join(parts)
 
 # Utilities
-def _make_help_call(target, esc, lspace, next_input=None):
+def _make_help_call(target, esc, lspace):
     """Prepares a pinfo(2)/psearch call from a target name and the escape
     (i.e. ? or ??)"""
     method  = 'pinfo2' if esc == '??' \
                 else 'psearch' if '*' in target \
                 else 'pinfo'
     arg = " ".join([method, target])
     #Prepare arguments for get_ipython().run_line_magic(magic_name, magic_args)
     t_magic_name, _, t_magic_arg_s = arg.partition(' ')
     t_magic_name = t_magic_name.lstrip(ESC_MAGIC)
-    if next_input is None:
-        return '%sget_ipython().run_line_magic(%r, %r)' % (lspace, t_magic_name, t_magic_arg_s)
-    else:
-        return '%sget_ipython().set_next_input(%r);get_ipython().run_line_magic(%r, %r)' % \
-           (lspace, next_input, t_magic_name, t_magic_arg_s)
-    
+    return "%sget_ipython().run_line_magic(%r, %r)" % (
+        lspace,
+        t_magic_name,
+        t_magic_arg_s,
+    )
+
+
 # These define the transformations for the different escape characters.
 def _tr_system(line_info):
     "Translate lines escaped with: !"
     cmd = line_info.line.lstrip().lstrip(ESC_SHELL)
     return '%sget_ipython().system(%r)' % (line_info.pre, cmd)
 
 def _tr_system2(line_info):
     "Translate lines escaped with: !!"
     cmd = line_info.line.lstrip()[2:]
     return '%sget_ipython().getoutput(%r)' % (line_info.pre, cmd)
 
 def _tr_help(line_info):
     "Translate lines escaped with: ?/??"
     # A naked help line should just fire the intro help screen
     if not line_info.line[1:]:
         return 'get_ipython().show_usage()'
 
     return _make_help_call(line_info.ifun, line_info.esc, line_info.pre)
 
 def _tr_magic(line_info):
     "Translate lines escaped with: %"
     tpl = '%sget_ipython().run_line_magic(%r, %r)'
     if line_info.line.startswith(ESC_MAGIC2):
         return line_info.line
     cmd = ' '.join([line_info.ifun, line_info.the_rest]).strip()
     #Prepare arguments for get_ipython().run_line_magic(magic_name, magic_args)
     t_magic_name, _, t_magic_arg_s = cmd.partition(' ')
     t_magic_name = t_magic_name.lstrip(ESC_MAGIC)
     return tpl % (line_info.pre, t_magic_name, t_magic_arg_s)
 
 def _tr_quote(line_info):
     "Translate lines escaped with: ,"
     return '%s%s("%s")' % (line_info.pre, line_info.ifun,
                          '", "'.join(line_info.the_rest.split()) )
 
 def _tr_quote2(line_info):
     "Translate lines escaped with: ;"
     return '%s%s("%s")' % (line_info.pre, line_info.ifun,
                            line_info.the_rest)
 
 def _tr_paren(line_info):
     "Translate lines escaped with: /"
     return '%s%s(%s)' % (line_info.pre, line_info.ifun,
                          ", ".join(line_info.the_rest.split()))
 
 tr = { ESC_SHELL  : _tr_system,
        ESC_SH_CAP : _tr_system2,
        ESC_HELP   : _tr_help,
        ESC_HELP2  : _tr_help,
        ESC_MAGIC  : _tr_magic,
        ESC_QUOTE  : _tr_quote,
        ESC_QUOTE2 : _tr_quote2,
        ESC_PAREN  : _tr_paren }
 
 @StatelessInputTransformer.wrap
 def escaped_commands(line):
     """Transform escaped commands - %magic, !system, ?help + various autocalls.
     """
     if not line or line.isspace():
         return line
     lineinf = LineInfo(line)
     if lineinf.esc not in tr:
         return line
     
     return tr[lineinf.esc](lineinf)
 
 _initial_space_re = re.compile(r'\s*')
 
 _help_end_re = re.compile(r"""(%{0,2}
                               (?!\d)[\w*]+            # Variable name
                               (\.(?!\d)[\w*]+)*       # .etc.etc
                               )
                               (\?\??)$                # ? or ??
                               """,
                               re.VERBOSE)
 
 # Extra pseudotokens for multiline strings and data structures
 _MULTILINE_STRING = object()
 _MULTILINE_STRUCTURE = object()
 
 def _line_tokens(line):
     """Helper for has_comment and ends_in_comment_or_string."""
     readline = StringIO(line).readline
     toktypes = set()
     try:
         for t in generate_tokens(readline):
             toktypes.add(t[0])
     except TokenError as e:
         # There are only two cases where a TokenError is raised.
         if 'multi-line string' in e.args[0]:
             toktypes.add(_MULTILINE_STRING)
         else:
             toktypes.add(_MULTILINE_STRUCTURE)
     return toktypes
 
 def has_comment(src):
     """Indicate whether an input line has (i.e. ends in, or is) a comment.
 
     This uses tokenize, so it can distinguish comments from # inside strings.
 
     Parameters
     ----------
     src : string
         A single line input string.
 
     Returns
     -------
     comment : bool
         True if source has a comment.
     """
     return (tokenize.COMMENT in _line_tokens(src))
 
 def ends_in_comment_or_string(src):
     """Indicates whether or not an input line ends in a comment or within
     a multiline string.
 
     Parameters
     ----------
     src : string
         A single line input string.
 
     Returns
     -------
     comment : bool
         True if source ends in a comment or multiline string.
     """
     toktypes = _line_tokens(src)
     return (tokenize.COMMENT in toktypes) or (_MULTILINE_STRING in toktypes)
         
 
 @StatelessInputTransformer.wrap
 def help_end(line):
     """Translate lines with ?/?? at the end"""
     m = _help_end_re.search(line)
     if m is None or ends_in_comment_or_string(line):
         return line
     target = m.group(1)
     esc = m.group(3)
     lspace = _initial_space_re.match(line).group(0)
 
-    # If we're mid-command, put it back on the next prompt for the user.
-    next_input = line.rstrip('?') if line.strip() != m.group(0) else None
-
-    return _make_help_call(target, esc, lspace, next_input)
+    return _make_help_call(target, esc, lspace)
 
 
 @CoroutineInputTransformer.wrap
 def cellmagic(end_on_blank_line=False):
     """Captures & transforms cell magics.
 
     After a cell magic is started, this stores up any lines it gets until it is
     reset (sent None).
     """
     tpl = 'get_ipython().run_cell_magic(%r, %r, %r)'
     cellmagic_help_re = re.compile(r'%%\w+\?')
     line = ''
     while True:
         line = (yield line)
         # consume leading empty lines
         while not line:
             line = (yield line)
         
         if not line.startswith(ESC_MAGIC2):
             # This isn't a cell magic, idle waiting for reset then start over
             while line is not None:
                 line = (yield line)
             continue
         
         if cellmagic_help_re.match(line):
             # This case will be handled by help_end
             continue
         
         first = line
         body = []
         line = (yield None)
         while (line is not None) and \
                                 ((line.strip() != '') or not end_on_blank_line):
             body.append(line)
             line = (yield None)
         
         # Output
         magic_name, _, first = first.partition(' ')
         magic_name = magic_name.lstrip(ESC_MAGIC2)
         line = tpl % (magic_name, first, u'\n'.join(body))
 
 
 def _strip_prompts(prompt_re, initial_re=None, turnoff_re=None):
     """Remove matching input prompts from a block of input.
 
     Parameters
     ----------
     prompt_re : regular expression
         A regular expression matching any input prompt (including continuation)
     initial_re : regular expression, optional
         A regular expression matching only the initial prompt, but not continuation.
         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.
 
     Notes
     -----
     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,
     prompts will be stripped from the rest of the block.
     """
     if initial_re is None:
         initial_re = prompt_re
     line = ''
     while True:
         line = (yield line)
         
         # First line of cell
         if line is None:
             continue
         out, n1 = initial_re.subn('', line, count=1)
         if turnoff_re and not n1:
             if turnoff_re.match(line):
                 # We're in e.g. a cell magic; disable this transformer for
                 # the rest of the cell.
                 while line is not None:
                     line = (yield line)
                 continue
 
         line = (yield out)
         
         if line is None:
             continue
         # check for any prompt on the second line of the cell,
         # because people often copy from just after the first prompt,
         # so we might not see it in the first line.
         out, n2 = prompt_re.subn('', line, count=1)
         line = (yield out)
         
         if n1 or n2:
             # Found a prompt in the first two lines - check for it in
             # the rest of the cell as well.
             while line is not None:
                 line = (yield prompt_re.sub('', line, count=1))
         
         else:
             # Prompts not in input - wait for reset
             while line is not None:
                 line = (yield line)
 
 @CoroutineInputTransformer.wrap
 def classic_prompt():
     """Strip the >>>/... prompts of the Python interactive shell."""
     # FIXME: non-capturing version (?:...) usable?
     prompt_re = re.compile(r'^(>>>|\.\.\.)( |$)')
     initial_re = re.compile(r'^>>>( |$)')
     # Any %magic/!system is IPython syntax, so we needn't look for >>> prompts
     turnoff_re = re.compile(r'^[%!]')
     return _strip_prompts(prompt_re, initial_re, turnoff_re)
 
 @CoroutineInputTransformer.wrap
 def ipy_prompt():
     """Strip IPython's In [1]:/...: prompts."""
     # FIXME: non-capturing version (?:...) usable?
     prompt_re = re.compile(r'^(In \[\d+\]: |\s*\.{3,}: ?)')
     # Disable prompt stripping inside cell magics
     turnoff_re = re.compile(r'^%%')
     return _strip_prompts(prompt_re, turnoff_re=turnoff_re)
 
 
 @CoroutineInputTransformer.wrap
 def leading_indent():
     """Remove leading indentation.
 
     If the first line starts with a spaces or tabs, the same whitespace will be
     removed from each following line until it is reset.
     """
     space_re = re.compile(r'^[ \t]+')
     line = ''
     while True:
         line = (yield line)
         
         if line is None:
             continue
         
         m = space_re.match(line)
         if m:
             space = m.group(0)
             while line is not None:
                 if line.startswith(space):
                     line = line[len(space):]
                 line = (yield line)
         else:
             # No leading spaces - wait for reset
             while line is not None:
                 line = (yield line)
 
 
 _assign_pat = \
 r'''(?P<lhs>(\s*)
     ([\w\.]+)                # Initial identifier
     (\s*,\s*
         \*?[\w\.]+)*         # Further identifiers for unpacking
     \s*?,?                   # Trailing comma
     )
     \s*=\s*
 '''
 
 assign_system_re = re.compile(r'{}!\s*(?P<cmd>.*)'.format(_assign_pat), re.VERBOSE)
 assign_system_template = '%s = get_ipython().getoutput(%r)'
 @StatelessInputTransformer.wrap
 def assign_from_system(line):
     """Transform assignment from system commands (e.g. files = !ls)"""
     m = assign_system_re.match(line)
     if m is None:
         return line
     
     return assign_system_template % m.group('lhs', 'cmd')
 
 assign_magic_re = re.compile(r'{}%\s*(?P<cmd>.*)'.format(_assign_pat), re.VERBOSE)
 assign_magic_template = '%s = get_ipython().run_line_magic(%r, %r)'
 @StatelessInputTransformer.wrap
 def assign_from_magic(line):
     """Transform assignment from magic commands (e.g. a = %who_ls)"""
     m = assign_magic_re.match(line)
     if m is None:
         return line
     #Prepare arguments for get_ipython().run_line_magic(magic_name, magic_args)
     m_lhs, m_cmd = m.group('lhs', 'cmd')
     t_magic_name, _, t_magic_arg_s = m_cmd.partition(' ')
     t_magic_name = t_magic_name.lstrip(ESC_MAGIC)
     return assign_magic_template % (m_lhs, t_magic_name, t_magic_arg_s)

IPython/core/inputtransformer2.py

@@ -1,796 +1,788 b''
 """Input transformer machinery to support IPython special syntax.
 
 This includes the machinery to recognise and transform ``%magic`` commands,
 ``!system`` commands, ``help?`` querying, prompt stripping, and so forth.
 
 Added: IPython 7.0. Replaces inputsplitter and inputtransformer which were
 deprecated in 7.0.
 """
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import ast
 import sys
 from codeop import CommandCompiler, Compile
 import re
 import tokenize
 from typing import List, Tuple, Optional, Any
 import warnings
 
 _indent_re = re.compile(r'^[ \t]+')
 
 def leading_empty_lines(lines):
     """Remove leading empty lines
 
     If the leading lines are empty or contain only whitespace, they will be
     removed.
     """
     if not lines:
         return lines
     for i, line in enumerate(lines):
         if line and not line.isspace():
             return lines[i:]
     return lines
 
 def leading_indent(lines):
     """Remove leading indentation.
 
     If the first line starts with a spaces or tabs, the same whitespace will be
     removed from each following line in the cell.
     """
     if not lines:
         return lines
     m = _indent_re.match(lines[0])
     if not m:
         return lines
     space = m.group(0)
     n = len(space)
     return [l[n:] if l.startswith(space) else l
             for l in lines]
 
 class PromptStripper:
     """Remove matching input prompts from a block of input.
 
     Parameters
     ----------
     prompt_re : regular expression
         A regular expression matching any input prompt (including continuation,
         e.g. ``...``)
     initial_re : regular expression, optional
         A regular expression matching only the initial prompt, but not continuation.
         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.
 
     Notes
     -----
 
     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,
     prompts will be stripped from the rest of the block.
     """
     def __init__(self, prompt_re, initial_re=None):
         self.prompt_re = prompt_re
         self.initial_re = initial_re or prompt_re
 
     def _strip(self, lines):
         return [self.prompt_re.sub('', l, count=1) for l in lines]
 
     def __call__(self, lines):
         if not lines:
             return lines
         if self.initial_re.match(lines[0]) or \
                 (len(lines) > 1 and self.prompt_re.match(lines[1])):
             return self._strip(lines)
         return lines
 
 classic_prompt = PromptStripper(
     prompt_re=re.compile(r'^(>>>|\.\.\.)( |$)'),
     initial_re=re.compile(r'^>>>( |$)')
 )
 
 ipython_prompt = PromptStripper(
     re.compile(
         r"""
         ^(                         # Match from the beginning of a line, either:
 
                                    # 1. First-line prompt:
         ((\[nav\]|\[ins\])?\ )?    # Vi editing mode prompt, if it's there
         In\                        # The 'In' of the prompt, with a space
         \[\d+\]:                   # Command index, as displayed in the prompt
         \                          # With a mandatory trailing space
 
         |                          # ... or ...
 
                                    # 2. The three dots of the multiline prompt
         \s*                        # All leading whitespace characters
         \.{3,}:                    # The three (or more) dots
         \ ?                        # With an optional trailing space
 
         )
         """,
         re.VERBOSE,
     )
 )
 
 
 def cell_magic(lines):
     if not lines or not lines[0].startswith('%%'):
         return lines
     if re.match(r'%%\w+\?', lines[0]):
         # This case will be handled by help_end
         return lines
     magic_name, _, first_line = lines[0][2:].rstrip().partition(' ')
     body = ''.join(lines[1:])
     return ['get_ipython().run_cell_magic(%r, %r, %r)\n'
             % (magic_name, first_line, body)]
 
 
 def _find_assign_op(token_line) -> Optional[int]:
     """Get the index of the first assignment in the line ('=' not inside brackets)
 
     Note: We don't try to support multiple special assignment (a = b = %foo)
     """
     paren_level = 0
     for i, ti in enumerate(token_line):
         s = ti.string
         if s == '=' and paren_level == 0:
             return i
         if s in {'(','[','{'}:
             paren_level += 1
         elif s in {')', ']', '}'}:
             if paren_level > 0:
                 paren_level -= 1
     return None
 
 def find_end_of_continued_line(lines, start_line: int):
     """Find the last line of a line explicitly extended using backslashes.
 
     Uses 0-indexed line numbers.
     """
     end_line = start_line
     while lines[end_line].endswith('\\\n'):
         end_line += 1
         if end_line >= len(lines):
             break
     return end_line
 
 def assemble_continued_line(lines, start: Tuple[int, int], end_line: int):
     r"""Assemble a single line from multiple continued line pieces
 
     Continued lines are lines ending in ``\``, and the line following the last
     ``\`` in the block.
 
     For example, this code continues over multiple lines::
 
         if (assign_ix is not None) \
              and (len(line) >= assign_ix + 2) \
              and (line[assign_ix+1].string == '%') \
              and (line[assign_ix+2].type == tokenize.NAME):
 
     This statement contains four continued line pieces.
     Assembling these pieces into a single line would give::
 
         if (assign_ix is not None) and (len(line) >= assign_ix + 2) and (line[...
 
     This uses 0-indexed line numbers. *start* is (lineno, colno).
 
     Used to allow ``%magic`` and ``!system`` commands to be continued over
     multiple lines.
     """
     parts = [lines[start[0]][start[1]:]] + lines[start[0]+1:end_line+1]
     return ' '.join([p.rstrip()[:-1] for p in parts[:-1]]  # Strip backslash+newline
                     + [parts[-1].rstrip()])         # Strip newline from last line
 
 class TokenTransformBase:
     """Base class for transformations which examine tokens.
 
     Special syntax should not be transformed when it occurs inside strings or
     comments. This is hard to reliably avoid with regexes. The solution is to
     tokenise the code as Python, and recognise the special syntax in the tokens.
 
     IPython's special syntax is not valid Python syntax, so tokenising may go
     wrong after the special syntax starts. These classes therefore find and
     transform *one* instance of special syntax at a time into regular Python
     syntax. After each transformation, tokens are regenerated to find the next
     piece of special syntax.
 
     Subclasses need to implement one class method (find)
     and one regular method (transform).
 
     The priority attribute can select which transformation to apply if multiple
     transformers match in the same place. Lower numbers have higher priority.
     This allows "%magic?" to be turned into a help call rather than a magic call.
     """
     # Lower numbers -> higher priority (for matches in the same location)
     priority = 10
 
     def sortby(self):
         return self.start_line, self.start_col, self.priority
 
     def __init__(self, start):
         self.start_line = start[0] - 1   # Shift from 1-index to 0-index
         self.start_col = start[1]
 
     @classmethod
     def find(cls, tokens_by_line):
         """Find one instance of special syntax in the provided tokens.
 
         Tokens are grouped into logical lines for convenience,
         so it is easy to e.g. look at the first token of each line.
         *tokens_by_line* is a list of lists of tokenize.TokenInfo objects.
 
         This should return an instance of its class, pointing to the start
         position it has found, or None if it found no match.
         """
         raise NotImplementedError
 
     def transform(self, lines: List[str]):
         """Transform one instance of special syntax found by ``find()``
 
         Takes a list of strings representing physical lines,
         returns a similar list of transformed lines.
         """
         raise NotImplementedError
 
 class MagicAssign(TokenTransformBase):
     """Transformer for assignments from magics (a = %foo)"""
     @classmethod
     def find(cls, tokens_by_line):
         """Find the first magic assignment (a = %foo) in the cell.
         """
         for line in tokens_by_line:
             assign_ix = _find_assign_op(line)
             if (assign_ix is not None) \
                     and (len(line) >= assign_ix + 2) \
                     and (line[assign_ix+1].string == '%') \
                     and (line[assign_ix+2].type == tokenize.NAME):
                 return cls(line[assign_ix+1].start)
 
     def transform(self, lines: List[str]):
         """Transform a magic assignment found by the ``find()`` classmethod.
         """
         start_line, start_col = self.start_line, self.start_col
         lhs = lines[start_line][:start_col]
         end_line = find_end_of_continued_line(lines, start_line)
         rhs = assemble_continued_line(lines, (start_line, start_col), end_line)
         assert rhs.startswith('%'), rhs
         magic_name, _, args = rhs[1:].partition(' ')
 
         lines_before = lines[:start_line]
         call = "get_ipython().run_line_magic({!r}, {!r})".format(magic_name, args)
         new_line = lhs + call + '\n'
         lines_after = lines[end_line+1:]
 
         return lines_before + [new_line] + lines_after
 
 
 class SystemAssign(TokenTransformBase):
     """Transformer for assignments from system commands (a = !foo)"""
     @classmethod
     def find(cls, tokens_by_line):
         """Find the first system assignment (a = !foo) in the cell.
         """
         for line in tokens_by_line:
             assign_ix = _find_assign_op(line)
             if (assign_ix is not None) \
                     and not line[assign_ix].line.strip().startswith('=') \
                     and (len(line) >= assign_ix + 2) \
                     and (line[assign_ix + 1].type == tokenize.ERRORTOKEN):
                 ix = assign_ix + 1
 
                 while ix < len(line) and line[ix].type == tokenize.ERRORTOKEN:
                     if line[ix].string == '!':
                         return cls(line[ix].start)
                     elif not line[ix].string.isspace():
                         break
                     ix += 1
 
     def transform(self, lines: List[str]):
         """Transform a system assignment found by the ``find()`` classmethod.
         """
         start_line, start_col = self.start_line, self.start_col
 
         lhs = lines[start_line][:start_col]
         end_line = find_end_of_continued_line(lines, start_line)
         rhs = assemble_continued_line(lines, (start_line, start_col), end_line)
         assert rhs.startswith('!'), rhs
         cmd = rhs[1:]
 
         lines_before = lines[:start_line]
         call = "get_ipython().getoutput({!r})".format(cmd)
         new_line = lhs + call + '\n'
         lines_after = lines[end_line + 1:]
 
         return lines_before + [new_line] + lines_after
 
 # The escape sequences that define the syntax transformations IPython will
 # apply to user input.  These can NOT be just changed here: many regular
 # expressions and other parts of the code may use their hardcoded values, and
 # for all intents and purposes they constitute the 'IPython syntax', so they
 # should be considered fixed.
 
 ESC_SHELL  = '!'     # Send line to underlying system shell
 ESC_SH_CAP = '!!'    # Send line to system shell and capture output
 ESC_HELP   = '?'     # Find information about object
 ESC_HELP2  = '??'    # Find extra-detailed information about object
 ESC_MAGIC  = '%'     # Call magic function
 ESC_MAGIC2 = '%%'    # Call cell-magic function
 ESC_QUOTE  = ','     # Split args on whitespace, quote each as string and call
 ESC_QUOTE2 = ';'     # Quote all args as a single string, call
 ESC_PAREN  = '/'     # Call first argument with rest of line as arguments
 
 ESCAPE_SINGLES = {'!', '?', '%', ',', ';', '/'}
 ESCAPE_DOUBLES = {'!!', '??'}  # %% (cell magic) is handled separately
 
-def _make_help_call(target, esc, next_input=None):
+def _make_help_call(target, esc):
     """Prepares a pinfo(2)/psearch call from a target name and the escape
     (i.e. ? or ??)"""
     method  = 'pinfo2' if esc == '??' \
                 else 'psearch' if '*' in target \
                 else 'pinfo'
     arg = " ".join([method, target])
     #Prepare arguments for get_ipython().run_line_magic(magic_name, magic_args)
     t_magic_name, _, t_magic_arg_s = arg.partition(' ')
     t_magic_name = t_magic_name.lstrip(ESC_MAGIC)
-    if next_input is None:
-        return 'get_ipython().run_line_magic(%r, %r)' % (t_magic_name, t_magic_arg_s)
-    else:
-        return 'get_ipython().set_next_input(%r);get_ipython().run_line_magic(%r, %r)' % \
-           (next_input, t_magic_name, t_magic_arg_s)
+    return "get_ipython().run_line_magic(%r, %r)" % (t_magic_name, t_magic_arg_s)
+
 
 def _tr_help(content):
     """Translate lines escaped with: ?
 
     A naked help line should fire the intro help screen (shell.show_usage())
     """
     if not content:
         return 'get_ipython().show_usage()'
 
     return _make_help_call(content, '?')
 
 def _tr_help2(content):
     """Translate lines escaped with: ??
 
     A naked help line should fire the intro help screen (shell.show_usage())
     """
     if not content:
         return 'get_ipython().show_usage()'
 
     return _make_help_call(content, '??')
 
 def _tr_magic(content):
     "Translate lines escaped with a percent sign: %"
     name, _, args = content.partition(' ')
     return 'get_ipython().run_line_magic(%r, %r)' % (name, args)
 
 def _tr_quote(content):
     "Translate lines escaped with a comma: ,"
     name, _, args = content.partition(' ')
     return '%s("%s")' % (name, '", "'.join(args.split()) )
 
 def _tr_quote2(content):
     "Translate lines escaped with a semicolon: ;"
     name, _, args = content.partition(' ')
     return '%s("%s")' % (name, args)
 
 def _tr_paren(content):
     "Translate lines escaped with a slash: /"
     name, _, args = content.partition(' ')
     return '%s(%s)' % (name, ", ".join(args.split()))
 
 tr = { ESC_SHELL  : 'get_ipython().system({!r})'.format,
        ESC_SH_CAP : 'get_ipython().getoutput({!r})'.format,
        ESC_HELP   : _tr_help,
        ESC_HELP2  : _tr_help2,
        ESC_MAGIC  : _tr_magic,
        ESC_QUOTE  : _tr_quote,
        ESC_QUOTE2 : _tr_quote2,
        ESC_PAREN  : _tr_paren }
 
 class EscapedCommand(TokenTransformBase):
     """Transformer for escaped commands like %foo, !foo, or /foo"""
     @classmethod
     def find(cls, tokens_by_line):
         """Find the first escaped command (%foo, !foo, etc.) in the cell.
         """
         for line in tokens_by_line:
             if not line:
                 continue
             ix = 0
             ll = len(line)
             while ll > ix and line[ix].type in {tokenize.INDENT, tokenize.DEDENT}:
                 ix += 1
             if ix >= ll:
                 continue
             if line[ix].string in ESCAPE_SINGLES:
                 return cls(line[ix].start)
 
     def transform(self, lines):
         """Transform an escaped line found by the ``find()`` classmethod.
         """
         start_line, start_col = self.start_line, self.start_col
 
         indent = lines[start_line][:start_col]
         end_line = find_end_of_continued_line(lines, start_line)
         line = assemble_continued_line(lines, (start_line, start_col), end_line)
 
         if len(line) > 1 and line[:2] in ESCAPE_DOUBLES:
             escape, content = line[:2], line[2:]
         else:
             escape, content = line[:1], line[1:]
 
         if escape in tr:
             call = tr[escape](content)
         else:
             call = ''
 
         lines_before = lines[:start_line]
         new_line = indent + call + '\n'
         lines_after = lines[end_line + 1:]
 
         return lines_before + [new_line] + lines_after
 
 _help_end_re = re.compile(r"""(%{0,2}
                               (?!\d)[\w*]+            # Variable name
                               (\.(?!\d)[\w*]+)*       # .etc.etc
                               )
                               (\?\??)$                # ? or ??
                               """,
                               re.VERBOSE)
 
 class HelpEnd(TokenTransformBase):
     """Transformer for help syntax: obj? and obj??"""
     # This needs to be higher priority (lower number) than EscapedCommand so
     # that inspecting magics (%foo?) works.
     priority = 5
 
     def __init__(self, start, q_locn):
         super().__init__(start)
         self.q_line = q_locn[0] - 1  # Shift from 1-indexed to 0-indexed
         self.q_col = q_locn[1]
 
     @classmethod
     def find(cls, tokens_by_line):
         """Find the first help command (foo?) in the cell.
         """
         for line in tokens_by_line:
             # Last token is NEWLINE; look at last but one
             if len(line) > 2 and line[-2].string == '?':
                 # Find the first token that's not INDENT/DEDENT
                 ix = 0
                 while line[ix].type in {tokenize.INDENT, tokenize.DEDENT}:
                     ix += 1
                 return cls(line[ix].start, line[-2].start)
 
     def transform(self, lines):
         """Transform a help command found by the ``find()`` classmethod.
         """
         piece = ''.join(lines[self.start_line:self.q_line+1])
         indent, content = piece[:self.start_col], piece[self.start_col:]
         lines_before = lines[:self.start_line]
         lines_after = lines[self.q_line + 1:]
 
         m = _help_end_re.search(content)
         if not m:
             raise SyntaxError(content)
         assert m is not None, content
         target = m.group(1)
         esc = m.group(3)
 
-        # If we're mid-command, put it back on the next prompt for the user.
-        next_input = None
-        if (not lines_before) and (not lines_after) \
-                and content.strip() != m.group(0):
-            next_input = content.rstrip('?\n')
 
-        call = _make_help_call(target, esc, next_input=next_input)
+        call = _make_help_call(target, esc)
         new_line = indent + call + '\n'
 
         return lines_before + [new_line] + lines_after
 
 def make_tokens_by_line(lines:List[str]):
     """Tokenize a series of lines and group tokens by line.
 
     The tokens for a multiline Python string or expression are grouped as one
     line. All lines except the last lines should keep their line ending ('\\n',
     '\\r\\n') for this to properly work. Use `.splitlines(keeplineending=True)`
     for example when passing block of text to this function.
 
     """
     # NL tokens are used inside multiline expressions, but also after blank
     # lines or comments. This is intentional - see https://bugs.python.org/issue17061
     # We want to group the former case together but split the latter, so we
     # track parentheses level, similar to the internals of tokenize.
 
     #   reexported from token on 3.7+
     NEWLINE, NL = tokenize.NEWLINE, tokenize.NL  # type: ignore
     tokens_by_line: List[List[Any]] = [[]]
     if len(lines) > 1 and not lines[0].endswith(("\n", "\r", "\r\n", "\x0b", "\x0c")):
         warnings.warn(
             "`make_tokens_by_line` received a list of lines which do not have lineending markers ('\\n', '\\r', '\\r\\n', '\\x0b', '\\x0c'), behavior will be unspecified",
             stacklevel=2,
         )
     parenlev = 0
     try:
         for token in tokenize.generate_tokens(iter(lines).__next__):
             tokens_by_line[-1].append(token)
             if (token.type == NEWLINE) \
                     or ((token.type == NL) and (parenlev <= 0)):
                 tokens_by_line.append([])
             elif token.string in {'(', '[', '{'}:
                 parenlev += 1
             elif token.string in {')', ']', '}'}:
                 if parenlev > 0:
                     parenlev -= 1
     except tokenize.TokenError:
         # Input ended in a multiline string or expression. That's OK for us.
         pass
 
 
     if not tokens_by_line[-1]:
         tokens_by_line.pop()
 
 
     return tokens_by_line
 
 
 def has_sunken_brackets(tokens: List[tokenize.TokenInfo]):
     """Check if the depth of brackets in the list of tokens drops below 0"""
     parenlev = 0
     for token in tokens:
         if token.string in {"(", "[", "{"}:
             parenlev += 1
         elif token.string in {")", "]", "}"}:
             parenlev -= 1
             if parenlev < 0:
                 return True
     return False
 
 
 def show_linewise_tokens(s: str):
     """For investigation and debugging"""
     if not s.endswith('\n'):
         s += '\n'
     lines = s.splitlines(keepends=True)
     for line in make_tokens_by_line(lines):
         print("Line -------")
         for tokinfo in line:
             print(" ", tokinfo)
 
 # Arbitrary limit to prevent getting stuck in infinite loops
 TRANSFORM_LOOP_LIMIT = 500
 
 class TransformerManager:
     """Applies various transformations to a cell or code block.
 
     The key methods for external use are ``transform_cell()``
     and ``check_complete()``.
     """
     def __init__(self):
         self.cleanup_transforms = [
             leading_empty_lines,
             leading_indent,
             classic_prompt,
             ipython_prompt,
         ]
         self.line_transforms = [
             cell_magic,
         ]
         self.token_transformers = [
             MagicAssign,
             SystemAssign,
             EscapedCommand,
             HelpEnd,
         ]
 
     def do_one_token_transform(self, lines):
         """Find and run the transform earliest in the code.
 
         Returns (changed, lines).
 
         This method is called repeatedly until changed is False, indicating
         that all available transformations are complete.
 
         The tokens following IPython special syntax might not be valid, so
         the transformed code is retokenised every time to identify the next
         piece of special syntax. Hopefully long code cells are mostly valid
         Python, not using lots of IPython special syntax, so this shouldn't be
         a performance issue.
         """
         tokens_by_line = make_tokens_by_line(lines)
         candidates = []
         for transformer_cls in self.token_transformers:
             transformer = transformer_cls.find(tokens_by_line)
             if transformer:
                 candidates.append(transformer)
 
         if not candidates:
             # Nothing to transform
             return False, lines
         ordered_transformers = sorted(candidates, key=TokenTransformBase.sortby)
         for transformer in ordered_transformers:
             try:
                 return True, transformer.transform(lines)
             except SyntaxError:
                 pass
         return False, lines
 
     def do_token_transforms(self, lines):
         for _ in range(TRANSFORM_LOOP_LIMIT):
             changed, lines = self.do_one_token_transform(lines)
             if not changed:
                 return lines
 
         raise RuntimeError("Input transformation still changing after "
                            "%d iterations. Aborting." % TRANSFORM_LOOP_LIMIT)
 
     def transform_cell(self, cell: str) -> str:
         """Transforms a cell of input code"""
         if not cell.endswith('\n'):
             cell += '\n'  # Ensure the cell has a trailing newline
         lines = cell.splitlines(keepends=True)
         for transform in self.cleanup_transforms + self.line_transforms:
             lines = transform(lines)
 
         lines = self.do_token_transforms(lines)
         return ''.join(lines)
 
     def check_complete(self, cell: str):
         """Return whether a block of code is ready to execute, or should be continued
 
         Parameters
         ----------
         cell : string
             Python input code, which can be multiline.
 
         Returns
         -------
         status : str
             One of 'complete', 'incomplete', or 'invalid' if source is not a
             prefix of valid code.
         indent_spaces : int or None
             The number of spaces by which to indent the next line of code. If
             status is not 'incomplete', this is None.
         """
         # Remember if the lines ends in a new line.
         ends_with_newline = False
         for character in reversed(cell):
             if character == '\n':
                 ends_with_newline = True
                 break
             elif character.strip():
                 break
             else:
                 continue
 
         if not ends_with_newline:
             # Append an newline for consistent tokenization
             # See https://bugs.python.org/issue33899
             cell += '\n'
 
         lines = cell.splitlines(keepends=True)
 
         if not lines:
             return 'complete', None
 
         if lines[-1].endswith('\\'):
             # Explicit backslash continuation
             return 'incomplete', find_last_indent(lines)
 
         try:
             for transform in self.cleanup_transforms:
                 if not getattr(transform, 'has_side_effects', False):
                     lines = transform(lines)
         except SyntaxError:
             return 'invalid', None
 
         if lines[0].startswith('%%'):
             # Special case for cell magics - completion marked by blank line
             if lines[-1].strip():
                 return 'incomplete', find_last_indent(lines)
             else:
                 return 'complete', None
 
         try:
             for transform in self.line_transforms:
                 if not getattr(transform, 'has_side_effects', False):
                     lines = transform(lines)
             lines = self.do_token_transforms(lines)
         except SyntaxError:
             return 'invalid', None
 
         tokens_by_line = make_tokens_by_line(lines)
 
         # Bail if we got one line and there are more closing parentheses than
         # the opening ones
         if (
             len(lines) == 1
             and tokens_by_line
             and has_sunken_brackets(tokens_by_line[0])
         ):
             return "invalid", None
 
         if not tokens_by_line:
             return 'incomplete', find_last_indent(lines)
 
         if tokens_by_line[-1][-1].type != tokenize.ENDMARKER:
             # We're in a multiline string or expression
             return 'incomplete', find_last_indent(lines)
 
         newline_types = {tokenize.NEWLINE, tokenize.COMMENT, tokenize.ENDMARKER} # type: ignore
 
         # Pop the last line which only contains DEDENTs and ENDMARKER
         last_token_line = None
         if {t.type for t in tokens_by_line[-1]} in [
             {tokenize.DEDENT, tokenize.ENDMARKER},
             {tokenize.ENDMARKER}
         ] and len(tokens_by_line) > 1:
             last_token_line = tokens_by_line.pop()
 
         while tokens_by_line[-1] and tokens_by_line[-1][-1].type in newline_types:
             tokens_by_line[-1].pop()
 
         if not tokens_by_line[-1]:
             return 'incomplete', find_last_indent(lines)
 
         if tokens_by_line[-1][-1].string == ':':
             # The last line starts a block (e.g. 'if foo:')
             ix = 0
             while tokens_by_line[-1][ix].type in {tokenize.INDENT, tokenize.DEDENT}:
                 ix += 1
 
             indent = tokens_by_line[-1][ix].start[1]
             return 'incomplete', indent + 4
 
         if tokens_by_line[-1][0].line.endswith('\\'):
             return 'incomplete', None
 
         # At this point, our checks think the code is complete (or invalid).
         # We'll use codeop.compile_command to check this with the real parser
         try:
             with warnings.catch_warnings():
                 warnings.simplefilter('error', SyntaxWarning)
                 res = compile_command(''.join(lines), symbol='exec')
         except (SyntaxError, OverflowError, ValueError, TypeError,
                 MemoryError, SyntaxWarning):
             return 'invalid', None
         else:
             if res is None:
                 return 'incomplete', find_last_indent(lines)
 
         if last_token_line and last_token_line[0].type == tokenize.DEDENT:
             if ends_with_newline:
                 return 'complete', None
             return 'incomplete', find_last_indent(lines)
 
         # If there's a blank line at the end, assume we're ready to execute
         if not lines[-1].strip():
             return 'complete', None
 
         return 'complete', None
 
 
 def find_last_indent(lines):
     m = _indent_re.match(lines[-1])
     if not m:
         return 0
     return len(m.group(0).replace('\t', ' '*4))
 
 
 class MaybeAsyncCompile(Compile):
     def __init__(self, extra_flags=0):
         super().__init__()
         self.flags |= extra_flags
 
 
 class MaybeAsyncCommandCompiler(CommandCompiler):
     def __init__(self, extra_flags=0):
         self.compiler = MaybeAsyncCompile(extra_flags=extra_flags)
 
 
 _extra_flags = ast.PyCF_ALLOW_TOP_LEVEL_AWAIT
 
 compile_command = MaybeAsyncCommandCompiler(extra_flags=_extra_flags)

IPython/core/tests/test_inputtransformer.py

@@ -1,484 +1,469 b''
 import tokenize
 
 from IPython.testing import tools as tt
 
 from IPython.core import inputtransformer as ipt
 
 def transform_and_reset(transformer):
     transformer = transformer()
     def transform(inp):
         try:
             return transformer.push(inp)
         finally:
             transformer.reset()
     
     return transform
 
 # Transformer tests
 def transform_checker(tests, transformer, **kwargs):
     """Utility to loop over test inputs"""
     transformer = transformer(**kwargs)
     try:
         for inp, tr in tests:
             if inp is None:
                 out = transformer.reset()
             else:
                 out = transformer.push(inp)
             assert out == tr
     finally:
         transformer.reset()
 
 # Data for all the syntax tests in the form of lists of pairs of
 # raw/transformed input.  We store it here as a global dict so that we can use
 # it both within single-function tests and also to validate the behavior of the
 # larger objects
 
 syntax = \
   dict(assign_system =
        [('a =! ls', "a = get_ipython().getoutput('ls')"),
         ('b = !ls', "b = get_ipython().getoutput('ls')"),
         ('c= !ls', "c = get_ipython().getoutput('ls')"),
         ('d == !ls', 'd == !ls'), # Invalid syntax, but we leave == alone.
         ('x=1', 'x=1'), # normal input is unmodified
         ('    ','    '),  # blank lines are kept intact
         # Tuple unpacking
         ("a, b = !echo 'a\\nb'", "a, b = get_ipython().getoutput(\"echo 'a\\\\nb'\")"),
         ("a,= !echo 'a'", "a, = get_ipython().getoutput(\"echo 'a'\")"),
         ("a, *bc = !echo 'a\\nb\\nc'", "a, *bc = get_ipython().getoutput(\"echo 'a\\\\nb\\\\nc'\")"),
         # Tuple unpacking with regular Python expressions, not our syntax.
         ("a, b = range(2)", "a, b = range(2)"),
         ("a, = range(1)", "a, = range(1)"),
         ("a, *bc = range(3)", "a, *bc = range(3)"),
         ],
 
        assign_magic =
        [('a =% who', "a = get_ipython().run_line_magic('who', '')"),
         ('b = %who', "b = get_ipython().run_line_magic('who', '')"),
         ('c= %ls', "c = get_ipython().run_line_magic('ls', '')"),
         ('d == %ls', 'd == %ls'), # Invalid syntax, but we leave == alone.
         ('x=1', 'x=1'), # normal input is unmodified
         ('    ','    '),  # blank lines are kept intact
         ("a, b = %foo", "a, b = get_ipython().run_line_magic('foo', '')"),
-        ],
-
-       classic_prompt =
-       [('>>> x=1', 'x=1'),
-        ('x=1', 'x=1'), # normal input is unmodified
-        ('    ', '    '),  # blank lines are kept intact
-        ],
-
-       ipy_prompt =
-       [('In [1]: x=1', 'x=1'),
-        ('x=1', 'x=1'), # normal input is unmodified
-        ('    ','    '),  # blank lines are kept intact
-        ],
-
-       # Tests for the escape transformer to leave normal code alone
-       escaped_noesc =
-       [ ('    ', '    '),
-         ('x=1', 'x=1'),
-         ],
-
-       # System calls
-       escaped_shell =
-       [ ('!ls', "get_ipython().system('ls')"),
-         # Double-escape shell, this means to capture the output of the
-         # subprocess and return it
-         ('!!ls', "get_ipython().getoutput('ls')"),
-         ],
-
-       # Help/object info
-       escaped_help =
-       [ ('?', 'get_ipython().show_usage()'),
-         ('?x1', "get_ipython().run_line_magic('pinfo', 'x1')"),
-         ('??x2', "get_ipython().run_line_magic('pinfo2', 'x2')"),
-         ('?a.*s', "get_ipython().run_line_magic('psearch', 'a.*s')"),
-         ('?%hist1', "get_ipython().run_line_magic('pinfo', '%hist1')"),
-         ('?%%hist2', "get_ipython().run_line_magic('pinfo', '%%hist2')"),
-         ('?abc = qwe', "get_ipython().run_line_magic('pinfo', 'abc')"),
-         ],
-
-      end_help =
-      [ ('x3?', "get_ipython().run_line_magic('pinfo', 'x3')"),
-        ('x4??', "get_ipython().run_line_magic('pinfo2', 'x4')"),
-        ('%hist1?', "get_ipython().run_line_magic('pinfo', '%hist1')"),
-        ('%hist2??', "get_ipython().run_line_magic('pinfo2', '%hist2')"),
-        ('%%hist3?', "get_ipython().run_line_magic('pinfo', '%%hist3')"),
-        ('%%hist4??', "get_ipython().run_line_magic('pinfo2', '%%hist4')"),
-        ('π.foo?', "get_ipython().run_line_magic('pinfo', 'π.foo')"),
-        ('f*?', "get_ipython().run_line_magic('psearch', 'f*')"),
-        ('ax.*aspe*?', "get_ipython().run_line_magic('psearch', 'ax.*aspe*')"),
-        ('a = abc?', "get_ipython().set_next_input('a = abc');"
-                      "get_ipython().run_line_magic('pinfo', 'abc')"),
-        ('a = abc.qe??', "get_ipython().set_next_input('a = abc.qe');"
-                          "get_ipython().run_line_magic('pinfo2', 'abc.qe')"),
-        ('a = *.items?', "get_ipython().set_next_input('a = *.items');"
-                          "get_ipython().run_line_magic('psearch', '*.items')"),
-        ('plot(a?', "get_ipython().set_next_input('plot(a');"
-                     "get_ipython().run_line_magic('pinfo', 'a')"),
-        ('a*2 #comment?', 'a*2 #comment?'),
-        ],
-
-       # Explicit magic calls
-       escaped_magic =
-       [ ('%cd', "get_ipython().run_line_magic('cd', '')"),
-         ('%cd /home', "get_ipython().run_line_magic('cd', '/home')"),
-         # Backslashes need to be escaped.
-         ('%cd C:\\User', "get_ipython().run_line_magic('cd', 'C:\\\\User')"),
-         ('    %magic', "    get_ipython().run_line_magic('magic', '')"),
-         ],
-
-       # Quoting with separate arguments
-       escaped_quote =
-       [ (',f', 'f("")'),
-         (',f x', 'f("x")'),
-         ('  ,f y', '  f("y")'),
-         (',f a b', 'f("a", "b")'),
-         ],
-
-       # Quoting with single argument
-       escaped_quote2 =
-       [ (';f', 'f("")'),
-         (';f x', 'f("x")'),
-         ('  ;f y', '  f("y")'),
-         (';f a b', 'f("a b")'),
-         ],
-
-       # Simply apply parens
-       escaped_paren =
-       [ ('/f', 'f()'),
-         ('/f x', 'f(x)'),
-         ('  /f y', '  f(y)'),
-         ('/f a b', 'f(a, b)'),
-         ],
-
-       # Check that we transform prompts before other transforms
-       mixed =
-       [ ('In [1]: %lsmagic', "get_ipython().run_line_magic('lsmagic', '')"),
-         ('>>> %lsmagic', "get_ipython().run_line_magic('lsmagic', '')"),
-         ('In [2]: !ls', "get_ipython().system('ls')"),
-         ('In [3]: abs?', "get_ipython().run_line_magic('pinfo', 'abs')"),
-         ('In [4]: b = %who', "b = get_ipython().run_line_magic('who', '')"),
-         ],
-       )
+    ],
+    classic_prompt=[
+        (">>> x=1", "x=1"),
+        ("x=1", "x=1"),  # normal input is unmodified
+        ("    ", "    "),  # blank lines are kept intact
+    ],
+    ipy_prompt=[
+        ("In [1]: x=1", "x=1"),
+        ("x=1", "x=1"),  # normal input is unmodified
+        ("    ", "    "),  # blank lines are kept intact
+    ],
+    # Tests for the escape transformer to leave normal code alone
+    escaped_noesc=[
+        ("    ", "    "),
+        ("x=1", "x=1"),
+    ],
+    # System calls
+    escaped_shell=[
+        ("!ls", "get_ipython().system('ls')"),
+        # Double-escape shell, this means to capture the output of the
+        # subprocess and return it
+        ("!!ls", "get_ipython().getoutput('ls')"),
+    ],
+    # Help/object info
+    escaped_help=[
+        ("?", "get_ipython().show_usage()"),
+        ("?x1", "get_ipython().run_line_magic('pinfo', 'x1')"),
+        ("??x2", "get_ipython().run_line_magic('pinfo2', 'x2')"),
+        ("?a.*s", "get_ipython().run_line_magic('psearch', 'a.*s')"),
+        ("?%hist1", "get_ipython().run_line_magic('pinfo', '%hist1')"),
+        ("?%%hist2", "get_ipython().run_line_magic('pinfo', '%%hist2')"),
+        ("?abc = qwe", "get_ipython().run_line_magic('pinfo', 'abc')"),
+    ],
+    end_help=[
+        ("x3?", "get_ipython().run_line_magic('pinfo', 'x3')"),
+        ("x4??", "get_ipython().run_line_magic('pinfo2', 'x4')"),
+        ("%hist1?", "get_ipython().run_line_magic('pinfo', '%hist1')"),
+        ("%hist2??", "get_ipython().run_line_magic('pinfo2', '%hist2')"),
+        ("%%hist3?", "get_ipython().run_line_magic('pinfo', '%%hist3')"),
+        ("%%hist4??", "get_ipython().run_line_magic('pinfo2', '%%hist4')"),
+        ("π.foo?", "get_ipython().run_line_magic('pinfo', 'π.foo')"),
+        ("f*?", "get_ipython().run_line_magic('psearch', 'f*')"),
+        ("ax.*aspe*?", "get_ipython().run_line_magic('psearch', 'ax.*aspe*')"),
+        ("a = abc?", "get_ipython().run_line_magic('pinfo', 'abc')"),
+        ("a = abc.qe??", "get_ipython().run_line_magic('pinfo2', 'abc.qe')"),
+        ("a = *.items?", "get_ipython().run_line_magic('psearch', '*.items')"),
+        ("plot(a?", "get_ipython().run_line_magic('pinfo', 'a')"),
+        ("a*2 #comment?", "a*2 #comment?"),
+    ],
+    # Explicit magic calls
+    escaped_magic=[
+        ("%cd", "get_ipython().run_line_magic('cd', '')"),
+        ("%cd /home", "get_ipython().run_line_magic('cd', '/home')"),
+        # Backslashes need to be escaped.
+        ("%cd C:\\User", "get_ipython().run_line_magic('cd', 'C:\\\\User')"),
+        ("    %magic", "    get_ipython().run_line_magic('magic', '')"),
+    ],
+    # Quoting with separate arguments
+    escaped_quote=[
+        (",f", 'f("")'),
+        (",f x", 'f("x")'),
+        ("  ,f y", '  f("y")'),
+        (",f a b", 'f("a", "b")'),
+    ],
+    # Quoting with single argument
+    escaped_quote2=[
+        (";f", 'f("")'),
+        (";f x", 'f("x")'),
+        ("  ;f y", '  f("y")'),
+        (";f a b", 'f("a b")'),
+    ],
+    # Simply apply parens
+    escaped_paren=[
+        ("/f", "f()"),
+        ("/f x", "f(x)"),
+        ("  /f y", "  f(y)"),
+        ("/f a b", "f(a, b)"),
+    ],
+    # Check that we transform prompts before other transforms
+    mixed=[
+        ("In [1]: %lsmagic", "get_ipython().run_line_magic('lsmagic', '')"),
+        (">>> %lsmagic", "get_ipython().run_line_magic('lsmagic', '')"),
+        ("In [2]: !ls", "get_ipython().system('ls')"),
+        ("In [3]: abs?", "get_ipython().run_line_magic('pinfo', 'abs')"),
+        ("In [4]: b = %who", "b = get_ipython().run_line_magic('who', '')"),
+    ],
+)
 
 # multiline syntax examples.  Each of these should be a list of lists, with
 # each entry itself having pairs of raw/transformed input.  The union (with
 # '\n'.join() of the transformed inputs is what the splitter should produce
 # when fed the raw lines one at a time via push.
 syntax_ml = \
   dict(classic_prompt =
        [ [('>>> for i in range(10):','for i in range(10):'),
           ('...     print i','    print i'),
           ('... ', ''),
           ],
          [('>>> a="""','a="""'),
           ('... 123"""','123"""'),
           ],
          [('a="""','a="""'),
           ('... 123','123'),
           ('... 456"""','456"""'),
           ],
          [('a="""','a="""'),
           ('>>> 123','123'),
           ('... 456"""','456"""'),
           ],
          [('a="""','a="""'),
           ('123','123'),
           ('... 456"""','... 456"""'),
           ],
          [('....__class__','....__class__'),
          ],
          [('a=5', 'a=5'),
           ('...', ''),
          ],
          [('>>> def f(x):', 'def f(x):'),
           ('...', ''),
           ('...     return x', '    return x'),
           ],
          [('board = """....', 'board = """....'),
           ('....', '....'),
           ('...."""', '...."""'),
           ],
         ],
 
        ipy_prompt =
        [ [('In [24]: for i in range(10):','for i in range(10):'),
           ('   ....:     print i','    print i'),
           ('   ....: ', ''),
           ],
          [('In [24]: for i in range(10):','for i in range(10):'),
           # Qt console prompts expand with spaces, not dots
           ('    ...:     print i','    print i'),
           ('    ...: ', ''),
           ],
          [('In [24]: for i in range(10):','for i in range(10):'),
           # Sometimes whitespace preceding '...' has been removed
           ('...:     print i','    print i'),
           ('...: ', ''),
           ],
          [('In [24]: for i in range(10):','for i in range(10):'),
           # Space after last continuation prompt has been removed (issue #6674)
           ('...:     print i','    print i'),
           ('...:', ''),
           ],
          [('In [2]: a="""','a="""'),
           ('   ...: 123"""','123"""'),
           ],
          [('a="""','a="""'),
           ('   ...: 123','123'),
           ('   ...: 456"""','456"""'),
           ],
          [('a="""','a="""'),
           ('In [1]: 123','123'),
           ('   ...: 456"""','456"""'),
           ],
          [('a="""','a="""'),
           ('123','123'),
           ('   ...: 456"""','   ...: 456"""'),
           ],
          ],
 
        multiline_datastructure_prompt =
        [ [('>>> a = [1,','a = [1,'),
           ('... 2]','2]'),
          ],
        ],
         
        multiline_datastructure =
        [ [('b = ("%s"', None),
           ('# comment', None),
           ('%foo )', 'b = ("%s"\n# comment\n%foo )'),
          ],
        ],
        
        multiline_string =
        [ [("'''foo?", None),
           ("bar'''", "'''foo?\nbar'''"),
          ],
        ],
        
        leading_indent =
        [ [('    print "hi"','print "hi"'),
           ],
          [('  for a in range(5):','for a in range(5):'),
           ('    a*2','  a*2'),
           ],
          [('    a="""','a="""'),
           ('    123"""','123"""'),
            ],
          [('a="""','a="""'),
           ('    123"""','    123"""'),
           ],
        ],
        
        cellmagic =
        [ [('%%foo a', None),
           (None, "get_ipython().run_cell_magic('foo', 'a', '')"),
           ],
          [('%%bar 123', None),
           ('hello', None),
           (None , "get_ipython().run_cell_magic('bar', '123', 'hello')"),
           ],
          [('a=5', 'a=5'),
           ('%%cellmagic', '%%cellmagic'),
           ],
        ],
        
        escaped =
        [ [('%abc def \\', None),
           ('ghi', "get_ipython().run_line_magic('abc', 'def ghi')"),
           ],
          [('%abc def \\', None),
           ('ghi\\', None),
           (None, "get_ipython().run_line_magic('abc', 'def ghi')"),
           ],
        ],
        
        assign_magic =
        [ [('a = %bc de \\', None),
           ('fg', "a = get_ipython().run_line_magic('bc', 'de fg')"),
           ],
          [('a = %bc de \\', None),
           ('fg\\', None),
           (None, "a = get_ipython().run_line_magic('bc', 'de fg')"),
           ],
        ],
        
        assign_system =
        [ [('a = !bc de \\', None),
           ('fg', "a = get_ipython().getoutput('bc de fg')"),
           ],
          [('a = !bc de \\', None),
           ('fg\\', None),
           (None, "a = get_ipython().getoutput('bc de fg')"),
           ],
        ],
        )
 
 
 def test_assign_system():
     tt.check_pairs(transform_and_reset(ipt.assign_from_system), syntax['assign_system'])
 
 def test_assign_magic():
     tt.check_pairs(transform_and_reset(ipt.assign_from_magic), syntax['assign_magic'])
 
 def test_classic_prompt():
     tt.check_pairs(transform_and_reset(ipt.classic_prompt), syntax['classic_prompt'])
     for example in syntax_ml['classic_prompt']:
         transform_checker(example, ipt.classic_prompt)
     for example in syntax_ml['multiline_datastructure_prompt']:
         transform_checker(example, ipt.classic_prompt)
 
     # Check that we don't transform the second line if the first is obviously
     # IPython syntax
     transform_checker([
         ('%foo', '%foo'),
         ('>>> bar', '>>> bar'),
     ], ipt.classic_prompt)
 
 
 def test_ipy_prompt():
     tt.check_pairs(transform_and_reset(ipt.ipy_prompt), syntax['ipy_prompt'])
     for example in syntax_ml['ipy_prompt']:
         transform_checker(example, ipt.ipy_prompt)
 
     # Check that we don't transform the second line if we're inside a cell magic
     transform_checker([
         ('%%foo', '%%foo'),
         ('In [1]: bar', 'In [1]: bar'),
     ], ipt.ipy_prompt)
 
 def test_assemble_logical_lines():
     tests = \
     [ [("a = \\", None),
        ("123", "a = 123"),
       ],
       [("a = \\", None),  # Test resetting when within a multi-line string
        ("12 *\\", None),
        (None, "a = 12 *"),
       ],
       [("# foo\\", "# foo\\"), # Comments can't be continued like this
       ],
     ]
     for example in tests:
         transform_checker(example, ipt.assemble_logical_lines)
 
 def test_assemble_python_lines():
     tests = \
     [ [("a = '''", None),
        ("abc'''", "a = '''\nabc'''"),
       ],
       [("a = '''", None),  # Test resetting when within a multi-line string
        ("def", None),
        (None, "a = '''\ndef"),
       ],
       [("a = [1,", None),
        ("2]", "a = [1,\n2]"),
       ],
       [("a = [1,", None),  # Test resetting when within a multi-line string
        ("2,", None),
        (None, "a = [1,\n2,"),
       ],
       [("a = '''", None),  # Test line continuation within a multi-line string
        ("abc\\", None),
        ("def", None),
        ("'''", "a = '''\nabc\\\ndef\n'''"),
       ],
     ] + syntax_ml['multiline_datastructure']
     for example in tests:
         transform_checker(example, ipt.assemble_python_lines)
 
 
 def test_help_end():
     tt.check_pairs(transform_and_reset(ipt.help_end), syntax['end_help'])
 
 def test_escaped_noesc():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_noesc'])
 
 
 def test_escaped_shell():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_shell'])
 
 
 def test_escaped_help():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_help'])
 
 
 def test_escaped_magic():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_magic'])
 
 
 def test_escaped_quote():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_quote'])
 
 
 def test_escaped_quote2():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_quote2'])
 
 
 def test_escaped_paren():
     tt.check_pairs(transform_and_reset(ipt.escaped_commands), syntax['escaped_paren'])
 
 
 def test_cellmagic():
     for example in syntax_ml['cellmagic']:
         transform_checker(example, ipt.cellmagic)
     
     line_example = [('%%bar 123', None),
                     ('hello', None),
                     ('' , "get_ipython().run_cell_magic('bar', '123', 'hello')"),
                    ]
     transform_checker(line_example, ipt.cellmagic, end_on_blank_line=True)
 
 def test_has_comment():
     tests = [('text', False),
              ('text #comment', True),
              ('text #comment\n', True),
              ('#comment', True),
              ('#comment\n', True),
              ('a = "#string"', False),
              ('a = "#string" # comment', True),
              ('a #comment not "string"', True),
              ]
     tt.check_pairs(ipt.has_comment, tests)
 
 @ipt.TokenInputTransformer.wrap
 def decistmt(tokens):
     """Substitute Decimals for floats in a string of statements.
 
     Based on an example from the tokenize module docs.
     """
     result = []
     for toknum, tokval, _, _, _  in tokens:
         if toknum == tokenize.NUMBER and '.' in tokval:  # replace NUMBER tokens
             yield from [
                 (tokenize.NAME, 'Decimal'),
                 (tokenize.OP, '('),
                 (tokenize.STRING, repr(tokval)),
                 (tokenize.OP, ')')
             ]
         else:
             yield (toknum, tokval)
 
 
 
 def test_token_input_transformer():
     tests = [('1.2', "Decimal ('1.2')"),
              ('"1.2"', '"1.2"'),
              ]
     tt.check_pairs(transform_and_reset(decistmt), tests)
     ml_tests = \
     [ [("a = 1.2; b = '''x", None),
        ("y'''", "a =Decimal ('1.2');b ='''x\ny'''"),
       ],
       [("a = [1.2,", None),
        ("3]", "a =[Decimal ('1.2'),\n3 ]"),
       ],
       [("a = '''foo", None),  # Test resetting when within a multi-line string
        ("bar", None),
        (None, "a = '''foo\nbar"),
       ],
     ]
     for example in ml_tests:
         transform_checker(example, decistmt)

IPython/core/tests/test_inputtransformer2.py

@@ -1,405 +1,442 b''
 """Tests for the token-based transformers in IPython.core.inputtransformer2
 
 Line-based transformers are the simpler ones; token-based transformers are
 more complex. See test_inputtransformer2_line for tests for line-based
 transformations.
 """
 import platform
 import string
 import sys
 from textwrap import dedent
 
 import pytest
 
 from IPython.core import inputtransformer2 as ipt2
 from IPython.core.inputtransformer2 import _find_assign_op, make_tokens_by_line
 
-MULTILINE_MAGIC = ("""\
+MULTILINE_MAGIC = (
+    """\
 a = f()
 %foo \\
 bar
 g()
-""".splitlines(keepends=True), (2, 0), """\
+""".splitlines(
+        keepends=True
+    ),
+    (2, 0),
+    """\
 a = f()
 get_ipython().run_line_magic('foo', ' bar')
 g()
-""".splitlines(keepends=True))
+""".splitlines(
+        keepends=True
+    ),
+)
 
-INDENTED_MAGIC = ("""\
+INDENTED_MAGIC = (
+    """\
 for a in range(5):
     %ls
-""".splitlines(keepends=True), (2, 4), """\
+""".splitlines(
+        keepends=True
+    ),
+    (2, 4),
+    """\
 for a in range(5):
     get_ipython().run_line_magic('ls', '')
-""".splitlines(keepends=True))
+""".splitlines(
+        keepends=True
+    ),
+)
 
-CRLF_MAGIC = ([
-    "a = f()\n",
-    "%ls\r\n",
-    "g()\n"
-], (2, 0), [
-    "a = f()\n",
-    "get_ipython().run_line_magic('ls', '')\n",
-    "g()\n"
-])
-
-MULTILINE_MAGIC_ASSIGN = ("""\
+CRLF_MAGIC = (
+    ["a = f()\n", "%ls\r\n", "g()\n"],
+    (2, 0),
+    ["a = f()\n", "get_ipython().run_line_magic('ls', '')\n", "g()\n"],
+)
+
+MULTILINE_MAGIC_ASSIGN = (
+    """\
 a = f()
 b = %foo \\
   bar
 g()
-""".splitlines(keepends=True), (2, 4), """\
+""".splitlines(
+        keepends=True
+    ),
+    (2, 4),
+    """\
 a = f()
 b = get_ipython().run_line_magic('foo', '   bar')
 g()
-""".splitlines(keepends=True))
+""".splitlines(
+        keepends=True
+    ),
+)
 
 MULTILINE_SYSTEM_ASSIGN = ("""\
 a = f()
 b = !foo \\
   bar
 g()
 """.splitlines(keepends=True), (2, 4), """\
 a = f()
 b = get_ipython().getoutput('foo    bar')
 g()
 """.splitlines(keepends=True))
 
 #####
 
 MULTILINE_SYSTEM_ASSIGN_AFTER_DEDENT = ("""\
 def test():
   for i in range(1):
     print(i)
   res =! ls
-""".splitlines(keepends=True), (4, 7), '''\
+""".splitlines(
+        keepends=True
+    ),
+    (4, 7),
+    """\
 def test():
   for i in range(1):
     print(i)
   res =get_ipython().getoutput(\' ls\')
-'''.splitlines(keepends=True))
+""".splitlines(
+        keepends=True
+    ),
+)
 
 ######
 
-AUTOCALL_QUOTE = (
-    [",f 1 2 3\n"], (1, 0),
-    ['f("1", "2", "3")\n']
-)
+AUTOCALL_QUOTE = ([",f 1 2 3\n"], (1, 0), ['f("1", "2", "3")\n'])
 
-AUTOCALL_QUOTE2 = (
-    [";f 1 2 3\n"], (1, 0),
-    ['f("1 2 3")\n']
-)
+AUTOCALL_QUOTE2 = ([";f 1 2 3\n"], (1, 0), ['f("1 2 3")\n'])
 
-AUTOCALL_PAREN = (
-    ["/f 1 2 3\n"], (1, 0),
-    ['f(1, 2, 3)\n']
-)
+AUTOCALL_PAREN = (["/f 1 2 3\n"], (1, 0), ["f(1, 2, 3)\n"])
 
-SIMPLE_HELP = (
-    ["foo?\n"], (1, 0),
-    ["get_ipython().run_line_magic('pinfo', 'foo')\n"]
-)
+SIMPLE_HELP = (["foo?\n"], (1, 0), ["get_ipython().run_line_magic('pinfo', 'foo')\n"])
 
 DETAILED_HELP = (
-    ["foo??\n"], (1, 0),
-    ["get_ipython().run_line_magic('pinfo2', 'foo')\n"]
+    ["foo??\n"],
+    (1, 0),
+    ["get_ipython().run_line_magic('pinfo2', 'foo')\n"],
 )
 
-MAGIC_HELP = (
-    ["%foo?\n"], (1, 0),
-    ["get_ipython().run_line_magic('pinfo', '%foo')\n"]
-)
+MAGIC_HELP = (["%foo?\n"], (1, 0), ["get_ipython().run_line_magic('pinfo', '%foo')\n"])
 
 HELP_IN_EXPR = (
-    ["a = b + c?\n"], (1, 0),
-    ["get_ipython().set_next_input('a = b + c');"
-     "get_ipython().run_line_magic('pinfo', 'c')\n"]
+    ["a = b + c?\n"],
+    (1, 0),
+    ["get_ipython().run_line_magic('pinfo', 'c')\n"],
 )
 
-HELP_CONTINUED_LINE = ("""\
+HELP_CONTINUED_LINE = (
+    """\
 a = \\
 zip?
-""".splitlines(keepends=True), (1, 0),
-[r"get_ipython().set_next_input('a = \\\nzip');get_ipython().run_line_magic('pinfo', 'zip')" + "\n"]
+""".splitlines(
+        keepends=True
+    ),
+    (1, 0),
+    [r"get_ipython().run_line_magic('pinfo', 'zip')" + "\n"],
 )
 
-HELP_MULTILINE = ("""\
+HELP_MULTILINE = (
+    """\
 (a,
 b) = zip?
-""".splitlines(keepends=True), (1, 0),
-[r"get_ipython().set_next_input('(a,\nb) = zip');get_ipython().run_line_magic('pinfo', 'zip')" + "\n"]
+""".splitlines(
+        keepends=True
+    ),
+    (1, 0),
+    [r"get_ipython().run_line_magic('pinfo', 'zip')" + "\n"],
 )
 
 HELP_UNICODE = (
-    ["π.foo?\n"], (1, 0),
-    ["get_ipython().run_line_magic('pinfo', 'π.foo')\n"]
+    ["π.foo?\n"],
+    (1, 0),
+    ["get_ipython().run_line_magic('pinfo', 'π.foo')\n"],
 )
 
 
 def null_cleanup_transformer(lines):
     """
     A cleanup transform that returns an empty list.
     """
     return []
 
 
 def test_check_make_token_by_line_never_ends_empty():
     """
     Check that not sequence of single or double characters ends up leading to en empty list of tokens
     """
     from string import printable
+
     for c in printable:
         assert make_tokens_by_line(c)[-1] != []
         for k in printable:
             assert make_tokens_by_line(c + k)[-1] != []
 
 
 def check_find(transformer, case, match=True):
-    sample, expected_start, _  = case
+    sample, expected_start, _ = case
     tbl = make_tokens_by_line(sample)
     res = transformer.find(tbl)
     if match:
         # start_line is stored 0-indexed, expected values are 1-indexed
         assert (res.start_line + 1, res.start_col) == expected_start
         return res
     else:
         assert res is None
 
+
 def check_transform(transformer_cls, case):
     lines, start, expected = case
     transformer = transformer_cls(start)
     assert transformer.transform(lines) == expected
 
+
 def test_continued_line():
     lines = MULTILINE_MAGIC_ASSIGN[0]
     assert ipt2.find_end_of_continued_line(lines, 1) == 2
 
     assert ipt2.assemble_continued_line(lines, (1, 5), 2) == "foo    bar"
 
+
 def test_find_assign_magic():
     check_find(ipt2.MagicAssign, MULTILINE_MAGIC_ASSIGN)
     check_find(ipt2.MagicAssign, MULTILINE_SYSTEM_ASSIGN, match=False)
     check_find(ipt2.MagicAssign, MULTILINE_SYSTEM_ASSIGN_AFTER_DEDENT, match=False)
 
+
 def test_transform_assign_magic():
     check_transform(ipt2.MagicAssign, MULTILINE_MAGIC_ASSIGN)
 
+
 def test_find_assign_system():
     check_find(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN)
     check_find(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN_AFTER_DEDENT)
     check_find(ipt2.SystemAssign, (["a =  !ls\n"], (1, 5), None))
     check_find(ipt2.SystemAssign, (["a=!ls\n"], (1, 2), None))
     check_find(ipt2.SystemAssign, MULTILINE_MAGIC_ASSIGN, match=False)
 
+
 def test_transform_assign_system():
     check_transform(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN)
     check_transform(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN_AFTER_DEDENT)
 
+
 def test_find_magic_escape():
     check_find(ipt2.EscapedCommand, MULTILINE_MAGIC)
     check_find(ipt2.EscapedCommand, INDENTED_MAGIC)
     check_find(ipt2.EscapedCommand, MULTILINE_MAGIC_ASSIGN, match=False)
 
+
 def test_transform_magic_escape():
     check_transform(ipt2.EscapedCommand, MULTILINE_MAGIC)
     check_transform(ipt2.EscapedCommand, INDENTED_MAGIC)
     check_transform(ipt2.EscapedCommand, CRLF_MAGIC)
 
+
 def test_find_autocalls():
     for case in [AUTOCALL_QUOTE, AUTOCALL_QUOTE2, AUTOCALL_PAREN]:
         print("Testing %r" % case[0])
         check_find(ipt2.EscapedCommand, case)
 
+
 def test_transform_autocall():
     for case in [AUTOCALL_QUOTE, AUTOCALL_QUOTE2, AUTOCALL_PAREN]:
         print("Testing %r" % case[0])
         check_transform(ipt2.EscapedCommand, case)
 
+
 def test_find_help():
     for case in [SIMPLE_HELP, DETAILED_HELP, MAGIC_HELP, HELP_IN_EXPR]:
         check_find(ipt2.HelpEnd, case)
 
     tf = check_find(ipt2.HelpEnd, HELP_CONTINUED_LINE)
     assert tf.q_line == 1
     assert tf.q_col == 3
 
     tf = check_find(ipt2.HelpEnd, HELP_MULTILINE)
     assert tf.q_line == 1
     assert tf.q_col == 8
 
     # ? in a comment does not trigger help
     check_find(ipt2.HelpEnd, (["foo # bar?\n"], None, None), match=False)
     # Nor in a string
     check_find(ipt2.HelpEnd, (["foo = '''bar?\n"], None, None), match=False)
 
+
 def test_transform_help():
     tf = ipt2.HelpEnd((1, 0), (1, 9))
     assert tf.transform(HELP_IN_EXPR[0]) == HELP_IN_EXPR[2]
 
     tf = ipt2.HelpEnd((1, 0), (2, 3))
     assert tf.transform(HELP_CONTINUED_LINE[0]) == HELP_CONTINUED_LINE[2]
 
     tf = ipt2.HelpEnd((1, 0), (2, 8))
     assert tf.transform(HELP_MULTILINE[0]) == HELP_MULTILINE[2]
 
     tf = ipt2.HelpEnd((1, 0), (1, 0))
     assert tf.transform(HELP_UNICODE[0]) == HELP_UNICODE[2]
 
+
 def test_find_assign_op_dedent():
     """
     be careful that empty token like dedent are not counted as parens
     """
+
     class Tk:
         def __init__(self, s):
             self.string = s
 
     assert _find_assign_op([Tk(s) for s in ("", "a", "=", "b")]) == 2
     assert (
         _find_assign_op([Tk(s) for s in ("", "(", "a", "=", "b", ")", "=", "5")]) == 6
     )
 
 
 examples = [
     pytest.param("a = 1", "complete", None),
     pytest.param("for a in range(5):", "incomplete", 4),
     pytest.param("for a in range(5):\n    if a > 0:", "incomplete", 8),
     pytest.param("raise = 2", "invalid", None),
     pytest.param("a = [1,\n2,", "incomplete", 0),
     pytest.param("(\n))", "incomplete", 0),
     pytest.param("\\\r\n", "incomplete", 0),
     pytest.param("a = '''\n   hi", "incomplete", 3),
     pytest.param("def a():\n x=1\n global x", "invalid", None),
     pytest.param(
         "a \\ ",
         "invalid",
         None,
         marks=pytest.mark.xfail(
             reason="Bug in python 3.9.8 – bpo 45738",
             condition=sys.version_info
             in [(3, 9, 8, "final", 0), (3, 11, 0, "alpha", 2)],
             raises=SystemError,
             strict=True,
         ),
     ),  # Nothing allowed after backslash,
     pytest.param("1\\\n+2", "complete", None),
 ]
 
 
 @pytest.mark.parametrize("code, expected, number", examples)
 def test_check_complete_param(code, expected, number):
     cc = ipt2.TransformerManager().check_complete
     assert cc(code) == (expected, number)
 
 
 @pytest.mark.xfail(platform.python_implementation() == "PyPy", reason="fail on pypy")
 @pytest.mark.xfail(
     reason="Bug in python 3.9.8 – bpo 45738",
     condition=sys.version_info in [(3, 9, 8, "final", 0), (3, 11, 0, "alpha", 2)],
     raises=SystemError,
     strict=True,
 )
 def test_check_complete():
     cc = ipt2.TransformerManager().check_complete
 
-    example = dedent("""
+    example = dedent(
+        """
         if True:
-            a=1""" )
+            a=1"""
+    )
 
     assert cc(example) == ("incomplete", 4)
     assert cc(example + "\n") == ("complete", None)
     assert cc(example + "\n    ") == ("complete", None)
 
     # no need to loop on all the letters/numbers.
-    short = '12abAB'+string.printable[62:]
+    short = "12abAB" + string.printable[62:]
     for c in short:
         # test does not raise:
         cc(c)
         for k in short:
-            cc(c+k)
+            cc(c + k)
 
     assert cc("def f():\n  x=0\n  \\\n  ") == ("incomplete", 2)
 
 
 @pytest.mark.xfail(platform.python_implementation() == "PyPy", reason="fail on pypy")
 @pytest.mark.parametrize(
     "value, expected",
     [
         ('''def foo():\n    """''', ("incomplete", 4)),
         ("""async with example:\n    pass""", ("incomplete", 4)),
         ("""async with example:\n    pass\n    """, ("complete", None)),
     ],
 )
 def test_check_complete_II(value, expected):
     """
     Test that multiple line strings are properly handled.
 
     Separate test function for convenience
 
     """
     cc = ipt2.TransformerManager().check_complete
     assert cc(value) == expected
 
 
 @pytest.mark.parametrize(
     "value, expected",
     [
         (")", ("invalid", None)),
         ("]", ("invalid", None)),
         ("}", ("invalid", None)),
         (")(", ("invalid", None)),
         ("][", ("invalid", None)),
         ("}{", ("invalid", None)),
         ("]()(", ("invalid", None)),
         ("())(", ("invalid", None)),
         (")[](", ("invalid", None)),
         ("()](", ("invalid", None)),
     ],
 )
 def test_check_complete_invalidates_sunken_brackets(value, expected):
     """
     Test that a single line with more closing brackets than the opening ones is
     interpreted as invalid
     """
     cc = ipt2.TransformerManager().check_complete
     assert cc(value) == expected
 
 
 def test_null_cleanup_transformer():
     manager = ipt2.TransformerManager()
     manager.cleanup_transforms.insert(0, null_cleanup_transformer)
     assert manager.transform_cell("") == ""
 
 
-
-
 def test_side_effects_I():
     count = 0
+
     def counter(lines):
         nonlocal count
         count += 1
         return lines
 
     counter.has_side_effects = True
 
     manager = ipt2.TransformerManager()
     manager.cleanup_transforms.insert(0, counter)
-    assert manager.check_complete("a=1\n") == ('complete', None)
+    assert manager.check_complete("a=1\n") == ("complete", None)
     assert count == 0
 
 
-
-
 def test_side_effects_II():
     count = 0
+
     def counter(lines):
         nonlocal count
         count += 1
         return lines
 
     counter.has_side_effects = True
 
     manager = ipt2.TransformerManager()
     manager.line_transforms.insert(0, counter)
-    assert manager.check_complete("b=1\n") == ('complete', None)
+    assert manager.check_complete("b=1\n") == ("complete", None)
     assert count == 0

docs/source/whatsnew/version8.rst

@@ -1,1059 +1,1064 b''
 ============
  8.x Series
 ============
 
 
 .. _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.
+
+
  - :ghpull:`13600`, ``pre_run_*``-hooks will now have a ``cell_id`` attribute on
    the info object when frontend provide it.
 
 .. _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 seem to be
 random, and would appreciate help if you find  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
 Update a few behavior 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 formating
    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 issue and
 new features where 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 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 updates 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 exists anymore. 
  - minimum officially support ``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