' + title + '

' + else: + ds = ds_or_None + + ds = prelude + ds # store output in a dict, we initialize it here and fill it as we go - out = dict(name=oname, found=True, isalias=isalias, ismagic=ismagic, subclasses=None) string_max = 200 # max size of strings to show (snipped if longer) shalf = int((string_max - 5) / 2) @@ -779,20 +921,20 @@ def info(self, obj, oname="", info=None, detail_level=0) -> dict: try: bclass = obj.__class__ out['base_class'] = str(bclass) - except: + except AttributeError: pass # String form, but snip if too long in ? form (full in ??) if detail_level >= self.str_detail_level: try: ostr = str(obj) - str_head = 'string_form' - if not detail_level and len(ostr)>string_max: + if not detail_level and len(ostr) > string_max: ostr = ostr[:shalf] + ' <...> ' + ostr[-shalf:] - ostr = ("\n" + " " * len(str_head.expandtabs())).\ - join(q.strip() for q in ostr.split("\n")) - out[str_head] = ostr - except: + ostr = ("\n" + " " * len("string_form")).join( + q.strip() for q in ostr.split("\n") + ) + out["string_form"] = ostr + except Exception: pass if ospace: @@ -891,7 +1033,7 @@ def info(self, obj, oname="", info=None, detail_level=0) -> dict: if ds: try: cls = getattr(obj,'__class__') - except: + except AttributeError: class_ds = None else: class_ds = getdoc(cls) @@ -926,19 +1068,19 @@ def info(self, obj, oname="", info=None, detail_level=0) -> dict: if call_ds: out['call_docstring'] = call_ds - return object_info(**out) + return out @staticmethod def _source_contains_docstring(src, doc): """ Check whether the source *src* contains the docstring *doc*. - This is is helper function to skip displaying the docstring if the + This is a helper function to skip displaying the docstring if the source already contains it, avoiding repetition of information. """ try: - def_node, = ast.parse(dedent(src)).body - return ast.get_docstring(def_node) == doc + (def_node,) = ast.parse(dedent(src)).body + return ast.get_docstring(def_node) == doc # type: ignore[arg-type] except Exception: # The source can become invalid or even non-existent (because it # is re-fetched from the source file) so the above code fail in @@ -968,7 +1110,7 @@ def psearch(self,pattern,ns_table,ns_search=[], - list_types(False): list all available object types for object matching. """ - #print 'ps pattern:<%r>' % pattern # dbg + # print('ps pattern:<%r>' % pattern) # dbg # defaults type_pattern = 'all' @@ -997,7 +1139,7 @@ def psearch(self,pattern,ns_table,ns_search=[], raise ValueError('invalid namespace <%s>. Valid names: %s' % (name,ns_table.keys())) - #print 'type_pattern:',type_pattern # dbg + # print('type_pattern:',type_pattern) # dbg search_result, namespaces_seen = set(), set() for ns_name in ns_search: ns = ns_table[ns_name] @@ -1022,15 +1164,15 @@ def _render_signature(obj_signature, obj_name) -> str: pos_only = False kw_only = True for param in obj_signature.parameters.values(): - if param.kind == inspect._POSITIONAL_ONLY: + if param.kind == inspect.Parameter.POSITIONAL_ONLY: pos_only = True elif pos_only: result.append('/') pos_only = False - if param.kind == inspect._VAR_POSITIONAL: + if param.kind == inspect.Parameter.VAR_POSITIONAL: kw_only = False - elif param.kind == inspect._KEYWORD_ONLY and kw_only: + elif param.kind == inspect.Parameter.KEYWORD_ONLY and kw_only: result.append('*') kw_only = False @@ -1043,13 +1185,13 @@ def _render_signature(obj_signature, obj_name) -> str: if len(obj_name) + sum(len(r) + 2 for r in result) > 75: # This doesn’t fit behind “Signature: ” in an inspect window. rendered = '{}(\n{})'.format(obj_name, ''.join( - ' {},\n'.format(r) for r in result) + f' {r},\n' for r in result) ) else: rendered = '{}({})'.format(obj_name, ', '.join(result)) if obj_signature.return_annotation is not inspect._empty: anno = inspect.formatannotation(obj_signature.return_annotation) - rendered += ' -> {}'.format(anno) + rendered += f' -> {anno}' return rendered diff --git a/IPython/core/page.py b/IPython/core/page.py index d3e6a9eef50..5720114190d 100644 --- a/IPython/core/page.py +++ b/IPython/core/page.py @@ -1,4 +1,3 @@ -# encoding: utf-8 """ Paging capabilities for IPython.core @@ -18,19 +17,14 @@ import io import re import sys -import tempfile -import subprocess from io import UnsupportedOperation from pathlib import Path -from IPython import get_ipython -from IPython.display import display +from IPython.core.getipython import get_ipython from IPython.core.error import TryNext from IPython.utils.data import chop -from IPython.utils.process import system from IPython.utils.terminal import get_terminal_size -from IPython.utils import py3compat def display_page(strng, start=0, screen_lines=25): @@ -39,8 +33,9 @@ def display_page(strng, start=0, screen_lines=25): data = strng else: if start: - strng = u'\n'.join(strng.splitlines()[start:]) + strng = '\n'.join(strng.splitlines()[start:]) data = { 'text/plain': strng } + from IPython.display import display display(data, raw=True) @@ -89,13 +84,13 @@ def _detect_screen_size(screen_lines_def): # curses causes problems on many terminals other than xterm, and # some termios calls lock up on Sun OS5. return screen_lines_def - + try: import termios import curses except ImportError: return screen_lines_def - + # There is a bug in curses, where *sometimes* it fails to properly # initialize, and then after the endwin() call is made, the # terminal is left in an unusable state. Rather than trying to @@ -107,14 +102,14 @@ def _detect_screen_size(screen_lines_def): term_flags = termios.tcgetattr(sys.stdout) except termios.error as err: # can fail on Linux 2.6, pager_page will catch the TypeError - raise TypeError('termios error: {0}'.format(err)) from err + raise TypeError(f'termios error: {err}') from err try: scr = curses.initscr() except AttributeError: # Curses on Solaris may not be complete, so we can't use it there return screen_lines_def - + screen_lines_real,screen_cols = scr.getmaxyx() curses.endwin() @@ -122,10 +117,10 @@ def _detect_screen_size(screen_lines_def): termios.tcsetattr(sys.stdout,termios.TCSANOW,term_flags) # Now we have what we needed: the screen size in rows/columns return screen_lines_real - #print '***Screen size:',screen_lines_real,'lines x',\ - #screen_cols,'columns.' # dbg + # print('***Screen size:',screen_lines_real,'lines x', + # screen_cols,'columns.') # dbg -def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): +def pager_page(strng, start=0, screen_lines=0, pager_cmd=None) -> None: """Display a string, piping through a pager after a certain length. strng can be a mime-bundle dict, supplying multiple representations, @@ -148,7 +143,7 @@ def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): If no system pager works, the string is sent through a 'dumb pager' written in python, very simplistic. """ - + # for compatibility with mime-bundle form: if isinstance(strng, dict): strng = strng['text/plain'] @@ -179,9 +174,9 @@ def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): print(str_toprint) return - #print 'numlines',numlines,'screenlines',screen_lines # dbg + # print('numlines',numlines,'screenlines',screen_lines) # dbg if numlines <= screen_lines : - #print '*** normal print' # dbg + # print('*** normal print') # dbg print(str_toprint) else: # Try to open pager and default to internal one if that fails. @@ -195,13 +190,14 @@ def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): # The default WinXP 'type' command is failing on complex strings. retval = 1 else: + import tempfile fd, tmpname = tempfile.mkstemp('.txt') tmppath = Path(tmpname) try: os.close(fd) with tmppath.open("wt", encoding="utf-8") as tmpfile: tmpfile.write(strng) - cmd = "%s < %s" % (pager_cmd, tmppath) + cmd = "{} < {}".format(pager_cmd, tmppath) # tmpfile needs to be closed for windows if os.system(cmd): retval = 1 @@ -213,6 +209,7 @@ def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): try: retval = None # Emulate os.popen, but redirect stderr + import subprocess proc = subprocess.Popen( pager_cmd, shell=True, @@ -227,19 +224,18 @@ def pager_page(strng, start=0, screen_lines=0, pager_cmd=None): pager.write(strng) finally: retval = pager.close() - except IOError as msg: # broken pipe when user quits + except OSError as msg: # broken pipe when user quits + # msg.args == (32, 'Broken pipe') for that case; other + # OSErrors are strange problems, sometimes seen in Win2k/cygwin if msg.args == (32, 'Broken pipe'): retval = None else: retval = 1 - except OSError: - # Other strange problems, sometimes seen in Win2k/cygwin - retval = 1 if retval is not None: page_dumb(strng,screen_lines=screen_lines) -def page(data, start=0, screen_lines=0, pager_cmd=None): +def page(data, start: int = 0, screen_lines: int = 0, pager_cmd=None): """Display content in a pager, piping through a pager after a certain length. data can be a mime-bundle dict, supplying multiple representations, @@ -260,7 +256,7 @@ def page(data, start=0, screen_lines=0, pager_cmd=None): return except TryNext: pass - + # fallback on default pager return pager_page(data, start, screen_lines, pager_cmd) @@ -274,14 +270,15 @@ def page_file(fname, start=0, pager_cmd=None): try: if os.environ['TERM'] in ['emacs','dumb']: - raise EnvironmentError + raise OSError + from IPython.utils.process import system system(pager_cmd + ' ' + fname) - except: + except Exception: try: if start > 0: start -= 1 page(open(fname, encoding="utf-8").read(), start) - except: + except Exception: print('Unable to show file',repr(fname)) @@ -298,12 +295,12 @@ def get_pager_cmd(pager_cmd=None): if pager_cmd is None: try: pager_cmd = os.environ['PAGER'] - except: + except KeyError: pager_cmd = default_pager_cmd - + if pager_cmd == 'less' and '-r' not in os.environ.get('LESS', '').lower(): pager_cmd += ' -R' - + return pager_cmd @@ -341,7 +338,7 @@ def page_more(): return result else: def page_more(): - ans = py3compat.input('---Return to continue, q to quit--- ') + ans = input('---Return to continue, q to quit--- ') if ans.lower().startswith('q'): return False else: diff --git a/IPython/core/payload.py b/IPython/core/payload.py index 6818be15372..e096bc4e06e 100644 --- a/IPython/core/payload.py +++ b/IPython/core/payload.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Payload system for IPython. Authors: @@ -26,8 +25,7 @@ #----------------------------------------------------------------------------- class PayloadManager(Configurable): - - _payload = List([]) + _payload: List = List([]) def write_payload(self, data, single=True): """Include or update the specified `data` payload in the PayloadManager. diff --git a/IPython/core/payloadpage.py b/IPython/core/payloadpage.py index 4958108076b..9ba4157cec8 100644 --- a/IPython/core/payloadpage.py +++ b/IPython/core/payloadpage.py @@ -1,4 +1,3 @@ -# encoding: utf-8 """A payload based version of page.""" # Copyright (c) IPython Development Team. @@ -7,6 +6,9 @@ import warnings from IPython.core.getipython import get_ipython +# see https://github.com/ipython/ipykernel/issues/1304 +# this should be moved to ipykernel and removed in the long run. + def page(strng, start=0, screen_lines=0, pager_cmd=None): """Print a string, piping through a pager. @@ -26,26 +28,14 @@ def page(strng, start=0, screen_lines=0, pager_cmd=None): # negative value. Offset to 0 for robustness. start = max(0, start) shell = get_ipython() - + if isinstance(strng, dict): data = strng else: - data = {'text/plain' : strng} + data = {"text/plain": strng} payload = dict( - source='page', + source="page", data=data, start=start, - ) + ) shell.payload_manager.write_payload(payload) - - -def install_payload_page(): - """DEPRECATED, use show_in_pager hook - - Install this version of page as IPython.core.page.page. - """ - warnings.warn("""install_payload_page is deprecated. - Use `ip.set_hook('show_in_pager, page.as_hook(payloadpage.page))` - """) - from IPython.core import page as corepage - corepage.page = page diff --git a/IPython/core/prefilter.py b/IPython/core/prefilter.py index 0038e5c673e..e7f37f68548 100644 --- a/IPython/core/prefilter.py +++ b/IPython/core/prefilter.py @@ -1,4 +1,3 @@ -# encoding: utf-8 """ Prefiltering components. @@ -118,7 +117,7 @@ class PrefilterManager(Configurable): shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) def __init__(self, shell=None, **kwargs): - super(PrefilterManager, self).__init__(shell=shell, **kwargs) + super().__init__(shell=shell, **kwargs) self.shell = shell self._transformers = [] self.init_handlers() @@ -240,7 +239,7 @@ def prefilter_line_info(self, line_info): This implements the checker/handler part of the prefilter pipe. """ - # print "prefilter_line_info: ", line_info + # print("prefilter_line_info: ", line_info) handler = self.find_handler(line_info) return handler.handle(line_info) @@ -267,7 +266,7 @@ def prefilter_line(self, line, continue_prompt=False): transformers and then the checkers/handlers. """ - # print "prefilter_line: ", line, continue_prompt + # print("prefilter_line: ", line, continue_prompt) # All handlers *must* return a value, even if it's blank (''). # save the line away in case we crash, so the post-mortem handler can @@ -300,7 +299,7 @@ def prefilter_line(self, line, continue_prompt=False): return normal_handler.handle(line_info) prefiltered = self.prefilter_line_info(line_info) - # print "prefiltered line: %r" % prefiltered + # print("prefiltered line: %r" % prefiltered) return prefiltered def prefilter_lines(self, lines, continue_prompt=False): @@ -344,7 +343,7 @@ class PrefilterTransformer(Configurable): enabled = Bool(True).tag(config=True) def __init__(self, shell=None, prefilter_manager=None, **kwargs): - super(PrefilterTransformer, self).__init__( + super().__init__( shell=shell, prefilter_manager=prefilter_manager, **kwargs ) self.prefilter_manager.register_transformer(self) @@ -354,7 +353,7 @@ def transform(self, line, continue_prompt): return None def __repr__(self): - return "<%s(priority=%r, enabled=%r)>" % ( + return "<{}(priority={!r}, enabled={!r})>".format( self.__class__.__name__, self.priority, self.enabled) @@ -372,7 +371,7 @@ class PrefilterChecker(Configurable): enabled = Bool(True).tag(config=True) def __init__(self, shell=None, prefilter_manager=None, **kwargs): - super(PrefilterChecker, self).__init__( + super().__init__( shell=shell, prefilter_manager=prefilter_manager, **kwargs ) self.prefilter_manager.register_checker(self) @@ -382,7 +381,7 @@ def check(self, line_info): return None def __repr__(self): - return "<%s(priority=%r, enabled=%r)>" % ( + return "<{}(priority={!r}, enabled={!r})>".format( self.__class__.__name__, self.priority, self.enabled) @@ -476,8 +475,8 @@ def check(self, line_info): any python operator, we should simply execute the line (regardless of whether or not there's a possible autocall expansion). This avoids spurious (and very confusing) geattr() accesses.""" - if line_info.the_rest and line_info.the_rest[0] in '!=()<>,+*/%^&|': - return self.prefilter_manager.get_handler_by_name('normal') + if line_info.the_rest and line_info.the_rest[0] in "!=()<>,+*/%^&|": + return self.prefilter_manager.get_handler_by_name("normal") else: return None @@ -498,8 +497,8 @@ def check(self, line_info): if not self.shell.autocall: return None - oinfo = line_info.ofind(self.shell) # This can mutate state via getattr - if not oinfo['found']: + oinfo = self.shell._ofind(line_info.ifun) # This can mutate state via getattr + if not oinfo.found: return None ignored_funs = ['b', 'f', 'r', 'u', 'br', 'rb', 'fr', 'rf'] @@ -508,10 +507,16 @@ def check(self, line_info): if ifun.lower() in ignored_funs and (line.startswith(ifun + "'") or line.startswith(ifun + '"')): return None - if callable(oinfo['obj']) \ - and (not self.exclude_regexp.match(line_info.the_rest)) \ - and self.function_name_regexp.match(line_info.ifun): - return self.prefilter_manager.get_handler_by_name('auto') + if ( + callable(oinfo.obj) + and (not self.exclude_regexp.match(line_info.the_rest)) + and self.function_name_regexp.match(line_info.ifun) + and ( + line_info.raw_the_rest.startswith(" ") + or not line_info.raw_the_rest.strip() + ) + ): + return self.prefilter_manager.get_handler_by_name("auto") else: return None @@ -522,14 +527,17 @@ def check(self, line_info): class PrefilterHandler(Configurable): - - handler_name = Unicode('normal') - esc_strings = List([]) - shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) - prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) + handler_name = Unicode("normal") + esc_strings: List = List([]) + shell = Instance( + "IPython.core.interactiveshell.InteractiveShellABC", allow_none=True + ) + prefilter_manager = Instance( + "IPython.core.prefilter.PrefilterManager", allow_none=True + ) def __init__(self, shell=None, prefilter_manager=None, **kwargs): - super(PrefilterHandler, self).__init__( + super().__init__( shell=shell, prefilter_manager=prefilter_manager, **kwargs ) self.prefilter_manager.register_handler( @@ -539,7 +547,7 @@ def __init__(self, shell=None, prefilter_manager=None, **kwargs): ) def handle(self, line_info): - # print "normal: ", line_info + # print("normal: ", line_info) """Handle normal input lines. Use as a template for handlers.""" # With autoindent on, we need some way to exit the input loop, and I @@ -559,7 +567,7 @@ def handle(self, line_info): return line def __str__(self): - return "<%s(name=%s)>" % (self.__class__.__name__, self.handler_name) + return "<{}(name={})>".format(self.__class__.__name__, self.handler_name) class MacroHandler(PrefilterHandler): @@ -585,7 +593,7 @@ def handle(self, line_info): t_arg_s = ifun + " " + the_rest t_magic_name, _, t_magic_arg_s = t_arg_s.partition(' ') t_magic_name = t_magic_name.lstrip(ESC_MAGIC) - cmd = '%sget_ipython().run_line_magic(%r, %r)' % (line_info.pre_whitespace, t_magic_name, t_magic_arg_s) + cmd = '{}get_ipython().run_line_magic({!r}, {!r})'.format(line_info.pre_whitespace, t_magic_name, t_magic_arg_s) return cmd @@ -601,7 +609,7 @@ def handle(self, line_info): the_rest = line_info.the_rest esc = line_info.esc continue_prompt = line_info.continue_prompt - obj = line_info.ofind(self.shell)['obj'] + obj = self.shell._ofind(line_info.ifun).obj # This should only be active for single-line input! if continue_prompt: @@ -619,12 +627,12 @@ def handle(self, line_info): if esc == ESC_QUOTE: # Auto-quote splitting on whitespace - newcmd = '%s("%s")' % (ifun,'", "'.join(the_rest.split()) ) + newcmd = '{}("{}")'.format(ifun,'", "'.join(the_rest.split()) ) elif esc == ESC_QUOTE2: # Auto-quote whole string - newcmd = '%s("%s")' % (ifun,the_rest) + newcmd = '{}("{}")'.format(ifun,the_rest) elif esc == ESC_PAREN: - newcmd = '%s(%s)' % (ifun,",".join(the_rest.split())) + newcmd = '{}({})'.format(ifun,",".join(the_rest.split())) else: # Auto-paren. if force_auto: @@ -645,9 +653,9 @@ def handle(self, line_info): # Figure out the rewritten command if do_rewrite: if the_rest.endswith(';'): - newcmd = '%s(%s);' % (ifun.rstrip(),the_rest[:-1]) + newcmd = '{}({});'.format(ifun.rstrip(),the_rest[:-1]) else: - newcmd = '%s(%s)' % (ifun.rstrip(), the_rest) + newcmd = '{}({})'.format(ifun.rstrip(), the_rest) else: normal_handler = self.prefilter_manager.get_handler_by_name('normal') return normal_handler.handle(line_info) diff --git a/IPython/core/profileapp.py b/IPython/core/profileapp.py index 9a1bae55ac5..f3a5632ae6e 100644 --- a/IPython/core/profileapp.py +++ b/IPython/core/profileapp.py @@ -1,4 +1,3 @@ -# encoding: utf-8 """ An application for managing IPython profiles. @@ -108,7 +107,7 @@ def list_profiles_in(path): def list_bundled_profiles(): """list profiles that are bundled with IPython.""" - path = os.path.join(get_ipython_package_dir(), u'core', u'profile') + path = os.path.join(get_ipython_package_dir(), 'core', 'profile') profiles = [] # for python 3.6+ rewrite to: with os.scandir(path) as dirlist: @@ -121,18 +120,18 @@ def list_bundled_profiles(): class ProfileLocate(BaseIPythonApplication): description = """print the path to an IPython profile dir""" - + def parse_command_line(self, argv=None): - super(ProfileLocate, self).parse_command_line(argv) + super().parse_command_line(argv) if self.extra_args: self.profile = self.extra_args[0] - + def start(self): print(self.profile_dir.location) class ProfileList(Application): - name = u'ipython-profile' + name = 'ipython-profile' description = list_help examples = _list_examples @@ -171,13 +170,13 @@ def list_profile_dirs(self): print(" The first request for a bundled profile will copy it") print(" into your IPython directory (%s)," % self.ipython_dir) print(" where you can customize it.") - + profiles = list_profiles_in(self.ipython_dir) if profiles: print() print("Available profiles in %s:" % self.ipython_dir) self._print_profiles(profiles) - + profiles = list_profiles_in(os.getcwd()) if profiles: print() @@ -206,10 +205,10 @@ def start(self): class ProfileCreate(BaseIPythonApplication): - name = u'ipython-profile' + name = 'ipython-profile' description = create_help examples = _create_examples - auto_create = Bool(True) + auto_create = Bool(True).tag(config=True) def _log_format_default(self): return "[%(name)s] %(message)s" @@ -235,7 +234,7 @@ def _parallel_changed(self, change): self.config_files.remove(cf) def parse_command_line(self, argv): - super(ProfileCreate, self).parse_command_line(argv) + super().parse_command_line(argv) # accept positional arg as profile name if self.extra_args: self.profile = self.extra_args[0] @@ -243,7 +242,7 @@ def parse_command_line(self, argv): flags = Dict(create_flags) classes = [ProfileDir] - + def _import_app(self, app_path): """import an app class""" app = None @@ -257,7 +256,7 @@ def _import_app(self, app_path): return app def init_config_files(self): - super(ProfileCreate, self).init_config_files() + super().init_config_files() # use local imports, since these classes may import from here from IPython.terminal.ipapp import TerminalIPythonApp apps = [TerminalIPythonApp] @@ -291,7 +290,7 @@ def stage_default_config_file(self): class ProfileApp(Application): - name = u'ipython profile' + name = 'ipython profile' description = profile_help examples = _main_examples @@ -303,8 +302,11 @@ class ProfileApp(Application): def start(self): if self.subapp is None: - print("No subcommand specified. Must specify one of: %s"%(self.subcommands.keys())) - print() + print( + "No subcommand specified. Must specify one of: " + + ", ".join(map(repr, self.subcommands)) + + ".\n" + ) self.print_description() self.print_subcommands() self.exit(1) diff --git a/IPython/core/profiledir.py b/IPython/core/profiledir.py index 1e33b552fb7..f0ac1f7adf1 100644 --- a/IPython/core/profiledir.py +++ b/IPython/core/profiledir.py @@ -1,11 +1,9 @@ -# encoding: utf-8 """An object for managing IPython profile directories.""" # Copyright (c) IPython Development Team. # Distributed under the terms of the Modified BSD License. import os -import shutil import errno from pathlib import Path @@ -41,13 +39,13 @@ class ProfileDir(LoggingConfigurable): startup_dir_name = Unicode('startup') pid_dir_name = Unicode('pid') static_dir_name = Unicode('static') - security_dir = Unicode(u'') - log_dir = Unicode(u'') - startup_dir = Unicode(u'') - pid_dir = Unicode(u'') - static_dir = Unicode(u'') + security_dir = Unicode('') + log_dir = Unicode('') + startup_dir = Unicode('') + pid_dir = Unicode('') + static_dir = Unicode('') - location = Unicode(u'', + location = Unicode('', help="""Set the profile location directly. This overrides the logic used by the `profile` option.""", ).tag(config=True) @@ -68,18 +66,31 @@ def _location_changed(self, change): self.pid_dir = os.path.join(new, self.pid_dir_name) self.static_dir = os.path.join(new, self.static_dir_name) self.check_dirs() - - def _mkdir(self, path, mode=None): + + def _mkdir(self, path: str, mode: int | None = None) -> bool: """ensure a directory exists at a given path This is a version of os.mkdir, with the following differences: - - returns True if it created the directory, False otherwise + - returns whether the directory has been created or not. - ignores EEXIST, protecting against race conditions where the dir may have been created in between the check and the creation - sets permissions if requested and the dir already exists + + Parameters + ---------- + path: str + path of the dir to create + mode: int + see `mode` of `os.mkdir` + + Returns + ------- + bool: + returns True if it created the directory, False otherwise """ + if os.path.exists(path): if mode and os.stat(path).st_mode != mode: try: @@ -102,23 +113,28 @@ def _mkdir(self, path, mode=None): raise return True - + @observe('log_dir') def check_log_dir(self, change=None): self._mkdir(self.log_dir) - + @observe('startup_dir') def check_startup_dir(self, change=None): - self._mkdir(self.startup_dir) - - readme = os.path.join(self.startup_dir, 'README') - src = os.path.join(get_ipython_package_dir(), u'core', u'profile', u'README_STARTUP') - - if not os.path.exists(src): - self.log.warning("Could not copy README_STARTUP to startup dir. Source file %s does not exist.", src) - - if os.path.exists(src) and not os.path.exists(readme): - shutil.copy(src, readme) + if self._mkdir(self.startup_dir): + readme = os.path.join(self.startup_dir, "README") + src = os.path.join( + get_ipython_package_dir(), "core", "profile", "README_STARTUP" + ) + + if os.path.exists(src): + if not os.path.exists(readme): + import shutil + shutil.copy(src, readme) + else: + self.log.warning( + "Could not copy README_STARTUP to startup dir. Source file %s does not exist.", + src, + ) @observe('security_dir') def check_security_dir(self, change=None): @@ -141,12 +157,10 @@ def copy_config_file(self, config_file: str, path: Path, overwrite=False) -> boo This function moves these from that location to the working profile directory. """ + import shutil dst = Path(os.path.join(self.location, config_file)) if dst.exists() and not overwrite: return False - if path is None: - path = os.path.join(get_ipython_package_dir(), u'core', u'profile', u'default') - assert isinstance(path, Path) src = path / config_file shutil.copy(src, dst) return True @@ -164,7 +178,7 @@ def create_profile_dir(cls, profile_dir, config=None): return cls(location=profile_dir, config=config) @classmethod - def create_profile_dir_by_name(cls, path, name=u'default', config=None): + def create_profile_dir_by_name(cls, path, name='default', config=None): """Create a profile dir by profile name and path. Parameters @@ -177,11 +191,11 @@ def create_profile_dir_by_name(cls, path, name=u'default', config=None): """ if not os.path.isdir(path): raise ProfileDirError('Directory not found: %s' % path) - profile_dir = os.path.join(path, u'profile_' + name) + profile_dir = os.path.join(path, 'profile_' + name) return cls(location=profile_dir, config=config) @classmethod - def find_profile_dir_by_name(cls, ipython_dir, name=u'default', config=None): + def find_profile_dir_by_name(cls, ipython_dir, name='default', config=None): """Find an existing profile dir by profile name, return its ProfileDir. This searches through a sequence of paths for a profile dir. If it @@ -199,7 +213,7 @@ def find_profile_dir_by_name(cls, ipython_dir, name=u'default', config=None): The name of the profile. The name of the profile directory will be "profile_". """ - dirname = u'profile_' + name + dirname = 'profile_' + name paths = [ipython_dir] for p in paths: profile_dir = os.path.join(p, dirname) diff --git a/IPython/core/prompts.py b/IPython/core/prompts.py deleted file mode 100644 index 7fd218d37ae..00000000000 --- a/IPython/core/prompts.py +++ /dev/null @@ -1,21 +0,0 @@ -# -*- coding: utf-8 -*- -"""Being removed -""" - -class LazyEvaluate(object): - """This is used for formatting strings with values that need to be updated - at that time, such as the current time or working directory.""" - def __init__(self, func, *args, **kwargs): - self.func = func - self.args = args - self.kwargs = kwargs - - def __call__(self, **kwargs): - self.kwargs.update(kwargs) - return self.func(*self.args, **self.kwargs) - - def __str__(self): - return str(self()) - - def __format__(self, format_spec): - return format(self(), format_spec) diff --git a/IPython/core/pylabtools.py b/IPython/core/pylabtools.py index 68e100f7d07..634b940c532 100644 --- a/IPython/core/pylabtools.py +++ b/IPython/core/pylabtools.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Pylab (matplotlib) support utilities.""" # Copyright (c) IPython Development Team. @@ -7,14 +6,18 @@ from io import BytesIO from binascii import b2a_base64 from functools import partial -import warnings from IPython.core.display import _pngxy from IPython.utils.decorators import flag_calls -# If user specifies a GUI, that dictates the backend, otherwise we read the -# user's mpl default from the mpl rc structure -backends = { + +# Matplotlib backend resolution functionality moved from IPython to Matplotlib +# in IPython 8.24 and Matplotlib 3.9.0. The dicts below are still needed by the +# find_gui_and_backend fallback path for Matplotlib < 3.9, which can be removed +# when Python 3.12 (the last version supported by Matplotlib < 3.9) reaches +# end-of-life in late 2028. The public module-level `backends` and +# `backend2gui` aliases were deprecated in IPython 8.24 and removed in 9.16. +_deprecated_backends = { "tk": "TkAgg", "gtk": "GTKAgg", "gtk3": "GTK3Agg", @@ -23,9 +26,10 @@ "qt4": "Qt4Agg", "qt5": "Qt5Agg", "qt6": "QtAgg", - "qt": "Qt5Agg", + "qt": "QtAgg", "osx": "MacOSX", "nbagg": "nbAgg", + "webagg": "WebAgg", "notebook": "nbAgg", "agg": "agg", "svg": "svg", @@ -40,29 +44,32 @@ # GUI support to activate based on the desired matplotlib backend. For the # most part it's just a reverse of the above dict, but we also need to add a # few others that map to the same GUI manually: -backend2gui = dict(zip(backends.values(), backends.keys())) +_deprecated_backend2gui = dict( + zip(_deprecated_backends.values(), _deprecated_backends.keys()) +) # In the reverse mapping, there are a few extra valid matplotlib backends that # map to the same GUI support -backend2gui["GTK"] = backend2gui["GTKCairo"] = "gtk" -backend2gui["GTK3Cairo"] = "gtk3" -backend2gui["GTK4Cairo"] = "gtk4" -backend2gui["WX"] = "wx" -backend2gui["CocoaAgg"] = "osx" +_deprecated_backend2gui["GTK"] = _deprecated_backend2gui["GTKCairo"] = "gtk" +_deprecated_backend2gui["GTK3Cairo"] = "gtk3" +_deprecated_backend2gui["GTK4Cairo"] = "gtk4" +_deprecated_backend2gui["WX"] = "wx" +_deprecated_backend2gui["CocoaAgg"] = "osx" # There needs to be a hysteresis here as the new QtAgg Matplotlib backend # supports either Qt5 or Qt6 and the IPython qt event loop support Qt4, Qt5, # and Qt6. -backend2gui["QtAgg"] = "qt" -backend2gui["Qt4Agg"] = "qt" -backend2gui["Qt5Agg"] = "qt" +_deprecated_backend2gui["QtAgg"] = "qt" +_deprecated_backend2gui["Qt4Agg"] = "qt4" +_deprecated_backend2gui["Qt5Agg"] = "qt5" # And some backends that don't need GUI integration -del backend2gui["nbAgg"] -del backend2gui["agg"] -del backend2gui["svg"] -del backend2gui["pdf"] -del backend2gui["ps"] -del backend2gui["module://matplotlib_inline.backend_inline"] -del backend2gui["module://ipympl.backend_nbagg"] +del _deprecated_backend2gui["nbAgg"] +del _deprecated_backend2gui["agg"] +del _deprecated_backend2gui["svg"] +del _deprecated_backend2gui["pdf"] +del _deprecated_backend2gui["ps"] +del _deprecated_backend2gui["module://matplotlib_inline.backend_inline"] +del _deprecated_backend2gui["module://ipympl.backend_nbagg"] + #----------------------------------------------------------------------------- # Matplotlib utilities @@ -153,7 +160,7 @@ def print_figure(fig, fmt="png", bbox_inches="tight", base64=False, **kwargs): if fmt == 'svg': data = data.decode('utf-8') elif base64: - data = b2a_base64(data).decode("ascii") + data = b2a_base64(data, newline=False).decode("ascii") return data def retina_figure(fig, base64=False, **kwargs): @@ -173,7 +180,7 @@ def retina_figure(fig, base64=False, **kwargs): w, h = _pngxy(pngdata) metadata = {"width": w//2, "height":h//2} if base64: - pngdata = b2a_base64(pngdata).decode("ascii") + pngdata = b2a_base64(pngdata, newline=False).decode("ascii") return pngdata, metadata @@ -205,12 +212,14 @@ def mpl_execfile(fname,*where,**kw): import matplotlib import matplotlib.pyplot as plt - #print '*** Matplotlib runner ***' # dbg + # print('*** Matplotlib runner ***') # dbg # turn off rendering until end of script - is_interactive = matplotlib.rcParams['interactive'] - matplotlib.interactive(False) - safe_execfile(fname,*where,**kw) - matplotlib.interactive(is_interactive) + with matplotlib.rc_context({"interactive": False}): + safe_execfile(fname, *where, **kw) + + if matplotlib.is_interactive(): + plt.show() + # make rendering call now, if the user tried to do it if plt.draw_if_interactive.called: plt.draw() @@ -264,7 +273,7 @@ def select_figure_formats(shell, formats, **kwargs): [ f.pop(Figure, None) for f in shell.display_formatter.formatters.values() ] mplbackend = matplotlib.get_backend().lower() - if mplbackend == 'nbagg' or mplbackend == 'module://ipympl.backend_nbagg': + if mplbackend in ("nbagg", "ipympl", "widget", "module://ipympl.backend_nbagg"): formatter = shell.display_formatter.ipython_display_formatter formatter.for_type(Figure, _reshow_nbagg_figure) @@ -273,7 +282,7 @@ def select_figure_formats(shell, formats, **kwargs): if bad: bs = "%s" % ','.join([repr(f) for f in bad]) gs = "%s" % ','.join([repr(f) for f in supported]) - raise ValueError("supported formats are: %s not %s" % (gs, bs)) + raise ValueError("supported formats are: {} not {}".format(gs, bs)) if "png" in formats: png_formatter.for_type( @@ -316,9 +325,32 @@ def find_gui_and_backend(gui=None, gui_select=None): import matplotlib + if _matplotlib_manages_backends(): + backend_registry = matplotlib.backends.registry.backend_registry + + # gui argument may be a gui event loop or may be a backend name. + if gui in ("auto", None): + backend = matplotlib.rcParamsOrig["backend"] + backend, gui = backend_registry.resolve_backend(backend) + else: + gui = _convert_gui_to_matplotlib(gui) + backend, gui = backend_registry.resolve_gui_or_backend(gui) + + gui = _convert_gui_from_matplotlib(gui) + return gui, backend + + # Fallback to previous behaviour (Matplotlib < 3.9) + mpl_version_info = getattr(matplotlib, "__version_info__", (0, 0)) + has_unified_qt_backend = mpl_version_info >= (3, 5) + + + backends_ = dict(_deprecated_backends) + if not has_unified_qt_backend: + backends_["qt"] = "qt5agg" + if gui and gui != 'auto': # select backend based on requested gui - backend = backends[gui] + backend = backends_[gui] if gui == 'agg': gui = None else: @@ -327,15 +359,21 @@ def find_gui_and_backend(gui=None, gui_select=None): # overwritten that. # WARNING: this assumes matplotlib 1.1 or newer!! backend = matplotlib.rcParamsOrig['backend'] + # In this case, we need to find what the appropriate gui selection call # should be for IPython, so we can activate inputhook accordingly - gui = backend2gui.get(backend, None) + gui = _deprecated_backend2gui.get(backend, None) # If we have already had a gui active, we need it and inline are the # ones allowed. if gui_select and gui != gui_select: gui = gui_select - backend = backends[gui] + backend = backends_[gui] + + # Matplotlib before _matplotlib_manages_backends() can return "inline" for + # no gui event loop rather than the None that IPython >= 8.24.0 expects. + if gui == "inline": + gui = None return gui, backend @@ -397,28 +435,66 @@ def import_pylab(user_ns, import_all=True): user_ns['getfigs'] = getfigs -def configure_inline_support(shell, backend): +# Determine if Matplotlib manages backends only if needed, and cache result. +# Do not read this directly, instead use _matplotlib_manages_backends(). +_matplotlib_manages_backends_value: bool | None = None + + +def _matplotlib_manages_backends() -> bool: + """Return True if Matplotlib manages backends, False otherwise. + + If it returns True, the caller can be sure that + matplotlib.backends.registry.backend_registry is available along with + member functions resolve_gui_or_backend, resolve_backend, list_all, and + list_gui_frameworks. + + This function can be removed as it will always return True when Python + 3.12, the latest version supported by Matplotlib < 3.9, reaches + end-of-life in late 2028. """ - .. deprecated:: 7.23 + global _matplotlib_manages_backends_value + if _matplotlib_manages_backends_value is None: + try: + from matplotlib.backends.registry import backend_registry - use `matplotlib_inline.backend_inline.configure_inline_support()` + _matplotlib_manages_backends_value = hasattr( + backend_registry, "resolve_gui_or_backend" + ) + except ImportError: + _matplotlib_manages_backends_value = False - Configure an IPython shell object for matplotlib use. + return _matplotlib_manages_backends_value - Parameters - ---------- - shell : InteractiveShell instance - backend : matplotlib backend + +def _list_matplotlib_backends_and_gui_loops() -> list[str]: + """Return list of all Matplotlib backends and GUI event loops. + + This is the list returned by + %matplotlib --list """ - warnings.warn( - "`configure_inline_support` is deprecated since IPython 7.23, directly " - "use `matplotlib_inline.backend_inline.configure_inline_support()`", - DeprecationWarning, - stacklevel=2, - ) - - from matplotlib_inline.backend_inline import ( - configure_inline_support as configure_inline_support_orig, - ) - - configure_inline_support_orig(shell, backend) + if _matplotlib_manages_backends(): + from matplotlib.backends.registry import backend_registry + + ret = backend_registry.list_all() + [ + _convert_gui_from_matplotlib(gui) + for gui in backend_registry.list_gui_frameworks() + ] + else: + ret = list(_deprecated_backends.keys()) + + return sorted(["auto"] + ret) + + +# Matplotlib and IPython do not always use the same gui framework name. +# Always use the appropriate one of these conversion functions when passing a +# gui framework name to/from Matplotlib. +def _convert_gui_to_matplotlib(gui: str | None) -> str | None: + if gui and gui.lower() == "osx": + return "macosx" + return gui + + +def _convert_gui_from_matplotlib(gui: str | None) -> str | None: + if gui and gui.lower() == "macosx": + return "osx" + return gui diff --git a/IPython/core/release.py b/IPython/core/release.py index ae19fa66f18..294b84e9817 100644 --- a/IPython/core/release.py +++ b/IPython/core/release.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Release data for the IPython project.""" #----------------------------------------------------------------------------- @@ -15,11 +14,11 @@ # IPython version information. An empty _version_extra corresponds to a full # release. 'dev' as a _version_extra string means this is a development # version -_version_major = 8 -_version_minor = 3 +_version_major = 9 +_version_minor = 17 _version_patch = 0 _version_extra = ".dev" -# _version_extra = "rc1" +# _version_extra = "b2" # _version_extra = "" # Uncomment this for full releases # Construct full version string from these. @@ -32,22 +31,13 @@ version = __version__ # backwards compatibility name version_info = (_version_major, _version_minor, _version_patch, _version_extra) -# Change this when incrementing the kernel protocol version -kernel_protocol_version_info = (5, 0) -kernel_protocol_version = "%i.%i" % kernel_protocol_version_info - -license = 'BSD' - -authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'), - 'Janko' : ('Janko Hauser','jhauser@zscout.de'), - 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'), - 'Ville' : ('Ville Vainio','vivainio@gmail.com'), - 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'), - 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com'), - 'Thomas' : ('Thomas A. Kluyver', 'takowl@gmail.com'), - 'Jorgen' : ('Jorgen Stenarson', 'jorgen.stenarson@bostream.nu'), - 'Matthias' : ('Matthias Bussonnier', 'bussonniermatthias@gmail.com'), - } + +license = "BSD-3-Clause" + +authors = { + "Fernando": ("Fernando Perez", "fperez.net@gmail.com"), + "M": ("M Bussonnier", "mbussonnier@gmail.com"), +} author = 'The IPython Development Team' diff --git a/IPython/core/shellapp.py b/IPython/core/shellapp.py index f737bcb56b7..9ad4d434e1d 100644 --- a/IPython/core/shellapp.py +++ b/IPython/core/shellapp.py @@ -1,4 +1,3 @@ -# encoding: utf-8 """ A mixin for :class:`~IPython.core.application.Application` classes that launch InteractiveShell instances, load extensions, etc. @@ -7,42 +6,51 @@ # Copyright (c) IPython Development Team. # Distributed under the terms of the Modified BSD License. +from __future__ import annotations + import glob from itertools import chain import os import sys +from typing import Any from traitlets.config.application import boolean_flag from traitlets.config.configurable import Configurable from traitlets.config.loader import Config from IPython.core.application import SYSTEM_CONFIG_DIRS, ENV_CONFIG_DIRS -from IPython.core import pylabtools from IPython.utils.contexts import preserve_keys from IPython.utils.path import filefind -import traitlets from traitlets import ( - Unicode, Instance, List, Bool, CaselessStrEnum, observe, + Unicode, + Instance, + List, + Bool, + CaselessStrEnum, + observe, DottedObjectName, + Undefined, ) from IPython.terminal import pt_inputhooks -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Aliases and Flags -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- gui_keys = tuple(sorted(pt_inputhooks.backends) + sorted(pt_inputhooks.aliases)) -backend_keys = sorted(pylabtools.backends.keys()) -backend_keys.insert(0, 'auto') - shell_flags = {} addflag = lambda *args: shell_flags.update(boolean_flag(*args)) -addflag('autoindent', 'InteractiveShell.autoindent', - 'Turn on autoindenting.', 'Turn off autoindenting.' +addflag( + "autoindent", + "InteractiveShell.autoindent", + "Turn on autoindenting.", + "Turn off autoindenting.", ) -addflag('automagic', 'InteractiveShell.automagic', - """Turn on the auto calling of magic commands. Type %%magic at the +addflag( + "automagic", + "InteractiveShell.automagic", + """Turn on the auto calling of magic commands. Type %%magic at the IPython prompt for more information.""", 'Turn off the auto calling of magic commands.' ) @@ -75,22 +83,25 @@ shell_flags['pylab'] = ( {'InteractiveShellApp' : {'pylab' : 'auto'}}, """Pre-load matplotlib and numpy for interactive use with - the default matplotlib backend.""" + the default matplotlib backend. The exact options available + depend on what Matplotlib provides at runtime.""", ) shell_flags['matplotlib'] = ( {'InteractiveShellApp' : {'matplotlib' : 'auto'}}, """Configure matplotlib for interactive use with - the default matplotlib backend.""" + the default matplotlib backend. The exact options available + depend on what Matplotlib provides at runtime.""", ) # it's possible we don't want short aliases for *all* of these: shell_aliases = dict( - autocall='InteractiveShell.autocall', - colors='InteractiveShell.colors', - logfile='InteractiveShell.logfile', - logappend='InteractiveShell.logappend', - c='InteractiveShellApp.code_to_run', - m='InteractiveShellApp.module_to_run', + autocall="InteractiveShell.autocall", + colors="InteractiveShell.colors", + theme="InteractiveShell.colors", + logfile="InteractiveShell.logfile", + logappend="InteractiveShell.logappend", + c="InteractiveShellApp.code_to_run", + m="InteractiveShellApp.module_to_run", ext="InteractiveShellApp.extra_extensions", gui='InteractiveShellApp.gui', pylab='InteractiveShellApp.pylab', @@ -98,6 +109,37 @@ ) shell_aliases['cache-size'] = 'InteractiveShell.cache_size' + +# ----------------------------------------------------------------------------- +# Traitlets +# ----------------------------------------------------------------------------- + + +class MatplotlibBackendCaselessStrEnum(CaselessStrEnum): + """An enum of Matplotlib backend strings where the case should be ignored. + + Prior to Matplotlib 3.9.0 the list of valid backends is hardcoded in + pylabtools.backends. After that, Matplotlib manages backends. + + The list of valid backends is determined when it is first needed to avoid + wasting unnecessary initialisation time. + """ + + def __init__( + self: CaselessStrEnum[Any], + default_value: Any = Undefined, + **kwargs: Any, + ) -> None: + super().__init__(None, default_value=default_value, **kwargs) + + def __getattribute__(self, name): + if name == "values" and object.__getattribute__(self, name) is None: + from IPython.core.pylabtools import _list_matplotlib_backends_and_gui_loops + + self.values = _list_matplotlib_backends_and_gui_loops() + return object.__getattribute__(self, name) + + #----------------------------------------------------------------------------- # Main classes and functions #----------------------------------------------------------------------------- @@ -137,7 +179,7 @@ class InteractiveShellApp(Configurable): ).tag(config=True) # Extensions that are always loaded (not configurable) - default_extensions = List(Unicode(), [u'storemagic']).tag(config=False) + default_extensions = List(Unicode(), ['storemagic']).tag(config=False) hide_initial_ns = Bool(True, help="""Should variables loaded at startup (by startup files, exec_lines, etc.) @@ -157,30 +199,33 @@ class InteractiveShellApp(Configurable): exec_lines = List(Unicode(), help="""lines of code to run at IPython startup.""" ).tag(config=True) - code_to_run = Unicode('', - help="Execute the given command string." - ).tag(config=True) - module_to_run = Unicode('', - help="Run the module as a script." - ).tag(config=True) - gui = CaselessStrEnum(gui_keys, allow_none=True, - help="Enable GUI event loop integration with any of {0}.".format(gui_keys) + code_to_run = Unicode("", help="Execute the given command string.").tag(config=True) + module_to_run = Unicode("", help="Run the module as a script.").tag(config=True) + gui = CaselessStrEnum( + gui_keys, + allow_none=True, + help=f"Enable GUI event loop integration with any of {gui_keys}.", ).tag(config=True) - matplotlib = CaselessStrEnum(backend_keys, allow_none=True, + matplotlib = MatplotlibBackendCaselessStrEnum( + allow_none=True, help="""Configure matplotlib for interactive use with - the default matplotlib backend.""" + the default matplotlib backend. The exact options available + depend on what Matplotlib provides at runtime.""", ).tag(config=True) - pylab = CaselessStrEnum(backend_keys, allow_none=True, + pylab = MatplotlibBackendCaselessStrEnum( + allow_none=True, help="""Pre-load matplotlib and numpy for interactive use, selecting a particular matplotlib backend and loop integration. - """ + The exact options available depend on what Matplotlib provides at runtime. + """, ).tag(config=True) - pylab_import_all = Bool(True, + pylab_import_all = Bool( + True, help="""If true, IPython will populate the user namespace with numpy, pylab, etc. and an ``import *`` is done from numpy and pylab, when using pylab mode. When False, pylab mode should not import any names into the user namespace. - """ + """, ).tag(config=True) ignore_cwd = Bool( False, @@ -203,6 +248,8 @@ def _user_ns_changed(self, change): def init_path(self): """Add current working directory, '', to sys.path + Unless disabled by ignore_cwd config or sys.flags.safe_path. + Unlike Python's default, we insert before the first `site-packages` or `dist-packages` directory, so that it is after the standard library. @@ -211,8 +258,10 @@ def init_path(self): Try to insert after the standard library, instead of first. .. versionchanged:: 8.0 Allow optionally not including the current directory in sys.path + .. versionchanged:: 9.7 + Respect sys.flags.safe_path (PYTHONSAFEPATH and -P flag) """ - if '' in sys.path or self.ignore_cwd: + if "" in sys.path or self.ignore_cwd or sys.flags.safe_path: return for idx, path in enumerate(sys.path): parent, last_part = os.path.split(path) @@ -279,9 +328,9 @@ def init_extensions(self): ) for ext in extensions: try: - self.log.info("Loading IPython extension: %s" % ext) + self.log.info("Loading IPython extension: %s", ext) self.shell.extension_manager.load_extension(ext) - except: + except Exception: if self.reraise_ipython_extension_failures: raise msg = ("Error in loading extension: {ext}\n" @@ -290,7 +339,7 @@ def init_extensions(self): location=self.profile_dir.location )) self.log.warning(msg, exc_info=True) - except: + except Exception: if self.reraise_ipython_extension_failures: raise self.log.warning("Unknown error in loading extensions:", exc_info=True) @@ -326,18 +375,18 @@ def _run_exec_lines(self): self.log.info("Running code in user namespace: %s" % line) self.shell.run_cell(line, store_history=False) - except: + except Exception: self.log.warning("Error in executing line in user " "namespace: %s" % line) self.shell.showtraceback() - except: + except Exception: self.log.warning("Unknown error in handling IPythonApp.exec_lines:") self.shell.showtraceback() def _exec_file(self, fname, shell_futures=False): try: - full_filename = filefind(fname, [u'.', self.ipython_dir]) - except IOError: + full_filename = filefind(fname, ['.', self.ipython_dir]) + except OSError: self.log.warning("File not found: %r"%fname) return # Make sure that the running script gets a proper sys.argv as if it @@ -377,7 +426,7 @@ def _run_startup_files(self): self.log.debug("Running PYTHONSTARTUP file %s...", python_startup) try: self._exec_file(python_startup) - except: + except Exception: self.log.warning("Unknown error in handling PYTHONSTARTUP file %s:", python_startup) self.shell.showtraceback() for startup_dir in startup_dirs[::-1]: @@ -390,7 +439,7 @@ def _run_startup_files(self): try: for fname in sorted(startup_files): self._exec_file(fname) - except: + except Exception: self.log.warning("Unknown error in handling startup files:") self.shell.showtraceback() @@ -403,7 +452,7 @@ def _run_exec_files(self): try: for fname in self.exec_files: self._exec_file(fname) - except: + except Exception: self.log.warning("Unknown error in handling IPythonApp.exec_files:") self.shell.showtraceback() @@ -415,7 +464,7 @@ def _run_cmd_line_code(self): self.log.info("Running code given at command line (c=): %s" % line) self.shell.run_cell(line, store_history=False) - except: + except Exception: self.log.warning("Error in executing line in user namespace: %s" % line) self.shell.showtraceback() @@ -433,7 +482,7 @@ def _run_cmd_line_code(self): self.exit(2) try: self._exec_file(fname, shell_futures=True) - except: + except Exception: self.shell.showtraceback(tb_offset=4) if not self.interact: self.exit(1) diff --git a/IPython/core/splitinput.py b/IPython/core/splitinput.py index 63cdce79558..0fd18483438 100644 --- a/IPython/core/splitinput.py +++ b/IPython/core/splitinput.py @@ -1,34 +1,22 @@ -# encoding: utf-8 """ Simple utility for splitting user input. This is used by both inputsplitter and prefilter. - -Authors: - -* Brian Granger -* Fernando Perez """ -#----------------------------------------------------------------------------- -# Copyright (C) 2008-2011 The IPython Development Team -# -# Distributed under the terms of the BSD License. The full license is in -# the file COPYING, distributed as part of this software. -#----------------------------------------------------------------------------- - -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Imports -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- import re -import sys +import warnings +from typing import TYPE_CHECKING -from IPython.utils import py3compat -from IPython.utils.encoding import get_stream_enc +if TYPE_CHECKING: + from IPython.core.oinspect import OInfo -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Main function -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # RegExp for splitting line contents into pre-char//first word-method//rest. # For clarity, each group in on one line. @@ -41,44 +29,47 @@ # ! and !! trigger if they are first char(s) *or* follow an indent # ? triggers as first or last char. -line_split = re.compile(r""" +line_split = re.compile( + r""" ^(\s*) # any leading space ([,;/%]|!!?|\?\??)? # escape character or characters \s*(%{0,2}[\w\.\*]*) # function/method, possibly with leading % # to correctly treat things like '?%magic' (.*?$|$) # rest of line - """, re.VERBOSE) + """, + re.VERBOSE, +) -def split_user_input(line, pattern=None): +def split_user_input( + line: str, pattern: re.Pattern[str] | None = None +) -> tuple[str, str, str, str]: """Split user input into initial whitespace, escape character, function part and the rest. """ - # We need to ensure that the rest of this routine deals only with unicode - encoding = get_stream_enc(sys.stdin, 'utf-8') - line = py3compat.cast_unicode(line, encoding) + assert isinstance(line, str) if pattern is None: pattern = line_split match = pattern.match(line) if not match: - # print "match failed for line '%s'" % line + # print("match failed for line '%s'" % line) try: - ifun, the_rest = line.split(None,1) + ifun, the_rest = line.split(None, 1) except ValueError: - # print "split failed for line '%s'" % line - ifun, the_rest = line, u'' - pre = re.match(r'^(\s*)(.*)',line).groups()[0] + # print("split failed for line '%s'" % line) + ifun, the_rest = line, "" + pre = re.match(r"^(\s*)(.*)", line).groups()[0] esc = "" else: pre, esc, ifun, the_rest = match.groups() - #print 'line:<%s>' % line # dbg - #print 'pre <%s> ifun <%s> rest <%s>' % (pre,ifun.strip(),the_rest) # dbg - return pre, esc or '', ifun.strip(), the_rest.lstrip() + # print('line:<%s>' % line) # dbg + # print('pre <%s> ifun <%s> rest <%s>' % (pre,ifun.strip(),the_rest)) # dbg + return pre, esc or "", ifun.strip(), the_rest -class LineInfo(object): +class LineInfo: """A single line of input and associated info. Includes the following as properties: @@ -106,19 +97,35 @@ class LineInfo(object): the_rest Everything else on the line. + + raw_the_rest + the_rest without whitespace stripped. """ - def __init__(self, line, continue_prompt=False): - self.line = line + + line: str + continue_prompt: bool + pre: str + esc: str + ifun: str + raw_the_rest: str + the_rest: str + pre_char: str + pre_whitespace: str + + def __init__(self, line: str, continue_prompt: bool = False) -> None: + assert isinstance(line, str) + self.line = line self.continue_prompt = continue_prompt - self.pre, self.esc, self.ifun, self.the_rest = split_user_input(line) + self.pre, self.esc, self.ifun, self.raw_the_rest = split_user_input(line) + self.the_rest = self.raw_the_rest.lstrip() - self.pre_char = self.pre.strip() + self.pre_char = self.pre.strip() if self.pre_char: - self.pre_whitespace = '' # No whitespace allowed before esc chars + self.pre_whitespace = "" # No whitespace allowed before esc chars else: self.pre_whitespace = self.pre - def ofind(self, ip): + def ofind(self, ip) -> "OInfo": """Do a full, attribute-walking lookup of the ifun in the various namespaces for the given IPython InteractiveShell instance. @@ -130,8 +137,20 @@ def ofind(self, ip): Does cache the results of the call, so can be called multiple times without worrying about *further* damaging state. + + .. deprecated:: 9.9 + Use ``shell._ofind(line_info.ifun)`` directly instead. """ + warnings.warn( + "LineInfo.ofind() is deprecated since IPython 9.9. " + "Use shell._ofind(line_info.ifun) directly instead.", + DeprecationWarning, + stacklevel=2, + ) return ip._ofind(self.ifun) - def __str__(self): - return "LineInfo [%s|%s|%s|%s]" %(self.pre, self.esc, self.ifun, self.the_rest) + def __str__(self) -> str: + return "LineInfo [{}|{}|{}|{}]".format(self.pre, self.esc, self.ifun, self.the_rest) + + def __repr__(self) -> str: + return "<" + str(self) + ">" diff --git a/IPython/core/tbtools.py b/IPython/core/tbtools.py new file mode 100644 index 00000000000..2b5eb220611 --- /dev/null +++ b/IPython/core/tbtools.py @@ -0,0 +1,583 @@ +from __future__ import annotations + +import functools +import sys +import types +import warnings +from types import TracebackType +from typing import TYPE_CHECKING, Any +from collections.abc import Callable + +from pygments.token import Token + +from IPython.core.getipython import get_ipython +from IPython.utils.PyColorize import Theme, TokenStream, theme_table + +if TYPE_CHECKING: + import stack_data + +_sentinel = object() +INDENT_SIZE = 8 + + +@functools.lru_cache(maxsize=128) +def count_lines_in_py_file(filename: str) -> int: + """ + Given a filename, returns the number of lines in the file + if it ends with the extension ".py". Otherwise, returns 0. + """ + if not filename.endswith(".py"): + return 0 + else: + try: + with open(filename) as file: + s = sum(1 for line in file) + except UnicodeError: + return 0 + return s + + +def get_line_number_of_frame(frame: types.FrameType) -> int: + """ + Given a frame object, returns the total number of lines in the file + containing the frame's code object, or the number of lines in the + frame's source code if the file is not available. + + Parameters + ---------- + frame : FrameType + The frame object whose line number is to be determined. + + Returns + ------- + int + The total number of lines in the file containing the frame's + code object, or the number of lines in the frame's source code + if the file is not available. + """ + filename = frame.f_code.co_filename + return count_lines_in_py_file(filename) + + +def _safe_string(value: Any, what: Any, func: Any = str) -> str: + # Copied from cpython/Lib/traceback.py + try: + return func(value) + except Exception: + return f"<{what} {func.__name__}() failed>" + + +def _format_traceback_lines( + lines: list[stack_data.Line | stack_data.core.LineGap], + theme: Theme, + has_colors: bool, + lvals_toks: list[TokenStream], +) -> TokenStream: + """ + Format tracebacks lines with pointing arrow, leading numbers, + this assumes the stack have been extracted using stackdata. + + + Parameters + ---------- + lines : list[Line | LineGap] + """ + import stack_data + + numbers_width = INDENT_SIZE - 1 + tokens: TokenStream = [] + + for stack_line in lines: + if isinstance(stack_line, stack_data.core.LineGap): + toks = [(Token.LinenoEm, " (...)")] + tokens.extend(toks) + continue + + lineno = stack_line.lineno + line = stack_line.render(pygmented=has_colors).rstrip("\n") + "\n" + if stack_line.is_current: + # This is the line with the error + pad = numbers_width - len(str(lineno)) + toks = [ + (Token.LinenoEm, theme.make_arrow(pad)), + (Token.LinenoEm, str(lineno)), + (Token, " "), + (Token, line), + ] + else: + num = "%*s" % (numbers_width, lineno) + toks = [ + (Token.LinenoEm, str(num)), + (Token, " "), + (Token, line), + ] + + tokens.extend(toks) + if lvals_toks and stack_line.is_current: + for lv in lvals_toks: + tokens.append((Token, " " * INDENT_SIZE)) + tokens.extend(lv) + tokens.append((Token, "\n")) + # strip the last newline + tokens = tokens[:-1] + + return tokens + + +# some internal-use functions +def text_repr(value: Any) -> str: + """Hopefully pretty robust repr equivalent.""" + # this is pretty horrible but should always return *something* + try: + import pydoc + + return pydoc.text.repr(value) + except KeyboardInterrupt: + raise + except Exception: + try: + return repr(value) + except KeyboardInterrupt: + raise + except Exception: + try: + # all still in an except block so we catch + # getattr raising + name = getattr(value, "__name__", None) + if name: + # ick, recursion + return text_repr(name) + klass = getattr(value, "__class__", None) + if klass: + return "%s instance" % text_repr(klass) + return "UNRECOVERABLE REPR FAILURE" + except KeyboardInterrupt: + raise + except Exception: + return "UNRECOVERABLE REPR FAILURE" + + +def eqrepr(value: Any, repr: Callable[[Any], str] = text_repr) -> str: + return "=%s" % repr(value) + + +def nullrepr(value: Any, repr: Callable[[Any], str] = text_repr) -> str: + return "" + + +def _tokens_filename( + em: bool, + file: str | None, + *, + lineno: int | None = None, +) -> TokenStream: + """ + Format filename lines with custom formatting from caching compiler or `File *.py` by default + + Parameters + ---------- + em: whether bold or not + file : str + """ + assert file is None or isinstance(file, str) + Normal = Token.NormalEm if em else Token.Normal + Filename = Token.FilenameEm if em else Token.Filename + ipinst = get_ipython() + if ( + ipinst is not None + and file is not None + and (data := ipinst.compile.format_code_name(file)) is not None + ): + label, name = data + if lineno is None: + return [ + (Normal, label), + (Normal, " "), + (Filename, name), + ] + else: + return [ + (Normal, label), + (Normal, " "), + (Filename, name), + (Filename, f", line {lineno}"), + ] + else: + file_str = file or "" + from IPython.utils import path as util_path + name = util_path.compress_user(file_str) + if lineno is None: + return [ + (Normal, "File "), + (Filename, name), + ] + else: + return [ + (Normal, "File "), + (Filename, f"{name}:{lineno}"), + ] + + +def _simple_format_traceback_lines( + lnum: int, + index: int, + lines: list[tuple[str, tuple[str, bool]]], + lvals_toks: list[TokenStream], + theme: Theme, +) -> TokenStream: + """ + Format tracebacks lines with pointing arrow, leading numbers + + This should be equivalent to _format_traceback_lines, but does not rely on stackdata + to format the lines + + This is due to the fact that stackdata may be slow on super long and complex files. + + Parameters + ========== + + lnum: int + number of the target line of code. + index: int + which line in the list should be highlighted. + lines: list[string] + lvals_toks: pairs of token type and str + Values of local variables, already colored, to inject just after the error line. + """ + for item in lvals_toks: + assert isinstance(item, list) + for subit in item: + assert isinstance(subit[1], str) + + numbers_width = INDENT_SIZE - 1 + res_toks: TokenStream = [] + for i, (line, (new_line, err)) in enumerate(lines, lnum - index): + if not err: + line = new_line + + colored_line = line + if i == lnum: + # This is the line with the error + pad = numbers_width - len(str(i)) + line_toks = [ + (Token.LinenoEm, theme.make_arrow(pad)), + (Token.LinenoEm, str(lnum)), + (Token, " "), + (Token, colored_line), + ] + else: + padding_num = "%*s" % (numbers_width, i) + + line_toks = [ + (Token.LinenoEm, padding_num), + (Token, " "), + (Token, colored_line), + ] + res_toks.extend(line_toks) + + if lvals_toks and i == lnum: + for lv in lvals_toks: + res_toks.extend(lv) + # res_toks.extend(lvals_toks) + return res_toks + + +class FrameInfo: + """ + Mirror of stack data's FrameInfo, but so that we can bypass highlighting on + really long frames. + """ + + description: str | None + filename: str | None + lineno: int + # number of context lines to use + context: int | None + raw_lines: list[str] + _sd: stack_data.core.FrameInfo | stack_data.core.RepeatedFrames | None + frame: Any + + @classmethod + def _from_stack_data_FrameInfo( + cls, frame_info: stack_data.core.FrameInfo | stack_data.core.RepeatedFrames + ) -> FrameInfo: + return cls( + getattr(frame_info, "description", None), + getattr(frame_info, "filename", None), # type: ignore[arg-type] + getattr(frame_info, "lineno", None), # type: ignore[arg-type] + getattr(frame_info, "frame", None), + getattr(frame_info, "code", None), + sd=frame_info, + context=None, + ) + + def __init__( + self, + description: str | None, + filename: str, + lineno: int, + frame: Any, + code: types.CodeType | None, + *, + sd: Any = None, + context: int | None = None, + ): + assert isinstance(lineno, (int, type(None))), lineno + self.description = description + self.filename = filename + self.lineno = lineno + self.frame = frame + self.code = code + self._sd = sd + self.context = context + + # self.lines = [] + if sd is None: + try: + # return a list of source lines and a starting line number + import inspect + self.raw_lines = inspect.getsourcelines(frame)[0] + except OSError: + self.raw_lines = [ + "'Could not get source, probably due dynamically evaluated source code.'" + ] + + @property + def variables_in_executing_piece(self) -> list[Any]: + # callers only reach here once RepeatedFrames-backed instances have + # been filtered out (see doctb.py/ultratb.py format_record) + if self._sd is not None: + return self._sd.variables_in_executing_piece # type:ignore[misc,union-attr] + else: + return [] + + @property + def lines(self) -> list[Any]: + from executing.executing import NotOneValueFound + + # callers only reach here once RepeatedFrames-backed instances have + # been filtered out (see doctb.py/ultratb.py format_record) + assert self._sd is not None + try: + return self._sd.lines # type: ignore[misc,union-attr] + except NotOneValueFound: + + class Dummy: + lineno = 0 + is_current = False + + def render(self, *, pygmented: bool) -> str: + return "" + + return [Dummy()] + + @property + def executing(self) -> Any: + # callers only reach here once RepeatedFrames-backed instances have + # been filtered out (see doctb.py/ultratb.py format_record) + if self._sd is not None: + return self._sd.executing # type: ignore[union-attr] + else: + return None + + +class TBTools: + """Basic tools used by all traceback printer classes.""" + + # Number of frames to skip when reporting tracebacks + tb_offset = 0 + _theme_name: str + _old_theme_name: str + call_pdb: bool + ostream: Any + _debugger_cls: Any + pdb: Any + + def __init__( + self, + color_scheme: Any = _sentinel, + call_pdb: bool = False, + ostream: Any = None, + *, + debugger_cls: type | None = None, + theme_name: str = "nocolor", + ): + if color_scheme is not _sentinel: + assert isinstance(color_scheme, str), color_scheme + warnings.warn( + "color_scheme is deprecated since IPython 9.0, use theme_name instead, all lowercase", + DeprecationWarning, + stacklevel=2, + ) + theme_name = color_scheme + if theme_name in ["Linux", "LightBG", "Neutral", "NoColor"]: + warnings.warn( + f"Theme names and color schemes are lowercase in IPython 9.0 use {theme_name.lower()} instead", + DeprecationWarning, + stacklevel=2, + ) + theme_name = theme_name.lower() + # Whether to call the interactive pdb debugger after printing + # tracebacks or not + super().__init__() + self.call_pdb = call_pdb + + # Output stream to write to. Note that we store the original value in + # a private attribute and then make the public ostream a property, so + # that we can delay accessing sys.stdout until runtime. The way + # things are written now, the sys.stdout object is dynamically managed + # so a reference to it should NEVER be stored statically. This + # property approach confines this detail to a single location, and all + # subclasses can simply access self.ostream for writing. + self._ostream = ostream + + # Create color table + self.set_theme_name(theme_name) + self._debugger_cls = debugger_cls + + if call_pdb: + self.pdb = self.debugger_cls() + else: + self.pdb = None + + def _get_ostream(self) -> Any: + """Output stream that exceptions are written to. + + Valid values are: + + - None: the default, which means that IPython will dynamically resolve + to sys.stdout. This ensures compatibility with most tools, including + Windows (where plain stdout doesn't recognize ANSI escapes). + + - Any object with 'write' and 'flush' attributes. + """ + return sys.stdout if self._ostream is None else self._ostream + + def _set_ostream(self, val) -> None: # type:ignore[no-untyped-def] + assert val is None or (hasattr(val, "write") and hasattr(val, "flush")) + self._ostream = val + + ostream = property(_get_ostream, _set_ostream) + + def _get_debugger_cls(self) -> Any: + if self._debugger_cls is None: + # Deferred: pdb (and everything it drags in) is only imported + # the first time a debugger class is actually needed, rather + # than on every IPython startup. Prefer the running shell's + # own choice (e.g. the terminal's TerminalPdb) if there is one. + ip = get_ipython() + if ip is not None: + self._debugger_cls = ip.debugger_cls + else: + from IPython.core import debugger + + self._debugger_cls = debugger.Pdb + return self._debugger_cls + + def _set_debugger_cls(self, val) -> None: # type:ignore[no-untyped-def] + self._debugger_cls = val + + debugger_cls = property(_get_debugger_cls, _set_debugger_cls) + + @staticmethod + def _get_chained_exception(exception_value: Any) -> Any: + cause = getattr(exception_value, "__cause__", None) + if cause: + return cause + if getattr(exception_value, "__suppress_context__", False): + return None + return getattr(exception_value, "__context__", None) + + def get_parts_of_chained_exception( + self, evalue: BaseException | None + ) -> tuple[type, BaseException, TracebackType] | None: + chained_evalue = self._get_chained_exception(evalue) + + if chained_evalue: + return ( + chained_evalue.__class__, + chained_evalue, + chained_evalue.__traceback__, + ) + return None + + def prepare_chained_exception_message( + self, cause: BaseException | None + ) -> list[list[str]]: + direct_cause = ( + "\nThe above exception was the direct cause of the following exception:\n" + ) + exception_during_handling = ( + "\nDuring handling of the above exception, another exception occurred:\n" + ) + + if cause: + message = [[direct_cause]] + else: + message = [[exception_during_handling]] + return message + + @property + def has_colors(self) -> bool: + assert self._theme_name == self._theme_name.lower() + return self._theme_name != "nocolor" + + def set_theme_name(self, name: str) -> None: + assert name in theme_table + assert name.lower() == name + self._theme_name = name + # Also set colors of debugger + if hasattr(self, "pdb") and self.pdb is not None: + self.pdb.set_theme_name(name) + + def set_colors(self, name: str) -> None: + """Shorthand access to the color table scheme selector method.""" + + # todo emit deprecation + warnings.warn( + "set_colors is deprecated since IPython 9.0, use set_theme_name instead", + DeprecationWarning, + stacklevel=2, + ) + self.set_theme_name(name) + + def color_toggle(self) -> None: + """Toggle between the currently active color scheme and nocolor.""" + if self._theme_name == "nocolor": + self._theme_name = self._old_theme_name + else: + self._old_theme_name = self._theme_name + self._theme_name = "nocolor" + + def stb2text(self, stb: list[str]) -> str: + """Convert a structured traceback (a list) to a string.""" + return "\n".join(stb) + + def text( + self, + etype: type, + value: BaseException | None, + tb: TracebackType | None, + tb_offset: int | None = None, + context: int = 5, + ) -> str: + """Return formatted traceback. + + Subclasses may override this if they add extra arguments. + """ + tb_list = self.structured_traceback(etype, value, tb, tb_offset, context) + return self.stb2text(tb_list) + + def structured_traceback( + self, + etype: type, + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: + """Return a list of traceback frames. + + Must be implemented by each class. + """ + raise NotImplementedError() diff --git a/IPython/core/tests/test_application.py b/IPython/core/tests/test_application.py deleted file mode 100644 index 827a1e36d8e..00000000000 --- a/IPython/core/tests/test_application.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Tests for IPython.core.application""" - -import os -import tempfile - -from tempfile import TemporaryDirectory -from traitlets import Unicode - -from IPython.core.application import BaseIPythonApplication -from IPython.testing import decorators as dec - - -@dec.onlyif_unicode_paths -def test_unicode_cwd(): - """Check that IPython starts with non-ascii characters in the path.""" - wd = tempfile.mkdtemp(suffix=u"€") - - old_wd = os.getcwd() - os.chdir(wd) - #raise Exception(repr(os.getcwd())) - try: - app = BaseIPythonApplication() - # The lines below are copied from Application.initialize() - app.init_profile_dir() - app.init_config_files() - app.load_config_file(suppress_errors=False) - finally: - os.chdir(old_wd) - -@dec.onlyif_unicode_paths -def test_unicode_ipdir(): - """Check that IPython starts with non-ascii characters in the IP dir.""" - ipdir = tempfile.mkdtemp(suffix=u"€") - - # Create the config file, so it tries to load it. - with open(os.path.join(ipdir, "ipython_config.py"), "w", encoding="utf-8") as f: - pass - - old_ipdir1 = os.environ.pop("IPYTHONDIR", None) - old_ipdir2 = os.environ.pop("IPYTHON_DIR", None) - os.environ["IPYTHONDIR"] = ipdir - try: - app = BaseIPythonApplication() - # The lines below are copied from Application.initialize() - app.init_profile_dir() - app.init_config_files() - app.load_config_file(suppress_errors=False) - finally: - if old_ipdir1: - os.environ["IPYTHONDIR"] = old_ipdir1 - if old_ipdir2: - os.environ["IPYTHONDIR"] = old_ipdir2 - -def test_cli_priority(): - with TemporaryDirectory() as td: - - class TestApp(BaseIPythonApplication): - test = Unicode().tag(config=True) - - # Create the config file, so it tries to load it. - with open(os.path.join(td, "ipython_config.py"), "w", encoding="utf-8") as f: - f.write("c.TestApp.test = 'config file'") - - app = TestApp() - app.initialize(["--profile-dir", td]) - assert app.test == "config file" - app = TestApp() - app.initialize(["--profile-dir", td, "--TestApp.test=cli"]) - assert app.test == "cli" diff --git a/IPython/core/tests/test_async_helpers.py b/IPython/core/tests/test_async_helpers.py deleted file mode 100644 index 40a840c5b16..00000000000 --- a/IPython/core/tests/test_async_helpers.py +++ /dev/null @@ -1,316 +0,0 @@ -""" -Test for async helpers. - -Should only trigger on python 3.5+ or will have syntax errors. -""" -import platform -from itertools import chain, repeat -from textwrap import dedent, indent -from unittest import TestCase -from IPython.testing.decorators import skip_without -import sys -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from IPython import get_ipython - - ip = get_ipython() - - -iprc = lambda x: ip.run_cell(dedent(x)).raise_error() -iprc_nr = lambda x: ip.run_cell(dedent(x)) - -from IPython.core.async_helpers import _should_be_async - -class AsyncTest(TestCase): - def test_should_be_async(self): - self.assertFalse(_should_be_async("False")) - self.assertTrue(_should_be_async("await bar()")) - self.assertTrue(_should_be_async("x = await bar()")) - self.assertFalse( - _should_be_async( - dedent( - """ - async def awaitable(): - pass - """ - ) - ) - ) - - def _get_top_level_cases(self): - # These are test cases that should be valid in a function - # but invalid outside of a function. - test_cases = [] - test_cases.append(('basic', "{val}")) - - # Note, in all conditional cases, I use True instead of - # False so that the peephole optimizer won't optimize away - # the return, so CPython will see this as a syntax error: - # - # while True: - # break - # return - # - # But not this: - # - # while False: - # return - # - # See https://bugs.python.org/issue1875 - - test_cases.append(('if', dedent(""" - if True: - {val} - """))) - - test_cases.append(('while', dedent(""" - while True: - {val} - break - """))) - - test_cases.append(('try', dedent(""" - try: - {val} - except: - pass - """))) - - test_cases.append(('except', dedent(""" - try: - pass - except: - {val} - """))) - - test_cases.append(('finally', dedent(""" - try: - pass - except: - pass - finally: - {val} - """))) - - test_cases.append(('for', dedent(""" - for _ in range(4): - {val} - """))) - - - test_cases.append(('nested', dedent(""" - if True: - while True: - {val} - break - """))) - - test_cases.append(('deep-nested', dedent(""" - if True: - while True: - break - for x in range(3): - if True: - while True: - for x in range(3): - {val} - """))) - - return test_cases - - def _get_ry_syntax_errors(self): - # This is a mix of tests that should be a syntax error if - # return or yield whether or not they are in a function - - test_cases = [] - - test_cases.append(('class', dedent(""" - class V: - {val} - """))) - - test_cases.append(('nested-class', dedent(""" - class V: - class C: - {val} - """))) - - return test_cases - - - def test_top_level_return_error(self): - tl_err_test_cases = self._get_top_level_cases() - tl_err_test_cases.extend(self._get_ry_syntax_errors()) - - vals = ('return', 'yield', 'yield from (_ for _ in range(3))', - dedent(''' - def f(): - pass - return - '''), - ) - - for test_name, test_case in tl_err_test_cases: - # This example should work if 'pass' is used as the value - with self.subTest((test_name, 'pass')): - iprc(test_case.format(val='pass')) - - # It should fail with all the values - for val in vals: - with self.subTest((test_name, val)): - msg = "Syntax error not raised for %s, %s" % (test_name, val) - with self.assertRaises(SyntaxError, msg=msg): - iprc(test_case.format(val=val)) - - def test_in_func_no_error(self): - # Test that the implementation of top-level return/yield - # detection isn't *too* aggressive, and works inside a function - func_contexts = [] - - func_contexts.append(('func', False, dedent(""" - def f():"""))) - - func_contexts.append(('method', False, dedent(""" - class MyClass: - def __init__(self): - """))) - - func_contexts.append(('async-func', True, dedent(""" - async def f():"""))) - - func_contexts.append(('async-method', True, dedent(""" - class MyClass: - async def f(self):"""))) - - func_contexts.append(('closure', False, dedent(""" - def f(): - def g(): - """))) - - def nest_case(context, case): - # Detect indentation - lines = context.strip().splitlines() - prefix_len = 0 - for c in lines[-1]: - if c != ' ': - break - prefix_len += 1 - - indented_case = indent(case, ' ' * (prefix_len + 4)) - return context + '\n' + indented_case - - # Gather and run the tests - - # yield is allowed in async functions, starting in Python 3.6, - # and yield from is not allowed in any version - vals = ('return', 'yield', 'yield from (_ for _ in range(3))') - - success_tests = zip(self._get_top_level_cases(), repeat(False)) - failure_tests = zip(self._get_ry_syntax_errors(), repeat(True)) - - tests = chain(success_tests, failure_tests) - - for context_name, async_func, context in func_contexts: - for (test_name, test_case), should_fail in tests: - nested_case = nest_case(context, test_case) - - for val in vals: - test_id = (context_name, test_name, val) - cell = nested_case.format(val=val) - - with self.subTest(test_id): - if should_fail: - msg = ("SyntaxError not raised for %s" % - str(test_id)) - with self.assertRaises(SyntaxError, msg=msg): - iprc(cell) - - print(cell) - else: - iprc(cell) - - def test_nonlocal(self): - # fails if outer scope is not a function scope or if var not defined - with self.assertRaises(SyntaxError): - iprc("nonlocal x") - iprc(""" - x = 1 - def f(): - nonlocal x - x = 10000 - yield x - """) - iprc(""" - def f(): - def g(): - nonlocal x - x = 10000 - yield x - """) - - # works if outer scope is a function scope and var exists - iprc(""" - def f(): - x = 20 - def g(): - nonlocal x - x = 10000 - yield x - """) - - - def test_execute(self): - iprc(""" - import asyncio - await asyncio.sleep(0.001) - """ - ) - - def test_autoawait(self): - iprc("%autoawait False") - iprc("%autoawait True") - iprc(""" - from asyncio import sleep - await sleep(0.1) - """ - ) - - if sys.version_info < (3, 9) and platform.python_implementation() != "PyPy": - # new pgen parser in 3.9 does not raise MemoryError on too many nested - # parens anymore - def test_memory_error(self): - with self.assertRaises(MemoryError): - iprc("(" * 200 + ")" * 200) - - @skip_without('curio') - def test_autoawait_curio(self): - iprc("%autoawait curio") - - @skip_without('trio') - def test_autoawait_trio(self): - iprc("%autoawait trio") - - @skip_without('trio') - def test_autoawait_trio_wrong_sleep(self): - iprc("%autoawait trio") - res = iprc_nr(""" - import asyncio - await asyncio.sleep(0) - """) - with self.assertRaises(TypeError): - res.raise_error() - - @skip_without('trio') - def test_autoawait_asyncio_wrong_sleep(self): - iprc("%autoawait asyncio") - res = iprc_nr(""" - import trio - await trio.sleep(0) - """) - with self.assertRaises(RuntimeError): - res.raise_error() - - - def tearDown(self): - ip.loop_runner = "asyncio" diff --git a/IPython/core/tests/test_autocall.py b/IPython/core/tests/test_autocall.py deleted file mode 100644 index ded9f78858a..00000000000 --- a/IPython/core/tests/test_autocall.py +++ /dev/null @@ -1,66 +0,0 @@ -"""These kinds of tests are less than ideal, but at least they run. - -This was an old test that was being run interactively in the top-level tests/ -directory, which we are removing. For now putting this here ensures at least -we do run the test, though ultimately this functionality should all be tested -with better-isolated tests that don't rely on the global instance in iptest. -""" -from IPython.core.splitinput import LineInfo -from IPython.core.prefilter import AutocallChecker - -def doctest_autocall(): - """ - In [1]: def f1(a,b,c): - ...: return a+b+c - ...: - - In [2]: def f2(a): - ...: return a + a - ...: - - In [3]: def r(x): - ...: return True - ...: - - In [4]: ;f2 a b c - Out[4]: 'a b ca b c' - - In [5]: assert _ == "a b ca b c" - - In [6]: ,f1 a b c - Out[6]: 'abc' - - In [7]: assert _ == 'abc' - - In [8]: print(_) - abc - - In [9]: /f1 1,2,3 - Out[9]: 6 - - In [10]: assert _ == 6 - - In [11]: /f2 4 - Out[11]: 8 - - In [12]: assert _ == 8 - - In [12]: del f1, f2 - - In [13]: ,r a - Out[13]: True - - In [14]: assert _ == True - - In [15]: r'a' - Out[15]: 'a' - - In [16]: assert _ == 'a' - """ - - -def test_autocall_should_ignore_raw_strings(): - line_info = LineInfo("r'a'") - pm = ip.prefilter_manager - ac = AutocallChecker(shell=pm.shell, prefilter_manager=pm, config=pm.config) - assert ac.check(line_info) is None diff --git a/IPython/core/tests/test_compilerop.py b/IPython/core/tests/test_compilerop.py deleted file mode 100644 index b939bb60676..00000000000 --- a/IPython/core/tests/test_compilerop.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Tests for the compilerop module. -""" -#----------------------------------------------------------------------------- -# Copyright (C) 2010-2011 The IPython Development Team. -# -# Distributed under the terms of the BSD License. -# -# The full license is in the file COPYING.txt, distributed with this software. -#----------------------------------------------------------------------------- - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -# Stdlib imports -import linecache -import sys - -# Third-party imports -import pytest - -# Our own imports -from IPython.core import compilerop - -#----------------------------------------------------------------------------- -# Test functions -#----------------------------------------------------------------------------- - -def test_code_name(): - code = 'x=1' - name = compilerop.code_name(code) - assert name.startswith(" ncache - -def test_proper_default_encoding(): - # Check we're in a proper Python 2 environment (some imports, such - # as GTK, can change the default encoding, which can hide bugs.) - assert sys.getdefaultencoding() == "utf-8" - -def test_cache_unicode(): - cp = compilerop.CachingCompiler() - ncache = len(linecache.cache) - cp.cache(u"t = 'žćčšđ'") - assert len(linecache.cache) > ncache - -def test_compiler_check_cache(): - """Test the compiler properly manages the cache. - """ - # Rather simple-minded tests that just exercise the API - cp = compilerop.CachingCompiler() - cp.cache('x=1', 99) - # Ensure now that after clearing the cache, our entries survive - linecache.checkcache() - assert any( - k.startswith(" 131808: - size, start, stop, prct = recompute_unicode_ranges() - message = f"""_UNICODE_RANGES likely wrong and need updating. This is - likely due to a new release of Python. We've find that the biggest gap - in unicode characters has reduces in size to be {size} characters - ({prct}), from {start}, to {stop}. In completer.py likely update to - - _UNICODE_RANGES = [(32, {start}), ({stop}, 0xe01f0)] - - And update the assertion below to use - - len_exp <= {len_exp} - """ - assert len_exp == len_test, message - - # fail if new unicode symbols have been added. - assert len_exp <= 138552, message - - -@contextmanager -def greedy_completion(): - ip = get_ipython() - greedy_original = ip.Completer.greedy - try: - ip.Completer.greedy = True - yield - finally: - ip.Completer.greedy = greedy_original - - -def test_protect_filename(): - if sys.platform == "win32": - pairs = [ - ("abc", "abc"), - (" abc", '" abc"'), - ("a bc", '"a bc"'), - ("a bc", '"a bc"'), - (" bc", '" bc"'), - ] - else: - pairs = [ - ("abc", "abc"), - (" abc", r"\ abc"), - ("a bc", r"a\ bc"), - ("a bc", r"a\ \ bc"), - (" bc", r"\ \ bc"), - # On posix, we also protect parens and other special characters. - ("a(bc", r"a$bc"), - ("a)bc", r"a$bc"), - ("a( )bc", r"a$\ $bc"), - ("a[1]bc", r"a\[1\]bc"), - ("a{1}bc", r"a\{1\}bc"), - ("a#bc", r"a\#bc"), - ("a?bc", r"a\?bc"), - ("a=bc", r"a\=bc"), - ("a\\bc", r"a\\bc"), - ("a|bc", r"a\|bc"), - ("a;bc", r"a\;bc"), - ("a:bc", r"a\:bc"), - ("a'bc", r"a\'bc"), - ("a*bc", r"a\*bc"), - ('a"bc', r"a\"bc"), - ("a^bc", r"a\^bc"), - ("a&bc", r"a\&bc"), - ] - # run the actual tests - for s1, s2 in pairs: - s1p = completer.protect_filename(s1) - assert s1p == s2 - - -def check_line_split(splitter, test_specs): - for part1, part2, split in test_specs: - cursor_pos = len(part1) - line = part1 + part2 - out = splitter.split_line(line, cursor_pos) - assert out == split - - -def test_line_split(): - """Basic line splitter test with default specs.""" - sp = completer.CompletionSplitter() - # The format of the test specs is: part1, part2, expected answer. Parts 1 - # and 2 are joined into the 'line' sent to the splitter, as if the cursor - # was at the end of part1. So an empty part2 represents someone hitting - # tab at the end of the line, the most common case. - t = [ - ("run some/scrip", "", "some/scrip"), - ("run scripts/er", "ror.py foo", "scripts/er"), - ("echo $HOM", "", "HOM"), - ("print sys.pa", "", "sys.pa"), - ("print(sys.pa", "", "sys.pa"), - ("execfile('scripts/er", "", "scripts/er"), - ("a[x.", "", "x."), - ("a[x.", "y", "x."), - ('cd "some_file/', "", "some_file/"), - ] - check_line_split(sp, t) - # Ensure splitting works OK with unicode by re-running the tests with - # all inputs turned into unicode - check_line_split(sp, [map(str, p) for p in t]) - - -class NamedInstanceClass: - instances = {} - - def __init__(self, name): - self.instances[name] = self - - @classmethod - def _ipython_key_completions_(cls): - return cls.instances.keys() - - -class KeyCompletable: - def __init__(self, things=()): - self.things = things - - def _ipython_key_completions_(self): - return list(self.things) - - -class TestCompleter(unittest.TestCase): - def setUp(self): - """ - We want to silence all PendingDeprecationWarning when testing the completer - """ - self._assertwarns = self.assertWarns(PendingDeprecationWarning) - self._assertwarns.__enter__() - - def tearDown(self): - try: - self._assertwarns.__exit__(None, None, None) - except AssertionError: - pass - - def test_custom_completion_error(self): - """Test that errors from custom attribute completers are silenced.""" - ip = get_ipython() - - class A: - pass - - ip.user_ns["x"] = A() - - @complete_object.register(A) - def complete_A(a, existing_completions): - raise TypeError("this should be silenced") - - ip.complete("x.") - - def test_custom_completion_ordering(self): - """Test that errors from custom attribute completers are silenced.""" - ip = get_ipython() - - _, matches = ip.complete('in') - assert matches.index('input') < matches.index('int') - - def complete_example(a): - return ['example2', 'example1'] - - ip.Completer.custom_completers.add_re('ex*', complete_example) - _, matches = ip.complete('ex') - assert matches.index('example2') < matches.index('example1') - - def test_unicode_completions(self): - ip = get_ipython() - # Some strings that trigger different types of completion. Check them both - # in str and unicode forms - s = ["ru", "%ru", "cd /", "floa", "float(x)/"] - for t in s + list(map(str, s)): - # We don't need to check exact completion values (they may change - # depending on the state of the namespace, but at least no exceptions - # should be thrown and the return value should be a pair of text, list - # values. - text, matches = ip.complete(t) - self.assertIsInstance(text, str) - self.assertIsInstance(matches, list) - - def test_latex_completions(self): - from IPython.core.latex_symbols import latex_symbols - import random - - ip = get_ipython() - # Test some random unicode symbols - keys = random.sample(sorted(latex_symbols), 10) - for k in keys: - text, matches = ip.complete(k) - self.assertEqual(text, k) - self.assertEqual(matches, [latex_symbols[k]]) - # Test a more complex line - text, matches = ip.complete("print(\\alpha") - self.assertEqual(text, "\\alpha") - self.assertEqual(matches[0], latex_symbols["\\alpha"]) - # Test multiple matching latex symbols - text, matches = ip.complete("\\al") - self.assertIn("\\alpha", matches) - self.assertIn("\\aleph", matches) - - def test_latex_no_results(self): - """ - forward latex should really return nothing in either field if nothing is found. - """ - ip = get_ipython() - text, matches = ip.Completer.latex_matches("\\really_i_should_match_nothing") - self.assertEqual(text, "") - self.assertEqual(matches, ()) - - def test_back_latex_completion(self): - ip = get_ipython() - - # do not return more than 1 matches for \beta, only the latex one. - name, matches = ip.complete("\\β") - self.assertEqual(matches, ["\\beta"]) - - def test_back_unicode_completion(self): - ip = get_ipython() - - name, matches = ip.complete("\\Ⅴ") - self.assertEqual(matches, ("\\ROMAN NUMERAL FIVE",)) - - def test_forward_unicode_completion(self): - ip = get_ipython() - - name, matches = ip.complete("\\ROMAN NUMERAL FIVE") - self.assertEqual(matches, ["Ⅴ"]) # This is not a V - self.assertEqual(matches, ["\u2164"]) # same as above but explicit. - - def test_delim_setting(self): - sp = completer.CompletionSplitter() - sp.delims = " " - self.assertEqual(sp.delims, " ") - self.assertEqual(sp._delim_expr, r"[\ ]") - - def test_spaces(self): - """Test with only spaces as split chars.""" - sp = completer.CompletionSplitter() - sp.delims = " " - t = [("foo", "", "foo"), ("run foo", "", "foo"), ("run foo", "bar", "foo")] - check_line_split(sp, t) - - def test_has_open_quotes1(self): - for s in ["'", "'''", "'hi' '"]: - self.assertEqual(completer.has_open_quotes(s), "'") - - def test_has_open_quotes2(self): - for s in ['"', '"""', '"hi" "']: - self.assertEqual(completer.has_open_quotes(s), '"') - - def test_has_open_quotes3(self): - for s in ["''", "''' '''", "'hi' 'ipython'"]: - self.assertFalse(completer.has_open_quotes(s)) - - def test_has_open_quotes4(self): - for s in ['""', '""" """', '"hi" "ipython"']: - self.assertFalse(completer.has_open_quotes(s)) - - @pytest.mark.xfail( - sys.platform == "win32", reason="abspath completions fail on Windows" - ) - def test_abspath_file_completions(self): - ip = get_ipython() - with TemporaryDirectory() as tmpdir: - prefix = os.path.join(tmpdir, "foo") - suffixes = ["1", "2"] - names = [prefix + s for s in suffixes] - for n in names: - open(n, "w", encoding="utf-8").close() - - # Check simple completion - c = ip.complete(prefix)[1] - self.assertEqual(c, names) - - # Now check with a function call - cmd = 'a = f("%s' % prefix - c = ip.complete(prefix, cmd)[1] - comp = [prefix + s for s in suffixes] - self.assertEqual(c, comp) - - def test_local_file_completions(self): - ip = get_ipython() - with TemporaryWorkingDirectory(): - prefix = "./foo" - suffixes = ["1", "2"] - names = [prefix + s for s in suffixes] - for n in names: - open(n, "w", encoding="utf-8").close() - - # Check simple completion - c = ip.complete(prefix)[1] - self.assertEqual(c, names) - - # Now check with a function call - cmd = 'a = f("%s' % prefix - c = ip.complete(prefix, cmd)[1] - comp = {prefix + s for s in suffixes} - self.assertTrue(comp.issubset(set(c))) - - def test_quoted_file_completions(self): - ip = get_ipython() - with TemporaryWorkingDirectory(): - name = "foo'bar" - open(name, "w", encoding="utf-8").close() - - # Don't escape Windows - escaped = name if sys.platform == "win32" else "foo\\'bar" - - # Single quote matches embedded single quote - text = "open('foo" - c = ip.Completer._complete( - cursor_line=0, cursor_pos=len(text), full_text=text - )[1] - self.assertEqual(c, [escaped]) - - # Double quote requires no escape - text = 'open("foo' - c = ip.Completer._complete( - cursor_line=0, cursor_pos=len(text), full_text=text - )[1] - self.assertEqual(c, [name]) - - # No quote requires an escape - text = "%ls foo" - c = ip.Completer._complete( - cursor_line=0, cursor_pos=len(text), full_text=text - )[1] - self.assertEqual(c, [escaped]) - - def test_all_completions_dups(self): - """ - Make sure the output of `IPCompleter.all_completions` does not have - duplicated prefixes. - """ - ip = get_ipython() - c = ip.Completer - ip.ex("class TestClass():\n\ta=1\n\ta1=2") - for jedi_status in [True, False]: - with provisionalcompleter(): - ip.Completer.use_jedi = jedi_status - matches = c.all_completions("TestCl") - assert matches == ["TestClass"], (jedi_status, matches) - matches = c.all_completions("TestClass.") - assert len(matches) > 2, (jedi_status, matches) - matches = c.all_completions("TestClass.a") - assert matches == ['TestClass.a', 'TestClass.a1'], jedi_status - - def test_jedi(self): - """ - A couple of issue we had with Jedi - """ - ip = get_ipython() - - def _test_complete(reason, s, comp, start=None, end=None): - l = len(s) - start = start if start is not None else l - end = end if end is not None else l - with provisionalcompleter(): - ip.Completer.use_jedi = True - completions = set(ip.Completer.completions(s, l)) - ip.Completer.use_jedi = False - assert Completion(start, end, comp) in completions, reason - - def _test_not_complete(reason, s, comp): - l = len(s) - with provisionalcompleter(): - ip.Completer.use_jedi = True - completions = set(ip.Completer.completions(s, l)) - ip.Completer.use_jedi = False - assert Completion(l, l, comp) not in completions, reason - - import jedi - - jedi_version = tuple(int(i) for i in jedi.__version__.split(".")[:3]) - if jedi_version > (0, 10): - _test_complete("jedi >0.9 should complete and not crash", "a=1;a.", "real") - _test_complete("can infer first argument", 'a=(1,"foo");a[0].', "real") - _test_complete("can infer second argument", 'a=(1,"foo");a[1].', "capitalize") - _test_complete("cover duplicate completions", "im", "import", 0, 2) - - _test_not_complete("does not mix types", 'a=(1,"foo");a[0].', "capitalize") - - def test_completion_have_signature(self): - """ - Lets make sure jedi is capable of pulling out the signature of the function we are completing. - """ - ip = get_ipython() - with provisionalcompleter(): - ip.Completer.use_jedi = True - completions = ip.Completer.completions("ope", 3) - c = next(completions) # should be `open` - ip.Completer.use_jedi = False - assert "file" in c.signature, "Signature of function was not found by completer" - assert ( - "encoding" in c.signature - ), "Signature of function was not found by completer" - - @pytest.mark.xfail(reason="Known failure on jedi<=0.18.0") - def test_deduplicate_completions(self): - """ - Test that completions are correctly deduplicated (even if ranges are not the same) - """ - ip = get_ipython() - ip.ex( - textwrap.dedent( - """ - class Z: - zoo = 1 - """ - ) - ) - with provisionalcompleter(): - ip.Completer.use_jedi = True - l = list( - _deduplicate_completions("Z.z", ip.Completer.completions("Z.z", 3)) - ) - ip.Completer.use_jedi = False - - assert len(l) == 1, "Completions (Z.z) correctly deduplicate: %s " % l - assert l[0].text == "zoo" # and not `it.accumulate` - - def test_greedy_completions(self): - """ - Test the capability of the Greedy completer. - - Most of the test here does not really show off the greedy completer, for proof - each of the text below now pass with Jedi. The greedy completer is capable of more. - - See the :any:`test_dict_key_completion_contexts` - - """ - ip = get_ipython() - ip.ex("a=list(range(5))") - _, c = ip.complete(".", line="a[0].") - self.assertFalse(".real" in c, "Shouldn't have completed on a[0]: %s" % c) - - def _(line, cursor_pos, expect, message, completion): - with greedy_completion(), provisionalcompleter(): - ip.Completer.use_jedi = False - _, c = ip.complete(".", line=line, cursor_pos=cursor_pos) - self.assertIn(expect, c, message % c) - - ip.Completer.use_jedi = True - with provisionalcompleter(): - completions = ip.Completer.completions(line, cursor_pos) - self.assertIn(completion, completions) - - with provisionalcompleter(): - _( - "a[0].", - 5, - "a[0].real", - "Should have completed on a[0].: %s", - Completion(5, 5, "real"), - ) - _( - "a[0].r", - 6, - "a[0].real", - "Should have completed on a[0].r: %s", - Completion(5, 6, "real"), - ) - - _( - "a[0].from_", - 10, - "a[0].from_bytes", - "Should have completed on a[0].from_: %s", - Completion(5, 10, "from_bytes"), - ) - - def test_omit__names(self): - # also happens to test IPCompleter as a configurable - ip = get_ipython() - ip._hidden_attr = 1 - ip._x = {} - c = ip.Completer - ip.ex("ip=get_ipython()") - cfg = Config() - cfg.IPCompleter.omit__names = 0 - c.update_config(cfg) - with provisionalcompleter(): - c.use_jedi = False - s, matches = c.complete("ip.") - self.assertIn("ip.__str__", matches) - self.assertIn("ip._hidden_attr", matches) - - # c.use_jedi = True - # completions = set(c.completions('ip.', 3)) - # self.assertIn(Completion(3, 3, '__str__'), completions) - # self.assertIn(Completion(3,3, "_hidden_attr"), completions) - - cfg = Config() - cfg.IPCompleter.omit__names = 1 - c.update_config(cfg) - with provisionalcompleter(): - c.use_jedi = False - s, matches = c.complete("ip.") - self.assertNotIn("ip.__str__", matches) - # self.assertIn('ip._hidden_attr', matches) - - # c.use_jedi = True - # completions = set(c.completions('ip.', 3)) - # self.assertNotIn(Completion(3,3,'__str__'), completions) - # self.assertIn(Completion(3,3, "_hidden_attr"), completions) - - cfg = Config() - cfg.IPCompleter.omit__names = 2 - c.update_config(cfg) - with provisionalcompleter(): - c.use_jedi = False - s, matches = c.complete("ip.") - self.assertNotIn("ip.__str__", matches) - self.assertNotIn("ip._hidden_attr", matches) - - # c.use_jedi = True - # completions = set(c.completions('ip.', 3)) - # self.assertNotIn(Completion(3,3,'__str__'), completions) - # self.assertNotIn(Completion(3,3, "_hidden_attr"), completions) - - with provisionalcompleter(): - c.use_jedi = False - s, matches = c.complete("ip._x.") - self.assertIn("ip._x.keys", matches) - - # c.use_jedi = True - # completions = set(c.completions('ip._x.', 6)) - # self.assertIn(Completion(6,6, "keys"), completions) - - del ip._hidden_attr - del ip._x - - def test_limit_to__all__False_ok(self): - """ - Limit to all is deprecated, once we remove it this test can go away. - """ - ip = get_ipython() - c = ip.Completer - c.use_jedi = False - ip.ex("class D: x=24") - ip.ex("d=D()") - cfg = Config() - cfg.IPCompleter.limit_to__all__ = False - c.update_config(cfg) - s, matches = c.complete("d.") - self.assertIn("d.x", matches) - - def test_get__all__entries_ok(self): - class A: - __all__ = ["x", 1] - - words = completer.get__all__entries(A()) - self.assertEqual(words, ["x"]) - - def test_get__all__entries_no__all__ok(self): - class A: - pass - - words = completer.get__all__entries(A()) - self.assertEqual(words, []) - - def test_func_kw_completions(self): - ip = get_ipython() - c = ip.Completer - c.use_jedi = False - ip.ex("def myfunc(a=1,b=2): return a+b") - s, matches = c.complete(None, "myfunc(1,b") - self.assertIn("b=", matches) - # Simulate completing with cursor right after b (pos==10): - s, matches = c.complete(None, "myfunc(1,b)", 10) - self.assertIn("b=", matches) - s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b') - self.assertIn("b=", matches) - # builtin function - s, matches = c.complete(None, "min(k, k") - self.assertIn("key=", matches) - - def test_default_arguments_from_docstring(self): - ip = get_ipython() - c = ip.Completer - kwd = c._default_arguments_from_docstring("min(iterable[, key=func]) -> value") - self.assertEqual(kwd, ["key"]) - # with cython type etc - kwd = c._default_arguments_from_docstring( - "Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n" - ) - self.assertEqual(kwd, ["ncall", "resume", "nsplit"]) - # white spaces - kwd = c._default_arguments_from_docstring( - "\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n" - ) - self.assertEqual(kwd, ["ncall", "resume", "nsplit"]) - - def test_line_magics(self): - ip = get_ipython() - c = ip.Completer - s, matches = c.complete(None, "lsmag") - self.assertIn("%lsmagic", matches) - s, matches = c.complete(None, "%lsmag") - self.assertIn("%lsmagic", matches) - - def test_cell_magics(self): - from IPython.core.magic import register_cell_magic - - @register_cell_magic - def _foo_cellm(line, cell): - pass - - ip = get_ipython() - c = ip.Completer - - s, matches = c.complete(None, "_foo_ce") - self.assertIn("%%_foo_cellm", matches) - s, matches = c.complete(None, "%%_foo_ce") - self.assertIn("%%_foo_cellm", matches) - - def test_line_cell_magics(self): - from IPython.core.magic import register_line_cell_magic - - @register_line_cell_magic - def _bar_cellm(line, cell): - pass - - ip = get_ipython() - c = ip.Completer - - # The policy here is trickier, see comments in completion code. The - # returned values depend on whether the user passes %% or not explicitly, - # and this will show a difference if the same name is both a line and cell - # magic. - s, matches = c.complete(None, "_bar_ce") - self.assertIn("%_bar_cellm", matches) - self.assertIn("%%_bar_cellm", matches) - s, matches = c.complete(None, "%_bar_ce") - self.assertIn("%_bar_cellm", matches) - self.assertIn("%%_bar_cellm", matches) - s, matches = c.complete(None, "%%_bar_ce") - self.assertNotIn("%_bar_cellm", matches) - self.assertIn("%%_bar_cellm", matches) - - def test_magic_completion_order(self): - ip = get_ipython() - c = ip.Completer - - # Test ordering of line and cell magics. - text, matches = c.complete("timeit") - self.assertEqual(matches, ["%timeit", "%%timeit"]) - - def test_magic_completion_shadowing(self): - ip = get_ipython() - c = ip.Completer - c.use_jedi = False - - # Before importing matplotlib, %matplotlib magic should be the only option. - text, matches = c.complete("mat") - self.assertEqual(matches, ["%matplotlib"]) - - # The newly introduced name should shadow the magic. - ip.run_cell("matplotlib = 1") - text, matches = c.complete("mat") - self.assertEqual(matches, ["matplotlib"]) - - # After removing matplotlib from namespace, the magic should again be - # the only option. - del ip.user_ns["matplotlib"] - text, matches = c.complete("mat") - self.assertEqual(matches, ["%matplotlib"]) - - def test_magic_completion_shadowing_explicit(self): - """ - If the user try to complete a shadowed magic, and explicit % start should - still return the completions. - """ - ip = get_ipython() - c = ip.Completer - - # Before importing matplotlib, %matplotlib magic should be the only option. - text, matches = c.complete("%mat") - self.assertEqual(matches, ["%matplotlib"]) - - ip.run_cell("matplotlib = 1") - - # After removing matplotlib from namespace, the magic should still be - # the only option. - text, matches = c.complete("%mat") - self.assertEqual(matches, ["%matplotlib"]) - - def test_magic_config(self): - ip = get_ipython() - c = ip.Completer - - s, matches = c.complete(None, "conf") - self.assertIn("%config", matches) - s, matches = c.complete(None, "conf") - self.assertNotIn("AliasManager", matches) - s, matches = c.complete(None, "config ") - self.assertIn("AliasManager", matches) - s, matches = c.complete(None, "%config ") - self.assertIn("AliasManager", matches) - s, matches = c.complete(None, "config Ali") - self.assertListEqual(["AliasManager"], matches) - s, matches = c.complete(None, "%config Ali") - self.assertListEqual(["AliasManager"], matches) - s, matches = c.complete(None, "config AliasManager") - self.assertListEqual(["AliasManager"], matches) - s, matches = c.complete(None, "%config AliasManager") - self.assertListEqual(["AliasManager"], matches) - s, matches = c.complete(None, "config AliasManager.") - self.assertIn("AliasManager.default_aliases", matches) - s, matches = c.complete(None, "%config AliasManager.") - self.assertIn("AliasManager.default_aliases", matches) - s, matches = c.complete(None, "config AliasManager.de") - self.assertListEqual(["AliasManager.default_aliases"], matches) - s, matches = c.complete(None, "config AliasManager.de") - self.assertListEqual(["AliasManager.default_aliases"], matches) - - def test_magic_color(self): - ip = get_ipython() - c = ip.Completer - - s, matches = c.complete(None, "colo") - self.assertIn("%colors", matches) - s, matches = c.complete(None, "colo") - self.assertNotIn("NoColor", matches) - s, matches = c.complete(None, "%colors") # No trailing space - self.assertNotIn("NoColor", matches) - s, matches = c.complete(None, "colors ") - self.assertIn("NoColor", matches) - s, matches = c.complete(None, "%colors ") - self.assertIn("NoColor", matches) - s, matches = c.complete(None, "colors NoCo") - self.assertListEqual(["NoColor"], matches) - s, matches = c.complete(None, "%colors NoCo") - self.assertListEqual(["NoColor"], matches) - - def test_match_dict_keys(self): - """ - Test that match_dict_keys works on a couple of use case does return what - expected, and does not crash - """ - delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?" - - keys = ["foo", b"far"] - assert match_dict_keys(keys, "b'", delims=delims) == ("'", 2, ["far"]) - assert match_dict_keys(keys, "b'f", delims=delims) == ("'", 2, ["far"]) - assert match_dict_keys(keys, 'b"', delims=delims) == ('"', 2, ["far"]) - assert match_dict_keys(keys, 'b"f', delims=delims) == ('"', 2, ["far"]) - - assert match_dict_keys(keys, "'", delims=delims) == ("'", 1, ["foo"]) - assert match_dict_keys(keys, "'f", delims=delims) == ("'", 1, ["foo"]) - assert match_dict_keys(keys, '"', delims=delims) == ('"', 1, ["foo"]) - assert match_dict_keys(keys, '"f', delims=delims) == ('"', 1, ["foo"]) - - match_dict_keys - - def test_match_dict_keys_tuple(self): - """ - Test that match_dict_keys called with extra prefix works on a couple of use case, - does return what expected, and does not crash. - """ - delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?" - - keys = [("foo", "bar"), ("foo", "oof"), ("foo", b"bar"), ('other', 'test')] - - # Completion on first key == "foo" - assert match_dict_keys(keys, "'", delims=delims, extra_prefix=("foo",)) == ("'", 1, ["bar", "oof"]) - assert match_dict_keys(keys, "\"", delims=delims, extra_prefix=("foo",)) == ("\"", 1, ["bar", "oof"]) - assert match_dict_keys(keys, "'o", delims=delims, extra_prefix=("foo",)) == ("'", 1, ["oof"]) - assert match_dict_keys(keys, "\"o", delims=delims, extra_prefix=("foo",)) == ("\"", 1, ["oof"]) - assert match_dict_keys(keys, "b'", delims=delims, extra_prefix=("foo",)) == ("'", 2, ["bar"]) - assert match_dict_keys(keys, "b\"", delims=delims, extra_prefix=("foo",)) == ("\"", 2, ["bar"]) - assert match_dict_keys(keys, "b'b", delims=delims, extra_prefix=("foo",)) == ("'", 2, ["bar"]) - assert match_dict_keys(keys, "b\"b", delims=delims, extra_prefix=("foo",)) == ("\"", 2, ["bar"]) - - # No Completion - assert match_dict_keys(keys, "'", delims=delims, extra_prefix=("no_foo",)) == ("'", 1, []) - assert match_dict_keys(keys, "'", delims=delims, extra_prefix=("fo",)) == ("'", 1, []) - - keys = [('foo1', 'foo2', 'foo3', 'foo4'), ('foo1', 'foo2', 'bar', 'foo4')] - assert match_dict_keys(keys, "'foo", delims=delims, extra_prefix=('foo1',)) == ("'", 1, ["foo2", "foo2"]) - assert match_dict_keys(keys, "'foo", delims=delims, extra_prefix=('foo1', 'foo2')) == ("'", 1, ["foo3"]) - assert match_dict_keys(keys, "'foo", delims=delims, extra_prefix=('foo1', 'foo2', 'foo3')) == ("'", 1, ["foo4"]) - assert match_dict_keys(keys, "'foo", delims=delims, extra_prefix=('foo1', 'foo2', 'foo3', 'foo4')) == ("'", 1, []) - - def test_dict_key_completion_string(self): - """Test dictionary key completion for string keys""" - ip = get_ipython() - complete = ip.Completer.complete - - ip.user_ns["d"] = {"abc": None} - - # check completion at different stages - _, matches = complete(line_buffer="d[") - self.assertIn("'abc'", matches) - self.assertNotIn("'abc']", matches) - - _, matches = complete(line_buffer="d['") - self.assertIn("abc", matches) - self.assertNotIn("abc']", matches) - - _, matches = complete(line_buffer="d['a") - self.assertIn("abc", matches) - self.assertNotIn("abc']", matches) - - # check use of different quoting - _, matches = complete(line_buffer='d["') - self.assertIn("abc", matches) - self.assertNotIn('abc"]', matches) - - _, matches = complete(line_buffer='d["a') - self.assertIn("abc", matches) - self.assertNotIn('abc"]', matches) - - # check sensitivity to following context - _, matches = complete(line_buffer="d[]", cursor_pos=2) - self.assertIn("'abc'", matches) - - _, matches = complete(line_buffer="d['']", cursor_pos=3) - self.assertIn("abc", matches) - self.assertNotIn("abc'", matches) - self.assertNotIn("abc']", matches) - - # check multiple solutions are correctly returned and that noise is not - ip.user_ns["d"] = { - "abc": None, - "abd": None, - "bad": None, - object(): None, - 5: None, - ("abe", None): None, - (None, "abf"): None - } - - _, matches = complete(line_buffer="d['a") - self.assertIn("abc", matches) - self.assertIn("abd", matches) - self.assertNotIn("bad", matches) - self.assertNotIn("abe", matches) - self.assertNotIn("abf", matches) - assert not any(m.endswith(("]", '"', "'")) for m in matches), matches - - # check escaping and whitespace - ip.user_ns["d"] = {"a\nb": None, "a'b": None, 'a"b': None, "a word": None} - _, matches = complete(line_buffer="d['a") - self.assertIn("a\\nb", matches) - self.assertIn("a\\'b", matches) - self.assertIn('a"b', matches) - self.assertIn("a word", matches) - assert not any(m.endswith(("]", '"', "'")) for m in matches), matches - - # - can complete on non-initial word of the string - _, matches = complete(line_buffer="d['a w") - self.assertIn("word", matches) - - # - understands quote escaping - _, matches = complete(line_buffer="d['a\\'") - self.assertIn("b", matches) - - # - default quoting should work like repr - _, matches = complete(line_buffer="d[") - self.assertIn('"a\'b"', matches) - - # - when opening quote with ", possible to match with unescaped apostrophe - _, matches = complete(line_buffer="d[\"a'") - self.assertIn("b", matches) - - # need to not split at delims that readline won't split at - if "-" not in ip.Completer.splitter.delims: - ip.user_ns["d"] = {"before-after": None} - _, matches = complete(line_buffer="d['before-af") - self.assertIn("before-after", matches) - - # check completion on tuple-of-string keys at different stage - on first key - ip.user_ns["d"] = {('foo', 'bar'): None} - _, matches = complete(line_buffer="d[") - self.assertIn("'foo'", matches) - self.assertNotIn("'foo']", matches) - self.assertNotIn("'bar'", matches) - self.assertNotIn("foo", matches) - self.assertNotIn("bar", matches) - - # - match the prefix - _, matches = complete(line_buffer="d['f") - self.assertIn("foo", matches) - self.assertNotIn("foo']", matches) - self.assertNotIn('foo"]', matches) - _, matches = complete(line_buffer="d['foo") - self.assertIn("foo", matches) - - # - can complete on second key - _, matches = complete(line_buffer="d['foo', ") - self.assertIn("'bar'", matches) - _, matches = complete(line_buffer="d['foo', 'b") - self.assertIn("bar", matches) - self.assertNotIn("foo", matches) - - # - does not propose missing keys - _, matches = complete(line_buffer="d['foo', 'f") - self.assertNotIn("bar", matches) - self.assertNotIn("foo", matches) - - # check sensitivity to following context - _, matches = complete(line_buffer="d['foo',]", cursor_pos=8) - self.assertIn("'bar'", matches) - self.assertNotIn("bar", matches) - self.assertNotIn("'foo'", matches) - self.assertNotIn("foo", matches) - - _, matches = complete(line_buffer="d['']", cursor_pos=3) - self.assertIn("foo", matches) - assert not any(m.endswith(("]", '"', "'")) for m in matches), matches - - _, matches = complete(line_buffer='d[""]', cursor_pos=3) - self.assertIn("foo", matches) - assert not any(m.endswith(("]", '"', "'")) for m in matches), matches - - _, matches = complete(line_buffer='d["foo","]', cursor_pos=9) - self.assertIn("bar", matches) - assert not any(m.endswith(("]", '"', "'")) for m in matches), matches - - _, matches = complete(line_buffer='d["foo",]', cursor_pos=8) - self.assertIn("'bar'", matches) - self.assertNotIn("bar", matches) - - # Can complete with longer tuple keys - ip.user_ns["d"] = {('foo', 'bar', 'foobar'): None} - - # - can complete second key - _, matches = complete(line_buffer="d['foo', 'b") - self.assertIn("bar", matches) - self.assertNotIn("foo", matches) - self.assertNotIn("foobar", matches) - - # - can complete third key - _, matches = complete(line_buffer="d['foo', 'bar', 'fo") - self.assertIn("foobar", matches) - self.assertNotIn("foo", matches) - self.assertNotIn("bar", matches) - - def test_dict_key_completion_contexts(self): - """Test expression contexts in which dict key completion occurs""" - ip = get_ipython() - complete = ip.Completer.complete - d = {"abc": None} - ip.user_ns["d"] = d - - class C: - data = d - - ip.user_ns["C"] = C - ip.user_ns["get"] = lambda: d - - def assert_no_completion(**kwargs): - _, matches = complete(**kwargs) - self.assertNotIn("abc", matches) - self.assertNotIn("abc'", matches) - self.assertNotIn("abc']", matches) - self.assertNotIn("'abc'", matches) - self.assertNotIn("'abc']", matches) - - def assert_completion(**kwargs): - _, matches = complete(**kwargs) - self.assertIn("'abc'", matches) - self.assertNotIn("'abc']", matches) - - # no completion after string closed, even if reopened - assert_no_completion(line_buffer="d['a'") - assert_no_completion(line_buffer='d["a"') - assert_no_completion(line_buffer="d['a' + ") - assert_no_completion(line_buffer="d['a' + '") - - # completion in non-trivial expressions - assert_completion(line_buffer="+ d[") - assert_completion(line_buffer="(d[") - assert_completion(line_buffer="C.data[") - - # greedy flag - def assert_completion(**kwargs): - _, matches = complete(**kwargs) - self.assertIn("get()['abc']", matches) - - assert_no_completion(line_buffer="get()[") - with greedy_completion(): - assert_completion(line_buffer="get()[") - assert_completion(line_buffer="get()['") - assert_completion(line_buffer="get()['a") - assert_completion(line_buffer="get()['ab") - assert_completion(line_buffer="get()['abc") - - def test_dict_key_completion_bytes(self): - """Test handling of bytes in dict key completion""" - ip = get_ipython() - complete = ip.Completer.complete - - ip.user_ns["d"] = {"abc": None, b"abd": None} - - _, matches = complete(line_buffer="d[") - self.assertIn("'abc'", matches) - self.assertIn("b'abd'", matches) - - if False: # not currently implemented - _, matches = complete(line_buffer="d[b") - self.assertIn("b'abd'", matches) - self.assertNotIn("b'abc'", matches) - - _, matches = complete(line_buffer="d[b'") - self.assertIn("abd", matches) - self.assertNotIn("abc", matches) - - _, matches = complete(line_buffer="d[B'") - self.assertIn("abd", matches) - self.assertNotIn("abc", matches) - - _, matches = complete(line_buffer="d['") - self.assertIn("abc", matches) - self.assertNotIn("abd", matches) - - def test_dict_key_completion_unicode_py3(self): - """Test handling of unicode in dict key completion""" - ip = get_ipython() - complete = ip.Completer.complete - - ip.user_ns["d"] = {"a\u05d0": None} - - # query using escape - if sys.platform != "win32": - # Known failure on Windows - _, matches = complete(line_buffer="d['a\\u05d0") - self.assertIn("u05d0", matches) # tokenized after \\ - - # query using character - _, matches = complete(line_buffer="d['a\u05d0") - self.assertIn("a\u05d0", matches) - - with greedy_completion(): - # query using escape - _, matches = complete(line_buffer="d['a\\u05d0") - self.assertIn("d['a\\u05d0']", matches) # tokenized after \\ - - # query using character - _, matches = complete(line_buffer="d['a\u05d0") - self.assertIn("d['a\u05d0']", matches) - - @dec.skip_without("numpy") - def test_struct_array_key_completion(self): - """Test dict key completion applies to numpy struct arrays""" - import numpy - - ip = get_ipython() - complete = ip.Completer.complete - ip.user_ns["d"] = numpy.array([], dtype=[("hello", "f"), ("world", "f")]) - _, matches = complete(line_buffer="d['") - self.assertIn("hello", matches) - self.assertIn("world", matches) - # complete on the numpy struct itself - dt = numpy.dtype( - [("my_head", [("my_dt", ">u4"), ("my_df", ">u4")]), ("my_data", ">f4", 5)] - ) - x = numpy.zeros(2, dtype=dt) - ip.user_ns["d"] = x[1] - _, matches = complete(line_buffer="d['") - self.assertIn("my_head", matches) - self.assertIn("my_data", matches) - # complete on a nested level - with greedy_completion(): - ip.user_ns["d"] = numpy.zeros(2, dtype=dt) - _, matches = complete(line_buffer="d[1]['my_head']['") - self.assertTrue(any(["my_dt" in m for m in matches])) - self.assertTrue(any(["my_df" in m for m in matches])) - - @dec.skip_without("pandas") - def test_dataframe_key_completion(self): - """Test dict key completion applies to pandas DataFrames""" - import pandas - - ip = get_ipython() - complete = ip.Completer.complete - ip.user_ns["d"] = pandas.DataFrame({"hello": [1], "world": [2]}) - _, matches = complete(line_buffer="d['") - self.assertIn("hello", matches) - self.assertIn("world", matches) - - def test_dict_key_completion_invalids(self): - """Smoke test cases dict key completion can't handle""" - ip = get_ipython() - complete = ip.Completer.complete - - ip.user_ns["no_getitem"] = None - ip.user_ns["no_keys"] = [] - ip.user_ns["cant_call_keys"] = dict - ip.user_ns["empty"] = {} - ip.user_ns["d"] = {"abc": 5} - - _, matches = complete(line_buffer="no_getitem['") - _, matches = complete(line_buffer="no_keys['") - _, matches = complete(line_buffer="cant_call_keys['") - _, matches = complete(line_buffer="empty['") - _, matches = complete(line_buffer="name_error['") - _, matches = complete(line_buffer="d['\\") # incomplete escape - - def test_object_key_completion(self): - ip = get_ipython() - ip.user_ns["key_completable"] = KeyCompletable(["qwerty", "qwick"]) - - _, matches = ip.Completer.complete(line_buffer="key_completable['qw") - self.assertIn("qwerty", matches) - self.assertIn("qwick", matches) - - def test_class_key_completion(self): - ip = get_ipython() - NamedInstanceClass("qwerty") - NamedInstanceClass("qwick") - ip.user_ns["named_instance_class"] = NamedInstanceClass - - _, matches = ip.Completer.complete(line_buffer="named_instance_class['qw") - self.assertIn("qwerty", matches) - self.assertIn("qwick", matches) - - def test_tryimport(self): - """ - Test that try-import don't crash on trailing dot, and import modules before - """ - from IPython.core.completerlib import try_import - - assert try_import("IPython.") - - def test_aimport_module_completer(self): - ip = get_ipython() - _, matches = ip.complete("i", "%aimport i") - self.assertIn("io", matches) - self.assertNotIn("int", matches) - - def test_nested_import_module_completer(self): - ip = get_ipython() - _, matches = ip.complete(None, "import IPython.co", 17) - self.assertIn("IPython.core", matches) - self.assertNotIn("import IPython.core", matches) - self.assertNotIn("IPython.display", matches) - - def test_import_module_completer(self): - ip = get_ipython() - _, matches = ip.complete("i", "import i") - self.assertIn("io", matches) - self.assertNotIn("int", matches) - - def test_from_module_completer(self): - ip = get_ipython() - _, matches = ip.complete("B", "from io import B", 16) - self.assertIn("BytesIO", matches) - self.assertNotIn("BaseException", matches) - - def test_snake_case_completion(self): - ip = get_ipython() - ip.Completer.use_jedi = False - ip.user_ns["some_three"] = 3 - ip.user_ns["some_four"] = 4 - _, matches = ip.complete("s_", "print(s_f") - self.assertIn("some_three", matches) - self.assertIn("some_four", matches) - - def test_mix_terms(self): - ip = get_ipython() - from textwrap import dedent - - ip.Completer.use_jedi = False - ip.ex( - dedent( - """ - class Test: - def meth(self, meth_arg1): - print("meth") - - def meth_1(self, meth1_arg1, meth1_arg2): - print("meth1") - - def meth_2(self, meth2_arg1, meth2_arg2): - print("meth2") - test = Test() - """ - ) - ) - _, matches = ip.complete(None, "test.meth(") - self.assertIn("meth_arg1=", matches) - self.assertNotIn("meth2_arg1=", matches) - - def test_percent_symbol_restrict_to_magic_completions(self): - ip = get_ipython() - completer = ip.Completer - text = "%a" - - with provisionalcompleter(): - completer.use_jedi = True - completions = completer.completions(text, len(text)) - for c in completions: - self.assertEqual(c.text[0], "%") diff --git a/IPython/core/tests/test_completerlib.py b/IPython/core/tests/test_completerlib.py deleted file mode 100644 index 0e8bf192da1..00000000000 --- a/IPython/core/tests/test_completerlib.py +++ /dev/null @@ -1,193 +0,0 @@ -# -*- coding: utf-8 -*- -"""Tests for completerlib. - -""" - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -import os -import shutil -import sys -import tempfile -import unittest -from os.path import join - -from tempfile import TemporaryDirectory - -from IPython.core.completerlib import magic_run_completer, module_completion, try_import -from IPython.testing.decorators import onlyif_unicode_paths - - -class MockEvent(object): - def __init__(self, line): - self.line = line - -#----------------------------------------------------------------------------- -# Test functions begin -#----------------------------------------------------------------------------- -class Test_magic_run_completer(unittest.TestCase): - files = [u"aao.py", u"a.py", u"b.py", u"aao.txt"] - dirs = [u"adir/", "bdir/"] - - def setUp(self): - self.BASETESTDIR = tempfile.mkdtemp() - for fil in self.files: - with open(join(self.BASETESTDIR, fil), "w", encoding="utf-8") as sfile: - sfile.write("pass\n") - for d in self.dirs: - os.mkdir(join(self.BASETESTDIR, d)) - - self.oldpath = os.getcwd() - os.chdir(self.BASETESTDIR) - - def tearDown(self): - os.chdir(self.oldpath) - shutil.rmtree(self.BASETESTDIR) - - def test_1(self): - """Test magic_run_completer, should match two alternatives - """ - event = MockEvent(u"%run a") - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"a.py", u"aao.py", u"adir/"}) - - def test_2(self): - """Test magic_run_completer, should match one alternative - """ - event = MockEvent(u"%run aa") - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"aao.py"}) - - def test_3(self): - """Test magic_run_completer with unterminated " """ - event = MockEvent(u'%run "a') - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"a.py", u"aao.py", u"adir/"}) - - def test_completion_more_args(self): - event = MockEvent(u'%run a.py ') - match = set(magic_run_completer(None, event)) - self.assertEqual(match, set(self.files + self.dirs)) - - def test_completion_in_dir(self): - # Github issue #3459 - event = MockEvent(u'%run a.py {}'.format(join(self.BASETESTDIR, 'a'))) - print(repr(event.line)) - match = set(magic_run_completer(None, event)) - # We specifically use replace here rather than normpath, because - # at one point there were duplicates 'adir' and 'adir/', and normpath - # would hide the failure for that. - self.assertEqual(match, {join(self.BASETESTDIR, f).replace('\\','/') - for f in (u'a.py', u'aao.py', u'aao.txt', u'adir/')}) - -class Test_magic_run_completer_nonascii(unittest.TestCase): - @onlyif_unicode_paths - def setUp(self): - self.BASETESTDIR = tempfile.mkdtemp() - for fil in [u"aaø.py", u"a.py", u"b.py"]: - with open(join(self.BASETESTDIR, fil), "w", encoding="utf-8") as sfile: - sfile.write("pass\n") - self.oldpath = os.getcwd() - os.chdir(self.BASETESTDIR) - - def tearDown(self): - os.chdir(self.oldpath) - shutil.rmtree(self.BASETESTDIR) - - @onlyif_unicode_paths - def test_1(self): - """Test magic_run_completer, should match two alternatives - """ - event = MockEvent(u"%run a") - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"a.py", u"aaø.py"}) - - @onlyif_unicode_paths - def test_2(self): - """Test magic_run_completer, should match one alternative - """ - event = MockEvent(u"%run aa") - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"aaø.py"}) - - @onlyif_unicode_paths - def test_3(self): - """Test magic_run_completer with unterminated " """ - event = MockEvent(u'%run "a') - mockself = None - match = set(magic_run_completer(mockself, event)) - self.assertEqual(match, {u"a.py", u"aaø.py"}) - -# module_completer: - -def test_import_invalid_module(): - """Testing of issue https://github.com/ipython/ipython/issues/1107""" - invalid_module_names = {'foo-bar', 'foo:bar', '10foo'} - valid_module_names = {'foobar'} - with TemporaryDirectory() as tmpdir: - sys.path.insert( 0, tmpdir ) - for name in invalid_module_names | valid_module_names: - filename = os.path.join(tmpdir, name + ".py") - open(filename, "w", encoding="utf-8").close() - - s = set( module_completion('import foo') ) - intersection = s.intersection(invalid_module_names) - assert intersection == set() - - assert valid_module_names.issubset(s), valid_module_names.intersection(s) - - -def test_bad_module_all(): - """Test module with invalid __all__ - - https://github.com/ipython/ipython/issues/9678 - """ - testsdir = os.path.dirname(__file__) - sys.path.insert(0, testsdir) - try: - results = module_completion("from bad_all import ") - assert "puppies" in results - for r in results: - assert isinstance(r, str) - - # bad_all doesn't contain submodules, but this completion - # should finish without raising an exception: - results = module_completion("import bad_all.") - assert results == [] - finally: - sys.path.remove(testsdir) - - -def test_module_without_init(): - """ - Test module without __init__.py. - - https://github.com/ipython/ipython/issues/11226 - """ - fake_module_name = "foo" - with TemporaryDirectory() as tmpdir: - sys.path.insert(0, tmpdir) - try: - os.makedirs(os.path.join(tmpdir, fake_module_name)) - s = try_import(mod=fake_module_name) - assert s == [] - finally: - sys.path.remove(tmpdir) - - -def test_valid_exported_submodules(): - """ - Test checking exported (__all__) objects are submodules - """ - results = module_completion("import os.pa") - # ensure we get a valid submodule: - assert "os.path" in results - # ensure we don't get objects that aren't submodules: - assert "os.pathconf" not in results diff --git a/IPython/core/tests/test_debugger.py b/IPython/core/tests/test_debugger.py deleted file mode 100644 index d2d5bd09991..00000000000 --- a/IPython/core/tests/test_debugger.py +++ /dev/null @@ -1,567 +0,0 @@ -"""Tests for debugging machinery. -""" - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - -import bdb -import builtins -import os -import sys -import platform - -from tempfile import NamedTemporaryFile -from textwrap import dedent -from unittest.mock import patch - -from IPython.core import debugger -from IPython.testing import IPYTHON_TESTING_TIMEOUT_SCALE -from IPython.testing.decorators import skip_win32 -import pytest - -#----------------------------------------------------------------------------- -# Helper classes, from CPython's Pdb test suite -#----------------------------------------------------------------------------- - -class _FakeInput(object): - """ - A fake input stream for pdb's interactive debugger. Whenever a - line is read, print it (to simulate the user typing it), and then - return it. The set of lines to return is specified in the - constructor; they should not have trailing newlines. - """ - def __init__(self, lines): - self.lines = iter(lines) - - def readline(self): - line = next(self.lines) - print(line) - return line+'\n' - -class PdbTestInput(object): - """Context manager that makes testing Pdb in doctests easier.""" - - def __init__(self, input): - self.input = input - - def __enter__(self): - self.real_stdin = sys.stdin - sys.stdin = _FakeInput(self.input) - - def __exit__(self, *exc): - sys.stdin = self.real_stdin - -#----------------------------------------------------------------------------- -# Tests -#----------------------------------------------------------------------------- - -def test_ipdb_magics(): - '''Test calling some IPython magics from ipdb. - - First, set up some test functions and classes which we can inspect. - - >>> class ExampleClass(object): - ... """Docstring for ExampleClass.""" - ... def __init__(self): - ... """Docstring for ExampleClass.__init__""" - ... pass - ... def __str__(self): - ... return "ExampleClass()" - - >>> def example_function(x, y, z="hello"): - ... """Docstring for example_function.""" - ... pass - - >>> old_trace = sys.gettrace() - - Create a function which triggers ipdb. - - >>> def trigger_ipdb(): - ... a = ExampleClass() - ... debugger.Pdb().set_trace() - - >>> with PdbTestInput([ - ... 'pdef example_function', - ... 'pdoc ExampleClass', - ... 'up', - ... 'down', - ... 'list', - ... 'pinfo a', - ... 'll', - ... 'continue', - ... ]): - ... trigger_ipdb() - --Return-- - None - > (3)trigger_ipdb() - 1 def trigger_ipdb(): - 2 a = ExampleClass() - ----> 3 debugger.Pdb().set_trace() - - ipdb> pdef example_function - example_function(x, y, z='hello') - ipdb> pdoc ExampleClass - Class docstring: - Docstring for ExampleClass. - Init docstring: - Docstring for ExampleClass.__init__ - ipdb> up - > (11)() - 7 'pinfo a', - 8 'll', - 9 'continue', - 10 ]): - ---> 11 trigger_ipdb() - - ipdb> down - None - > (3)trigger_ipdb() - 1 def trigger_ipdb(): - 2 a = ExampleClass() - ----> 3 debugger.Pdb().set_trace() - - ipdb> list - 1 def trigger_ipdb(): - 2 a = ExampleClass() - ----> 3 debugger.Pdb().set_trace() - - ipdb> pinfo a - Type: ExampleClass - String form: ExampleClass() - Namespace: Local... - Docstring: Docstring for ExampleClass. - Init docstring: Docstring for ExampleClass.__init__ - ipdb> ll - 1 def trigger_ipdb(): - 2 a = ExampleClass() - ----> 3 debugger.Pdb().set_trace() - - ipdb> continue - - Restore previous trace function, e.g. for coverage.py - - >>> sys.settrace(old_trace) - ''' - -def test_ipdb_magics2(): - '''Test ipdb with a very short function. - - >>> old_trace = sys.gettrace() - - >>> def bar(): - ... pass - - Run ipdb. - - >>> with PdbTestInput([ - ... 'continue', - ... ]): - ... debugger.Pdb().runcall(bar) - > (2)bar() - 1 def bar(): - ----> 2 pass - - ipdb> continue - - Restore previous trace function, e.g. for coverage.py - - >>> sys.settrace(old_trace) - ''' - -def can_quit(): - '''Test that quit work in ipydb - - >>> old_trace = sys.gettrace() - - >>> def bar(): - ... pass - - >>> with PdbTestInput([ - ... 'quit', - ... ]): - ... debugger.Pdb().runcall(bar) - > (2)bar() - 1 def bar(): - ----> 2 pass - - ipdb> quit - - Restore previous trace function, e.g. for coverage.py - - >>> sys.settrace(old_trace) - ''' - - -def can_exit(): - '''Test that quit work in ipydb - - >>> old_trace = sys.gettrace() - - >>> def bar(): - ... pass - - >>> with PdbTestInput([ - ... 'exit', - ... ]): - ... debugger.Pdb().runcall(bar) - > (2)bar() - 1 def bar(): - ----> 2 pass - - ipdb> exit - - Restore previous trace function, e.g. for coverage.py - - >>> sys.settrace(old_trace) - ''' - - -def test_interruptible_core_debugger(): - """The debugger can be interrupted. - - The presumption is there is some mechanism that causes a KeyboardInterrupt - (this is implemented in ipykernel). We want to ensure the - KeyboardInterrupt cause debugging to cease. - """ - def raising_input(msg="", called=[0]): - called[0] += 1 - assert called[0] == 1, "input() should only be called once!" - raise KeyboardInterrupt() - - tracer_orig = sys.gettrace() - try: - with patch.object(builtins, "input", raising_input): - debugger.InterruptiblePdb().set_trace() - # The way this test will fail is by set_trace() never exiting, - # resulting in a timeout by the test runner. The alternative - # implementation would involve a subprocess, but that adds issues - # with interrupting subprocesses that are rather complex, so it's - # simpler just to do it this way. - finally: - # restore the original trace function - sys.settrace(tracer_orig) - - -@skip_win32 -def test_xmode_skip(): - """that xmode skip frames - - Not as a doctest as pytest does not run doctests. - """ - import pexpect - env = os.environ.copy() - env["IPY_TEST_SIMPLE_PROMPT"] = "1" - - child = pexpect.spawn( - sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env - ) - child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE - - child.expect("IPython") - child.expect("\n") - child.expect_exact("In [1]") - - block = dedent( - """ - def f(): - __tracebackhide__ = True - g() - - def g(): - raise ValueError - - f() - """ - ) - - for line in block.splitlines(): - child.sendline(line) - child.expect_exact(line) - child.expect_exact("skipping") - - block = dedent( - """ - def f(): - __tracebackhide__ = True - g() - - def g(): - from IPython.core.debugger import set_trace - set_trace() - - f() - """ - ) - - for line in block.splitlines(): - child.sendline(line) - child.expect_exact(line) - - child.expect("ipdb>") - child.sendline("w") - child.expect("hidden") - child.expect("ipdb>") - child.sendline("skip_hidden false") - child.sendline("w") - child.expect("__traceba") - child.expect("ipdb>") - - child.close() - - -skip_decorators_blocks = ( - """ - def helpers_helper(): - pass # should not stop here except breakpoint - """, - """ - def helper_1(): - helpers_helper() # should not stop here - """, - """ - def helper_2(): - pass # should not stop here - """, - """ - def pdb_skipped_decorator2(function): - def wrapped_fn(*args, **kwargs): - __debuggerskip__ = True - helper_2() - __debuggerskip__ = False - result = function(*args, **kwargs) - __debuggerskip__ = True - helper_2() - return result - return wrapped_fn - """, - """ - def pdb_skipped_decorator(function): - def wrapped_fn(*args, **kwargs): - __debuggerskip__ = True - helper_1() - __debuggerskip__ = False - result = function(*args, **kwargs) - __debuggerskip__ = True - helper_2() - return result - return wrapped_fn - """, - """ - @pdb_skipped_decorator - @pdb_skipped_decorator2 - def bar(x, y): - return x * y - """, - """import IPython.terminal.debugger as ipdb""", - """ - def f(): - ipdb.set_trace() - bar(3, 4) - """, - """ - f() - """, -) - - -def _decorator_skip_setup(): - import pexpect - - env = os.environ.copy() - env["IPY_TEST_SIMPLE_PROMPT"] = "1" - - child = pexpect.spawn( - sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env - ) - child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE - - child.expect("IPython") - child.expect("\n") - - child.timeout = 5 * IPYTHON_TESTING_TIMEOUT_SCALE - - dedented_blocks = [dedent(b).strip() for b in skip_decorators_blocks] - in_prompt_number = 1 - for cblock in dedented_blocks: - child.expect_exact(f"In [{in_prompt_number}]:") - in_prompt_number += 1 - for line in cblock.splitlines(): - child.sendline(line) - child.expect_exact(line) - child.sendline("") - return child - - -@skip_win32 -def test_decorator_skip(): - """test that decorator frames can be skipped.""" - - child = _decorator_skip_setup() - - child.expect_exact("3 bar(3, 4)") - child.expect("ipdb>") - - child.expect("ipdb>") - child.sendline("step") - child.expect_exact("step") - - child.expect_exact("1 @pdb_skipped_decorator") - - child.sendline("s") - child.expect_exact("return x * y") - - child.close() - - -@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="issues on PyPy") -@skip_win32 -def test_decorator_skip_disabled(): - """test that decorator frame skipping can be disabled""" - - child = _decorator_skip_setup() - - child.expect_exact("3 bar(3, 4)") - - for input_, expected in [ - ("skip_predicates debuggerskip False", ""), - ("skip_predicates", "debuggerskip : False"), - ("step", "---> 2 def wrapped_fn"), - ("step", "----> 3 __debuggerskip__"), - ("step", "----> 4 helper_1()"), - ("step", "---> 1 def helper_1():"), - ("next", "----> 2 helpers_helper()"), - ("next", "--Return--"), - ("next", "----> 5 __debuggerskip__ = False"), - ]: - child.expect("ipdb>") - child.sendline(input_) - child.expect_exact(input_) - child.expect_exact(expected) - - child.close() - - -@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="issues on PyPy") -@skip_win32 -def test_decorator_skip_with_breakpoint(): - """test that decorator frame skipping can be disabled""" - - import pexpect - - env = os.environ.copy() - env["IPY_TEST_SIMPLE_PROMPT"] = "1" - - child = pexpect.spawn( - sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env - ) - child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE - - child.expect("IPython") - child.expect("\n") - - child.timeout = 5 * IPYTHON_TESTING_TIMEOUT_SCALE - - ### we need a filename, so we need to exec the full block with a filename - with NamedTemporaryFile(suffix=".py", dir=".", delete=True) as tf: - - name = tf.name[:-3].split("/")[-1] - tf.write("\n".join([dedent(x) for x in skip_decorators_blocks[:-1]]).encode()) - tf.flush() - codeblock = f"from {name} import f" - - dedented_blocks = [ - codeblock, - "f()", - ] - - in_prompt_number = 1 - for cblock in dedented_blocks: - child.expect_exact(f"In [{in_prompt_number}]:") - in_prompt_number += 1 - for line in cblock.splitlines(): - child.sendline(line) - child.expect_exact(line) - child.sendline("") - - # as the filename does not exists, we'll rely on the filename prompt - child.expect_exact("47 bar(3, 4)") - - for input_, expected in [ - (f"b {name}.py:3", ""), - ("step", "1---> 3 pass # should not stop here except"), - ("step", "---> 38 @pdb_skipped_decorator"), - ("continue", ""), - ]: - child.expect("ipdb>") - child.sendline(input_) - child.expect_exact(input_) - child.expect_exact(expected) - - child.close() - - -@skip_win32 -def test_where_erase_value(): - """Test that `where` does not access f_locals and erase values.""" - import pexpect - - env = os.environ.copy() - env["IPY_TEST_SIMPLE_PROMPT"] = "1" - - child = pexpect.spawn( - sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env - ) - child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE - - child.expect("IPython") - child.expect("\n") - child.expect_exact("In [1]") - - block = dedent( - """ - def simple_f(): - myvar = 1 - print(myvar) - 1/0 - print(myvar) - simple_f() """ - ) - - for line in block.splitlines(): - child.sendline(line) - child.expect_exact(line) - child.expect_exact("ZeroDivisionError") - child.expect_exact("In [2]:") - - child.sendline("%debug") - - ## - child.expect("ipdb>") - - child.sendline("myvar") - child.expect("1") - - ## - child.expect("ipdb>") - - child.sendline("myvar = 2") - - ## - child.expect_exact("ipdb>") - - child.sendline("myvar") - - child.expect_exact("2") - - ## - child.expect("ipdb>") - child.sendline("where") - - ## - child.expect("ipdb>") - child.sendline("myvar") - - child.expect_exact("2") - child.expect("ipdb>") - - child.close() diff --git a/IPython/core/tests/test_displayhook.py b/IPython/core/tests/test_displayhook.py deleted file mode 100644 index 6ad89793442..00000000000 --- a/IPython/core/tests/test_displayhook.py +++ /dev/null @@ -1,112 +0,0 @@ -import sys -from IPython.testing.tools import AssertPrints, AssertNotPrints -from IPython.core.displayhook import CapturingDisplayHook -from IPython.utils.capture import CapturedIO - -def test_output_displayed(): - """Checking to make sure that output is displayed""" - - with AssertPrints('2'): - ip.run_cell('1+1', store_history=True) - - with AssertPrints('2'): - ip.run_cell('1+1 # comment with a semicolon;', store_history=True) - - with AssertPrints('2'): - ip.run_cell('1+1\n#commented_out_function();', store_history=True) - - -def test_output_quiet(): - """Checking to make sure that output is quiet""" - - with AssertNotPrints('2'): - ip.run_cell('1+1;', store_history=True) - - with AssertNotPrints('2'): - ip.run_cell('1+1; # comment with a semicolon', store_history=True) - - with AssertNotPrints('2'): - ip.run_cell('1+1;\n#commented_out_function()', store_history=True) - -def test_underscore_no_overrite_user(): - ip.run_cell('_ = 42', store_history=True) - ip.run_cell('1+1', store_history=True) - - with AssertPrints('42'): - ip.run_cell('print(_)', store_history=True) - - ip.run_cell('del _', store_history=True) - ip.run_cell('6+6', store_history=True) - with AssertPrints('12'): - ip.run_cell('_', store_history=True) - - -def test_underscore_no_overrite_builtins(): - ip.run_cell("import gettext ; gettext.install('foo')", store_history=True) - ip.run_cell('3+3', store_history=True) - - with AssertPrints('gettext'): - ip.run_cell('print(_)', store_history=True) - - ip.run_cell('_ = "userset"', store_history=True) - - with AssertPrints('userset'): - ip.run_cell('print(_)', store_history=True) - ip.run_cell('import builtins; del builtins._') - - -def test_interactivehooks_ast_modes(): - """ - Test that ast nodes can be triggered with different modes - """ - saved_mode = ip.ast_node_interactivity - ip.ast_node_interactivity = 'last_expr_or_assign' - - try: - with AssertPrints('2'): - ip.run_cell('a = 1+1', store_history=True) - - with AssertPrints('9'): - ip.run_cell('b = 1+8 # comment with a semicolon;', store_history=False) - - with AssertPrints('7'): - ip.run_cell('c = 1+6\n#commented_out_function();', store_history=True) - - ip.run_cell('d = 11', store_history=True) - with AssertPrints('12'): - ip.run_cell('d += 1', store_history=True) - - with AssertNotPrints('42'): - ip.run_cell('(u,v) = (41+1, 43-1)') - - finally: - ip.ast_node_interactivity = saved_mode - -def test_interactivehooks_ast_modes_semi_suppress(): - """ - Test that ast nodes can be triggered with different modes and suppressed - by semicolon - """ - saved_mode = ip.ast_node_interactivity - ip.ast_node_interactivity = 'last_expr_or_assign' - - try: - with AssertNotPrints('2'): - ip.run_cell('x = 1+1;', store_history=True) - - with AssertNotPrints('7'): - ip.run_cell('y = 1+6; # comment with a semicolon', store_history=True) - - with AssertNotPrints('9'): - ip.run_cell('z = 1+8;\n#commented_out_function()', store_history=True) - - finally: - ip.ast_node_interactivity = saved_mode - -def test_capture_display_hook_format(): - """Tests that the capture display hook conforms to the CapturedIO output format""" - hook = CapturingDisplayHook(ip) - hook({"foo": "bar"}) - captured = CapturedIO(sys.stdout, sys.stderr, hook.outputs) - # Should not raise with RichOutput transformation error - captured.outputs diff --git a/IPython/core/tests/test_events.py b/IPython/core/tests/test_events.py deleted file mode 100644 index cc9bf40fd6d..00000000000 --- a/IPython/core/tests/test_events.py +++ /dev/null @@ -1,91 +0,0 @@ -import unittest -from unittest.mock import Mock - -from IPython.core import events -import IPython.testing.tools as tt - - -@events._define_event -def ping_received(): - pass - - -@events._define_event -def event_with_argument(argument): - pass - - -class CallbackTests(unittest.TestCase): - def setUp(self): - self.em = events.EventManager(get_ipython(), - {'ping_received': ping_received, - 'event_with_argument': event_with_argument}) - - def test_register_unregister(self): - cb = Mock() - - self.em.register('ping_received', cb) - self.em.trigger('ping_received') - self.assertEqual(cb.call_count, 1) - - self.em.unregister('ping_received', cb) - self.em.trigger('ping_received') - self.assertEqual(cb.call_count, 1) - - def test_bare_function_missed_unregister(self): - def cb1(): - ... - - def cb2(): - ... - - self.em.register("ping_received", cb1) - self.assertRaises(ValueError, self.em.unregister, "ping_received", cb2) - self.em.unregister("ping_received", cb1) - - def test_cb_error(self): - cb = Mock(side_effect=ValueError) - self.em.register('ping_received', cb) - with tt.AssertPrints("Error in callback"): - self.em.trigger('ping_received') - - def test_cb_keyboard_interrupt(self): - cb = Mock(side_effect=KeyboardInterrupt) - self.em.register('ping_received', cb) - with tt.AssertPrints("Error in callback"): - self.em.trigger('ping_received') - - def test_unregister_during_callback(self): - invoked = [False] * 3 - - def func1(*_): - invoked[0] = True - self.em.unregister('ping_received', func1) - self.em.register('ping_received', func3) - - def func2(*_): - invoked[1] = True - self.em.unregister('ping_received', func2) - - def func3(*_): - invoked[2] = True - - self.em.register('ping_received', func1) - self.em.register('ping_received', func2) - - self.em.trigger('ping_received') - self.assertEqual([True, True, False], invoked) - self.assertEqual([func3], self.em.callbacks['ping_received']) - - def test_ignore_event_arguments_if_no_argument_required(self): - call_count = [0] - def event_with_no_argument(): - call_count[0] += 1 - - self.em.register('event_with_argument', event_with_no_argument) - self.em.trigger('event_with_argument', 'the argument') - self.assertEqual(call_count[0], 1) - - self.em.unregister('event_with_argument', event_with_no_argument) - self.em.trigger('ping_received') - self.assertEqual(call_count[0], 1) diff --git a/IPython/core/tests/test_handlers.py b/IPython/core/tests/test_handlers.py deleted file mode 100644 index 604dadee1ab..00000000000 --- a/IPython/core/tests/test_handlers.py +++ /dev/null @@ -1,97 +0,0 @@ -"""Tests for input handlers. -""" -#----------------------------------------------------------------------------- -# Module imports -#----------------------------------------------------------------------------- - -# our own packages -from IPython.core import autocall -from IPython.testing import tools as tt - -#----------------------------------------------------------------------------- -# Globals -#----------------------------------------------------------------------------- - -# Get the public instance of IPython - -failures = [] -num_tests = 0 - -#----------------------------------------------------------------------------- -# Test functions -#----------------------------------------------------------------------------- - -class CallableIndexable(object): - def __getitem__(self, idx): return True - def __call__(self, *args, **kws): return True - - -class Autocallable(autocall.IPyAutocall): - def __call__(self): - return "called" - - -def run(tests): - """Loop through a list of (pre, post) inputs, where pre is the string - handed to ipython, and post is how that string looks after it's been - transformed (i.e. ipython's notion of _i)""" - tt.check_pairs(ip.prefilter_manager.prefilter_lines, tests) - - -def test_handlers(): - call_idx = CallableIndexable() - ip.user_ns['call_idx'] = call_idx - - # For many of the below, we're also checking that leading whitespace - # turns off the esc char, which it should unless there is a continuation - # line. - run( - [('"no change"', '"no change"'), # normal - (u"lsmagic", "get_ipython().run_line_magic('lsmagic', '')"), # magic - #("a = b # PYTHON-MODE", '_i'), # emacs -- avoids _in cache - ]) - - # Objects which are instances of IPyAutocall are *always* autocalled - autocallable = Autocallable() - ip.user_ns['autocallable'] = autocallable - - # auto - ip.run_line_magic("autocall", "0") - # Only explicit escapes or instances of IPyAutocallable should get - # expanded - run( - [ - ('len "abc"', 'len "abc"'), - ("autocallable", "autocallable()"), - # Don't add extra brackets (gh-1117) - ("autocallable()", "autocallable()"), - ] - ) - ip.run_line_magic("autocall", "1") - run( - [ - ('len "abc"', 'len("abc")'), - ('len "abc";', 'len("abc");'), # ; is special -- moves out of parens - # Autocall is turned off if first arg is [] and the object - # is both callable and indexable. Like so: - ("len [1,2]", "len([1,2])"), # len doesn't support __getitem__... - ("call_idx [1]", "call_idx [1]"), # call_idx *does*.. - ("call_idx 1", "call_idx(1)"), - ("len", "len"), # only at 2 does it auto-call on single args - ] - ) - ip.run_line_magic("autocall", "2") - run( - [ - ('len "abc"', 'len("abc")'), - ('len "abc";', 'len("abc");'), - ("len [1,2]", "len([1,2])"), - ("call_idx [1]", "call_idx [1]"), - ("call_idx 1", "call_idx(1)"), - # This is what's different: - ("len", "len()"), # only at 2 does it auto-call on single args - ] - ) - ip.run_line_magic("autocall", "1") - - assert failures == [] diff --git a/IPython/core/tests/test_history.py b/IPython/core/tests/test_history.py deleted file mode 100644 index 73d50c87d34..00000000000 --- a/IPython/core/tests/test_history.py +++ /dev/null @@ -1,229 +0,0 @@ -# coding: utf-8 -"""Tests for the IPython tab-completion machinery. -""" -#----------------------------------------------------------------------------- -# Module imports -#----------------------------------------------------------------------------- - -# stdlib -import io -import sqlite3 -import sys -import tempfile -from datetime import datetime -from pathlib import Path - -from tempfile import TemporaryDirectory -# our own packages -from traitlets.config.loader import Config - -from IPython.core.history import HistoryManager, extract_hist_ranges - - -def test_proper_default_encoding(): - assert sys.getdefaultencoding() == "utf-8" - -def test_history(): - ip = get_ipython() - with TemporaryDirectory() as tmpdir: - tmp_path = Path(tmpdir) - hist_manager_ori = ip.history_manager - hist_file = tmp_path / "history.sqlite" - try: - ip.history_manager = HistoryManager(shell=ip, hist_file=hist_file) - hist = ["a=1", "def f():\n test = 1\n return test", "b='€Æ¾÷ß'"] - for i, h in enumerate(hist, start=1): - ip.history_manager.store_inputs(i, h) - - ip.history_manager.db_log_output = True - # Doesn't match the input, but we'll just check it's stored. - ip.history_manager.output_hist_reprs[3] = "spam" - ip.history_manager.store_output(3) - - assert ip.history_manager.input_hist_raw == [""] + hist - - # Detailed tests for _get_range_session - grs = ip.history_manager._get_range_session - assert list(grs(start=2, stop=-1)) == list(zip([0], [2], hist[1:-1])) - assert list(grs(start=-2)) == list(zip([0, 0], [2, 3], hist[-2:])) - assert list(grs(output=True)) == list( - zip([0, 0, 0], [1, 2, 3], zip(hist, [None, None, "spam"])) - ) - - # Check whether specifying a range beyond the end of the current - # session results in an error (gh-804) - ip.run_line_magic("hist", "2-500") - - # Check that we can write non-ascii characters to a file - ip.run_line_magic("hist", "-f %s" % (tmp_path / "test1")) - ip.run_line_magic("hist", "-pf %s" % (tmp_path / "test2")) - ip.run_line_magic("hist", "-nf %s" % (tmp_path / "test3")) - ip.run_line_magic("save", "%s 1-10" % (tmp_path / "test4")) - - # New session - ip.history_manager.reset() - newcmds = ["z=5", "class X(object):\n pass", "k='p'", "z=5"] - for i, cmd in enumerate(newcmds, start=1): - ip.history_manager.store_inputs(i, cmd) - gothist = ip.history_manager.get_range(start=1, stop=4) - assert list(gothist) == list(zip([0, 0, 0], [1, 2, 3], newcmds)) - # Previous session: - gothist = ip.history_manager.get_range(-1, 1, 4) - assert list(gothist) == list(zip([1, 1, 1], [1, 2, 3], hist)) - - newhist = [(2, i, c) for (i, c) in enumerate(newcmds, 1)] - - # Check get_hist_tail - gothist = ip.history_manager.get_tail(5, output=True, - include_latest=True) - expected = [(1, 3, (hist[-1], "spam"))] \ - + [(s, n, (c, None)) for (s, n, c) in newhist] - assert list(gothist) == expected - - gothist = ip.history_manager.get_tail(2) - expected = newhist[-3:-1] - assert list(gothist) == expected - - # Check get_hist_search - - gothist = ip.history_manager.search("*test*") - assert list(gothist) == [(1, 2, hist[1])] - - gothist = ip.history_manager.search("*=*") - assert list(gothist) == [ - (1, 1, hist[0]), - (1, 2, hist[1]), - (1, 3, hist[2]), - newhist[0], - newhist[2], - newhist[3], - ] - - gothist = ip.history_manager.search("*=*", n=4) - assert list(gothist) == [ - (1, 3, hist[2]), - newhist[0], - newhist[2], - newhist[3], - ] - - gothist = ip.history_manager.search("*=*", unique=True) - assert list(gothist) == [ - (1, 1, hist[0]), - (1, 2, hist[1]), - (1, 3, hist[2]), - newhist[2], - newhist[3], - ] - - gothist = ip.history_manager.search("*=*", unique=True, n=3) - assert list(gothist) == [(1, 3, hist[2]), newhist[2], newhist[3]] - - gothist = ip.history_manager.search("b*", output=True) - assert list(gothist) == [(1, 3, (hist[2], "spam"))] - - # Cross testing: check that magic %save can get previous session. - testfilename = (tmp_path / "test.py").resolve() - ip.run_line_magic("save", str(testfilename) + " ~1/1-3") - with io.open(testfilename, encoding="utf-8") as testfile: - assert testfile.read() == "# coding: utf-8\n" + "\n".join(hist) + "\n" - - # Duplicate line numbers - check that it doesn't crash, and - # gets a new session - ip.history_manager.store_inputs(1, "rogue") - ip.history_manager.writeout_cache() - assert ip.history_manager.session_number == 3 - - # Check that session and line values are not just max values - sessid, lineno, entry = newhist[-1] - assert lineno > 1 - ip.history_manager.reset() - lineno = 1 - ip.history_manager.store_inputs(lineno, entry) - gothist = ip.history_manager.search("*=*", unique=True) - hist = list(gothist)[-1] - assert sessid < hist[0] - assert hist[1:] == (lineno, entry) - finally: - # Ensure saving thread is shut down before we try to clean up the files - ip.history_manager.save_thread.stop() - # Forcibly close database rather than relying on garbage collection - ip.history_manager.db.close() - # Restore history manager - ip.history_manager = hist_manager_ori - - -def test_extract_hist_ranges(): - instr = "1 2/3 ~4/5-6 ~4/7-~4/9 ~9/2-~7/5 ~10/" - expected = [(0, 1, 2), # 0 == current session - (2, 3, 4), - (-4, 5, 7), - (-4, 7, 10), - (-9, 2, None), # None == to end - (-8, 1, None), - (-7, 1, 6), - (-10, 1, None)] - actual = list(extract_hist_ranges(instr)) - assert actual == expected - - -def test_extract_hist_ranges_empty_str(): - instr = "" - expected = [(0, 1, None)] # 0 == current session, None == to end - actual = list(extract_hist_ranges(instr)) - assert actual == expected - - -def test_magic_rerun(): - """Simple test for %rerun (no args -> rerun last line)""" - ip = get_ipython() - ip.run_cell("a = 10", store_history=True) - ip.run_cell("a += 1", store_history=True) - assert ip.user_ns["a"] == 11 - ip.run_cell("%rerun", store_history=True) - assert ip.user_ns["a"] == 12 - -def test_timestamp_type(): - ip = get_ipython() - info = ip.history_manager.get_session_info() - assert isinstance(info[1], datetime) - -def test_hist_file_config(): - cfg = Config() - tfile = tempfile.NamedTemporaryFile(delete=False) - cfg.HistoryManager.hist_file = Path(tfile.name) - try: - hm = HistoryManager(shell=get_ipython(), config=cfg) - assert hm.hist_file == cfg.HistoryManager.hist_file - finally: - try: - Path(tfile.name).unlink() - except OSError: - # same catch as in testing.tools.TempFileMixin - # On Windows, even though we close the file, we still can't - # delete it. I have no clue why - pass - -def test_histmanager_disabled(): - """Ensure that disabling the history manager doesn't create a database.""" - cfg = Config() - cfg.HistoryAccessor.enabled = False - - ip = get_ipython() - with TemporaryDirectory() as tmpdir: - hist_manager_ori = ip.history_manager - hist_file = Path(tmpdir) / "history.sqlite" - cfg.HistoryManager.hist_file = hist_file - try: - ip.history_manager = HistoryManager(shell=ip, config=cfg) - hist = ["a=1", "def f():\n test = 1\n return test", "b='€Æ¾÷ß'"] - for i, h in enumerate(hist, start=1): - ip.history_manager.store_inputs(i, h) - assert ip.history_manager.input_hist_raw == [""] + hist - ip.history_manager.reset() - ip.history_manager.end_session() - finally: - ip.history_manager = hist_manager_ori - - # hist_file should not be created - assert hist_file.exists() is False diff --git a/IPython/core/tests/test_hooks.py b/IPython/core/tests/test_hooks.py deleted file mode 100644 index 6e0b1c152fa..00000000000 --- a/IPython/core/tests/test_hooks.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -"""Tests for CommandChainDispatcher.""" - - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -import pytest -from IPython.core.error import TryNext -from IPython.core.hooks import CommandChainDispatcher - -#----------------------------------------------------------------------------- -# Local utilities -#----------------------------------------------------------------------------- - -# Define two classes, one which succeeds and one which raises TryNext. Each -# sets the attribute `called` to True when it is called. -class Okay(object): - def __init__(self, message): - self.message = message - self.called = False - def __call__(self): - self.called = True - return self.message - -class Fail(object): - def __init__(self, message): - self.message = message - self.called = False - def __call__(self): - self.called = True - raise TryNext(self.message) - -#----------------------------------------------------------------------------- -# Test functions -#----------------------------------------------------------------------------- - -def test_command_chain_dispatcher_ff(): - """Test two failing hooks""" - fail1 = Fail("fail1") - fail2 = Fail("fail2") - dp = CommandChainDispatcher([(0, fail1), (10, fail2)]) - - with pytest.raises(TryNext) as e: - dp() - assert str(e.value) == "fail2" - - assert fail1.called is True - assert fail2.called is True - -def test_command_chain_dispatcher_fofo(): - """Test a mixture of failing and succeeding hooks.""" - fail1 = Fail("fail1") - fail2 = Fail("fail2") - okay1 = Okay("okay1") - okay2 = Okay("okay2") - - dp = CommandChainDispatcher([(0, fail1), - # (5, okay1), # add this later - (10, fail2), - (15, okay2)]) - dp.add(okay1, 5) - - assert dp() == "okay1" - - assert fail1.called is True - assert okay1.called is True - assert fail2.called is False - assert okay2.called is False - -def test_command_chain_dispatcher_eq_priority(): - okay1 = Okay(u'okay1') - okay2 = Okay(u'okay2') - dp = CommandChainDispatcher([(1, okay1)]) - dp.add(okay2, 1) diff --git a/IPython/core/tests/test_imports.py b/IPython/core/tests/test_imports.py deleted file mode 100644 index 7aa278fb63a..00000000000 --- a/IPython/core/tests/test_imports.py +++ /dev/null @@ -1,52 +0,0 @@ -# encoding: utf-8 - -def test_import_completer(): - from IPython.core import completer - -def test_import_crashhandler(): - from IPython.core import crashhandler - -def test_import_debugger(): - from IPython.core import debugger - -def test_import_excolors(): - from IPython.core import excolors - -def test_import_history(): - from IPython.core import history - -def test_import_hooks(): - from IPython.core import hooks - -def test_import_getipython(): - from IPython.core import getipython - -def test_import_interactiveshell(): - from IPython.core import interactiveshell - -def test_import_logger(): - from IPython.core import logger - -def test_import_macro(): - from IPython.core import macro - -def test_import_magic(): - from IPython.core import magic - -def test_import_oinspect(): - from IPython.core import oinspect - -def test_import_prefilter(): - from IPython.core import prefilter - -def test_import_prompts(): - from IPython.core import prompts - -def test_import_release(): - from IPython.core import release - -def test_import_ultratb(): - from IPython.core import ultratb - -def test_import_usage(): - from IPython.core import usage diff --git a/IPython/core/tests/test_inputsplitter.py b/IPython/core/tests/test_inputsplitter.py deleted file mode 100644 index 5a228957705..00000000000 --- a/IPython/core/tests/test_inputsplitter.py +++ /dev/null @@ -1,642 +0,0 @@ -# -*- coding: utf-8 -*- -"""Tests for the inputsplitter module.""" - - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - -import unittest -import pytest -import sys - -with pytest.warns(DeprecationWarning, match="inputsplitter"): - from IPython.core import inputsplitter as isp -from IPython.core.inputtransformer import InputTransformer -from IPython.core.tests.test_inputtransformer import syntax, syntax_ml -from IPython.testing import tools as tt - -#----------------------------------------------------------------------------- -# Semi-complete examples (also used as tests) -#----------------------------------------------------------------------------- - -# Note: at the bottom, there's a slightly more complete version of this that -# can be useful during development of code here. - -def mini_interactive_loop(input_func): - """Minimal example of the logic of an interactive interpreter loop. - - This serves as an example, and it is used by the test system with a fake - raw_input that simulates interactive input.""" - - from IPython.core.inputsplitter import InputSplitter - - isp = InputSplitter() - # In practice, this input loop would be wrapped in an outside loop to read - # input indefinitely, until some exit/quit command was issued. Here we - # only illustrate the basic inner loop. - while isp.push_accepts_more(): - indent = ' '*isp.get_indent_spaces() - prompt = '>>> ' + indent - line = indent + input_func(prompt) - isp.push(line) - - # Here we just return input so we can use it in a test suite, but a real - # interpreter would instead send it for execution somewhere. - src = isp.source_reset() - #print 'Input source was:\n', src # dbg - return src - -#----------------------------------------------------------------------------- -# Test utilities, just for local use -#----------------------------------------------------------------------------- - - -def pseudo_input(lines): - """Return a function that acts like raw_input but feeds the input list.""" - ilines = iter(lines) - def raw_in(prompt): - try: - return next(ilines) - except StopIteration: - return '' - return raw_in - -#----------------------------------------------------------------------------- -# Tests -#----------------------------------------------------------------------------- -def test_spaces(): - tests = [('', 0), - (' ', 1), - ('\n', 0), - (' \n', 1), - ('x', 0), - (' x', 1), - (' x',2), - (' x',4), - # Note: tabs are counted as a single whitespace! - ('\tx', 1), - ('\t x', 2), - ] - tt.check_pairs(isp.num_ini_spaces, tests) - - -def test_remove_comments(): - tests = [('text', 'text'), - ('text # comment', 'text '), - ('text # comment\n', 'text \n'), - ('text # comment \n', 'text \n'), - ('line # c \nline\n','line \nline\n'), - ('line # c \nline#c2 \nline\nline #c\n\n', - 'line \nline\nline\nline \n\n'), - ] - tt.check_pairs(isp.remove_comments, tests) - - -def test_get_input_encoding(): - encoding = isp.get_input_encoding() - assert isinstance(encoding, str) - # simple-minded check that at least encoding a simple string works with the - # encoding we got. - assert "test".encode(encoding) == b"test" - - -class NoInputEncodingTestCase(unittest.TestCase): - def setUp(self): - self.old_stdin = sys.stdin - class X: pass - fake_stdin = X() - sys.stdin = fake_stdin - - def test(self): - # Verify that if sys.stdin has no 'encoding' attribute we do the right - # thing - enc = isp.get_input_encoding() - self.assertEqual(enc, 'ascii') - - def tearDown(self): - sys.stdin = self.old_stdin - - -class InputSplitterTestCase(unittest.TestCase): - def setUp(self): - self.isp = isp.InputSplitter() - - def test_reset(self): - isp = self.isp - isp.push('x=1') - isp.reset() - self.assertEqual(isp._buffer, []) - self.assertEqual(isp.get_indent_spaces(), 0) - self.assertEqual(isp.source, '') - self.assertEqual(isp.code, None) - self.assertEqual(isp._is_complete, False) - - def test_source(self): - self.isp._store('1') - self.isp._store('2') - self.assertEqual(self.isp.source, '1\n2\n') - self.assertEqual(len(self.isp._buffer)>0, True) - self.assertEqual(self.isp.source_reset(), '1\n2\n') - self.assertEqual(self.isp._buffer, []) - self.assertEqual(self.isp.source, '') - - def test_indent(self): - isp = self.isp # shorthand - isp.push('x=1') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n x=1') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('y=2\n') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_indent2(self): - isp = self.isp - isp.push('if 1:') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push(' x=1') - self.assertEqual(isp.get_indent_spaces(), 4) - # Blank lines shouldn't change the indent level - isp.push(' '*2) - self.assertEqual(isp.get_indent_spaces(), 4) - - def test_indent3(self): - isp = self.isp - # When a multiline statement contains parens or multiline strings, we - # shouldn't get confused. - isp.push("if 1:") - isp.push(" x = (1+\n 2)") - self.assertEqual(isp.get_indent_spaces(), 4) - - def test_indent4(self): - isp = self.isp - # whitespace after ':' should not screw up indent level - isp.push('if 1: \n x=1') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('y=2\n') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\t\n x=1') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('y=2\n') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_dedent_pass(self): - isp = self.isp # shorthand - # should NOT cause dedent - isp.push('if 1:\n passes = 5') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('if 1:\n pass') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n pass ') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_dedent_break(self): - isp = self.isp # shorthand - # should NOT cause dedent - isp.push('while 1:\n breaks = 5') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('while 1:\n break') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('while 1:\n break ') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_dedent_continue(self): - isp = self.isp # shorthand - # should NOT cause dedent - isp.push('while 1:\n continues = 5') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('while 1:\n continue') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('while 1:\n continue ') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_dedent_raise(self): - isp = self.isp # shorthand - # should NOT cause dedent - isp.push('if 1:\n raised = 4') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('if 1:\n raise TypeError()') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n raise') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n raise ') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_dedent_return(self): - isp = self.isp # shorthand - # should NOT cause dedent - isp.push('if 1:\n returning = 4') - self.assertEqual(isp.get_indent_spaces(), 4) - isp.push('if 1:\n return 5 + 493') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n return') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n return ') - self.assertEqual(isp.get_indent_spaces(), 0) - isp.push('if 1:\n return(0)') - self.assertEqual(isp.get_indent_spaces(), 0) - - def test_push(self): - isp = self.isp - self.assertEqual(isp.push('x=1'), True) - - def test_push2(self): - isp = self.isp - self.assertEqual(isp.push('if 1:'), False) - for line in [' x=1', '# a comment', ' y=2']: - print(line) - self.assertEqual(isp.push(line), True) - - def test_push3(self): - isp = self.isp - isp.push('if True:') - isp.push(' a = 1') - self.assertEqual(isp.push('b = [1,'), False) - - def test_push_accepts_more(self): - isp = self.isp - isp.push('x=1') - self.assertEqual(isp.push_accepts_more(), False) - - def test_push_accepts_more2(self): - isp = self.isp - isp.push('if 1:') - self.assertEqual(isp.push_accepts_more(), True) - isp.push(' x=1') - self.assertEqual(isp.push_accepts_more(), True) - isp.push('') - self.assertEqual(isp.push_accepts_more(), False) - - def test_push_accepts_more3(self): - isp = self.isp - isp.push("x = (2+\n3)") - self.assertEqual(isp.push_accepts_more(), False) - - def test_push_accepts_more4(self): - isp = self.isp - # When a multiline statement contains parens or multiline strings, we - # shouldn't get confused. - # FIXME: we should be able to better handle de-dents in statements like - # multiline strings and multiline expressions (continued with \ or - # parens). Right now we aren't handling the indentation tracking quite - # correctly with this, though in practice it may not be too much of a - # problem. We'll need to see. - isp.push("if 1:") - isp.push(" x = (2+") - isp.push(" 3)") - self.assertEqual(isp.push_accepts_more(), True) - isp.push(" y = 3") - self.assertEqual(isp.push_accepts_more(), True) - isp.push('') - self.assertEqual(isp.push_accepts_more(), False) - - def test_push_accepts_more5(self): - isp = self.isp - isp.push('try:') - isp.push(' a = 5') - isp.push('except:') - isp.push(' raise') - # We want to be able to add an else: block at this point, so it should - # wait for a blank line. - self.assertEqual(isp.push_accepts_more(), True) - - def test_continuation(self): - isp = self.isp - isp.push("import os, \\") - self.assertEqual(isp.push_accepts_more(), True) - isp.push("sys") - self.assertEqual(isp.push_accepts_more(), False) - - def test_syntax_error(self): - isp = self.isp - # Syntax errors immediately produce a 'ready' block, so the invalid - # Python can be sent to the kernel for evaluation with possible ipython - # special-syntax conversion. - isp.push('run foo') - self.assertEqual(isp.push_accepts_more(), False) - - def test_unicode(self): - self.isp.push(u"Pérez") - self.isp.push(u'\xc3\xa9') - self.isp.push(u"u'\xc3\xa9'") - - @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_line_continuation(self): - """ Test issue #2108.""" - isp = self.isp - # A blank line after a line continuation should not accept more - isp.push("1 \\\n\n") - self.assertEqual(isp.push_accepts_more(), False) - # Whitespace after a \ is a SyntaxError. The only way to test that - # here is to test that push doesn't accept more (as with - # test_syntax_error() above). - isp.push(r"1 \ ") - self.assertEqual(isp.push_accepts_more(), False) - # Even if the line is continuable (c.f. the regular Python - # interpreter) - isp.push(r"(1 \ ") - self.assertEqual(isp.push_accepts_more(), False) - - def test_check_complete(self): - isp = self.isp - self.assertEqual(isp.check_complete("a = 1"), ('complete', None)) - self.assertEqual(isp.check_complete("for a in range(5):"), ('incomplete', 4)) - self.assertEqual(isp.check_complete("raise = 2"), ('invalid', None)) - self.assertEqual(isp.check_complete("a = [1,\n2,"), ('incomplete', 0)) - self.assertEqual(isp.check_complete("def a():\n x=1\n global x"), ('invalid', None)) - -class InteractiveLoopTestCase(unittest.TestCase): - """Tests for an interactive loop like a python shell. - """ - def check_ns(self, lines, ns): - """Validate that the given input lines produce the resulting namespace. - - Note: the input lines are given exactly as they would be typed in an - auto-indenting environment, as mini_interactive_loop above already does - auto-indenting and prepends spaces to the input. - """ - src = mini_interactive_loop(pseudo_input(lines)) - test_ns = {} - exec(src, test_ns) - # We can't check that the provided ns is identical to the test_ns, - # because Python fills test_ns with extra keys (copyright, etc). But - # we can check that the given dict is *contained* in test_ns - for k,v in ns.items(): - self.assertEqual(test_ns[k], v) - - def test_simple(self): - self.check_ns(['x=1'], dict(x=1)) - - def test_simple2(self): - self.check_ns(['if 1:', 'x=2'], dict(x=2)) - - def test_xy(self): - self.check_ns(['x=1; y=2'], dict(x=1, y=2)) - - def test_abc(self): - self.check_ns(['if 1:','a=1','b=2','c=3'], dict(a=1, b=2, c=3)) - - def test_multi(self): - self.check_ns(['x =(1+','1+','2)'], dict(x=4)) - - -class IPythonInputTestCase(InputSplitterTestCase): - """By just creating a new class whose .isp is a different instance, we - re-run the same test battery on the new input splitter. - - In addition, this runs the tests over the syntax and syntax_ml dicts that - were tested by individual functions, as part of the OO interface. - - It also makes some checks on the raw buffer storage. - """ - - def setUp(self): - self.isp = isp.IPythonInputSplitter() - - def test_syntax(self): - """Call all single-line syntax tests from the main object""" - isp = self.isp - for example in syntax.values(): - for raw, out_t in example: - if raw.startswith(' '): - continue - - isp.push(raw+'\n') - out_raw = isp.source_raw - out = isp.source_reset() - self.assertEqual(out.rstrip(), out_t, - tt.pair_fail_msg.format("inputsplitter",raw, out_t, out)) - self.assertEqual(out_raw.rstrip(), raw.rstrip()) - - def test_syntax_multiline(self): - isp = self.isp - for example in syntax_ml.values(): - for line_pairs in example: - out_t_parts = [] - raw_parts = [] - for lraw, out_t_part in line_pairs: - if out_t_part is not None: - out_t_parts.append(out_t_part) - - if lraw is not None: - isp.push(lraw) - raw_parts.append(lraw) - - out_raw = isp.source_raw - out = isp.source_reset() - out_t = '\n'.join(out_t_parts).rstrip() - raw = '\n'.join(raw_parts).rstrip() - self.assertEqual(out.rstrip(), out_t) - self.assertEqual(out_raw.rstrip(), raw) - - def test_syntax_multiline_cell(self): - isp = self.isp - for example in syntax_ml.values(): - - out_t_parts = [] - for line_pairs in example: - raw = '\n'.join(r for r, _ in line_pairs if r is not None) - out_t = '\n'.join(t for _,t in line_pairs if t is not None) - out = isp.transform_cell(raw) - # Match ignoring trailing whitespace - self.assertEqual(out.rstrip(), out_t.rstrip()) - - def test_cellmagic_preempt(self): - isp = self.isp - for raw, name, line, cell in [ - ("%%cellm a\nIn[1]:", u'cellm', u'a', u'In[1]:'), - ("%%cellm \nline\n>>> hi", u'cellm', u'', u'line\n>>> hi'), - (">>> %%cellm \nline\n>>> hi", u'cellm', u'', u'line\nhi'), - ("%%cellm \n>>> hi", u'cellm', u'', u'>>> hi'), - ("%%cellm \nline1\nline2", u'cellm', u'', u'line1\nline2'), - ("%%cellm \nline1\\\\\nline2", u'cellm', u'', u'line1\\\\\nline2'), - ]: - expected = "get_ipython().run_cell_magic(%r, %r, %r)" % ( - name, line, cell - ) - out = isp.transform_cell(raw) - self.assertEqual(out.rstrip(), expected.rstrip()) - - def test_multiline_passthrough(self): - isp = self.isp - class CommentTransformer(InputTransformer): - def __init__(self): - self._lines = [] - - def push(self, line): - self._lines.append(line + '#') - - def reset(self): - text = '\n'.join(self._lines) - self._lines = [] - return text - - isp.physical_line_transforms.insert(0, CommentTransformer()) - - for raw, expected in [ - ("a=5", "a=5#"), - ("%ls foo", "get_ipython().run_line_magic(%r, %r)" % (u'ls', u'foo#')), - ("!ls foo\n%ls bar", "get_ipython().system(%r)\nget_ipython().run_line_magic(%r, %r)" % ( - u'ls foo#', u'ls', u'bar#' - )), - ("1\n2\n3\n%ls foo\n4\n5", "1#\n2#\n3#\nget_ipython().run_line_magic(%r, %r)\n4#\n5#" % (u'ls', u'foo#')), - ]: - out = isp.transform_cell(raw) - self.assertEqual(out.rstrip(), expected.rstrip()) - -#----------------------------------------------------------------------------- -# Main - use as a script, mostly for developer experiments -#----------------------------------------------------------------------------- - -if __name__ == '__main__': - # A simple demo for interactive experimentation. This code will not get - # picked up by any test suite. - from IPython.core.inputsplitter import IPythonInputSplitter - - # configure here the syntax to use, prompt and whether to autoindent - #isp, start_prompt = InputSplitter(), '>>> ' - isp, start_prompt = IPythonInputSplitter(), 'In> ' - - autoindent = True - #autoindent = False - - try: - while True: - prompt = start_prompt - while isp.push_accepts_more(): - indent = ' '*isp.get_indent_spaces() - if autoindent: - line = indent + input(prompt+indent) - else: - line = input(prompt) - isp.push(line) - prompt = '... ' - - # Here we just return input so we can use it in a test suite, but a - # real interpreter would instead send it for execution somewhere. - #src = isp.source; raise EOFError # dbg - raw = isp.source_raw - src = isp.source_reset() - print('Input source was:\n', src) - print('Raw source was:\n', raw) - except EOFError: - print('Bye') - -# Tests for cell magics support - -def test_last_blank(): - assert isp.last_blank("") is False - assert isp.last_blank("abc") is False - assert isp.last_blank("abc\n") is False - assert isp.last_blank("abc\na") is False - - assert isp.last_blank("\n") is True - assert isp.last_blank("\n ") is True - assert isp.last_blank("abc\n ") is True - assert isp.last_blank("abc\n\n") is True - assert isp.last_blank("abc\nd\n\n") is True - assert isp.last_blank("abc\nd\ne\n\n") is True - assert isp.last_blank("abc \n \n \n\n") is True - - -def test_last_two_blanks(): - assert isp.last_two_blanks("") is False - assert isp.last_two_blanks("abc") is False - assert isp.last_two_blanks("abc\n") is False - assert isp.last_two_blanks("abc\n\na") is False - assert isp.last_two_blanks("abc\n \n") is False - assert isp.last_two_blanks("abc\n\n") is False - - assert isp.last_two_blanks("\n\n") is True - assert isp.last_two_blanks("\n\n ") is True - assert isp.last_two_blanks("\n \n") is True - assert isp.last_two_blanks("abc\n\n ") is True - assert isp.last_two_blanks("abc\n\n\n") is True - assert isp.last_two_blanks("abc\n\n \n") is True - assert isp.last_two_blanks("abc\n\n \n ") is True - assert isp.last_two_blanks("abc\n\n \n \n") is True - assert isp.last_two_blanks("abc\nd\n\n\n") is True - assert isp.last_two_blanks("abc\nd\ne\nf\n\n\n") is True - - -class CellMagicsCommon(object): - - def test_whole_cell(self): - src = "%%cellm line\nbody\n" - out = self.sp.transform_cell(src) - ref = "get_ipython().run_cell_magic('cellm', 'line', 'body')\n" - assert out == ref - - def test_cellmagic_help(self): - self.sp.push('%%cellm?') - assert self.sp.push_accepts_more() is False - - def tearDown(self): - self.sp.reset() - - -class CellModeCellMagics(CellMagicsCommon, unittest.TestCase): - sp = isp.IPythonInputSplitter(line_input_checker=False) - - def test_incremental(self): - sp = self.sp - sp.push("%%cellm firstline\n") - assert sp.push_accepts_more() is True # 1 - sp.push("line2\n") - assert sp.push_accepts_more() is True # 2 - sp.push("\n") - # This should accept a blank line and carry on until the cell is reset - assert sp.push_accepts_more() is True # 3 - - def test_no_strip_coding(self): - src = '\n'.join([ - '%%writefile foo.py', - '# coding: utf-8', - 'print(u"üñîçø∂é")', - ]) - out = self.sp.transform_cell(src) - assert "# coding: utf-8" in out - - -class LineModeCellMagics(CellMagicsCommon, unittest.TestCase): - sp = isp.IPythonInputSplitter(line_input_checker=True) - - def test_incremental(self): - sp = self.sp - sp.push("%%cellm line2\n") - assert sp.push_accepts_more() is True # 1 - sp.push("\n") - # In this case, a blank line should end the cell magic - assert sp.push_accepts_more() is False # 2 - - -indentation_samples = [ - ('a = 1', 0), - ('for a in b:', 4), - ('def f():', 4), - ('def f(): #comment', 4), - ('a = ":#not a comment"', 0), - ('def f():\n a = 1', 4), - ('def f():\n return 1', 0), - ('for a in b:\n' - ' if a < 0:' - ' continue', 3), - ('a = {', 4), - ('a = {\n' - ' 1,', 5), - ('b = """123', 0), - ('', 0), - ('def f():\n pass', 0), - ('class Bar:\n def f():\n pass', 4), - ('class Bar:\n def f():\n raise', 4), -] - -def test_find_next_indent(): - for code, exp in indentation_samples: - res = isp.find_next_indent(code) - msg = "{!r} != {!r} (expected)\n Code: {!r}".format(res, exp, code) - assert res == exp, msg diff --git a/IPython/core/tests/test_inputtransformer.py b/IPython/core/tests/test_inputtransformer.py deleted file mode 100644 index bfc936d3176..00000000000 --- a/IPython/core/tests/test_inputtransformer.py +++ /dev/null @@ -1,469 +0,0 @@ -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().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) diff --git a/IPython/core/tests/test_inputtransformer2_line.py b/IPython/core/tests/test_inputtransformer2_line.py deleted file mode 100644 index 30558fd7e25..00000000000 --- a/IPython/core/tests/test_inputtransformer2_line.py +++ /dev/null @@ -1,168 +0,0 @@ -"""Tests for the line-based transformers in IPython.core.inputtransformer2 - -Line-based transformers are the simpler ones; token-based transformers are -more complex. See test_inputtransformer2 for tests for token-based transformers. -""" -import pytest - -from IPython.core import inputtransformer2 as ipt2 - -CELL_MAGIC = ("""\ -%%foo arg -body 1 -body 2 -""", """\ -get_ipython().run_cell_magic('foo', 'arg', 'body 1\\nbody 2\\n') -""") - -def test_cell_magic(): - for sample, expected in [CELL_MAGIC]: - assert ipt2.cell_magic(sample.splitlines(keepends=True)) == expected.splitlines( - keepends=True - ) - -CLASSIC_PROMPT = ("""\ ->>> for a in range(5): -... print(a) -""", """\ -for a in range(5): - print(a) -""") - -CLASSIC_PROMPT_L2 = ("""\ -for a in range(5): -... print(a) -... print(a ** 2) -""", """\ -for a in range(5): - print(a) - print(a ** 2) -""") - -def test_classic_prompt(): - for sample, expected in [CLASSIC_PROMPT, CLASSIC_PROMPT_L2]: - assert ipt2.classic_prompt( - sample.splitlines(keepends=True) - ) == expected.splitlines(keepends=True) - -IPYTHON_PROMPT = ("""\ -In [1]: for a in range(5): - ...: print(a) -""", """\ -for a in range(5): - print(a) -""") - -IPYTHON_PROMPT_L2 = ("""\ -for a in range(5): - ...: print(a) - ...: print(a ** 2) -""", """\ -for a in range(5): - print(a) - print(a ** 2) -""") - - -IPYTHON_PROMPT_VI_INS = ( - """\ -[ins] In [11]: def a(): - ...: 123 - ...: - ...: 123 -""", - """\ -def a(): - 123 - -123 -""", -) - -IPYTHON_PROMPT_VI_NAV = ( - """\ -[nav] In [11]: def a(): - ...: 123 - ...: - ...: 123 -""", - """\ -def a(): - 123 - -123 -""", -) - - -def test_ipython_prompt(): - for sample, expected in [ - IPYTHON_PROMPT, - IPYTHON_PROMPT_L2, - IPYTHON_PROMPT_VI_INS, - IPYTHON_PROMPT_VI_NAV, - ]: - assert ipt2.ipython_prompt( - sample.splitlines(keepends=True) - ) == expected.splitlines(keepends=True) - - -INDENT_SPACES = ("""\ - if True: - a = 3 -""", """\ -if True: - a = 3 -""") - -INDENT_TABS = ("""\ -\tif True: -\t\tb = 4 -""", """\ -if True: -\tb = 4 -""") - -def test_leading_indent(): - for sample, expected in [INDENT_SPACES, INDENT_TABS]: - assert ipt2.leading_indent( - sample.splitlines(keepends=True) - ) == expected.splitlines(keepends=True) - -LEADING_EMPTY_LINES = ("""\ - \t - -if True: - a = 3 - -b = 4 -""", """\ -if True: - a = 3 - -b = 4 -""") - -ONLY_EMPTY_LINES = ("""\ - \t - -""", """\ - \t - -""") - -def test_leading_empty_lines(): - for sample, expected in [LEADING_EMPTY_LINES, ONLY_EMPTY_LINES]: - assert ipt2.leading_empty_lines( - sample.splitlines(keepends=True) - ) == expected.splitlines(keepends=True) - -CRLF_MAGIC = ([ - "%%ls\r\n" -], [ - "get_ipython().run_cell_magic('ls', '', '')\n" -]) - -def test_crlf_magic(): - for sample, expected in [CRLF_MAGIC]: - assert ipt2.cell_magic(sample) == expected diff --git a/IPython/core/tests/test_interactiveshell.py b/IPython/core/tests/test_interactiveshell.py deleted file mode 100644 index 10cce1fd646..00000000000 --- a/IPython/core/tests/test_interactiveshell.py +++ /dev/null @@ -1,1100 +0,0 @@ -# -*- coding: utf-8 -*- -"""Tests for the key interactiveshell module. - -Historically the main classes in interactiveshell have been under-tested. This -module should grow as many single-method tests as possible to trap many of the -recurring bugs we seem to encounter with high-level interaction. -""" - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - -import asyncio -import ast -import os -import signal -import shutil -import sys -import tempfile -import unittest -from unittest import mock - -from os.path import join - -from IPython.core.error import InputRejected -from IPython.core.inputtransformer import InputTransformer -from IPython.core import interactiveshell -from IPython.testing.decorators import ( - skipif, skip_win32, onlyif_unicode_paths, onlyif_cmds_exist, -) -from IPython.testing import tools as tt -from IPython.utils.process import find_cmd - -#----------------------------------------------------------------------------- -# Globals -#----------------------------------------------------------------------------- -# This is used by every single test, no point repeating it ad nauseam - -#----------------------------------------------------------------------------- -# Tests -#----------------------------------------------------------------------------- - -class DerivedInterrupt(KeyboardInterrupt): - pass - -class InteractiveShellTestCase(unittest.TestCase): - def test_naked_string_cells(self): - """Test that cells with only naked strings are fully executed""" - # First, single-line inputs - ip.run_cell('"a"\n') - self.assertEqual(ip.user_ns['_'], 'a') - # And also multi-line cells - ip.run_cell('"""a\nb"""\n') - self.assertEqual(ip.user_ns['_'], 'a\nb') - - def test_run_empty_cell(self): - """Just make sure we don't get a horrible error with a blank - cell of input. Yes, I did overlook that.""" - old_xc = ip.execution_count - res = ip.run_cell('') - self.assertEqual(ip.execution_count, old_xc) - self.assertEqual(res.execution_count, None) - - def test_run_cell_multiline(self): - """Multi-block, multi-line cells must execute correctly. - """ - src = '\n'.join(["x=1", - "y=2", - "if 1:", - " x += 1", - " y += 1",]) - res = ip.run_cell(src) - self.assertEqual(ip.user_ns['x'], 2) - self.assertEqual(ip.user_ns['y'], 3) - self.assertEqual(res.success, True) - self.assertEqual(res.result, None) - - def test_multiline_string_cells(self): - "Code sprinkled with multiline strings should execute (GH-306)" - ip.run_cell('tmp=0') - self.assertEqual(ip.user_ns['tmp'], 0) - res = ip.run_cell('tmp=1;"""a\nb"""\n') - self.assertEqual(ip.user_ns['tmp'], 1) - self.assertEqual(res.success, True) - self.assertEqual(res.result, "a\nb") - - def test_dont_cache_with_semicolon(self): - "Ending a line with semicolon should not cache the returned object (GH-307)" - oldlen = len(ip.user_ns['Out']) - for cell in ['1;', '1;1;']: - res = ip.run_cell(cell, store_history=True) - newlen = len(ip.user_ns['Out']) - self.assertEqual(oldlen, newlen) - self.assertIsNone(res.result) - i = 0 - #also test the default caching behavior - for cell in ['1', '1;1']: - ip.run_cell(cell, store_history=True) - newlen = len(ip.user_ns['Out']) - i += 1 - self.assertEqual(oldlen+i, newlen) - - def test_syntax_error(self): - res = ip.run_cell("raise = 3") - self.assertIsInstance(res.error_before_exec, SyntaxError) - - def test_In_variable(self): - "Verify that In variable grows with user input (GH-284)" - oldlen = len(ip.user_ns['In']) - ip.run_cell('1;', store_history=True) - newlen = len(ip.user_ns['In']) - self.assertEqual(oldlen+1, newlen) - self.assertEqual(ip.user_ns['In'][-1],'1;') - - def test_magic_names_in_string(self): - ip.run_cell('a = """\n%exit\n"""') - self.assertEqual(ip.user_ns['a'], '\n%exit\n') - - def test_trailing_newline(self): - """test that running !(command) does not raise a SyntaxError""" - ip.run_cell('!(true)\n', False) - ip.run_cell('!(true)\n\n\n', False) - - def test_gh_597(self): - """Pretty-printing lists of objects with non-ascii reprs may cause - problems.""" - class Spam(object): - def __repr__(self): - return "\xe9"*50 - import IPython.core.formatters - f = IPython.core.formatters.PlainTextFormatter() - f([Spam(),Spam()]) - - - def test_future_flags(self): - """Check that future flags are used for parsing code (gh-777)""" - ip.run_cell('from __future__ import barry_as_FLUFL') - try: - ip.run_cell('prfunc_return_val = 1 <> 2') - assert 'prfunc_return_val' in ip.user_ns - finally: - # Reset compiler flags so we don't mess up other tests. - ip.compile.reset_compiler_flags() - - def test_can_pickle(self): - "Can we pickle objects defined interactively (GH-29)" - ip = get_ipython() - ip.reset() - ip.run_cell(("class Mylist(list):\n" - " def __init__(self,x=[]):\n" - " list.__init__(self,x)")) - ip.run_cell("w=Mylist([1,2,3])") - - from pickle import dumps - - # We need to swap in our main module - this is only necessary - # inside the test framework, because IPython puts the interactive module - # in place (but the test framework undoes this). - _main = sys.modules['__main__'] - sys.modules['__main__'] = ip.user_module - try: - res = dumps(ip.user_ns["w"]) - finally: - sys.modules['__main__'] = _main - self.assertTrue(isinstance(res, bytes)) - - def test_global_ns(self): - "Code in functions must be able to access variables outside them." - ip = get_ipython() - ip.run_cell("a = 10") - ip.run_cell(("def f(x):\n" - " return x + a")) - ip.run_cell("b = f(12)") - self.assertEqual(ip.user_ns["b"], 22) - - def test_bad_custom_tb(self): - """Check that InteractiveShell is protected from bad custom exception handlers""" - ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0) - self.assertEqual(ip.custom_exceptions, (IOError,)) - with tt.AssertPrints("Custom TB Handler failed", channel='stderr'): - ip.run_cell(u'raise IOError("foo")') - self.assertEqual(ip.custom_exceptions, ()) - - def test_bad_custom_tb_return(self): - """Check that InteractiveShell is protected from bad return types in custom exception handlers""" - ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1) - self.assertEqual(ip.custom_exceptions, (NameError,)) - with tt.AssertPrints("Custom TB Handler failed", channel='stderr'): - ip.run_cell(u'a=abracadabra') - self.assertEqual(ip.custom_exceptions, ()) - - def test_drop_by_id(self): - myvars = {"a":object(), "b":object(), "c": object()} - ip.push(myvars, interactive=False) - for name in myvars: - assert name in ip.user_ns, name - assert name in ip.user_ns_hidden, name - ip.user_ns['b'] = 12 - ip.drop_by_id(myvars) - for name in ["a", "c"]: - assert name not in ip.user_ns, name - assert name not in ip.user_ns_hidden, name - assert ip.user_ns['b'] == 12 - ip.reset() - - def test_var_expand(self): - ip.user_ns['f'] = u'Ca\xf1o' - self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o') - self.assertEqual(ip.var_expand(u'echo {f}'), u'echo Ca\xf1o') - self.assertEqual(ip.var_expand(u'echo {f[:-1]}'), u'echo Ca\xf1') - self.assertEqual(ip.var_expand(u'echo {1*2}'), u'echo 2') - - self.assertEqual(ip.var_expand(u"grep x | awk '{print $1}'"), u"grep x | awk '{print $1}'") - - ip.user_ns['f'] = b'Ca\xc3\xb1o' - # This should not raise any exception: - ip.var_expand(u'echo $f') - - def test_var_expand_local(self): - """Test local variable expansion in !system and %magic calls""" - # !system - ip.run_cell( - "def test():\n" - ' lvar = "ttt"\n' - " ret = !echo {lvar}\n" - " return ret[0]\n" - ) - res = ip.user_ns["test"]() - self.assertIn("ttt", res) - - # %magic - ip.run_cell( - "def makemacro():\n" - ' macroname = "macro_var_expand_locals"\n' - " %macro {macroname} codestr\n" - ) - ip.user_ns["codestr"] = "str(12)" - ip.run_cell("makemacro()") - self.assertIn("macro_var_expand_locals", ip.user_ns) - - def test_var_expand_self(self): - """Test variable expansion with the name 'self', which was failing. - - See https://github.com/ipython/ipython/issues/1878#issuecomment-7698218 - """ - ip.run_cell( - "class cTest:\n" - ' classvar="see me"\n' - " def test(self):\n" - " res = !echo Variable: {self.classvar}\n" - " return res[0]\n" - ) - self.assertIn("see me", ip.user_ns["cTest"]().test()) - - def test_bad_var_expand(self): - """var_expand on invalid formats shouldn't raise""" - # SyntaxError - self.assertEqual(ip.var_expand(u"{'a':5}"), u"{'a':5}") - # NameError - self.assertEqual(ip.var_expand(u"{asdf}"), u"{asdf}") - # ZeroDivisionError - self.assertEqual(ip.var_expand(u"{1/0}"), u"{1/0}") - - def test_silent_postexec(self): - """run_cell(silent=True) doesn't invoke pre/post_run_cell callbacks""" - pre_explicit = mock.Mock() - pre_always = mock.Mock() - post_explicit = mock.Mock() - post_always = mock.Mock() - all_mocks = [pre_explicit, pre_always, post_explicit, post_always] - - ip.events.register('pre_run_cell', pre_explicit) - ip.events.register('pre_execute', pre_always) - ip.events.register('post_run_cell', post_explicit) - ip.events.register('post_execute', post_always) - - try: - ip.run_cell("1", silent=True) - assert pre_always.called - assert not pre_explicit.called - assert post_always.called - assert not post_explicit.called - # double-check that non-silent exec did what we expected - # silent to avoid - ip.run_cell("1") - assert pre_explicit.called - assert post_explicit.called - info, = pre_explicit.call_args[0] - result, = post_explicit.call_args[0] - self.assertEqual(info, result.info) - # check that post hooks are always called - [m.reset_mock() for m in all_mocks] - ip.run_cell("syntax error") - assert pre_always.called - assert pre_explicit.called - assert post_always.called - assert post_explicit.called - info, = pre_explicit.call_args[0] - result, = post_explicit.call_args[0] - self.assertEqual(info, result.info) - finally: - # remove post-exec - ip.events.unregister('pre_run_cell', pre_explicit) - ip.events.unregister('pre_execute', pre_always) - ip.events.unregister('post_run_cell', post_explicit) - ip.events.unregister('post_execute', post_always) - - def test_silent_noadvance(self): - """run_cell(silent=True) doesn't advance execution_count""" - ec = ip.execution_count - # silent should force store_history=False - ip.run_cell("1", store_history=True, silent=True) - - self.assertEqual(ec, ip.execution_count) - # double-check that non-silent exec did what we expected - # silent to avoid - ip.run_cell("1", store_history=True) - self.assertEqual(ec+1, ip.execution_count) - - def test_silent_nodisplayhook(self): - """run_cell(silent=True) doesn't trigger displayhook""" - d = dict(called=False) - - trap = ip.display_trap - save_hook = trap.hook - - def failing_hook(*args, **kwargs): - d['called'] = True - - try: - trap.hook = failing_hook - res = ip.run_cell("1", silent=True) - self.assertFalse(d['called']) - self.assertIsNone(res.result) - # double-check that non-silent exec did what we expected - # silent to avoid - ip.run_cell("1") - self.assertTrue(d['called']) - finally: - trap.hook = save_hook - - def test_ofind_line_magic(self): - from IPython.core.magic import register_line_magic - - @register_line_magic - def lmagic(line): - "A line magic" - - # Get info on line magic - lfind = ip._ofind("lmagic") - info = dict( - found=True, - isalias=False, - ismagic=True, - namespace="IPython internal", - obj=lmagic, - parent=None, - ) - self.assertEqual(lfind, info) - - def test_ofind_cell_magic(self): - from IPython.core.magic import register_cell_magic - - @register_cell_magic - def cmagic(line, cell): - "A cell magic" - - # Get info on cell magic - find = ip._ofind("cmagic") - info = dict( - found=True, - isalias=False, - ismagic=True, - namespace="IPython internal", - obj=cmagic, - parent=None, - ) - self.assertEqual(find, info) - - def test_ofind_property_with_error(self): - class A(object): - @property - def foo(self): - raise NotImplementedError() # pragma: no cover - - a = A() - - found = ip._ofind('a.foo', [('locals', locals())]) - info = dict(found=True, isalias=False, ismagic=False, - namespace='locals', obj=A.foo, parent=a) - self.assertEqual(found, info) - - def test_ofind_multiple_attribute_lookups(self): - class A(object): - @property - def foo(self): - raise NotImplementedError() # pragma: no cover - - a = A() - a.a = A() - a.a.a = A() - - found = ip._ofind('a.a.a.foo', [('locals', locals())]) - info = dict(found=True, isalias=False, ismagic=False, - namespace='locals', obj=A.foo, parent=a.a.a) - self.assertEqual(found, info) - - def test_ofind_slotted_attributes(self): - class A(object): - __slots__ = ['foo'] - def __init__(self): - self.foo = 'bar' - - a = A() - found = ip._ofind('a.foo', [('locals', locals())]) - info = dict(found=True, isalias=False, ismagic=False, - namespace='locals', obj=a.foo, parent=a) - self.assertEqual(found, info) - - found = ip._ofind('a.bar', [('locals', locals())]) - info = dict(found=False, isalias=False, ismagic=False, - namespace=None, obj=None, parent=a) - self.assertEqual(found, info) - - def test_ofind_prefers_property_to_instance_level_attribute(self): - class A(object): - @property - def foo(self): - return 'bar' - a = A() - a.__dict__["foo"] = "baz" - self.assertEqual(a.foo, "bar") - found = ip._ofind("a.foo", [("locals", locals())]) - self.assertIs(found["obj"], A.foo) - - def test_custom_syntaxerror_exception(self): - called = [] - def my_handler(shell, etype, value, tb, tb_offset=None): - called.append(etype) - shell.showtraceback((etype, value, tb), tb_offset=tb_offset) - - ip.set_custom_exc((SyntaxError,), my_handler) - try: - ip.run_cell("1f") - # Check that this was called, and only once. - self.assertEqual(called, [SyntaxError]) - finally: - # Reset the custom exception hook - ip.set_custom_exc((), None) - - def test_custom_exception(self): - called = [] - def my_handler(shell, etype, value, tb, tb_offset=None): - called.append(etype) - shell.showtraceback((etype, value, tb), tb_offset=tb_offset) - - ip.set_custom_exc((ValueError,), my_handler) - try: - res = ip.run_cell("raise ValueError('test')") - # Check that this was called, and only once. - self.assertEqual(called, [ValueError]) - # Check that the error is on the result object - self.assertIsInstance(res.error_in_exec, ValueError) - finally: - # Reset the custom exception hook - ip.set_custom_exc((), None) - - @mock.patch("builtins.print") - def test_showtraceback_with_surrogates(self, mocked_print): - values = [] - - def mock_print_func(value, sep=" ", end="\n", file=sys.stdout, flush=False): - values.append(value) - if value == chr(0xD8FF): - raise UnicodeEncodeError("utf-8", chr(0xD8FF), 0, 1, "") - - # mock builtins.print - mocked_print.side_effect = mock_print_func - - # ip._showtraceback() is replaced in globalipapp.py. - # Call original method to test. - interactiveshell.InteractiveShell._showtraceback(ip, None, None, chr(0xD8FF)) - - self.assertEqual(mocked_print.call_count, 2) - self.assertEqual(values, [chr(0xD8FF), "\\ud8ff"]) - - def test_mktempfile(self): - filename = ip.mktempfile() - # Check that we can open the file again on Windows - with open(filename, "w", encoding="utf-8") as f: - f.write("abc") - - filename = ip.mktempfile(data="blah") - with open(filename, "r", encoding="utf-8") as f: - self.assertEqual(f.read(), "blah") - - def test_new_main_mod(self): - # Smoketest to check that this accepts a unicode module name - name = u'jiefmw' - mod = ip.new_main_mod(u'%s.py' % name, name) - self.assertEqual(mod.__name__, name) - - def test_get_exception_only(self): - try: - raise KeyboardInterrupt - except KeyboardInterrupt: - msg = ip.get_exception_only() - self.assertEqual(msg, 'KeyboardInterrupt\n') - - try: - raise DerivedInterrupt("foo") - except KeyboardInterrupt: - msg = ip.get_exception_only() - self.assertEqual(msg, 'IPython.core.tests.test_interactiveshell.DerivedInterrupt: foo\n') - - def test_inspect_text(self): - ip.run_cell('a = 5') - text = ip.object_inspect_text('a') - self.assertIsInstance(text, str) - - def test_last_execution_result(self): - """ Check that last execution result gets set correctly (GH-10702) """ - result = ip.run_cell('a = 5; a') - self.assertTrue(ip.last_execution_succeeded) - self.assertEqual(ip.last_execution_result.result, 5) - - result = ip.run_cell('a = x_invalid_id_x') - self.assertFalse(ip.last_execution_succeeded) - self.assertFalse(ip.last_execution_result.success) - self.assertIsInstance(ip.last_execution_result.error_in_exec, NameError) - - def test_reset_aliasing(self): - """ Check that standard posix aliases work after %reset. """ - if os.name != 'posix': - return - - ip.reset() - for cmd in ('clear', 'more', 'less', 'man'): - res = ip.run_cell('%' + cmd) - self.assertEqual(res.success, True) - - -class TestSafeExecfileNonAsciiPath(unittest.TestCase): - - @onlyif_unicode_paths - def setUp(self): - self.BASETESTDIR = tempfile.mkdtemp() - self.TESTDIR = join(self.BASETESTDIR, u"åäö") - os.mkdir(self.TESTDIR) - with open( - join(self.TESTDIR, u"åäötestscript.py"), "w", encoding="utf-8" - ) as sfile: - sfile.write("pass\n") - self.oldpath = os.getcwd() - os.chdir(self.TESTDIR) - self.fname = u"åäötestscript.py" - - def tearDown(self): - os.chdir(self.oldpath) - shutil.rmtree(self.BASETESTDIR) - - @onlyif_unicode_paths - def test_1(self): - """Test safe_execfile with non-ascii path - """ - ip.safe_execfile(self.fname, {}, raise_exceptions=True) - -class ExitCodeChecks(tt.TempFileMixin): - - def setUp(self): - self.system = ip.system_raw - - def test_exit_code_ok(self): - self.system('exit 0') - self.assertEqual(ip.user_ns['_exit_code'], 0) - - def test_exit_code_error(self): - self.system('exit 1') - self.assertEqual(ip.user_ns['_exit_code'], 1) - - @skipif(not hasattr(signal, 'SIGALRM')) - def test_exit_code_signal(self): - self.mktmp("import signal, time\n" - "signal.setitimer(signal.ITIMER_REAL, 0.1)\n" - "time.sleep(1)\n") - self.system("%s %s" % (sys.executable, self.fname)) - self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGALRM) - - @onlyif_cmds_exist("csh") - def test_exit_code_signal_csh(self): # pragma: no cover - SHELL = os.environ.get("SHELL", None) - os.environ["SHELL"] = find_cmd("csh") - try: - self.test_exit_code_signal() - finally: - if SHELL is not None: - os.environ['SHELL'] = SHELL - else: - del os.environ['SHELL'] - - -class TestSystemRaw(ExitCodeChecks): - - def setUp(self): - super().setUp() - self.system = ip.system_raw - - @onlyif_unicode_paths - def test_1(self): - """Test system_raw with non-ascii cmd - """ - cmd = u'''python -c "'åäö'" ''' - ip.system_raw(cmd) - - @mock.patch('subprocess.call', side_effect=KeyboardInterrupt) - @mock.patch('os.system', side_effect=KeyboardInterrupt) - def test_control_c(self, *mocks): - try: - self.system("sleep 1 # wont happen") - except KeyboardInterrupt: # pragma: no cove - self.fail( - "system call should intercept " - "keyboard interrupt from subprocess.call" - ) - self.assertEqual(ip.user_ns["_exit_code"], -signal.SIGINT) - - def test_magic_warnings(self): - for magic_cmd in ("pip", "conda", "cd"): - with self.assertWarnsRegex(Warning, "You executed the system command"): - ip.system_raw(magic_cmd) - -# TODO: Exit codes are currently ignored on Windows. -class TestSystemPipedExitCode(ExitCodeChecks): - - def setUp(self): - super().setUp() - self.system = ip.system_piped - - @skip_win32 - def test_exit_code_ok(self): - ExitCodeChecks.test_exit_code_ok(self) - - @skip_win32 - def test_exit_code_error(self): - ExitCodeChecks.test_exit_code_error(self) - - @skip_win32 - def test_exit_code_signal(self): - ExitCodeChecks.test_exit_code_signal(self) - -class TestModules(tt.TempFileMixin): - def test_extraneous_loads(self): - """Test we're not loading modules on startup that we shouldn't. - """ - self.mktmp("import sys\n" - "print('numpy' in sys.modules)\n" - "print('ipyparallel' in sys.modules)\n" - "print('ipykernel' in sys.modules)\n" - ) - out = "False\nFalse\nFalse\n" - tt.ipexec_validate(self.fname, out) - -class Negator(ast.NodeTransformer): - """Negates all number literals in an AST.""" - - # for python 3.7 and earlier - def visit_Num(self, node): - node.n = -node.n - return node - - # for python 3.8+ - def visit_Constant(self, node): - if isinstance(node.value, int): - return self.visit_Num(node) - return node - -class TestAstTransform(unittest.TestCase): - def setUp(self): - self.negator = Negator() - ip.ast_transformers.append(self.negator) - - def tearDown(self): - ip.ast_transformers.remove(self.negator) - - def test_non_int_const(self): - with tt.AssertPrints("hello"): - ip.run_cell('print("hello")') - - def test_run_cell(self): - with tt.AssertPrints("-34"): - ip.run_cell("print(12 + 22)") - - # A named reference to a number shouldn't be transformed. - ip.user_ns["n"] = 55 - with tt.AssertNotPrints("-55"): - ip.run_cell("print(n)") - - def test_timeit(self): - called = set() - def f(x): - called.add(x) - ip.push({'f':f}) - - with tt.AssertPrints("std. dev. of"): - ip.run_line_magic("timeit", "-n1 f(1)") - self.assertEqual(called, {-1}) - called.clear() - - with tt.AssertPrints("std. dev. of"): - ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)") - self.assertEqual(called, {-2, -3}) - - def test_time(self): - called = [] - def f(x): - called.append(x) - ip.push({'f':f}) - - # Test with an expression - with tt.AssertPrints("Wall time: "): - ip.run_line_magic("time", "f(5+9)") - self.assertEqual(called, [-14]) - called[:] = [] - - # Test with a statement (different code path) - with tt.AssertPrints("Wall time: "): - ip.run_line_magic("time", "a = f(-3 + -2)") - self.assertEqual(called, [5]) - - def test_macro(self): - ip.push({'a':10}) - # The AST transformation makes this do a+=-1 - ip.define_macro("amacro", "a+=1\nprint(a)") - - with tt.AssertPrints("9"): - ip.run_cell("amacro") - with tt.AssertPrints("8"): - ip.run_cell("amacro") - -class TestMiscTransform(unittest.TestCase): - - - def test_transform_only_once(self): - cleanup = 0 - line_t = 0 - def count_cleanup(lines): - nonlocal cleanup - cleanup += 1 - return lines - - def count_line_t(lines): - nonlocal line_t - line_t += 1 - return lines - - ip.input_transformer_manager.cleanup_transforms.append(count_cleanup) - ip.input_transformer_manager.line_transforms.append(count_line_t) - - ip.run_cell('1') - - assert cleanup == 1 - assert line_t == 1 - -class IntegerWrapper(ast.NodeTransformer): - """Wraps all integers in a call to Integer()""" - - # for Python 3.7 and earlier - - # for Python 3.7 and earlier - def visit_Num(self, node): - if isinstance(node.n, int): - return ast.Call(func=ast.Name(id='Integer', ctx=ast.Load()), - args=[node], keywords=[]) - return node - - # For Python 3.8+ - def visit_Constant(self, node): - if isinstance(node.value, int): - return self.visit_Num(node) - return node - - -class TestAstTransform2(unittest.TestCase): - def setUp(self): - self.intwrapper = IntegerWrapper() - ip.ast_transformers.append(self.intwrapper) - - self.calls = [] - def Integer(*args): - self.calls.append(args) - return args - ip.push({"Integer": Integer}) - - def tearDown(self): - ip.ast_transformers.remove(self.intwrapper) - del ip.user_ns['Integer'] - - def test_run_cell(self): - ip.run_cell("n = 2") - self.assertEqual(self.calls, [(2,)]) - - # This shouldn't throw an error - ip.run_cell("o = 2.0") - self.assertEqual(ip.user_ns['o'], 2.0) - - def test_run_cell_non_int(self): - ip.run_cell("n = 'a'") - assert self.calls == [] - - def test_timeit(self): - called = set() - def f(x): - called.add(x) - ip.push({'f':f}) - - with tt.AssertPrints("std. dev. of"): - ip.run_line_magic("timeit", "-n1 f(1)") - self.assertEqual(called, {(1,)}) - called.clear() - - with tt.AssertPrints("std. dev. of"): - ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)") - self.assertEqual(called, {(2,), (3,)}) - -class ErrorTransformer(ast.NodeTransformer): - """Throws an error when it sees a number.""" - - def visit_Constant(self, node): - if isinstance(node.value, int): - raise ValueError("test") - return node - - -class TestAstTransformError(unittest.TestCase): - def test_unregistering(self): - err_transformer = ErrorTransformer() - ip.ast_transformers.append(err_transformer) - - with self.assertWarnsRegex(UserWarning, "It will be unregistered"): - ip.run_cell("1 + 2") - - # This should have been removed. - self.assertNotIn(err_transformer, ip.ast_transformers) - - -class StringRejector(ast.NodeTransformer): - """Throws an InputRejected when it sees a string literal. - - Used to verify that NodeTransformers can signal that a piece of code should - not be executed by throwing an InputRejected. - """ - - # 3.8 only - def visit_Constant(self, node): - if isinstance(node.value, str): - raise InputRejected("test") - return node - - -class TestAstTransformInputRejection(unittest.TestCase): - - def setUp(self): - self.transformer = StringRejector() - ip.ast_transformers.append(self.transformer) - - def tearDown(self): - ip.ast_transformers.remove(self.transformer) - - def test_input_rejection(self): - """Check that NodeTransformers can reject input.""" - - expect_exception_tb = tt.AssertPrints("InputRejected: test") - expect_no_cell_output = tt.AssertNotPrints("'unsafe'", suppress=False) - - # Run the same check twice to verify that the transformer is not - # disabled after raising. - with expect_exception_tb, expect_no_cell_output: - ip.run_cell("'unsafe'") - - with expect_exception_tb, expect_no_cell_output: - res = ip.run_cell("'unsafe'") - - self.assertIsInstance(res.error_before_exec, InputRejected) - -def test__IPYTHON__(): - # This shouldn't raise a NameError, that's all - __IPYTHON__ - - -class DummyRepr(object): - def __repr__(self): - return "DummyRepr" - - def _repr_html_(self): - return "dummy" - - def _repr_javascript_(self): - return "console.log('hi');", {'key': 'value'} - - -def test_user_variables(): - # enable all formatters - ip.display_formatter.active_types = ip.display_formatter.format_types - - ip.user_ns['dummy'] = d = DummyRepr() - keys = {'dummy', 'doesnotexist'} - r = ip.user_expressions({ key:key for key in keys}) - - assert keys == set(r.keys()) - dummy = r["dummy"] - assert {"status", "data", "metadata"} == set(dummy.keys()) - assert dummy["status"] == "ok" - data = dummy["data"] - metadata = dummy["metadata"] - assert data.get("text/html") == d._repr_html_() - js, jsmd = d._repr_javascript_() - assert data.get("application/javascript") == js - assert metadata.get("application/javascript") == jsmd - - dne = r["doesnotexist"] - assert dne["status"] == "error" - assert dne["ename"] == "NameError" - - # back to text only - ip.display_formatter.active_types = ['text/plain'] - -def test_user_expression(): - # enable all formatters - ip.display_formatter.active_types = ip.display_formatter.format_types - query = { - 'a' : '1 + 2', - 'b' : '1/0', - } - r = ip.user_expressions(query) - import pprint - pprint.pprint(r) - assert set(r.keys()) == set(query.keys()) - a = r["a"] - assert {"status", "data", "metadata"} == set(a.keys()) - assert a["status"] == "ok" - data = a["data"] - metadata = a["metadata"] - assert data.get("text/plain") == "3" - - b = r["b"] - assert b["status"] == "error" - assert b["ename"] == "ZeroDivisionError" - - # back to text only - ip.display_formatter.active_types = ['text/plain'] - - -class TestSyntaxErrorTransformer(unittest.TestCase): - """Check that SyntaxError raised by an input transformer is handled by run_cell()""" - - @staticmethod - def transformer(lines): - for line in lines: - pos = line.find('syntaxerror') - if pos >= 0: - e = SyntaxError('input contains "syntaxerror"') - e.text = line - e.offset = pos + 1 - raise e - return lines - - def setUp(self): - ip.input_transformers_post.append(self.transformer) - - def tearDown(self): - ip.input_transformers_post.remove(self.transformer) - - def test_syntaxerror_input_transformer(self): - with tt.AssertPrints('1234'): - ip.run_cell('1234') - with tt.AssertPrints('SyntaxError: invalid syntax'): - ip.run_cell('1 2 3') # plain python syntax error - with tt.AssertPrints('SyntaxError: input contains "syntaxerror"'): - ip.run_cell('2345 # syntaxerror') # input transformer syntax error - with tt.AssertPrints('3456'): - ip.run_cell('3456') - - -class TestWarningSuppression(unittest.TestCase): - def test_warning_suppression(self): - ip.run_cell("import warnings") - try: - with self.assertWarnsRegex(UserWarning, "asdf"): - ip.run_cell("warnings.warn('asdf')") - # Here's the real test -- if we run that again, we should get the - # warning again. Traditionally, each warning was only issued once per - # IPython session (approximately), even if the user typed in new and - # different code that should have also triggered the warning, leading - # to much confusion. - with self.assertWarnsRegex(UserWarning, "asdf"): - ip.run_cell("warnings.warn('asdf')") - finally: - ip.run_cell("del warnings") - - - def test_deprecation_warning(self): - ip.run_cell(""" -import warnings -def wrn(): - warnings.warn( - "I AM A WARNING", - DeprecationWarning - ) - """) - try: - with self.assertWarnsRegex(DeprecationWarning, "I AM A WARNING"): - ip.run_cell("wrn()") - finally: - ip.run_cell("del warnings") - ip.run_cell("del wrn") - - -class TestImportNoDeprecate(tt.TempFileMixin): - - def setUp(self): - """Make a valid python temp file.""" - self.mktmp(""" -import warnings -def wrn(): - warnings.warn( - "I AM A WARNING", - DeprecationWarning - ) -""") - super().setUp() - - def test_no_dep(self): - """ - No deprecation warning should be raised from imported functions - """ - ip.run_cell("from {} import wrn".format(self.fname)) - - with tt.AssertNotPrints("I AM A WARNING"): - ip.run_cell("wrn()") - ip.run_cell("del wrn") - - -def test_custom_exc_count(): - hook = mock.Mock(return_value=None) - ip.set_custom_exc((SyntaxError,), hook) - before = ip.execution_count - ip.run_cell("def foo()", store_history=True) - # restore default excepthook - ip.set_custom_exc((), None) - assert hook.call_count == 1 - assert ip.execution_count == before + 1 - - -def test_run_cell_async(): - ip.run_cell("import asyncio") - coro = ip.run_cell_async("await asyncio.sleep(0.01)\n5") - assert asyncio.iscoroutine(coro) - loop = asyncio.new_event_loop() - result = loop.run_until_complete(coro) - assert isinstance(result, interactiveshell.ExecutionResult) - assert result.result == 5 - - -def test_run_cell_await(): - ip.run_cell("import asyncio") - result = ip.run_cell("await asyncio.sleep(0.01); 10") - assert ip.user_ns["_"] == 10 - - -def test_run_cell_asyncio_run(): - ip.run_cell("import asyncio") - result = ip.run_cell("await asyncio.sleep(0.01); 1") - assert ip.user_ns["_"] == 1 - result = ip.run_cell("asyncio.run(asyncio.sleep(0.01)); 2") - assert ip.user_ns["_"] == 2 - result = ip.run_cell("await asyncio.sleep(0.01); 3") - assert ip.user_ns["_"] == 3 - - -def test_should_run_async(): - assert not ip.should_run_async("a = 5") - assert ip.should_run_async("await x") - assert ip.should_run_async("import asyncio; await asyncio.sleep(1)") - - -def test_set_custom_completer(): - num_completers = len(ip.Completer.matchers) - - def foo(*args, **kwargs): - return "I'm a completer!" - - ip.set_custom_completer(foo, 0) - - # check that we've really added a new completer - assert len(ip.Completer.matchers) == num_completers + 1 - - # check that the first completer is the function we defined - assert ip.Completer.matchers[0]() == "I'm a completer!" - - # clean up - ip.Completer.custom_matchers.pop() diff --git a/IPython/core/tests/test_logger.py b/IPython/core/tests/test_logger.py deleted file mode 100644 index 10e462098be..00000000000 --- a/IPython/core/tests/test_logger.py +++ /dev/null @@ -1,27 +0,0 @@ -# -*- coding: utf-8 -*- -"""Test IPython.core.logger""" - -import os.path - -import pytest -from tempfile import TemporaryDirectory - - -def test_logstart_inaccessible_file(): - with pytest.raises(IOError): - _ip.logger.logstart(logfname="/") # Opening that filename will fail. - - try: - _ip.run_cell("a=1") # Check it doesn't try to log this - finally: - _ip.logger.log_active = False # If this fails, don't let later tests fail - -def test_logstart_unicode(): - with TemporaryDirectory() as tdir: - logfname = os.path.join(tdir, "test_unicode.log") - _ip.run_cell("'abc€'") - try: - _ip.magic("logstart -to %s" % logfname) - _ip.run_cell("'abc€'") - finally: - _ip.logger.logstop() diff --git a/IPython/core/tests/test_magic_terminal.py b/IPython/core/tests/test_magic_terminal.py deleted file mode 100644 index f09014786e6..00000000000 --- a/IPython/core/tests/test_magic_terminal.py +++ /dev/null @@ -1,212 +0,0 @@ -"""Tests for various magic functions specific to the terminal frontend.""" - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -import sys -from io import StringIO -from unittest import TestCase - -from IPython.testing import tools as tt -#----------------------------------------------------------------------------- -# Test functions begin -#----------------------------------------------------------------------------- - - -MINIMAL_LAZY_MAGIC = """ -from IPython.core.magic import ( - Magics, - magics_class, - line_magic, - cell_magic, -) - - -@magics_class -class LazyMagics(Magics): - @line_magic - def lazy_line(self, line): - print("Lazy Line") - - @cell_magic - def lazy_cell(self, line, cell): - print("Lazy Cell") - - -def load_ipython_extension(ipython): - ipython.register_magics(LazyMagics) -""" - -def check_cpaste(code, should_fail=False): - """Execute code via 'cpaste' and ensure it was executed, unless - should_fail is set. - """ - ip.user_ns['code_ran'] = False - - src = StringIO() - src.write(code) - src.write('\n--\n') - src.seek(0) - - stdin_save = sys.stdin - sys.stdin = src - - try: - context = tt.AssertPrints if should_fail else tt.AssertNotPrints - with context("Traceback (most recent call last)"): - ip.run_line_magic("cpaste", "") - - if not should_fail: - assert ip.user_ns['code_ran'], "%r failed" % code - finally: - sys.stdin = stdin_save - -def test_cpaste(): - """Test cpaste magic""" - - def runf(): - """Marker function: sets a flag when executed. - """ - ip.user_ns['code_ran'] = True - return 'runf' # return string so '+ runf()' doesn't result in success - - tests = {'pass': ["runf()", - "In [1]: runf()", - "In [1]: if 1:\n ...: runf()", - "> > > runf()", - ">>> runf()", - " >>> runf()", - ], - - 'fail': ["1 + runf()", - "++ runf()", - ]} - - ip.user_ns['runf'] = runf - - for code in tests['pass']: - check_cpaste(code) - - for code in tests['fail']: - check_cpaste(code, should_fail=True) - - - -class PasteTestCase(TestCase): - """Multiple tests for clipboard pasting""" - - def paste(self, txt, flags='-q'): - """Paste input text, by default in quiet mode""" - ip.hooks.clipboard_get = lambda: txt - ip.run_line_magic("paste", flags) - - def setUp(self): - # Inject fake clipboard hook but save original so we can restore it later - self.original_clip = ip.hooks.clipboard_get - - def tearDown(self): - # Restore original hook - ip.hooks.clipboard_get = self.original_clip - - def test_paste(self): - ip.user_ns.pop("x", None) - self.paste("x = 1") - self.assertEqual(ip.user_ns["x"], 1) - ip.user_ns.pop("x") - - def test_paste_pyprompt(self): - ip.user_ns.pop("x", None) - self.paste(">>> x=2") - self.assertEqual(ip.user_ns["x"], 2) - ip.user_ns.pop("x") - - def test_paste_py_multi(self): - self.paste(""" - >>> x = [1,2,3] - >>> y = [] - >>> for i in x: - ... y.append(i**2) - ... - """ - ) - self.assertEqual(ip.user_ns["x"], [1, 2, 3]) - self.assertEqual(ip.user_ns["y"], [1, 4, 9]) - - def test_paste_py_multi_r(self): - "Now, test that self.paste -r works" - self.test_paste_py_multi() - self.assertEqual(ip.user_ns.pop("x"), [1, 2, 3]) - self.assertEqual(ip.user_ns.pop("y"), [1, 4, 9]) - self.assertFalse("x" in ip.user_ns) - ip.run_line_magic("paste", "-r") - self.assertEqual(ip.user_ns["x"], [1, 2, 3]) - self.assertEqual(ip.user_ns["y"], [1, 4, 9]) - - def test_paste_email(self): - "Test pasting of email-quoted contents" - self.paste("""\ - >> def foo(x): - >> return x + 1 - >> xx = foo(1.1)""" - ) - self.assertEqual(ip.user_ns["xx"], 2.1) - - def test_paste_email2(self): - "Email again; some programs add a space also at each quoting level" - self.paste("""\ - > > def foo(x): - > > return x + 1 - > > yy = foo(2.1) """ - ) - self.assertEqual(ip.user_ns["yy"], 3.1) - - def test_paste_email_py(self): - "Email quoting of interactive input" - self.paste("""\ - >> >>> def f(x): - >> ... return x+1 - >> ... - >> >>> zz = f(2.5) """ - ) - self.assertEqual(ip.user_ns["zz"], 3.5) - - def test_paste_echo(self): - "Also test self.paste echoing, by temporarily faking the writer" - w = StringIO() - old_write = sys.stdout.write - sys.stdout.write = w.write - code = """ - a = 100 - b = 200""" - try: - self.paste(code,'') - out = w.getvalue() - finally: - sys.stdout.write = old_write - self.assertEqual(ip.user_ns["a"], 100) - self.assertEqual(ip.user_ns["b"], 200) - assert out == code + "\n## -- End pasted text --\n" - - def test_paste_leading_commas(self): - "Test multiline strings with leading commas" - tm = ip.magics_manager.registry['TerminalMagics'] - s = '''\ -a = """ -,1,2,3 -"""''' - ip.user_ns.pop("foo", None) - tm.store_or_execute(s, "foo") - self.assertIn("foo", ip.user_ns) - - def test_paste_trailing_question(self): - "Test pasting sources with trailing question marks" - tm = ip.magics_manager.registry['TerminalMagics'] - s = '''\ -def funcfoo(): - if True: #am i true? - return 'fooresult' -''' - ip.user_ns.pop('funcfoo', None) - self.paste(s) - self.assertEqual(ip.user_ns["funcfoo"](), "fooresult") diff --git a/IPython/core/tests/test_page.py b/IPython/core/tests/test_page.py deleted file mode 100644 index 9f6a3742495..00000000000 --- a/IPython/core/tests/test_page.py +++ /dev/null @@ -1,20 +0,0 @@ -#----------------------------------------------------------------------------- -# Copyright (C) 2010-2011 The IPython Development Team. -# -# Distributed under the terms of the BSD License. -# -# The full license is in the file COPYING.txt, distributed with this software. -#----------------------------------------------------------------------------- -import io - -# N.B. For the test suite, page.page is overridden (see IPython.testing.globalipapp) -from IPython.core import page - -def test_detect_screen_size(): - """Simple smoketest for page._detect_screen_size.""" - try: - page._detect_screen_size(True, 25) - except (TypeError, io.UnsupportedOperation): - # This can happen in the test suite, because stdout may not have a - # fileno. - pass diff --git a/IPython/core/tests/test_profile.py b/IPython/core/tests/test_profile.py deleted file mode 100644 index a0de2f2d593..00000000000 --- a/IPython/core/tests/test_profile.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 -"""Tests for profile-related functions. - -Currently only the startup-dir functionality is tested, but more tests should -be added for: - - * ipython profile create - * ipython profile list - * ipython profile create --parallel - * security dir permissions - -Authors -------- - -* MinRK - -""" - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -import shutil -import sys -import tempfile -from pathlib import Path -from unittest import TestCase - -from tempfile import TemporaryDirectory - -from IPython.core.profileapp import list_bundled_profiles, list_profiles_in -from IPython.core.profiledir import ProfileDir -from IPython.testing import decorators as dec -from IPython.testing import tools as tt -from IPython.utils.process import getoutput - -#----------------------------------------------------------------------------- -# Globals -#----------------------------------------------------------------------------- -TMP_TEST_DIR = Path(tempfile.mkdtemp()) -HOME_TEST_DIR = TMP_TEST_DIR / "home_test_dir" -IP_TEST_DIR = HOME_TEST_DIR / ".ipython" - -# -# Setup/teardown functions/decorators -# - -def setup_module(): - """Setup test environment for the module: - - - Adds dummy home dir tree - """ - # Do not mask exceptions here. In particular, catching WindowsError is a - # problem because that exception is only defined on Windows... - (Path.cwd() / IP_TEST_DIR).mkdir(parents=True) - - -def teardown_module(): - """Teardown test environment for the module: - - - Remove dummy home dir tree - """ - # Note: we remove the parent test dir, which is the root of all test - # subdirs we may have created. Use shutil instead of os.removedirs, so - # that non-empty directories are all recursively removed. - shutil.rmtree(TMP_TEST_DIR) - - -#----------------------------------------------------------------------------- -# Test functions -#----------------------------------------------------------------------------- -class ProfileStartupTest(TestCase): - def setUp(self): - # create profile dir - self.pd = ProfileDir.create_profile_dir_by_name(IP_TEST_DIR, "test") - self.options = ["--ipython-dir", IP_TEST_DIR, "--profile", "test"] - self.fname = TMP_TEST_DIR / "test.py" - - def tearDown(self): - # We must remove this profile right away so its presence doesn't - # confuse other tests. - shutil.rmtree(self.pd.location) - - def init(self, startup_file, startup, test): - # write startup python file - with open(Path(self.pd.startup_dir) / startup_file, "w", encoding="utf-8") as f: - f.write(startup) - # write simple test file, to check that the startup file was run - with open(self.fname, "w", encoding="utf-8") as f: - f.write(test) - - def validate(self, output): - tt.ipexec_validate(self.fname, output, "", options=self.options) - - def test_startup_py(self): - self.init('00-start.py', 'zzz=123\n', 'print(zzz)\n') - self.validate('123') - - def test_startup_ipy(self): - self.init('00-start.ipy', '%xmode plain\n', '') - self.validate('Exception reporting mode: Plain') - - -def test_list_profiles_in(): - # No need to remove these directories and files, as they will get nuked in - # the module-level teardown. - td = Path(tempfile.mkdtemp(dir=TMP_TEST_DIR)) - for name in ("profile_foo", "profile_hello", "not_a_profile"): - Path(td / name).mkdir(parents=True) - if dec.unicode_paths: - Path(td / u"profile_ünicode").mkdir(parents=True) - - with open(td / "profile_file", "w", encoding="utf-8") as f: - f.write("I am not a profile directory") - profiles = list_profiles_in(td) - - # unicode normalization can turn u'ünicode' into u'u\0308nicode', - # so only check for *nicode, and that creating a ProfileDir from the - # name remains valid - found_unicode = False - for p in list(profiles): - if p.endswith('nicode'): - pd = ProfileDir.find_profile_dir_by_name(td, p) - profiles.remove(p) - found_unicode = True - break - if dec.unicode_paths: - assert found_unicode is True - assert set(profiles) == {"foo", "hello"} - - -def test_list_bundled_profiles(): - # This variable will need to be updated when a new profile gets bundled - bundled = sorted(list_bundled_profiles()) - assert bundled == [] - - -def test_profile_create_ipython_dir(): - """ipython profile create respects --ipython-dir""" - with TemporaryDirectory() as td: - getoutput( - [ - sys.executable, - "-m", - "IPython", - "profile", - "create", - "foo", - "--ipython-dir=%s" % td, - ] - ) - profile_dir = Path(td) / "profile_foo" - assert Path(profile_dir).exists() - ipython_config = profile_dir / "ipython_config.py" - assert Path(ipython_config).exists() diff --git a/IPython/core/tests/test_prompts.py b/IPython/core/tests/test_prompts.py deleted file mode 100644 index 95e6163b213..00000000000 --- a/IPython/core/tests/test_prompts.py +++ /dev/null @@ -1,30 +0,0 @@ -# -*- coding: utf-8 -"""Tests for prompt generation.""" - -import unittest - -from IPython.core.prompts import LazyEvaluate - -class PromptTests(unittest.TestCase): - def test_lazy_eval_unicode(self): - u = u'ünicødé' - lz = LazyEvaluate(lambda : u) - self.assertEqual(str(lz), u) - self.assertEqual(format(lz), u) - - def test_lazy_eval_nonascii_bytes(self): - u = u'ünicødé' - b = u.encode('utf8') - lz = LazyEvaluate(lambda : b) - # unicode(lz) would fail - self.assertEqual(str(lz), str(b)) - self.assertEqual(format(lz), str(b)) - - def test_lazy_eval_float(self): - f = 0.503 - lz = LazyEvaluate(lambda : f) - - self.assertEqual(str(lz), str(f)) - self.assertEqual(format(lz), str(f)) - self.assertEqual(format(lz, '.1'), '0.5') - diff --git a/IPython/core/tests/test_pylabtools.py b/IPython/core/tests/test_pylabtools.py deleted file mode 100644 index 78886373ced..00000000000 --- a/IPython/core/tests/test_pylabtools.py +++ /dev/null @@ -1,274 +0,0 @@ -"""Tests for pylab tools module. -""" - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - - -from binascii import a2b_base64 -from io import BytesIO - -import pytest - -matplotlib = pytest.importorskip("matplotlib") -matplotlib.use('Agg') -from matplotlib.figure import Figure - -from matplotlib import pyplot as plt -from matplotlib_inline import backend_inline -import numpy as np - -from IPython.core.getipython import get_ipython -from IPython.core.interactiveshell import InteractiveShell -from IPython.core.display import _PNG, _JPEG -from .. import pylabtools as pt - -from IPython.testing import decorators as dec - - -def test_figure_to_svg(): - # simple empty-figure test - fig = plt.figure() - assert pt.print_figure(fig, "svg") is None - - plt.close('all') - - # simple check for at least svg-looking output - fig = plt.figure() - ax = fig.add_subplot(1,1,1) - ax.plot([1,2,3]) - plt.draw() - svg = pt.print_figure(fig, "svg")[:100].lower() - assert "doctype svg" in svg - - -def _check_pil_jpeg_bytes(): - """Skip if PIL can't write JPEGs to BytesIO objects""" - # PIL's JPEG plugin can't write to BytesIO objects - # Pillow fixes this - from PIL import Image - buf = BytesIO() - img = Image.new("RGB", (4,4)) - try: - img.save(buf, 'jpeg') - except Exception as e: - ename = e.__class__.__name__ - raise pytest.skip("PIL can't write JPEG to BytesIO: %s: %s" % (ename, e)) from e - -@dec.skip_without("PIL.Image") -def test_figure_to_jpeg(): - _check_pil_jpeg_bytes() - # simple check for at least jpeg-looking output - fig = plt.figure() - ax = fig.add_subplot(1,1,1) - ax.plot([1,2,3]) - plt.draw() - jpeg = pt.print_figure(fig, 'jpeg', pil_kwargs={'optimize': 50})[:100].lower() - assert jpeg.startswith(_JPEG) - -def test_retina_figure(): - # simple empty-figure test - fig = plt.figure() - assert pt.retina_figure(fig) == None - plt.close('all') - - fig = plt.figure() - ax = fig.add_subplot(1,1,1) - ax.plot([1,2,3]) - plt.draw() - png, md = pt.retina_figure(fig) - assert png.startswith(_PNG) - assert "width" in md - assert "height" in md - - -_fmt_mime_map = { - 'png': 'image/png', - 'jpeg': 'image/jpeg', - 'pdf': 'application/pdf', - 'retina': 'image/png', - 'svg': 'image/svg+xml', -} - -def test_select_figure_formats_str(): - ip = get_ipython() - for fmt, active_mime in _fmt_mime_map.items(): - pt.select_figure_formats(ip, fmt) - for mime, f in ip.display_formatter.formatters.items(): - if mime == active_mime: - assert Figure in f - else: - assert Figure not in f - -def test_select_figure_formats_kwargs(): - ip = get_ipython() - kwargs = dict(bbox_inches="tight") - pt.select_figure_formats(ip, "png", **kwargs) - formatter = ip.display_formatter.formatters["image/png"] - f = formatter.lookup_by_type(Figure) - cell = f.keywords - expected = kwargs - expected["base64"] = True - expected["fmt"] = "png" - assert cell == expected - - # check that the formatter doesn't raise - fig = plt.figure() - ax = fig.add_subplot(1,1,1) - ax.plot([1,2,3]) - plt.draw() - formatter.enabled = True - png = formatter(fig) - assert isinstance(png, str) - png_bytes = a2b_base64(png) - assert png_bytes.startswith(_PNG) - -def test_select_figure_formats_set(): - ip = get_ipython() - for fmts in [ - {'png', 'svg'}, - ['png'], - ('jpeg', 'pdf', 'retina'), - {'svg'}, - ]: - active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} - pt.select_figure_formats(ip, fmts) - for mime, f in ip.display_formatter.formatters.items(): - if mime in active_mimes: - assert Figure in f - else: - assert Figure not in f - -def test_select_figure_formats_bad(): - ip = get_ipython() - with pytest.raises(ValueError): - pt.select_figure_formats(ip, 'foo') - with pytest.raises(ValueError): - pt.select_figure_formats(ip, {'png', 'foo'}) - with pytest.raises(ValueError): - pt.select_figure_formats(ip, ['retina', 'pdf', 'bar', 'bad']) - -def test_import_pylab(): - ns = {} - pt.import_pylab(ns, import_all=False) - assert "plt" in ns - assert ns["np"] == np - - -from traitlets.config import Config - - -class TestPylabSwitch(object): - class Shell(InteractiveShell): - def init_history(self): - """Sets up the command history, and starts regular autosaves.""" - self.config.HistoryManager.hist_file = ":memory:" - super().init_history() - - def enable_gui(self, gui): - pass - - def setup(self): - import matplotlib - def act_mpl(backend): - matplotlib.rcParams['backend'] = backend - - # Save rcParams since they get modified - self._saved_rcParams = matplotlib.rcParams - self._saved_rcParamsOrig = matplotlib.rcParamsOrig - matplotlib.rcParams = dict(backend='Qt4Agg') - matplotlib.rcParamsOrig = dict(backend='Qt4Agg') - - # Mock out functions - self._save_am = pt.activate_matplotlib - pt.activate_matplotlib = act_mpl - self._save_ip = pt.import_pylab - pt.import_pylab = lambda *a,**kw:None - self._save_cis = backend_inline.configure_inline_support - backend_inline.configure_inline_support = lambda *a, **kw: None - - def teardown(self): - pt.activate_matplotlib = self._save_am - pt.import_pylab = self._save_ip - backend_inline.configure_inline_support = self._save_cis - import matplotlib - matplotlib.rcParams = self._saved_rcParams - matplotlib.rcParamsOrig = self._saved_rcParamsOrig - - def test_qt(self): - - s = self.Shell() - gui, backend = s.enable_matplotlib(None) - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - gui, backend = s.enable_matplotlib("inline") - assert gui == "inline" - assert s.pylab_gui_select == "qt" - - gui, backend = s.enable_matplotlib("qt") - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - gui, backend = s.enable_matplotlib("inline") - assert gui == "inline" - assert s.pylab_gui_select == "qt" - - gui, backend = s.enable_matplotlib() - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - def test_inline(self): - s = self.Shell() - gui, backend = s.enable_matplotlib("inline") - assert gui == "inline" - assert s.pylab_gui_select == None - - gui, backend = s.enable_matplotlib("inline") - assert gui == "inline" - assert s.pylab_gui_select == None - - gui, backend = s.enable_matplotlib("qt") - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - def test_inline_twice(self): - "Using '%matplotlib inline' twice should not reset formatters" - - ip = self.Shell() - gui, backend = ip.enable_matplotlib("inline") - assert gui == "inline" - - fmts = {'png'} - active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} - pt.select_figure_formats(ip, fmts) - - gui, backend = ip.enable_matplotlib("inline") - assert gui == "inline" - - for mime, f in ip.display_formatter.formatters.items(): - if mime in active_mimes: - assert Figure in f - else: - assert Figure not in f - - def test_qt_gtk(self): - s = self.Shell() - gui, backend = s.enable_matplotlib("qt") - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - gui, backend = s.enable_matplotlib("gtk") - assert gui == "qt" - assert s.pylab_gui_select == "qt" - - -def test_no_gui_backends(): - for k in ['agg', 'svg', 'pdf', 'ps']: - assert k not in pt.backend2gui - - -def test_figure_no_canvas(): - fig = Figure() - fig.canvas = None - pt.print_figure(fig) diff --git a/IPython/core/tests/test_run.py b/IPython/core/tests/test_run.py deleted file mode 100644 index ae20ce6096b..00000000000 --- a/IPython/core/tests/test_run.py +++ /dev/null @@ -1,622 +0,0 @@ -# encoding: utf-8 -"""Tests for code execution (%run and related), which is particularly tricky. - -Because of how %run manages namespaces, and the fact that we are trying here to -verify subtle object deletion and reference counting issues, the %run tests -will be kept in this separate file. This makes it easier to aggregate in one -place the tricks needed to handle it; most other magics are much easier to test -and we do so in a common test_magic file. - -Note that any test using `run -i` should make sure to do a `reset` afterwards, -as otherwise it may influence later tests. -""" - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - - - -import functools -import os -import platform -import random -import string -import sys -import textwrap -import unittest -from os.path import join as pjoin -from unittest.mock import patch - -import pytest -from tempfile import TemporaryDirectory - -from IPython.core import debugger -from IPython.testing import decorators as dec -from IPython.testing import tools as tt -from IPython.utils.io import capture_output - - -def doctest_refbug(): - """Very nasty problem with references held by multiple runs of a script. - See: https://github.com/ipython/ipython/issues/141 - - In [1]: _ip.clear_main_mod_cache() - # random - - In [2]: %run refbug - - In [3]: call_f() - lowercased: hello - - In [4]: %run refbug - - In [5]: call_f() - lowercased: hello - lowercased: hello - """ - - -def doctest_run_builtins(): - r"""Check that %run doesn't damage __builtins__. - - In [1]: import tempfile - - In [2]: bid1 = id(__builtins__) - - In [3]: fname = tempfile.mkstemp('.py')[1] - - In [3]: f = open(fname, 'w', encoding='utf-8') - - In [4]: dummy= f.write('pass\n') - - In [5]: f.flush() - - In [6]: t1 = type(__builtins__) - - In [7]: %run $fname - - In [7]: f.close() - - In [8]: bid2 = id(__builtins__) - - In [9]: t2 = type(__builtins__) - - In [10]: t1 == t2 - Out[10]: True - - In [10]: bid1 == bid2 - Out[10]: True - - In [12]: try: - ....: os.unlink(fname) - ....: except: - ....: pass - ....: - """ - - -def doctest_run_option_parser(): - r"""Test option parser in %run. - - In [1]: %run print_argv.py - [] - - In [2]: %run print_argv.py print*.py - ['print_argv.py'] - - In [3]: %run -G print_argv.py print*.py - ['print*.py'] - - """ - - -@dec.skip_win32 -def doctest_run_option_parser_for_posix(): - r"""Test option parser in %run (Linux/OSX specific). - - You need double quote to escape glob in POSIX systems: - - In [1]: %run print_argv.py print\\*.py - ['print*.py'] - - You can't use quote to escape glob in POSIX systems: - - In [2]: %run print_argv.py 'print*.py' - ['print_argv.py'] - - """ - - -doctest_run_option_parser_for_posix.__skip_doctest__ = sys.platform == "win32" - - -@dec.skip_if_not_win32 -def doctest_run_option_parser_for_windows(): - r"""Test option parser in %run (Windows specific). - - In Windows, you can't escape ``*` `by backslash: - - In [1]: %run print_argv.py print\\*.py - ['print\\\\*.py'] - - You can use quote to escape glob: - - In [2]: %run print_argv.py 'print*.py' - ["'print*.py'"] - - """ - - -doctest_run_option_parser_for_windows.__skip_doctest__ = sys.platform != "win32" - - -def doctest_reset_del(): - """Test that resetting doesn't cause errors in __del__ methods. - - In [2]: class A(object): - ...: def __del__(self): - ...: print(str("Hi")) - ...: - - In [3]: a = A() - - In [4]: get_ipython().reset(); import gc; x = gc.collect(0) - Hi - - In [5]: 1+1 - Out[5]: 2 - """ - -# For some tests, it will be handy to organize them in a class with a common -# setup that makes a temp file - -class TestMagicRunPass(tt.TempFileMixin): - - def setUp(self): - content = "a = [1,2,3]\nb = 1" - self.mktmp(content) - - def run_tmpfile(self): - _ip = get_ipython() - # This fails on Windows if self.tmpfile.name has spaces or "~" in it. - # See below and ticket https://bugs.launchpad.net/bugs/366353 - _ip.magic('run %s' % self.fname) - - def run_tmpfile_p(self): - _ip = get_ipython() - # This fails on Windows if self.tmpfile.name has spaces or "~" in it. - # See below and ticket https://bugs.launchpad.net/bugs/366353 - _ip.magic('run -p %s' % self.fname) - - def test_builtins_id(self): - """Check that %run doesn't damage __builtins__ """ - _ip = get_ipython() - # Test that the id of __builtins__ is not modified by %run - bid1 = id(_ip.user_ns['__builtins__']) - self.run_tmpfile() - bid2 = id(_ip.user_ns['__builtins__']) - assert bid1 == bid2 - - def test_builtins_type(self): - """Check that the type of __builtins__ doesn't change with %run. - - However, the above could pass if __builtins__ was already modified to - be a dict (it should be a module) by a previous use of %run. So we - also check explicitly that it really is a module: - """ - _ip = get_ipython() - self.run_tmpfile() - assert type(_ip.user_ns["__builtins__"]) == type(sys) - - def test_run_profile(self): - """Test that the option -p, which invokes the profiler, do not - crash by invoking execfile""" - self.run_tmpfile_p() - - def test_run_debug_twice(self): - # https://github.com/ipython/ipython/issues/10028 - _ip = get_ipython() - with tt.fake_input(['c']): - _ip.magic('run -d %s' % self.fname) - with tt.fake_input(['c']): - _ip.magic('run -d %s' % self.fname) - - def test_run_debug_twice_with_breakpoint(self): - """Make a valid python temp file.""" - _ip = get_ipython() - with tt.fake_input(['b 2', 'c', 'c']): - _ip.magic('run -d %s' % self.fname) - - with tt.fake_input(['c']): - with tt.AssertNotPrints('KeyError'): - _ip.magic('run -d %s' % self.fname) - - -class TestMagicRunSimple(tt.TempFileMixin): - - def test_simpledef(self): - """Test that simple class definitions work.""" - src = ("class foo: pass\n" - "def f(): return foo()") - self.mktmp(src) - _ip.magic("run %s" % self.fname) - _ip.run_cell("t = isinstance(f(), foo)") - assert _ip.user_ns["t"] is True - - @pytest.mark.xfail( - platform.python_implementation() == "PyPy", - reason="expecting __del__ call on exit is unreliable and doesn't happen on PyPy", - ) - def test_obj_del(self): - """Test that object's __del__ methods are called on exit.""" - src = ("class A(object):\n" - " def __del__(self):\n" - " print('object A deleted')\n" - "a = A()\n") - self.mktmp(src) - err = None - tt.ipexec_validate(self.fname, 'object A deleted', err) - - def test_aggressive_namespace_cleanup(self): - """Test that namespace cleanup is not too aggressive GH-238 - - Returning from another run magic deletes the namespace""" - # see ticket https://github.com/ipython/ipython/issues/238 - - with tt.TempFileMixin() as empty: - empty.mktmp("") - # On Windows, the filename will have \users in it, so we need to use the - # repr so that the \u becomes \\u. - src = ( - "ip = get_ipython()\n" - "for i in range(5):\n" - " try:\n" - " ip.magic(%r)\n" - " except NameError as e:\n" - " print(i)\n" - " break\n" % ("run " + empty.fname) - ) - self.mktmp(src) - _ip.magic("run %s" % self.fname) - _ip.run_cell("ip == get_ipython()") - assert _ip.user_ns["i"] == 4 - - def test_run_second(self): - """Test that running a second file doesn't clobber the first, gh-3547""" - self.mktmp("avar = 1\n" "def afunc():\n" " return avar\n") - - with tt.TempFileMixin() as empty: - empty.mktmp("") - - _ip.magic("run %s" % self.fname) - _ip.magic("run %s" % empty.fname) - assert _ip.user_ns["afunc"]() == 1 - - def test_tclass(self): - mydir = os.path.dirname(__file__) - tc = os.path.join(mydir, "tclass") - src = f"""\ -import gc -%run "{tc}" C-first -gc.collect(0) -%run "{tc}" C-second -gc.collect(0) -%run "{tc}" C-third -gc.collect(0) -%reset -f -""" - self.mktmp(src, ".ipy") - out = """\ -ARGV 1-: ['C-first'] -ARGV 1-: ['C-second'] -tclass.py: deleting object: C-first -ARGV 1-: ['C-third'] -tclass.py: deleting object: C-second -tclass.py: deleting object: C-third -""" - err = None - tt.ipexec_validate(self.fname, out, err) - - def test_run_i_after_reset(self): - """Check that %run -i still works after %reset (gh-693)""" - src = "yy = zz\n" - self.mktmp(src) - _ip.run_cell("zz = 23") - try: - _ip.magic("run -i %s" % self.fname) - assert _ip.user_ns["yy"] == 23 - finally: - _ip.magic('reset -f') - - _ip.run_cell("zz = 23") - try: - _ip.magic("run -i %s" % self.fname) - assert _ip.user_ns["yy"] == 23 - finally: - _ip.magic('reset -f') - - def test_unicode(self): - """Check that files in odd encodings are accepted.""" - mydir = os.path.dirname(__file__) - na = os.path.join(mydir, 'nonascii.py') - _ip.magic('run "%s"' % na) - assert _ip.user_ns["u"] == "Ўт№Ф" - - def test_run_py_file_attribute(self): - """Test handling of `__file__` attribute in `%run .py`.""" - src = "t = __file__\n" - self.mktmp(src) - _missing = object() - file1 = _ip.user_ns.get('__file__', _missing) - _ip.magic('run %s' % self.fname) - file2 = _ip.user_ns.get('__file__', _missing) - - # Check that __file__ was equal to the filename in the script's - # namespace. - assert _ip.user_ns["t"] == self.fname - - # Check that __file__ was not leaked back into user_ns. - assert file1 == file2 - - def test_run_ipy_file_attribute(self): - """Test handling of `__file__` attribute in `%run `.""" - src = "t = __file__\n" - self.mktmp(src, ext='.ipy') - _missing = object() - file1 = _ip.user_ns.get('__file__', _missing) - _ip.magic('run %s' % self.fname) - file2 = _ip.user_ns.get('__file__', _missing) - - # Check that __file__ was equal to the filename in the script's - # namespace. - assert _ip.user_ns["t"] == self.fname - - # Check that __file__ was not leaked back into user_ns. - assert file1 == file2 - - def test_run_formatting(self): - """ Test that %run -t -N does not raise a TypeError for N > 1.""" - src = "pass" - self.mktmp(src) - _ip.magic('run -t -N 1 %s' % self.fname) - _ip.magic('run -t -N 10 %s' % self.fname) - - def test_ignore_sys_exit(self): - """Test the -e option to ignore sys.exit()""" - src = "import sys; sys.exit(1)" - self.mktmp(src) - with tt.AssertPrints('SystemExit'): - _ip.magic('run %s' % self.fname) - - with tt.AssertNotPrints('SystemExit'): - _ip.magic('run -e %s' % self.fname) - - def test_run_nb(self): - """Test %run notebook.ipynb""" - pytest.importorskip("nbformat") - from nbformat import v4, writes - nb = v4.new_notebook( - cells=[ - v4.new_markdown_cell("The Ultimate Question of Everything"), - v4.new_code_cell("answer=42") - ] - ) - src = writes(nb, version=4) - self.mktmp(src, ext='.ipynb') - - _ip.magic("run %s" % self.fname) - - assert _ip.user_ns["answer"] == 42 - - def test_run_nb_error(self): - """Test %run notebook.ipynb error""" - pytest.importorskip("nbformat") - from nbformat import v4, writes - - # %run when a file name isn't provided - pytest.raises(Exception, _ip.magic, "run") - - # %run when a file doesn't exist - pytest.raises(Exception, _ip.magic, "run foobar.ipynb") - - # %run on a notebook with an error - nb = v4.new_notebook( - cells=[ - v4.new_code_cell("0/0") - ] - ) - src = writes(nb, version=4) - self.mktmp(src, ext='.ipynb') - pytest.raises(Exception, _ip.magic, "run %s" % self.fname) - - def test_file_options(self): - src = ('import sys\n' - 'a = " ".join(sys.argv[1:])\n') - self.mktmp(src) - test_opts = "-x 3 --verbose" - _ip.run_line_magic("run", "{0} {1}".format(self.fname, test_opts)) - assert _ip.user_ns["a"] == test_opts - - -class TestMagicRunWithPackage(unittest.TestCase): - - def writefile(self, name, content): - path = os.path.join(self.tempdir.name, name) - d = os.path.dirname(path) - if not os.path.isdir(d): - os.makedirs(d) - with open(path, "w", encoding="utf-8") as f: - f.write(textwrap.dedent(content)) - - def setUp(self): - self.package = package = 'tmp{0}'.format(''.join([random.choice(string.ascii_letters) for i in range(10)])) - """Temporary (probably) valid python package name.""" - - self.value = int(random.random() * 10000) - - self.tempdir = TemporaryDirectory() - self.__orig_cwd = os.getcwd() - sys.path.insert(0, self.tempdir.name) - - self.writefile(os.path.join(package, '__init__.py'), '') - self.writefile(os.path.join(package, 'sub.py'), """ - x = {0!r} - """.format(self.value)) - self.writefile(os.path.join(package, 'relative.py'), """ - from .sub import x - """) - self.writefile(os.path.join(package, 'absolute.py'), """ - from {0}.sub import x - """.format(package)) - self.writefile(os.path.join(package, 'args.py'), """ - import sys - a = " ".join(sys.argv[1:]) - """.format(package)) - - def tearDown(self): - os.chdir(self.__orig_cwd) - sys.path[:] = [p for p in sys.path if p != self.tempdir.name] - self.tempdir.cleanup() - - def check_run_submodule(self, submodule, opts=''): - _ip.user_ns.pop('x', None) - _ip.magic('run {2} -m {0}.{1}'.format(self.package, submodule, opts)) - self.assertEqual(_ip.user_ns['x'], self.value, - 'Variable `x` is not loaded from module `{0}`.' - .format(submodule)) - - def test_run_submodule_with_absolute_import(self): - self.check_run_submodule('absolute') - - def test_run_submodule_with_relative_import(self): - """Run submodule that has a relative import statement (#2727).""" - self.check_run_submodule('relative') - - def test_prun_submodule_with_absolute_import(self): - self.check_run_submodule('absolute', '-p') - - def test_prun_submodule_with_relative_import(self): - self.check_run_submodule('relative', '-p') - - def with_fake_debugger(func): - @functools.wraps(func) - def wrapper(*args, **kwds): - with patch.object(debugger.Pdb, 'run', staticmethod(eval)): - return func(*args, **kwds) - return wrapper - - @with_fake_debugger - def test_debug_run_submodule_with_absolute_import(self): - self.check_run_submodule('absolute', '-d') - - @with_fake_debugger - def test_debug_run_submodule_with_relative_import(self): - self.check_run_submodule('relative', '-d') - - def test_module_options(self): - _ip.user_ns.pop("a", None) - test_opts = "-x abc -m test" - _ip.run_line_magic("run", "-m {0}.args {1}".format(self.package, test_opts)) - assert _ip.user_ns["a"] == test_opts - - def test_module_options_with_separator(self): - _ip.user_ns.pop("a", None) - test_opts = "-x abc -m test" - _ip.run_line_magic("run", "-m {0}.args -- {1}".format(self.package, test_opts)) - assert _ip.user_ns["a"] == test_opts - - -def test_run__name__(): - with TemporaryDirectory() as td: - path = pjoin(td, "foo.py") - with open(path, "w", encoding="utf-8") as f: - f.write("q = __name__") - - _ip.user_ns.pop("q", None) - _ip.magic("run {}".format(path)) - assert _ip.user_ns.pop("q") == "__main__" - - _ip.magic("run -n {}".format(path)) - assert _ip.user_ns.pop("q") == "foo" - - try: - _ip.magic("run -i -n {}".format(path)) - assert _ip.user_ns.pop("q") == "foo" - finally: - _ip.magic('reset -f') - - -def test_run_tb(): - """Test traceback offset in %run""" - with TemporaryDirectory() as td: - path = pjoin(td, "foo.py") - with open(path, "w", encoding="utf-8") as f: - f.write( - "\n".join( - [ - "def foo():", - " return bar()", - "def bar():", - " raise RuntimeError('hello!')", - "foo()", - ] - ) - ) - with capture_output() as io: - _ip.magic('run {}'.format(path)) - out = io.stdout - assert "execfile" not in out - assert "RuntimeError" in out - assert out.count("---->") == 3 - del ip.user_ns['bar'] - del ip.user_ns['foo'] - - -def test_multiprocessing_run(): - """Set we can run mutiprocesgin without messing up up main namespace - - Note that import `nose.tools as nt` mdify the value s - sys.module['__mp_main__'] so we need to temporarily set it to None to test - the issue. - """ - with TemporaryDirectory() as td: - mpm = sys.modules.get('__mp_main__') - sys.modules['__mp_main__'] = None - try: - path = pjoin(td, "test.py") - with open(path, "w", encoding="utf-8") as f: - f.write("import multiprocessing\nprint('hoy')") - with capture_output() as io: - _ip.run_line_magic('run', path) - _ip.run_cell("i_m_undefined") - out = io.stdout - assert "hoy" in out - assert "AttributeError" not in out - assert "NameError" in out - assert out.count("---->") == 1 - except: - raise - finally: - sys.modules['__mp_main__'] = mpm - - -def test_script_tb(): - """Test traceback offset in `ipython script.py`""" - with TemporaryDirectory() as td: - path = pjoin(td, "foo.py") - with open(path, "w", encoding="utf-8") as f: - f.write( - "\n".join( - [ - "def foo():", - " return bar()", - "def bar():", - " raise RuntimeError('hello!')", - "foo()", - ] - ) - ) - out, err = tt.ipexec(path) - assert "execfile" not in out - assert "RuntimeError" in out - assert out.count("---->") == 3 diff --git a/IPython/core/tests/test_shellapp.py b/IPython/core/tests/test_shellapp.py deleted file mode 100644 index 9f4f87b81f2..00000000000 --- a/IPython/core/tests/test_shellapp.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -"""Tests for shellapp module. - -Authors -------- -* Bradley Froehle -""" -#----------------------------------------------------------------------------- -# Copyright (C) 2012 The IPython Development Team -# -# Distributed under the terms of the BSD License. The full license is in -# the file COPYING, distributed as part of this software. -#----------------------------------------------------------------------------- - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- -import unittest - -from IPython.testing import decorators as dec -from IPython.testing import tools as tt - - -class TestFileToRun(tt.TempFileMixin, unittest.TestCase): - """Test the behavior of the file_to_run parameter.""" - - def test_py_script_file_attribute(self): - """Test that `__file__` is set when running `ipython file.py`""" - src = "print(__file__)\n" - self.mktmp(src) - - err = None - tt.ipexec_validate(self.fname, self.fname, err) - - def test_ipy_script_file_attribute(self): - """Test that `__file__` is set when running `ipython file.ipy`""" - src = "print(__file__)\n" - self.mktmp(src, ext='.ipy') - - err = None - tt.ipexec_validate(self.fname, self.fname, err) - - # The commands option to ipexec_validate doesn't work on Windows, and it - # doesn't seem worth fixing - @dec.skip_win32 - def test_py_script_file_attribute_interactively(self): - """Test that `__file__` is not set after `ipython -i file.py`""" - src = "True\n" - self.mktmp(src) - - out, err = tt.ipexec( - self.fname, - options=["-i"], - commands=['"__file__" in globals()', "print(123)", "exit()"], - ) - assert "False" in out, f"Subprocess stderr:\n{err}\n-----" diff --git a/IPython/core/tests/test_splitinput.py b/IPython/core/tests/test_splitinput.py deleted file mode 100644 index 8969da250ae..00000000000 --- a/IPython/core/tests/test_splitinput.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 - -from IPython.core.splitinput import split_user_input, LineInfo -from IPython.testing import tools as tt - -tests = [ - ("x=1", ("", "", "x", "=1")), - ("?", ("", "?", "", "")), - ("??", ("", "??", "", "")), - (" ?", (" ", "?", "", "")), - (" ??", (" ", "??", "", "")), - ("??x", ("", "??", "x", "")), - ("?x=1", ("", "?", "x", "=1")), - ("!ls", ("", "!", "ls", "")), - (" !ls", (" ", "!", "ls", "")), - ("!!ls", ("", "!!", "ls", "")), - (" !!ls", (" ", "!!", "ls", "")), - (",ls", ("", ",", "ls", "")), - (";ls", ("", ";", "ls", "")), - (" ;ls", (" ", ";", "ls", "")), - ("f.g(x)", ("", "", "f.g", "(x)")), - ("f.g (x)", ("", "", "f.g", "(x)")), - ("?%hist1", ("", "?", "%hist1", "")), - ("?%%hist2", ("", "?", "%%hist2", "")), - ("??%hist3", ("", "??", "%hist3", "")), - ("??%%hist4", ("", "??", "%%hist4", "")), - ("?x*", ("", "?", "x*", "")), -] -tests.append(("Pérez Fernando", ("", "", "Pérez", "Fernando"))) - - -def test_split_user_input(): - return tt.check_pairs(split_user_input, tests) - -def test_LineInfo(): - """Simple test for LineInfo construction and str()""" - linfo = LineInfo(" %cd /home") - assert str(linfo) == "LineInfo [ |%|cd|/home]" diff --git a/IPython/core/tests/test_ultratb.py b/IPython/core/tests/test_ultratb.py deleted file mode 100644 index 1f49603ee88..00000000000 --- a/IPython/core/tests/test_ultratb.py +++ /dev/null @@ -1,409 +0,0 @@ -# encoding: utf-8 -"""Tests for IPython.core.ultratb -""" -import io -import logging -import os.path -import platform -import re -import sys -import traceback -import unittest -from textwrap import dedent - -from tempfile import TemporaryDirectory - -from IPython.core.ultratb import ColorTB, VerboseTB -from IPython.testing import tools as tt -from IPython.testing.decorators import onlyif_unicode_paths -from IPython.utils.syspathcontext import prepended_to_syspath - -file_1 = """1 -2 -3 -def f(): - 1/0 -""" - -file_2 = """def f(): - 1/0 -""" - - -def recursionlimit(frames): - """ - decorator to set the recursion limit temporarily - """ - - def inner(test_function): - def wrapper(*args, **kwargs): - rl = sys.getrecursionlimit() - sys.setrecursionlimit(frames) - try: - return test_function(*args, **kwargs) - finally: - sys.setrecursionlimit(rl) - - return wrapper - - return inner - - -class ChangedPyFileTest(unittest.TestCase): - def test_changing_py_file(self): - """Traceback produced if the line where the error occurred is missing? - - https://github.com/ipython/ipython/issues/1456 - """ - with TemporaryDirectory() as td: - fname = os.path.join(td, "foo.py") - with open(fname, "w", encoding="utf-8") as f: - f.write(file_1) - - with prepended_to_syspath(td): - ip.run_cell("import foo") - - with tt.AssertPrints("ZeroDivisionError"): - ip.run_cell("foo.f()") - - # Make the file shorter, so the line of the error is missing. - with open(fname, "w", encoding="utf-8") as f: - f.write(file_2) - - # For some reason, this was failing on the *second* call after - # changing the file, so we call f() twice. - with tt.AssertNotPrints("Internal Python error", channel='stderr'): - with tt.AssertPrints("ZeroDivisionError"): - ip.run_cell("foo.f()") - with tt.AssertPrints("ZeroDivisionError"): - ip.run_cell("foo.f()") - -iso_8859_5_file = u'''# coding: iso-8859-5 - -def fail(): - """дбИЖ""" - 1/0 # дбИЖ -''' - -class NonAsciiTest(unittest.TestCase): - @onlyif_unicode_paths - def test_nonascii_path(self): - # Non-ascii directory name as well. - with TemporaryDirectory(suffix=u'é') as td: - fname = os.path.join(td, u"fooé.py") - with open(fname, "w", encoding="utf-8") as f: - f.write(file_1) - - with prepended_to_syspath(td): - ip.run_cell("import foo") - - with tt.AssertPrints("ZeroDivisionError"): - ip.run_cell("foo.f()") - - def test_iso8859_5(self): - with TemporaryDirectory() as td: - fname = os.path.join(td, 'dfghjkl.py') - - with io.open(fname, 'w', encoding='iso-8859-5') as f: - f.write(iso_8859_5_file) - - with prepended_to_syspath(td): - ip.run_cell("from dfghjkl import fail") - - with tt.AssertPrints("ZeroDivisionError"): - with tt.AssertPrints(u'дбИЖ', suppress=False): - ip.run_cell('fail()') - - def test_nonascii_msg(self): - cell = u"raise Exception('é')" - expected = u"Exception('é')" - ip.run_cell("%xmode plain") - with tt.AssertPrints(expected): - ip.run_cell(cell) - - ip.run_cell("%xmode verbose") - with tt.AssertPrints(expected): - ip.run_cell(cell) - - ip.run_cell("%xmode context") - with tt.AssertPrints(expected): - ip.run_cell(cell) - - ip.run_cell("%xmode minimal") - with tt.AssertPrints(u"Exception: é"): - ip.run_cell(cell) - - # Put this back into Context mode for later tests. - ip.run_cell("%xmode context") - -class NestedGenExprTestCase(unittest.TestCase): - """ - Regression test for the following issues: - https://github.com/ipython/ipython/issues/8293 - https://github.com/ipython/ipython/issues/8205 - """ - def test_nested_genexpr(self): - code = dedent( - """\ - class SpecificException(Exception): - pass - - def foo(x): - raise SpecificException("Success!") - - sum(sum(foo(x) for _ in [0]) for x in [0]) - """ - ) - with tt.AssertPrints('SpecificException: Success!', suppress=False): - ip.run_cell(code) - - -indentationerror_file = """if True: -zoon() -""" - -class IndentationErrorTest(unittest.TestCase): - def test_indentationerror_shows_line(self): - # See issue gh-2398 - with tt.AssertPrints("IndentationError"): - with tt.AssertPrints("zoon()", suppress=False): - ip.run_cell(indentationerror_file) - - with TemporaryDirectory() as td: - fname = os.path.join(td, "foo.py") - with open(fname, "w", encoding="utf-8") as f: - f.write(indentationerror_file) - - with tt.AssertPrints("IndentationError"): - with tt.AssertPrints("zoon()", suppress=False): - ip.magic('run %s' % fname) - -se_file_1 = """1 -2 -7/ -""" - -se_file_2 = """7/ -""" - -class SyntaxErrorTest(unittest.TestCase): - - def test_syntaxerror_no_stacktrace_at_compile_time(self): - syntax_error_at_compile_time = """ -def foo(): - .. -""" - with tt.AssertPrints("SyntaxError"): - ip.run_cell(syntax_error_at_compile_time) - - with tt.AssertNotPrints("foo()"): - ip.run_cell(syntax_error_at_compile_time) - - def test_syntaxerror_stacktrace_when_running_compiled_code(self): - syntax_error_at_runtime = """ -def foo(): - eval("..") - -def bar(): - foo() - -bar() -""" - with tt.AssertPrints("SyntaxError"): - ip.run_cell(syntax_error_at_runtime) - # Assert syntax error during runtime generate stacktrace - with tt.AssertPrints(["foo()", "bar()"]): - ip.run_cell(syntax_error_at_runtime) - del ip.user_ns['bar'] - del ip.user_ns['foo'] - - def test_changing_py_file(self): - with TemporaryDirectory() as td: - fname = os.path.join(td, "foo.py") - with open(fname, "w", encoding="utf-8") as f: - f.write(se_file_1) - - with tt.AssertPrints(["7/", "SyntaxError"]): - ip.magic("run " + fname) - - # Modify the file - with open(fname, "w", encoding="utf-8") as f: - f.write(se_file_2) - - # The SyntaxError should point to the correct line - with tt.AssertPrints(["7/", "SyntaxError"]): - ip.magic("run " + fname) - - def test_non_syntaxerror(self): - # SyntaxTB may be called with an error other than a SyntaxError - # See e.g. gh-4361 - try: - raise ValueError('QWERTY') - except ValueError: - with tt.AssertPrints('QWERTY'): - ip.showsyntaxerror() - -import sys - -if sys.version_info < (3, 9) and platform.python_implementation() != "PyPy": - """ - New 3.9 Pgen Parser does not raise Memory error, except on failed malloc. - """ - class MemoryErrorTest(unittest.TestCase): - def test_memoryerror(self): - memoryerror_code = "(" * 200 + ")" * 200 - with tt.AssertPrints("MemoryError"): - ip.run_cell(memoryerror_code) - - -class Python3ChainedExceptionsTest(unittest.TestCase): - DIRECT_CAUSE_ERROR_CODE = """ -try: - x = 1 + 2 - print(not_defined_here) -except Exception as e: - x += 55 - x - 1 - y = {} - raise KeyError('uh') from e - """ - - EXCEPTION_DURING_HANDLING_CODE = """ -try: - x = 1 + 2 - print(not_defined_here) -except Exception as e: - x += 55 - x - 1 - y = {} - raise KeyError('uh') - """ - - SUPPRESS_CHAINING_CODE = """ -try: - 1/0 -except Exception: - raise ValueError("Yikes") from None - """ - - def test_direct_cause_error(self): - with tt.AssertPrints(["KeyError", "NameError", "direct cause"]): - ip.run_cell(self.DIRECT_CAUSE_ERROR_CODE) - - def test_exception_during_handling_error(self): - with tt.AssertPrints(["KeyError", "NameError", "During handling"]): - ip.run_cell(self.EXCEPTION_DURING_HANDLING_CODE) - - def test_suppress_exception_chaining(self): - with tt.AssertNotPrints("ZeroDivisionError"), \ - tt.AssertPrints("ValueError", suppress=False): - ip.run_cell(self.SUPPRESS_CHAINING_CODE) - - def test_plain_direct_cause_error(self): - with tt.AssertPrints(["KeyError", "NameError", "direct cause"]): - ip.run_cell("%xmode Plain") - ip.run_cell(self.DIRECT_CAUSE_ERROR_CODE) - ip.run_cell("%xmode Verbose") - - def test_plain_exception_during_handling_error(self): - with tt.AssertPrints(["KeyError", "NameError", "During handling"]): - ip.run_cell("%xmode Plain") - ip.run_cell(self.EXCEPTION_DURING_HANDLING_CODE) - ip.run_cell("%xmode Verbose") - - def test_plain_suppress_exception_chaining(self): - with tt.AssertNotPrints("ZeroDivisionError"), \ - tt.AssertPrints("ValueError", suppress=False): - ip.run_cell("%xmode Plain") - ip.run_cell(self.SUPPRESS_CHAINING_CODE) - ip.run_cell("%xmode Verbose") - - -class RecursionTest(unittest.TestCase): - DEFINITIONS = """ -def non_recurs(): - 1/0 - -def r1(): - r1() - -def r3a(): - r3b() - -def r3b(): - r3c() - -def r3c(): - r3a() - -def r3o1(): - r3a() - -def r3o2(): - r3o1() -""" - def setUp(self): - ip.run_cell(self.DEFINITIONS) - - def test_no_recursion(self): - with tt.AssertNotPrints("skipping similar frames"): - ip.run_cell("non_recurs()") - - @recursionlimit(200) - def test_recursion_one_frame(self): - with tt.AssertPrints(re.compile( - r"\[\.\.\. skipping similar frames: r1 at line 5 $\d{2,3} times$\]") - ): - ip.run_cell("r1()") - - @recursionlimit(160) - def test_recursion_three_frames(self): - with tt.AssertPrints("[... skipping similar frames: "), \ - tt.AssertPrints(re.compile(r"r3a at line 8 $\d{2} times$"), suppress=False), \ - tt.AssertPrints(re.compile(r"r3b at line 11 $\d{2} times$"), suppress=False), \ - tt.AssertPrints(re.compile(r"r3c at line 14 $\d{2} times$"), suppress=False): - ip.run_cell("r3o2()") - - -#---------------------------------------------------------------------------- - -# module testing (minimal) -def test_handlers(): - def spam(c, d_e): - (d, e) = d_e - x = c + d - y = c * d - foo(x, y) - - def foo(a, b, bar=1): - eggs(a, b + bar) - - def eggs(f, g, z=globals()): - h = f + g - i = f - g - return h / i - - buff = io.StringIO() - - buff.write('') - buff.write('*** Before ***') - try: - buff.write(spam(1, (2, 3))) - except: - traceback.print_exc(file=buff) - - handler = ColorTB(ostream=buff) - buff.write('*** ColorTB ***') - try: - buff.write(spam(1, (2, 3))) - except: - handler(*sys.exc_info()) - buff.write('') - - handler = VerboseTB(ostream=buff) - buff.write('*** VerboseTB ***') - try: - buff.write(spam(1, (2, 3))) - except: - handler(*sys.exc_info()) - buff.write('') diff --git a/IPython/core/tips.py b/IPython/core/tips.py new file mode 100644 index 00000000000..41dc26458dd --- /dev/null +++ b/IPython/core/tips.py @@ -0,0 +1,135 @@ +from __future__ import annotations +from datetime import datetime +import importlib.util +import os +import sys +from typing import Any + +_tips: Any = { + # (month, day) + "every_year": { + (1, 1): "Happy new year!", + # European time: + # [2/8/25, 23:28:24] Fernando Perez: Hi! Yes, this was my first public + # announcement: + # [2/8/25, 23:28:25] Fernando Perez: + # https://mail.python.org/pipermail/python-list/2001-December/093408.html + # [2/8/25, 23:28:55] Fernando Perez: All that started two months earlier + # - in October 2001 I read this article: + # [2/8/25, 23:28:55] Fernando Perez: + # https://web.archive.org/web/20011202000624/http://www.onlamp.com/pub/a/python/2001/10/11/pythonnews.html + # [2/8/25, 23:29:05] Fernando Perez: Which is also archived here: + # [2/8/25, 23:29:05] Fernando Perez: + # https://docstore.mik.ua/orelly/weblinux2/orn/interactive_python.html + # [2/8/25, 23:29:48] Fernando Perez: That article put me on the trail of + # LazyPython, and I also found out (can’t remember where) about IPP + # (Interactive Python Prompt), another similar projecd by Janko Hauser. + # [2/8/25, 23:30:20] Fernando Perez: A also read an article around that + # time, about new features in Python 2.0, which spoke of how + # sys.displayhook could be programmed to call any object you wanted. + # [2/8/25, 23:31:01] Fernando Perez: Those things together gave me the + # idea of implementing a stateful object, the “IPython Prompt”, that + # could store a cache of old results, Mathematica-style, and that could + # have all kinds of other useful tricks up its sleeve. + # [2/8/25, 23:31:17] Fernando Perez: I can’t remember if I did the + # prompt stuff first and then read about LazyPython/IPP. + # [2/8/25, 23:31:41] Fernando Perez: I do know that, implementation + # wise, at first I just did the tiny IPython 0.0.1 that I posted much + # later on github as a gist: + # [2/8/25, 23:31:55] Fernando Perez: + # https://gist.github.com/fperez/1579699 + # [2/8/25, 23:32:03] Fernando Perez: But I only shared that publicly + # much later. + # [2/8/25, 23:33:19] Fernando Perez: I did find out about IPP/LazyPython + # sometime in October, contacted Janko and Nathan who told me to use + # their code at will but said they were busy with other things, and got + # cranking for a few mad weeks on what became the IPython 0.2.0 that I + # posted about in that comp.lang.python thread of December 2001. + # [2/8/25, 23:33:52] Fernando Perez: That period from Oct 11 to Dec 9 + # 2001 was maniacal coding, with very little sleep 🙂 + ( + 10, + 11, + ): "IPython's first line of code was written {} years ago by Fernando Pérez".format( + datetime.now().year - 2001 + ), + ( + 12, + 9, + ): "IPython 0.0.2 was announced {} years ago: https://mail.python.org/pipermail/python-list/2001-December/093408.html".format( + datetime.now().year - 2001 + ), + ( + 3, + 8, + ): "Today is International Women's Day: https://www.internationalwomensday.com/", + ( + 3, + 31, + ): "Happy International Transgender Day of Visibility! You are valid. You matter. https://en.wikipedia.org/wiki/International_Transgender_Day_of_Visibility", + }, + "random": [ + "Use `F2` or %edit with no arguments to open an empty editor with a temporary file.", + "Run your doctests from within IPython for development and debugging. The special %doctest_mode command toggles a mode where the prompt, output and exceptions display matches as closely as possible that of the default Python interpreter.", + "You can use `files = !ls *.png`", + "Use the IPython.lib.demo.Demo class to load any Python script as an interactive demo.", + "Put a ';' at the end of a line to suppress the printing of output.", + "You can use Ctrl-O to force a new line in terminal IPython", + "Use `object?` to see the help on `object`, `object??` to view its source", + "`?` alone on a line will brings up IPython's help", + "You can use `%hist` to view history, see the options with `%history?`", + "You can change the editing mode of IPython to behave more like vi, or emacs.", + "IPython 9.0+ has hooks to integrate AI/LLM completions.", + "Use `%timeit` or `%%timeit`, and the `-r`, `-n`, and `-o` options to easily profile your code.", + "Use `ipython --help-all | less` to view all the IPython configuration options.", + "Use `--theme`, or the `%colors` magic to change IPython's themes and colors.", + "The `%timeit` magic has a `-o` flag, which returns the results, making it easy to plot. See `%timeit?`.", + ], +} + +if os.name == "nt": + _tips["random"].extend( + [ + "We can't show you all tips on Windows as sometimes Unicode characters crash the Windows console, please help us debug it." + ] + ) + # unicode may crash windows console, so we filter out tips with non-ASCII characters. + _tips["every_year"] = { + k: v + for k, v in _tips["every_year"].items() + if all(ord(char) < 128 for char in v) + } +else: + _tips["random"].extend( + [ + "You can use LaTeX or Unicode completion, `\\alpha` will insert the α symbol.", + "You can find how to type a LaTeX symbol by back-completing it, eg `\\θ` will expand to `\\theta`.", + "You can find how to type a Unicode symbol by back-completing it, eg `\\Ⅷ` will expand to `\\ROMAN NUMERAL EIGHT`.", + "IPython supports combining unicode identifiers, eg F\\vec will become F⃗, useful for physics equations. Play with \\dot \\ddot and others.", + ] + ) + +if sys.version_info < (3, 12): + _tips["random"].append( + "IPython support for Python versions outside of SPEC-0 is funded by the D. E. Shaw group: https://deshaw.com" + ) + +# Check if argcomplete is installed and add tip. +# `find_spec` only looks the module up on sys.path; actually importing +# argcomplete costs ~3 ms and 8 modules on every IPython startup, just to +# decide whether one tip out of many is eligible to be shown. +if importlib.util.find_spec("argcomplete") is not None: + _tips["random"].append( + "Run `activate-global-python-argcomplete` from your shell to enable CLI completion for IPython" + ) + + +def pick_tip() -> str: + current_date = datetime.now() + month, day = current_date.month, current_date.day + + if (month, day) in _tips["every_year"]: + return _tips["every_year"][(month, day)] + + from random import choice + return choice(_tips["random"]) diff --git a/IPython/core/ultratb.py b/IPython/core/ultratb.py index 85697919408..1207692e798 100644 --- a/IPython/core/ultratb.py +++ b/IPython/core/ultratb.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ Verbose and colourful traceback formatting. @@ -52,27 +51,6 @@ Note: Much of the code in this module was lifted verbatim from the standard library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. -Color schemes -------------- - -The colors are defined in the class TBTools through the use of the -ColorSchemeTable class. Currently the following exist: - - - NoColor: allows all of this module to be used in any terminal (the color - escapes are just dummy blank strings). - - - Linux: is meant to look good in a terminal like the Linux console (black - or very dark background). - - - LightBG: similar to Linux but swaps dark/light colors to be more readable - in light background terminals. - - - Neutral: a neutral color scheme that should be readable on both light and - dark background - -You can implement other color schemes easily, the syntax is fairly -self-explanatory. Please send back new schemes you develop to the author for -possible inclusion in future releases. Inheritance diagram: @@ -80,267 +58,60 @@ :parts: 3 """ -#***************************************************************************** +from __future__ import annotations + +# ***************************************************************************** # Copyright (C) 2001 Nathaniel Gray # Copyright (C) 2001-2004 Fernando Perez # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. -#***************************************************************************** - +# ***************************************************************************** -import inspect import linecache -import pydoc import sys import time -import traceback +import types +import warnings +from collections.abc import Sequence from types import TracebackType -from typing import Tuple, List, Any, Optional - -import stack_data -from pygments.formatters.terminal256 import Terminal256Formatter -from pygments.styles import get_style_by_name - -# IPython's own modules -from IPython import get_ipython -from IPython.core import debugger -from IPython.core.display_trap import DisplayTrap -from IPython.core.excolors import exception_colors -from IPython.utils import path as util_path -from IPython.utils import py3compat +from typing import Any +from collections.abc import Callable +from typing import TYPE_CHECKING + +from pygments.token import Token + +from IPython.core.getipython import get_ipython from IPython.utils.terminal import get_terminal_size -import IPython.utils.colorable as colorable +from .display_trap import DisplayTrap +from .doctb import DocTB +from .tbtools import ( + FrameInfo, + TBTools, + _format_traceback_lines, + _safe_string, + _simple_format_traceback_lines, + _tokens_filename, + eqrepr, + get_line_number_of_frame, + nullrepr, +) + +if TYPE_CHECKING: + import stack_data + from IPython.utils.PyColorize import TokenStream + import traceback # Globals # amount of space to put line numbers before verbose tracebacks INDENT_SIZE = 8 -# Default color scheme. This is used, for example, by the traceback -# formatter. When running in an actual IPython instance, the user's rc.colors -# value is used, but having a module global makes this functionality available -# to users of ultratb who are NOT running inside ipython. -DEFAULT_SCHEME = 'NoColor' +# When files are too long do not use stackdata to get frames. +# it is too long. +FAST_THRESHOLD = 10_000 # --------------------------------------------------------------------------- -# Code begins - -# Helper function -- largely belongs to VerboseTB, but we need the same -# functionality to produce a pseudo verbose TB for SyntaxErrors, so that they -# can be recognized properly by ipython.el's py-traceback-line-re -# (SyntaxErrors have to be treated specially because they have no traceback) - - -def _format_traceback_lines(lines, Colors, has_colors: bool, lvals): - """ - Format tracebacks lines with pointing arrow, leading numbers... - - Parameters - ---------- - lines : list[Line] - Colors - ColorScheme used. - lvals : str - Values of local variables, already colored, to inject just after the error line. - """ - numbers_width = INDENT_SIZE - 1 - res = [] - - for stack_line in lines: - if stack_line is stack_data.LINE_GAP: - res.append('%s (...)%s\n' % (Colors.linenoEm, Colors.Normal)) - continue - - line = stack_line.render(pygmented=has_colors).rstrip('\n') + '\n' - lineno = stack_line.lineno - if stack_line.is_current: - # This is the line with the error - pad = numbers_width - len(str(lineno)) - num = '%s%s' % (debugger.make_arrow(pad), str(lineno)) - start_color = Colors.linenoEm - else: - num = '%*s' % (numbers_width, lineno) - start_color = Colors.lineno - - line = '%s%s%s %s' % (start_color, num, Colors.Normal, line) - - res.append(line) - if lvals and stack_line.is_current: - res.append(lvals + '\n') - return res - - -def _format_filename(file, ColorFilename, ColorNormal, *, lineno=None): - """ - Format filename lines with `In [n]` if it's the nth code cell or `File *.py` if it's a module. - - Parameters - ---------- - file : str - ColorFilename - ColorScheme's filename coloring to be used. - ColorNormal - ColorScheme's normal coloring to be used. - """ - ipinst = get_ipython() - - if ipinst is not None and file in ipinst.compile._filename_map: - file = "[%s]" % ipinst.compile._filename_map[file] - tpl_link = f"Input {ColorFilename}In {{file}}{ColorNormal}" - else: - file = util_path.compress_user( - py3compat.cast_unicode(file, util_path.fs_encoding) - ) - if lineno is None: - tpl_link = f"File {ColorFilename}{{file}}{ColorNormal}" - else: - tpl_link = f"File {ColorFilename}{{file}}:{{lineno}}{ColorNormal}" - - return tpl_link.format(file=file, lineno=lineno) - -#--------------------------------------------------------------------------- -# Module classes -class TBTools(colorable.Colorable): - """Basic tools used by all traceback printer classes.""" - - # Number of frames to skip when reporting tracebacks - tb_offset = 0 - - def __init__( - self, - color_scheme="NoColor", - call_pdb=False, - ostream=None, - parent=None, - config=None, - *, - debugger_cls=None, - ): - # Whether to call the interactive pdb debugger after printing - # tracebacks or not - super(TBTools, self).__init__(parent=parent, config=config) - self.call_pdb = call_pdb - - # Output stream to write to. Note that we store the original value in - # a private attribute and then make the public ostream a property, so - # that we can delay accessing sys.stdout until runtime. The way - # things are written now, the sys.stdout object is dynamically managed - # so a reference to it should NEVER be stored statically. This - # property approach confines this detail to a single location, and all - # subclasses can simply access self.ostream for writing. - self._ostream = ostream - - # Create color table - self.color_scheme_table = exception_colors() - - self.set_colors(color_scheme) - self.old_scheme = color_scheme # save initial value for toggles - self.debugger_cls = debugger_cls or debugger.Pdb - - if call_pdb: - self.pdb = debugger_cls() - else: - self.pdb = None - - def _get_ostream(self): - """Output stream that exceptions are written to. - - Valid values are: - - - None: the default, which means that IPython will dynamically resolve - to sys.stdout. This ensures compatibility with most tools, including - Windows (where plain stdout doesn't recognize ANSI escapes). - - - Any object with 'write' and 'flush' attributes. - """ - return sys.stdout if self._ostream is None else self._ostream - - def _set_ostream(self, val): - assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) - self._ostream = val - - ostream = property(_get_ostream, _set_ostream) - - @staticmethod - def _get_chained_exception(exception_value): - cause = getattr(exception_value, "__cause__", None) - if cause: - return cause - if getattr(exception_value, "__suppress_context__", False): - return None - return getattr(exception_value, "__context__", None) - - def get_parts_of_chained_exception( - self, evalue - ) -> Optional[Tuple[type, BaseException, TracebackType]]: - - chained_evalue = self._get_chained_exception(evalue) - - if chained_evalue: - return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__ - return None - - def prepare_chained_exception_message(self, cause) -> List[Any]: - direct_cause = "\nThe above exception was the direct cause of the following exception:\n" - exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n" - - if cause: - message = [[direct_cause]] - else: - message = [[exception_during_handling]] - return message - - @property - def has_colors(self) -> bool: - return self.color_scheme_table.active_scheme_name.lower() != "nocolor" - - def set_colors(self, *args, **kw): - """Shorthand access to the color table scheme selector method.""" - - # Set own color table - self.color_scheme_table.set_active_scheme(*args, **kw) - # for convenience, set Colors to the active scheme - self.Colors = self.color_scheme_table.active_colors - # Also set colors of debugger - if hasattr(self, 'pdb') and self.pdb is not None: - self.pdb.set_colors(*args, **kw) - - def color_toggle(self): - """Toggle between the currently active color scheme and NoColor.""" - - if self.color_scheme_table.active_scheme_name == 'NoColor': - self.color_scheme_table.set_active_scheme(self.old_scheme) - self.Colors = self.color_scheme_table.active_colors - else: - self.old_scheme = self.color_scheme_table.active_scheme_name - self.color_scheme_table.set_active_scheme('NoColor') - self.Colors = self.color_scheme_table.active_colors - - def stb2text(self, stb): - """Convert a structured traceback (a list) to a string.""" - return '\n'.join(stb) - - def text(self, etype, value, tb, tb_offset: Optional[int] = None, context=5): - """Return formatted traceback. - - Subclasses may override this if they add extra arguments. - """ - tb_list = self.structured_traceback(etype, value, tb, - tb_offset, context) - return self.stb2text(tb_list) - - def structured_traceback( - self, etype, evalue, tb, tb_offset: Optional[int] = None, context=5, mode=None - ): - """Return a list of traceback frames. - - Must be implemented by each class. - """ - raise NotImplementedError() - - -#--------------------------------------------------------------------------- class ListTB(TBTools): """Print traceback information from a traceback list, with optional color. @@ -360,13 +131,18 @@ class ListTB(TBTools): Because they are meant to be called without a full traceback (only a list), instances of this class can't call the interactive pdb debugger.""" - - def __call__(self, etype, value, elist): + def __call__( + self, + etype: type[BaseException], + evalue: BaseException | None, + etb: TracebackType | None, + ) -> None: self.ostream.flush() - self.ostream.write(self.text(etype, value, elist)) - self.ostream.write('\n') + self.ostream.write(self.text(etype, evalue, etb)) + self.ostream.write("\n") - def _extract_tb(self, tb): + def _extract_tb(self, tb: TracebackType | None) -> traceback.StackSummary | None: + import traceback if tb: return traceback.extract_tb(tb) else: @@ -375,11 +151,11 @@ def _extract_tb(self, tb): def structured_traceback( self, etype: type, - evalue: BaseException, - etb: Optional[TracebackType] = None, - tb_offset: Optional[int] = None, - context=5, - ): + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: """Return a color formatted string with the traceback info. Parameters @@ -403,52 +179,72 @@ def structured_traceback( """ # This is a workaround to get chained_exc_ids in recursive calls # etb should not be a tuple if structured_traceback is not recursive + # (see the recursive self.structured_traceback() call below), and can + # also be a pre-built list of frames per the docstring above; neither + # is expressible in the public `TracebackType | None` signature. + from IPython.utils.PyColorize import theme_table if isinstance(etb, tuple): - etb, chained_exc_ids = etb + etb, chained_exc_ids = etb # type: ignore[unreachable] else: chained_exc_ids = set() - + elist: list[Any] if isinstance(etb, list): - elist = etb + elist = etb # type: ignore[unreachable] elif etb is not None: - elist = self._extract_tb(etb) + elist = self._extract_tb(etb) # type: ignore[assignment] else: elist = [] tb_offset = self.tb_offset if tb_offset is None else tb_offset assert isinstance(tb_offset, int) - Colors = self.Colors - out_list = [] + out_list: list[str] = [] if elist: - if tb_offset and len(elist) > tb_offset: elist = elist[tb_offset:] - out_list.append('Traceback %s(most recent call last)%s:' % - (Colors.normalEm, Colors.Normal) + '\n') + out_list.append( + theme_table[self._theme_name].format( + [ + (Token, "Traceback"), + (Token, " "), + (Token.NormalEm, "(most recent call last)"), + (Token, ":"), + (Token, "\n"), + ] + ), + ) out_list.extend(self._format_list(elist)) # The exception info should be a single entry in the list. - lines = ''.join(self._format_exception_only(etype, evalue)) + lines = "".join(self._format_exception_only(etype, evalue)) out_list.append(lines) - exception = self.get_parts_of_chained_exception(evalue) + # Find chained exceptions if we have a traceback (not for exception-only mode) + if etb is not None: + exception = self.get_parts_of_chained_exception(evalue) - if exception and not id(exception[1]) in chained_exc_ids: - chained_exception_message = self.prepare_chained_exception_message( - evalue.__cause__)[0] - etype, evalue, etb = exception - # Trace exception to avoid infinite 'cause' loop - chained_exc_ids.add(id(exception[1])) - chained_exceptions_tb_offset = 0 - out_list = ( - self.structured_traceback( - etype, evalue, (etb, chained_exc_ids), - chained_exceptions_tb_offset, context) - + chained_exception_message - + out_list) + if exception and (id(exception[1]) not in chained_exc_ids): + chained_exception_message: list[str] = ( + self.prepare_chained_exception_message(evalue.__cause__)[0] + if evalue is not None + else [""] + ) + etype, evalue, etb = exception + # Trace exception to avoid infinite 'cause' loop + chained_exc_ids.add(id(exception[1])) + chained_exceptions_tb_offset = 0 + ol1 = self.structured_traceback( + etype, + evalue, + (etb, chained_exc_ids), # type: ignore[arg-type] + chained_exceptions_tb_offset, + context, + ) + ol2 = chained_exception_message + + out_list = ol1 + ol2 + out_list return out_list - def _format_list(self, extracted_list): + def _format_list(self, extracted_list: list[Any]) -> list[str]: """Format a list of traceback entry tuples for printing. Given a list of tuples as returned by extract_tb() or @@ -460,40 +256,45 @@ def _format_list(self, extracted_list): Lifted almost verbatim from traceback.py """ + from IPython.utils.PyColorize import theme_table - Colors = self.Colors - list = [] - for filename, lineno, name, line in extracted_list[:-1]: - item = " %s in %s%s%s\n" % ( - _format_filename( - filename, Colors.filename, Colors.Normal, lineno=lineno - ), - Colors.name, - name, - Colors.Normal, + output_list = [] + for ind, (filename, lineno, name, line) in enumerate(extracted_list): + # Will emphasize the last entry + em = True if ind == len(extracted_list) - 1 else False + + item = theme_table[self._theme_name].format( + [(Token.NormalEm if em else Token.Normal, " ")] + + _tokens_filename(em, filename, lineno=lineno) + ) + + # This seem to be only in xmode plain (%run sinpleer), investigate why not share with verbose. + # look at _tokens_filename in forma_record. + if name != "": + item += theme_table[self._theme_name].format( + [ + (Token.NormalEm if em else Token.Normal, " in "), + (Token.TB.NameEm if em else Token.TB.Name, name), + ] + ) + item += theme_table[self._theme_name].format( + [(Token.NormalEm if em else Token, "\n")] ) if line: - item += ' %s\n' % line.strip() - list.append(item) - # Emphasize the last entry - filename, lineno, name, line = extracted_list[-1] - item = "%s %s in %s%s%s%s\n" % ( - Colors.normalEm, - _format_filename( - filename, Colors.filenameEm, Colors.normalEm, lineno=lineno - ), - Colors.nameEm, - name, - Colors.normalEm, - Colors.Normal, - ) - if line: - item += '%s %s%s\n' % (Colors.line, line.strip(), - Colors.Normal) - list.append(item) - return list + item += theme_table[self._theme_name].format( + [ + (Token.Line if em else Token, " "), + (Token.Line if em else Token, line.strip()), + (Token, "\n"), + ] + ) + output_list.append(item) - def _format_exception_only(self, etype, value): + return output_list + + def _format_exception_only( + self, etype: type[BaseException], value: BaseException | None + ) -> list[str]: """Format the exception part of a traceback. The arguments are the exception type and value such as given by @@ -506,73 +307,107 @@ def _format_exception_only(self, etype, value): Also lifted nearly verbatim from traceback.py """ + from IPython.utils.PyColorize import theme_table + have_filedata = False - Colors = self.Colors - list = [] - stype = py3compat.cast_unicode(Colors.excName + etype.__name__ + Colors.Normal) + output_list = [] + stype_tokens = [(Token.ExcName, etype.__name__)] + stype: str = theme_table[self._theme_name].format(stype_tokens) if value is None: # Not sure if this can still happen in Python 2.6 and above - list.append(stype + '\n') + output_list.append(stype + "\n") else: if issubclass(etype, SyntaxError): + assert hasattr(value, "filename") + assert hasattr(value, "lineno") + assert hasattr(value, "text") + assert hasattr(value, "offset") + assert hasattr(value, "msg") have_filedata = True - if not value.filename: value.filename = "" + if not value.filename: + value.filename = "" if value.lineno: lineno = value.lineno textline = linecache.getline(value.filename, value.lineno) else: lineno = "unknown" textline = "" - list.append( - "%s %s%s\n" - % ( - Colors.normalEm, - _format_filename( + output_list.append( + theme_table[self._theme_name].format( + [(Token, " ")] + + _tokens_filename( + True, value.filename, - Colors.filenameEm, - Colors.normalEm, lineno=(None if lineno == "unknown" else lineno), - ), - Colors.Normal, + ) + + [(Token, "\n")] ) ) if textline == "": - textline = py3compat.cast_unicode(value.text, "utf-8") + # sep 2025: + # textline = py3compat.cast_unicode(value.text, "utf-8") + if value.text is None: + textline = "" + else: + assert isinstance(value.text, str) + textline = value.text if textline is not None: i = 0 while i < len(textline) and textline[i].isspace(): i += 1 - list.append('%s %s%s\n' % (Colors.line, - textline.strip(), - Colors.Normal)) + output_list.append( + theme_table[self._theme_name].format( + [ + (Token.Line, " "), + (Token.Line, textline.strip()), + (Token, "\n"), + ] + ) + ) if value.offset is not None: - s = ' ' - for c in textline[i:value.offset - 1]: + s = " " + for c in textline[i : value.offset - 1]: if c.isspace(): s += c else: - s += ' ' - list.append('%s%s^%s\n' % (Colors.caret, s, - Colors.Normal)) - - try: + s += " " + output_list.append( + theme_table[self._theme_name].format( + [(Token.Caret, s + "^"), (Token, "\n")] + ) + ) s = value.msg - except Exception: + else: s = self._some_str(value) if s: - list.append('%s%s:%s %s\n' % (stype, Colors.excName, - Colors.Normal, s)) + output_list.append( + theme_table[self._theme_name].format( + stype_tokens + + [ + (Token.ExcName, ":"), + (Token, " "), + (Token, s), + (Token, "\n"), + ] + ) + ) else: - list.append('%s\n' % stype) + output_list.append("%s\n" % stype) + + # PEP-678 notes + output_list.extend(f"{x}\n" for x in getattr(value, "__notes__", [])) # sync with user hooks if have_filedata: ipinst = get_ipython() if ipinst is not None: + assert value is not None + assert hasattr(value, "lineno") + assert hasattr(value, "filename") ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) - return list + return output_list def get_exception_only(self, etype, value): """Only print the exception type and message, without a traceback. @@ -584,7 +419,49 @@ def get_exception_only(self, etype, value): """ return ListTB.structured_traceback(self, etype, value) - def show_exception_only(self, etype, evalue): + def structured_traceback_doctest( + self, + etype, + evalue, + etb=None, + tb_offset=None, + context=5, + ): + """Return a doctest-freindly traceback. + + Shows only the header, an ellipsis, and the excepttion line. + """ + # Handle chained exception rule + if isinstance(etb, tuple): + etb, chained_exc_ids = etb + else: + chained_exc_ids = set() + + have_traceback = etb is not None + + out_list = [] + if have_traceback: + out_list.append("Traceback (most recent call last):\n") + out_list.append(" ...\n") + + lines = "".join(self._format_exception_only(etype, evalue)) + out_list.append(lines) + + # Handle chained exceptions + if etb is not None: + exception = self.get_parts_of_chained_exception(evalue) + if exception and (id(exception[1]) not in chained_exc_ids): + chained_exception_message = (self.prepare_chained_exception_message(evalue.__cause__)[0] if evalue is not None else [""]) + etype, evalue, etb = exception + chained_exc_ids.add(id(exception[1])) + chained_tb = self.structured_traceback_doctest(etype, evalue, (etb, chained_exc_ids), 0, context) + out_list = chained_tb + chained_exception_message + out_list + + return out_list + + def show_exception_only( + self, etype: BaseException | None, evalue: TracebackType | None + ) -> None: """Only print the exception type and message, without a traceback. Parameters @@ -596,18 +473,22 @@ def show_exception_only(self, etype, evalue): # a subclass whose signature or behavior may be different ostream = self.ostream ostream.flush() - ostream.write('\n'.join(self.get_exception_only(etype, evalue))) + ostream.write("\n".join(self.get_exception_only(etype, evalue))) ostream.flush() - def _some_str(self, value): + def _some_str(self, value: Any) -> str: # Lifted from traceback.py try: - return py3compat.cast_unicode(str(value)) - except: - return u'' % type(value).__name__ + return str(value) + except Exception: + return "" % type(value).__name__ + +_sentinel = object() +_default = "default" -#---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- class VerboseTB(TBTools): """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead of HTML. Requires inspect and pydoc. Crazy, man. @@ -616,18 +497,24 @@ class VerboseTB(TBTools): traceback, to be used with alternate interpreters (because their own code would appear in the traceback).""" + tb_highlight = "bg:ansiyellow" + tb_highlight_style = "default" + + _mode: str + def __init__( self, - color_scheme: str = "Linux", + # TODO: no default ? + theme_name: str = _default, call_pdb: bool = False, - ostream=None, + ostream: Any = None, tb_offset: int = 0, long_header: bool = False, include_vars: bool = True, - check_cache=None, - debugger_cls=None, - parent=None, - config=None, + check_cache: Callable[[], None] | None = None, + debugger_cls: type | None = None, + *, + color_scheme: Any = _sentinel, ): """Specify traceback offset, headers and color scheme. @@ -635,59 +522,85 @@ def __init__( tb_offset=1 allows use of this handler in interpreters which will have their own code at the top of the traceback (VerboseTB will first remove that frame before printing the traceback info).""" - TBTools.__init__( - self, - color_scheme=color_scheme, + if color_scheme is not _sentinel: + assert isinstance(color_scheme, str) + theme_name = color_scheme.lower() + + warnings.warn( + "color_scheme is deprecated as of IPython 9.0 and replaced by " + "theme_name (which should be lowercase). As you passed a " + "color_scheme value I will try to see if I have corresponding " + "theme.", + stacklevel=2, + category=DeprecationWarning, + ) + + if theme_name != _default: + warnings.warn( + "You passed both `theme_name` and `color_scheme` " + "(deprecated since IPython 9.0) to VerboseTB constructor. `theme_name` will " + "be ignored for the time being.", + stacklevel=2, + category=DeprecationWarning, + ) + + if theme_name == _default: + theme_name = "linux" + + assert isinstance(theme_name, str) + super().__init__( + theme_name=theme_name, call_pdb=call_pdb, ostream=ostream, - parent=parent, - config=config, debugger_cls=debugger_cls, ) self.tb_offset = tb_offset self.long_header = long_header self.include_vars = include_vars # By default we use linecache.checkcache, but the user can provide a - # different check_cache implementation. This is used by the IPython - # kernel to provide tracebacks for interactive code that is cached, - # by a compiler instance that flushes the linecache but preserves its - # own code cache. + # different check_cache implementation. This was formerly used by the + # IPython kernel for interactive code, but is no longer necessary. if check_cache is None: check_cache = linecache.checkcache self.check_cache = check_cache self.skip_hidden = True - def format_record(self, frame_info): + def format_record(self, frame_info: FrameInfo) -> str: """Format a single stack frame""" - Colors = self.Colors # just a shorthand + quicker name lookup - ColorsNormal = Colors.Normal # used a lot - - if isinstance(frame_info, stack_data.RepeatedFrames): - return ' %s[... skipping similar frames: %s]%s\n' % ( - Colors.excName, frame_info.description, ColorsNormal) - - indent = " " * INDENT_SIZE - em_normal = "%s\n%s%s" % (Colors.valEm, indent, ColorsNormal) - tpl_call = f"in {Colors.vName}{{file}}{Colors.valEm}{{scope}}{ColorsNormal}" - tpl_call_fail = "in %s%%s%s(***failed resolving arguments***)%s" % ( - Colors.vName, - Colors.valEm, - ColorsNormal, - ) - tpl_name_val = "%%s %s= %%s%s" % (Colors.valEm, ColorsNormal) + import inspect + import stack_data + from IPython.utils.PyColorize import theme_table + + assert isinstance(frame_info, FrameInfo) + + if isinstance(frame_info._sd, stack_data.RepeatedFrames): + return theme_table[self._theme_name].format( + [ + (Token, " "), + ( + Token.ExcName, + "[... skipping similar frames: %s]" % frame_info.description, + ), + (Token, "\n"), + ] + ) - link = _format_filename( - frame_info.filename, - Colors.filenameEm, - ColorsNormal, - lineno=frame_info.lineno, - ) - args, varargs, varkw, locals_ = inspect.getargvalues(frame_info.frame) + indent: str = " " * INDENT_SIZE - func = frame_info.executing.code_qualname() + assert isinstance(frame_info.lineno, int) + args, varargs, varkw, locals_ = inspect.getargvalues(frame_info.frame) + func: str + if frame_info.executing is not None: + func = frame_info.executing.code_qualname() + elif frame_info.code is not None: + func = ( + getattr(frame_info.code, "co_qualname", None) or frame_info.code.co_name + ) + else: + func = "?" if func == "": - call = tpl_call.format(file=func, scope="") + call = "" else: # Decide whether to include variable details or not var_repr = eqrepr if self.include_vars else nullrepr @@ -695,7 +608,10 @@ def format_record(self, frame_info): scope = inspect.formatargvalues( args, varargs, varkw, locals_, formatvalue=var_repr ) - call = tpl_call.format(file=func, scope=scope) + assert isinstance(scope, str) + call = theme_table[self._theme_name].format( + [(Token, "in "), (Token.VName, func), (Token.ValEm, scope)] + ) except KeyError: # This happens in situations like errors inside generator # expressions, where local variables are listed in the @@ -713,115 +629,234 @@ def format_record(self, frame_info): # dict( (k,v.strip()) for (k,v) in range(10) ) # will illustrate the error, if this exception catch is # disabled. - call = tpl_call_fail % func + call = theme_table[self._theme_name].format( + [ + (Token, "in "), + (Token.VName, func), + (Token.ValEm, "(***failed resolving arguments***)"), + ] + ) - lvals = '' - lvals_list = [] + lvals_toks: list[TokenStream] = [] if self.include_vars: try: # we likely want to fix stackdata at some point, but # still need a workaround. fibp = frame_info.variables_in_executing_piece for var in fibp: - lvals_list.append(tpl_name_val % (var.name, repr(var.value))) + lvals_toks.append( + [ + (Token, var.name), + (Token, " "), + (Token.ValEm, "= "), + (Token.ValEm, repr(var.value)), + ] + ) except Exception: - lvals_list.append( - "Exception trying to inspect frame. No more locals available." + lvals_toks.append( + [ + ( + Token, + "Exception trying to inspect frame. No more locals available.", + ), + ] ) - if lvals_list: - lvals = '%s%s' % (indent, em_normal.join(lvals_list)) - result = "%s, %s\n" % (link, call) + if frame_info._sd is None: + # fast fallback if file is too long + assert frame_info.filename is not None + level_tokens = ( + _tokens_filename(True, frame_info.filename, lineno=frame_info.lineno) + + [ + (Token, ", " if call else ""), + (Token, call), + (Token, "\n"), + ] + ) - result += ''.join(_format_traceback_lines(frame_info.lines, Colors, self.has_colors, lvals)) - return result + from IPython.utils.PyColorize import Parser + _line_format = Parser(theme_name=self._theme_name).format2 + assert isinstance(frame_info.code, types.CodeType) + first_line: int = frame_info.code.co_firstlineno + current_line: int = frame_info.lineno + raw_lines: list[str] = frame_info.raw_lines + index: int = current_line - first_line + assert frame_info.context is not None + if index >= frame_info.context: + start = max(index - frame_info.context, 0) + stop = index + frame_info.context + index = frame_info.context + else: + start = 0 + stop = index + frame_info.context + raw_lines = raw_lines[start:stop] + + # Jan 2025: may need _line_format(py3ompat.cast_unicode(s)) + raw_color_err = [] + for s in raw_lines: + formatted, is_error = _line_format(s, "str") + assert formatted is not None, "format2 should return str when out='str'" + raw_color_err.append((s, (formatted, is_error))) + + tb_tokens = _simple_format_traceback_lines( + current_line, + index, + raw_color_err, + lvals_toks, + theme=theme_table[self._theme_name], + ) + _tb_lines: str = theme_table[self._theme_name].format(tb_tokens) + + return theme_table[self._theme_name].format(level_tokens + tb_tokens) + else: + result = theme_table[self._theme_name].format( + _tokens_filename(True, frame_info.filename, lineno=frame_info.lineno) + ) + result += ", " if call else "" + result += f"{call}\n" + result += theme_table[self._theme_name].format( + _format_traceback_lines( + frame_info.lines, + theme_table[self._theme_name], + self.has_colors, + lvals_toks, + ) + ) + return result - def prepare_header(self, etype, long_version=False): - colors = self.Colors # just a shorthand + quicker name lookup - colorsnormal = colors.Normal # used a lot - exc = '%s%s%s' % (colors.excName, etype, colorsnormal) + def prepare_header(self, etype: str, long_version: bool = False) -> str: width = min(75, get_terminal_size()[0]) + from IPython.utils.PyColorize import theme_table if long_version: # Header with the exception type, python version, and date - pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable + pyver = "Python " + sys.version.split()[0] + ": " + sys.executable date = time.ctime(time.time()) - - head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * width, colorsnormal, - exc, ' ' * (width - len(str(etype)) - len(pyver)), - pyver, date.rjust(width) ) - head += "\nA problem occurred executing Python code. Here is the sequence of function" \ - "\ncalls leading up to the error, with the most recent (innermost) call last." + theme = theme_table[self._theme_name] + head = theme.format( + [ + (Token.Topline, theme.symbols["top_line"] * width), + (Token, "\n"), + (Token.ExcName, etype), + (Token, " " * (width - len(etype) - len(pyver))), + (Token, pyver), + (Token, "\n"), + (Token, date.rjust(width)), + ] + ) + head += ( + "\nA problem occurred executing Python code. Here is the sequence of function" + "\ncalls leading up to the error, with the most recent (innermost) call last." + ) else: # Simplified header - head = '%s%s' % (exc, 'Traceback (most recent call last)'. \ - rjust(width - len(str(etype))) ) + head = theme_table[self._theme_name].format( + [ + (Token.ExcName, etype), + ( + Token, + "Traceback (most recent call last)".rjust(width - len(etype)), + ), + ] + ) return head def format_exception(self, etype, evalue): - colors = self.Colors # just a shorthand + quicker name lookup - colorsnormal = colors.Normal # used a lot + from IPython.utils.PyColorize import theme_table + # Get (safely) a string form of the exception info try: etype_str, evalue_str = map(str, (etype, evalue)) - except: + except Exception: # User exception is improperly defined. etype, evalue = str, sys.exc_info()[:2] etype_str, evalue_str = map(str, (etype, evalue)) + + # PEP-678 notes + notes = getattr(evalue, "__notes__", []) + if not isinstance(notes, Sequence) or isinstance(notes, (str, bytes)): + notes = [_safe_string(notes, "__notes__", func=repr)] + + for note in notes: + assert isinstance(note, str) + + str_notes: Sequence[str] = notes + # ... and format it - return ['%s%s%s: %s' % (colors.excName, etype_str, - colorsnormal, py3compat.cast_unicode(evalue_str))] + return [ + theme_table[self._theme_name].format( + [(Token.ExcName, etype_str), (Token, ": "), (Token, evalue_str)] + ), + *( + theme_table[self._theme_name].format([(Token, note)]) + for note in str_notes + ), + ] def format_exception_as_a_whole( self, etype: type, - evalue: BaseException, - etb: Optional[TracebackType], - number_of_lines_of_context, - tb_offset: Optional[int], - ): + evalue: BaseException | None, + etb: TracebackType | None, + context: int, + tb_offset: int | None, + ) -> list[list[str]]: """Formats the header, traceback and exception message for a single exception. This may be called multiple times by Python 3 exception chaining (PEP 3134). """ + import stack_data + + from IPython.utils.PyColorize import theme_table + # some locals orig_etype = etype try: - etype = etype.__name__ + etype = etype.__name__ # type: ignore[assignment] except AttributeError: pass tb_offset = self.tb_offset if tb_offset is None else tb_offset assert isinstance(tb_offset, int) - head = self.prepare_header(etype, self.long_header) - records = ( - self.get_records(etb, number_of_lines_of_context, tb_offset) if etb else [] - ) + head = self.prepare_header(str(etype), self.long_header) + records = self.get_records(etb, context, tb_offset) if etb else [] frames = [] skipped = 0 lastrecord = len(records) - 1 - for i, r in enumerate(records): - if not isinstance(r, stack_data.RepeatedFrames) and self.skip_hidden: - if r.frame.f_locals.get("__tracebackhide__", 0) and i != lastrecord: + for i, record in enumerate(records): + if ( + not isinstance(record._sd, stack_data.RepeatedFrames) + and self.skip_hidden + ): + if ( + record.frame.f_locals.get("__tracebackhide__", 0) + and i != lastrecord + ): skipped += 1 continue if skipped: - Colors = self.Colors # just a shorthand + quicker name lookup - ColorsNormal = Colors.Normal # used a lot frames.append( - " %s[... skipping hidden %s frame]%s\n" - % (Colors.excName, skipped, ColorsNormal) + theme_table[self._theme_name].format( + [ + (Token, " "), + (Token.ExcName, "[... skipping hidden %s frame]" % skipped), + (Token, "\n"), + ] + ) ) skipped = 0 - frames.append(self.format_record(r)) + frames.append(self.format_record(record)) if skipped: - Colors = self.Colors # just a shorthand + quicker name lookup - ColorsNormal = Colors.Normal # used a lot frames.append( - " %s[... skipping hidden %s frame]%s\n" - % (Colors.excName, skipped, ColorsNormal) + theme_table[self._theme_name].format( + [ + (Token, " "), + (Token.ExcName, "[... skipping hidden %s frame]" % skipped), + (Token, "\n"), + ] + ) ) formatted_exception = self.format_exception(etype, evalue) @@ -829,20 +864,28 @@ def format_exception_as_a_whole( frame_info = records[-1] ipinst = get_ipython() if ipinst is not None: - ipinst.hooks.synchronize_with_editor(frame_info.filename, frame_info.lineno, 0) + ipinst.hooks.synchronize_with_editor( + frame_info.filename, frame_info.lineno, 0 + ) - return [[head] + frames + [''.join(formatted_exception[0])]] + return [[head] + frames + formatted_exception] + + def get_records(self, etb: TracebackType, context: int, tb_offset: int) -> Any: + import inspect + import stack_data + + from IPython.utils.PyColorize import theme_table - def get_records( - self, etb: TracebackType, number_of_lines_of_context: int, tb_offset: int - ): assert etb is not None - context = number_of_lines_of_context - 1 + context = context - 1 after = context // 2 before = context - after if self.has_colors: - style = get_style_by_name("default") - style = stack_data.style_with_executing_node(style, "bg:ansiyellow") + theme = theme_table[self._theme_name] + base_style = theme.as_pygments_style() + tb_highlight = theme.extra_style.get(Token.TbHighlight, self.tb_highlight) + style = stack_data.style_with_executing_node(base_style, tb_highlight) + from pygments.formatters.terminal256 import Terminal256Formatter formatter = Terminal256Formatter(style=style) else: formatter = None @@ -851,55 +894,135 @@ def get_records( after=after, pygments_formatter=formatter, ) - return list(stack_data.FrameInfo.stack_data(etb, options=options))[tb_offset:] + + # Collect traceback frames and their module sizes. + cf: TracebackType | None = etb + tbs: list[tuple[TracebackType, int]] = [] + while cf is not None: + try: + mod = inspect.getmodule(cf.tb_frame) + if mod is not None: + mod_name = mod.__name__ + root_name, *_ = mod_name.split(".") + if root_name == "IPython": + cf = cf.tb_next + continue + frame_len = get_line_number_of_frame(cf.tb_frame) + if frame_len == 0: + # File not found or not a .py file (e.g. from + # exec()). Check if source is actually available; if not, + # force the fast path so that FrameInfo's "Could not get + # source" fallback is rendered. + try: + inspect.getsourcelines(cf.tb_frame) + except OSError: + frame_len = FAST_THRESHOLD + 1 + except OSError: + frame_len = FAST_THRESHOLD + 1 + assert cf is not None # narrowing for mypy; guarded by while condition + tbs.append((cf, frame_len)) + cf = cf.tb_next + + # Group consecutive frames by fast/slow and process each group. + # Consecutive slow frames must be processed together so that + # stack_data can detect RepeatedFrames (recursion collapsing). + FIs: list[FrameInfo] = [] + i = 0 + while i < len(tbs): + tb, frame_len = tbs[i] + if frame_len > FAST_THRESHOLD: + frame = tb.tb_frame + lineno = frame.f_lineno + code = frame.f_code + filename = code.co_filename + FIs.append( + FrameInfo( + "Raw frame", filename, lineno, frame, code, context=context + ) + ) + i += 1 + else: + # Collect the consecutive run of slow frames + group_start = i + while i < len(tbs) and tbs[i][1] <= FAST_THRESHOLD: + i += 1 + # Build set of frame objects in this group for filtering + group_frames = {tbs[j][0].tb_frame for j in range(group_start, i)} + # Process via stack_data starting from the first tb in the group + for sd_fi in stack_data.FrameInfo.stack_data( + tbs[group_start][0], options=options + ): + # stack_data follows tb_next through the full chain, + # including IPython frames we skipped during collection. + # Filter those out, but always keep RepeatedFrames. + if isinstance(sd_fi, stack_data.RepeatedFrames) or sd_fi.frame in group_frames: + FIs.append(FrameInfo._from_stack_data_FrameInfo(sd_fi)) + + return FIs def structured_traceback( self, etype: type, - evalue: Optional[BaseException], - etb: Optional[TracebackType], - tb_offset: Optional[int] = None, - number_of_lines_of_context: int = 5, - ): + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: """Return a nice text document describing the traceback.""" - formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context, - tb_offset) + from IPython.utils.PyColorize import theme_table + + formatted_exceptions: list[list[str]] = self.format_exception_as_a_whole( + etype, evalue, etb, context, tb_offset + ) - colors = self.Colors # just a shorthand + quicker name lookup - colorsnormal = colors.Normal # used a lot - head = '%s%s%s' % (colors.topline, '-' * min(75, get_terminal_size()[0]), colorsnormal) - structured_traceback_parts = [head] + termsize = min(75, get_terminal_size()[0]) + theme = theme_table[self._theme_name] + head: str = theme.format( + [ + ( + Token.Topline, + theme.symbols["top_line"] * termsize, + ), + ] + ) + structured_traceback_parts: list[str] = [head] chained_exceptions_tb_offset = 0 lines_of_context = 3 - formatted_exceptions = formatted_exception exception = self.get_parts_of_chained_exception(evalue) if exception: assert evalue is not None - formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) + formatted_exceptions += self.prepare_chained_exception_message( + evalue.__cause__ + ) etype, evalue, etb = exception else: evalue = None chained_exc_ids = set() while evalue: - formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context, - chained_exceptions_tb_offset) + formatted_exceptions += self.format_exception_as_a_whole( + etype, evalue, etb, lines_of_context, chained_exceptions_tb_offset + ) exception = self.get_parts_of_chained_exception(evalue) - if exception and not id(exception[1]) in chained_exc_ids: - chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop - formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) + if exception and id(exception[1]) not in chained_exc_ids: + chained_exc_ids.add( + id(exception[1]) + ) # trace exception to avoid infinite 'cause' loop + formatted_exceptions += self.prepare_chained_exception_message( + evalue.__cause__ + ) etype, evalue, etb = exception else: evalue = None # we want to see exceptions in a reversed order: # the first exception should be on top - for formatted_exception in reversed(formatted_exceptions): - structured_traceback_parts += formatted_exception + for fx in reversed(formatted_exceptions): + structured_traceback_parts += fx return structured_traceback_parts - def debugger(self, force: bool = False): + def debugger(self, force: bool = False) -> None: """Call up the pdb debugger if desired, always clean up the tb reference. @@ -928,8 +1051,8 @@ def debugger(self, force: bool = False): with display_trap: self.pdb.reset() # Find the right frame so we don't pop up inside ipython itself - if hasattr(self, 'tb') and self.tb is not None: - etb = self.tb + if hasattr(self, "tb") and self.tb is not None: # type: ignore[has-type] + etb = self.tb # type: ignore[has-type] else: etb = self.tb = sys.last_traceback while self.tb is not None and self.tb.tb_next is not None: @@ -938,9 +1061,19 @@ def debugger(self, force: bool = False): if etb and etb.tb_next: etb = etb.tb_next self.pdb.botframe = etb.tb_frame - self.pdb.interaction(None, etb) + # last_value should be deprecated, but last-exc sometimme not set + # please check why later and remove the getattr. + exc = ( + sys.last_value + if sys.version_info < (3, 12) + else getattr(sys, "last_exc", sys.last_value) + ) + if exc: + self.pdb.interaction(None, exc) + else: + self.pdb.interaction(None, etb) - if hasattr(self, 'tb'): + if hasattr(self, "tb"): del self.tb def handler(self, info=None): @@ -948,8 +1081,8 @@ def handler(self, info=None): self.tb = etb ostream = self.ostream ostream.flush() - ostream.write(self.text(etype, evalue, etb)) - ostream.write('\n') + ostream.write(self.text(etype, evalue, etb)) # type:ignore[arg-type] + ostream.write("\n") ostream.flush() # Changed so an instance can just be called as VerboseTB_inst() and print @@ -966,7 +1099,7 @@ def __call__(self, etype=None, evalue=None, etb=None): print("\nKeyboardInterrupt") -#---------------------------------------------------------------------------- +# ---------------------------------------------------------------------------- class FormattedTB(VerboseTB, ListTB): """Subclass ListTB but allow calling with a traceback. @@ -977,64 +1110,101 @@ class FormattedTB(VerboseTB, ListTB): Allows a tb_offset to be specified. This is useful for situations where one needs to remove a number of topmost frames from the traceback (such as occurs with python programs that themselves execute other python code, - like Python shells). """ + like Python shells).""" mode: str - def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, - ostream=None, - tb_offset=0, long_header=False, include_vars=False, - check_cache=None, debugger_cls=None, - parent=None, config=None): - + def __init__( + self, + mode="Plain", + # TODO: no default + theme_name="linux", + call_pdb=False, + ostream=None, + tb_offset=0, + long_header=False, + include_vars=False, + check_cache=None, + debugger_cls=None, + ): # NEVER change the order of this list. Put new modes at the end: - self.valid_modes = ['Plain', 'Context', 'Verbose', 'Minimal'] + self.valid_modes = ["Plain", "Context", "Verbose", "Minimal", "Docs", "Doctest"] self.verbose_modes = self.valid_modes[1:3] - VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, - ostream=ostream, tb_offset=tb_offset, - long_header=long_header, include_vars=include_vars, - check_cache=check_cache, debugger_cls=debugger_cls, - parent=parent, config=config) + VerboseTB.__init__( + self, + theme_name=theme_name, + call_pdb=call_pdb, + ostream=ostream, + tb_offset=tb_offset, + long_header=long_header, + include_vars=include_vars, + check_cache=check_cache, + debugger_cls=debugger_cls, + ) # Different types of tracebacks are joined with different separators to # form a single string. They are taken from this dict - self._join_chars = dict(Plain='', Context='\n', Verbose='\n', - Minimal='') + self._join_chars = dict( + Plain="", Context="\n", Verbose="\n", Minimal="", Docs="", Doctest="" + ) # set_mode also sets the tb_join_char attribute self.set_mode(mode) - def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5): + def structured_traceback( + self, + etype: type, + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: tb_offset = self.tb_offset if tb_offset is None else tb_offset mode = self.mode if mode in self.verbose_modes: # Verbose modes need a full traceback return VerboseTB.structured_traceback( - self, etype, value, tb, tb_offset, number_of_lines_of_context + self, etype, evalue, etb, tb_offset, context + ) + elif mode == "Docs": + # return DocTB + return DocTB( + theme_name=self._theme_name, + call_pdb=self.call_pdb, + ostream=self.ostream, + tb_offset=tb_offset, + long_header=self.long_header, + include_vars=self.include_vars, + check_cache=self.check_cache, + debugger_cls=self.debugger_cls, + ).structured_traceback( + etype, evalue, etb, tb_offset, 1 ) - elif mode == 'Minimal': - return ListTB.get_exception_only(self, etype, value) + + elif mode == "Minimal": + return ListTB.get_exception_only(self, etype, evalue) + elif mode == "Doctest": + return ListTB.structured_traceback_doctest(self, etype, evalue, etb, tb_offset, context) else: # We must check the source cache because otherwise we can print # out-of-date source code. self.check_cache() # Now we can extract and format the exception return ListTB.structured_traceback( - self, etype, value, tb, tb_offset, number_of_lines_of_context + self, etype, evalue, etb, tb_offset, context ) - def stb2text(self, stb): + def stb2text(self, stb: list[str]) -> str: """Convert a structured traceback (a list) to a string.""" return self.tb_join_char.join(stb) - def set_mode(self, mode: Optional[str] = None): + def set_mode(self, mode: str | None = None) -> None: """Switch to the desired mode. If mode is not specified, cycles through the available modes.""" if not mode: - new_idx = (self.valid_modes.index(self.mode) + 1 ) % \ - len(self.valid_modes) + new_idx = (self.valid_modes.index(self.mode) + 1) % len(self.valid_modes) self.mode = self.valid_modes[new_idx] elif mode not in self.valid_modes: raise ValueError( @@ -1045,25 +1215,25 @@ def set_mode(self, mode: Optional[str] = None): assert isinstance(mode, str) self.mode = mode # include variable details only in 'Verbose' mode - self.include_vars = (self.mode == self.valid_modes[2]) + self.include_vars = self.mode == self.valid_modes[2] # Set the join character for generating text tracebacks self.tb_join_char = self._join_chars[self.mode] # some convenient shortcuts - def plain(self): + def plain(self) -> None: self.set_mode(self.valid_modes[0]) - def context(self): + def context(self) -> None: self.set_mode(self.valid_modes[1]) - def verbose(self): + def verbose(self) -> None: self.set_mode(self.valid_modes[2]) - def minimal(self): + def minimal(self) -> None: self.set_mode(self.valid_modes[3]) -#---------------------------------------------------------------------------- +# ---------------------------------------------------------------------------- class AutoFormattedTB(FormattedTB): """A traceback printer which can be called on the fly. @@ -1071,15 +1241,21 @@ class AutoFormattedTB(FormattedTB): A brief example:: - AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') + AutoTB = AutoFormattedTB(mode = 'Verbose', theme_name='linux') try: ... except: AutoTB() # or AutoTB(out=logfile) where logfile is an open file object """ - def __call__(self, etype=None, evalue=None, etb=None, - out=None, tb_offset=None): + def __call__( + self, + etype: type | None = None, + evalue: BaseException | None = None, + etb: TracebackType | None = None, + out: Any = None, + tb_offset: int | None = None, + ) -> None: """Print out a formatted exception traceback. Optional arguments: @@ -1092,8 +1268,8 @@ def __call__(self, etype=None, evalue=None, etb=None, if out is None: out = self.ostream out.flush() - out.write(self.text(etype, evalue, etb, tb_offset)) - out.write('\n') + out.write(self.text(etype, evalue, etb, tb_offset)) # type:ignore[arg-type] + out.write("\n") out.flush() # FIXME: we should remove the auto pdb behavior from here and leave # that to the clients. @@ -1102,106 +1278,93 @@ def __call__(self, etype=None, evalue=None, etb=None, except KeyboardInterrupt: print("\nKeyboardInterrupt") - def structured_traceback(self, etype=None, value=None, tb=None, - tb_offset=None, number_of_lines_of_context=5): - - etype: type - value: BaseException + def structured_traceback( + self, + etype: type, + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: # tb: TracebackType or tupleof tb types ? + # etype can be None when called as structured_traceback(*sys.exc_info()) + # with no active exception; etb can be a tuple for a chained exception. + # Neither is expressible in the public signature above. if etype is None: - etype, value, tb = sys.exc_info() - if isinstance(tb, tuple): + etype, evalue, etb = sys.exc_info() # type: ignore[unreachable] + if isinstance(etb, tuple): # tb is a tuple if this is a chained exception. - self.tb = tb[0] + self.tb = etb[0] # type: ignore[unreachable] else: - self.tb = tb + self.tb = etb return FormattedTB.structured_traceback( - self, etype, value, tb, tb_offset, number_of_lines_of_context) + self, etype, evalue, etb, tb_offset, context + ) + +# --------------------------------------------------------------------------- -#--------------------------------------------------------------------------- # A simple class to preserve Nathan's original functionality. class ColorTB(FormattedTB): - """Shorthand to initialize a FormattedTB in Linux colors mode.""" + """Deprecated since IPython 9.0.""" - def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs): - FormattedTB.__init__(self, color_scheme=color_scheme, - call_pdb=call_pdb, **kwargs) + def __init__(self, *args, **kwargs): + warnings.warn( + "Deprecated since IPython 9.0 use FormattedTB directly ColorTB is just an alias", + DeprecationWarning, + stacklevel=2, + ) + + super().__init__(*args, **kwargs) class SyntaxTB(ListTB): """Extension which holds some state: the last exception value""" - def __init__(self, color_scheme='NoColor', parent=None, config=None): - ListTB.__init__(self, color_scheme, parent=parent, config=config) + last_syntax_error: BaseException | None + + def __init__(self, *, theme_name): + super().__init__(theme_name=theme_name) self.last_syntax_error = None def __call__(self, etype, value, elist): self.last_syntax_error = value - ListTB.__call__(self, etype, value, elist) + super().__call__(etype, value, elist) - def structured_traceback(self, etype, value, elist, tb_offset=None, - context=5): + def structured_traceback( + self, + etype: type, + evalue: BaseException | None, + etb: TracebackType | None = None, + tb_offset: int | None = None, + context: int = 5, + ) -> list[str]: + value = evalue # If the source file has been edited, the line in the syntax error can # be wrong (retrieved from an outdated cache). This replaces it with # the current value. - if isinstance(value, SyntaxError) \ - and isinstance(value.filename, str) \ - and isinstance(value.lineno, int): + if ( + isinstance(value, SyntaxError) + and isinstance(value.filename, str) + and isinstance(value.lineno, int) + ): linecache.checkcache(value.filename) newtext = linecache.getline(value.filename, value.lineno) if newtext: value.text = newtext self.last_syntax_error = value - return super(SyntaxTB, self).structured_traceback(etype, value, elist, - tb_offset=tb_offset, context=context) + return super().structured_traceback( + etype, value, etb, tb_offset=tb_offset, context=context + ) - def clear_err_state(self): + def clear_err_state(self) -> Any | None: """Return the current error state and clear it""" e = self.last_syntax_error self.last_syntax_error = None return e - def stb2text(self, stb): + def stb2text(self, stb: list[str]) -> str: """Convert a structured traceback (a list) to a string.""" - return ''.join(stb) - - -# some internal-use functions -def text_repr(value): - """Hopefully pretty robust repr equivalent.""" - # this is pretty horrible but should always return *something* - try: - return pydoc.text.repr(value) - except KeyboardInterrupt: - raise - except: - try: - return repr(value) - except KeyboardInterrupt: - raise - except: - try: - # all still in an except block so we catch - # getattr raising - name = getattr(value, '__name__', None) - if name: - # ick, recursion - return text_repr(name) - klass = getattr(value, '__class__', None) - if klass: - return '%s instance' % text_repr(klass) - except KeyboardInterrupt: - raise - except: - return 'UNRECOVERABLE REPR FAILURE' - - -def eqrepr(value, repr=text_repr): - return '=%s' % repr(value) - - -def nullrepr(value, repr=text_repr): - return '' + return "".join(stb) diff --git a/IPython/core/usage.py b/IPython/core/usage.py index 53219bceb25..7ee1db34343 100644 --- a/IPython/core/usage.py +++ b/IPython/core/usage.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Usage information for the main IPython applications. """ #----------------------------------------------------------------------------- @@ -46,7 +45,7 @@ This file is typically installed in the `IPYTHONDIR` directory, and there is a separate configuration directory for each profile. The default profile directory will be located in $IPYTHONDIR/profile_default. IPYTHONDIR - defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to + defaults to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Users\\YourUserName in most instances. To initialize a profile with the default configuration file, do:: @@ -194,16 +193,16 @@ * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) 1. Auto-parentheses - + Callable objects (i.e. functions, methods, etc) can be invoked like this (notice the commas between the arguments):: - + In [1]: callable_ob arg1, arg2, arg3 - + and the input will be translated to this:: - + callable_ob(arg1, arg2, arg3) - + This feature is off by default (in rare cases it can produce undesirable side-effects), but you can activate it at the command-line by starting IPython with `--autocall 1`, set it permanently in your @@ -211,49 +210,49 @@ You can force auto-parentheses by using '/' as the first character of a line. For example:: - + In [1]: /globals # becomes 'globals()' - + Note that the '/' MUST be the first character on the line! This won't work:: - + In [2]: print /globals # syntax error In most cases the automatic algorithm should work, so you should rarely need to explicitly invoke /. One notable exception is if you are trying to call a function with a list of tuples as arguments (the parenthesis will confuse IPython):: - + In [1]: zip (1,2,3),(4,5,6) # won't work - + but this will work:: - + In [2]: /zip (1,2,3),(4,5,6) ------> zip ((1,2,3),(4,5,6)) Out[2]= [(1, 4), (2, 5), (3, 6)] IPython tells you that it has altered your command line by displaying the new command line preceded by -->. e.g.:: - + In [18]: callable list -------> callable (list) 2. Auto-Quoting - + You can force auto-quoting of a function's arguments by using ',' as the first character of a line. For example:: - + In [1]: ,my_function /home/me # becomes my_function("/home/me") If you use ';' instead, the whole argument is quoted as a single string (while ',' splits on whitespace):: - + In [2]: ,my_function a b c # becomes my_function("a","b","c") In [3]: ;my_function a b c # becomes my_function("a b c") Note that the ',' MUST be the first character on the line! This won't work:: - + In [4]: x = ,my_function /home/me # syntax error """ @@ -335,7 +334,7 @@ default_banner_parts = ["Python %s\n"%sys.version.split("\n")[0], "Type 'copyright', 'credits' or 'license' for more information\n" , - "IPython {version} -- An enhanced Interactive Python. Type '?' for help.\n".format(version=release.version), + f"IPython {release.version} -- An enhanced Interactive Python. Type '?' for help.\n", ] default_banner = ''.join(default_banner_parts) diff --git a/IPython/display.py b/IPython/display.py index b7f64f25c97..da8982d6e2d 100644 --- a/IPython/display.py +++ b/IPython/display.py @@ -1,5 +1,4 @@ -"""Public API for display tools in IPython. -""" +"""Public API for display tools in IPython.""" # ----------------------------------------------------------------------------- # Copyright (C) 2012 The IPython Development Team @@ -14,31 +13,29 @@ from IPython.core.display_functions import * from IPython.core.display import ( - display_pretty, - display_html, - display_markdown, - display_svg, - display_png, - display_jpeg, - display_latex, - display_json, - display_javascript, - display_pdf, - DisplayObject, - TextDisplayObject, - Pretty, - HTML, - Markdown, - Math, - Latex, - SVG, - ProgressBar, - JSON, - GeoJSON, - Javascript, - Image, - set_matplotlib_formats, - set_matplotlib_close, - Video, + display_pretty as display_pretty, + display_html as display_html, + display_markdown as display_markdown, + display_svg as display_svg, + display_png as display_png, + display_jpeg as display_jpeg, + display_latex as display_latex, + display_json as display_json, + display_javascript as display_javascript, + display_pdf as display_pdf, + DisplayObject as DisplayObject, + TextDisplayObject as TextDisplayObject, + Pretty as Pretty, + HTML as HTML, + Markdown as Markdown, + Math as Math, + Latex as Latex, + SVG as SVG, + ProgressBar as ProgressBar, + JSON as JSON, + GeoJSON as GeoJSON, + Javascript as Javascript, + Image as Image, + Video as Video, ) from IPython.lib.display import * diff --git a/IPython/extensions/__init__.py b/IPython/extensions/__init__.py index db7f79fca6a..5634df8f255 100644 --- a/IPython/extensions/__init__.py +++ b/IPython/extensions/__init__.py @@ -1,2 +1 @@ -# -*- coding: utf-8 -*- """This directory is meant for IPython extensions.""" diff --git a/IPython/extensions/autoreload.py b/IPython/extensions/autoreload.py index 816d2f35ea2..e5e0b956f42 100644 --- a/IPython/extensions/autoreload.py +++ b/IPython/extensions/autoreload.py @@ -29,29 +29,33 @@ The following magic commands are provided: -``%autoreload`` +``%autoreload``, ``%autoreload now`` Reload all modules (except those excluded by ``%aimport``) automatically now. -``%autoreload 0`` +``%autoreload 0``, ``%autoreload off`` Disable automatic reloading. -``%autoreload 1`` +``%autoreload 1``, ``%autoreload explicit`` Reload all modules imported with ``%aimport`` every time before executing the Python code typed. -``%autoreload 2`` +``%autoreload 2``, ``%autoreload all`` Reload all modules (except those excluded by ``%aimport``) every time before executing the Python code typed. -``%autoreload 3`` +``%autoreload 3``, ``%autoreload complete`` - Reload all modules AND autoload newly added objects - every time before executing the Python code typed. + Same as 2/all, but also adds any new objects in the module. See + unit test at IPython/extensions/tests/test_autoreload.py::test_autoload_newly_added_objects + + Adding ``--print`` or ``-p`` to the ``%autoreload`` line will print autoreload activity to + standard out. ``--log`` or ``-l`` will do it to the log at INFO level; both can be used + simultaneously. ``%aimport`` @@ -69,6 +73,30 @@ Mark module 'foo' to not be autoreloaded. +Import Conflict Resolution +========================== + +In ``%autoreload 3`` mode, the extension tracks ``from X import Y`` style imports +and intelligently resolves conflicts when the same name is imported multiple ways. + +Import tracking occurs after successful code execution, ensuring that only valid +imports are tracked. This approach handles edge cases such as: + +- Importing a name that doesn't initially exist in a module, then adding that name + to the module and importing it again +- Conflicts between aliased imports (``from X import Y as Z``) and direct imports + (``from X import Z``) + +When conflicts occur: + +- If you first do ``from X import Y as Z`` then later ``from X import Z``, + the extension will switch to reloading ``Z`` instead of ``Y`` under the name ``Z``. + +- Similarly, if you first do ``from X import Z`` then later ``from X import Y as Z``, + the extension will switch to reloading ``Y`` as ``Z`` instead of the original ``Z``. + +- The most recent successful import always takes precedence in conflict resolution. + Caveats ======= @@ -95,7 +123,16 @@ before it is reloaded are not upgraded. - C extension modules cannot be reloaded, and so cannot be autoreloaded. + +- While comparing Enum and Flag, the 'is' Identity Operator is used (even in the case '==' has been used (Similar to the 'None' keyword)). + +- Reloading a module, or importing the same module by a different name, creates new Enums. These may look the same, but are not. """ +from __future__ import annotations + +from IPython.core import magic_arguments +from IPython.core.magic import Magics, magics_class, line_magic +from IPython.extensions.deduperreload.deduperreload import DeduperReloader __skip_doctest__ = True @@ -115,12 +152,14 @@ # Imports # ----------------------------------------------------------------------------- +import ast import os import sys import traceback import types import weakref import gc +import logging from importlib import import_module, reload from importlib.util import source_from_cache @@ -152,9 +191,21 @@ def __init__(self, shell=None): self.modules_mtimes = {} self.shell = shell + # Reporting callable for verbosity + self._report = lambda msg: None # by default, be quiet. + + # Deduper reloader + self.deduper_reloader = DeduperReloader() + + # Persistent import tracker for from-imports + self.import_from_tracker = ImportFromTracker({}, {}) + # Cache module modification times self.check(check_all=True, do_reload=False) + # To hide autoreload errors + self.hide_errors = False + def mark_module_skipped(self, module_name): """Skip reloading the named module in the future""" try: @@ -171,6 +222,10 @@ def mark_module_reloadable(self, module_name): pass self.modules[module_name] = True + def clear_import_tracker(self): + """Clear the persistent import tracker state""" + self.import_from_tracker = ImportFromTracker({}, {}) + def aimport_module(self, module_name): """Import a module, and mark it reloadable @@ -215,7 +270,7 @@ def filename_and_mtime(self, module): return py_filename, pymtime - def check(self, check_all=False, do_reload=True): + def check(self, check_all=False, do_reload=True, execution_info=None): """Check whether some modules need to be reloaded.""" if not self.enabled and not check_all: @@ -226,6 +281,10 @@ def check(self, check_all=False, do_reload=True): else: modules = list(self.modules.keys()) + # Use the persistent import_from_tracker + import_from_tracker = ( + self.import_from_tracker if self.import_from_tracker.imports_froms else None + ) for modname in modules: m = sys.modules.get(modname, None) @@ -250,21 +309,37 @@ def check(self, check_all=False, do_reload=True): # If we've reached this point, we should try to reload the module if do_reload: + self._report(f"Reloading '{modname}'.") try: if self.autoload_obj: - superreload(m, reload, self.old_objects, self.shell) + superreload( + m, + reload, + self.old_objects, + self.shell, + import_from_tracker=import_from_tracker, + ) + # if not using autoload, check if deduperreload is viable for this module + elif self.deduper_reloader.maybe_reload_module(m): + pass else: superreload(m, reload, self.old_objects) if py_filename in self.failed: del self.failed[py_filename] - except: - print( - "[autoreload of {} failed: {}]".format( - modname, traceback.format_exc(10) - ), - file=sys.stderr, - ) + except Exception: + if not self.hide_errors: + logger = logging.getLogger("autoreload") + logger.exception( + f"Failed to reload module '{modname}' from file '{py_filename}'" + ) + print( + "[autoreload of {} failed: {}]".format( + modname, traceback.format_exc(10) + ), + file=sys.stderr, + ) self.failed[py_filename] = pymtime + self.deduper_reloader.update_sources() # ------------------------------------------------------------------------------ @@ -279,6 +354,9 @@ def check(self, check_all=False, do_reload=True): "__closure__", "__globals__", "__dict__", + "__kwdefaults__", + "__annotations__", + "__type_params__", # PEP 695, Python 3.12+ ] @@ -300,7 +378,7 @@ class definition and update their __class__ to point to the new class for ref in refs: if type(ref) is old: - ref.__class__ = new + object.__setattr__(ref, "__class__", new) def update_class(old, new): @@ -379,14 +457,6 @@ def update_generic(a, b): return False -class StrongRef: - def __init__(self, obj): - self.obj = obj - - def __call__(self): - return self.obj - - mod_attrs = [ "__name__", "__doc__", @@ -399,6 +469,59 @@ def __call__(self): ] +class ImportFromTracker: + def __init__(self, imports_froms: dict, symbol_map: dict): + self.imports_froms = imports_froms + # symbol_map maps original_name -> list of resolved_names + self.symbol_map = {} + if symbol_map: + for module_name, mappings in symbol_map.items(): + self.symbol_map[module_name] = {} + for original_name, resolved_names in mappings.items(): + if isinstance(resolved_names, list): + self.symbol_map[module_name][original_name] = resolved_names[:] + else: + self.symbol_map[module_name][original_name] = [resolved_names] + else: + self.symbol_map = symbol_map or {} + + def add_import( + self, module_name: str, original_name: str, resolved_name: str + ) -> None: + """Add an import, handling conflicts with existing imports. + + This method is called after successful code execution, so we know the import is valid. + """ + if module_name not in self.imports_froms: + self.imports_froms[module_name] = [] + if module_name not in self.symbol_map: + self.symbol_map[module_name] = {} + + # Check if there's already a different mapping for the same resolved_name from a different original_name + # We need to remove any conflicting mappings + for orig_name, res_names in list(self.symbol_map[module_name].items()): + if resolved_name in res_names and orig_name != original_name: + # Remove the conflicting resolved_name from the other original_name's list + res_names.remove(resolved_name) + if ( + not res_names + ): # If the list is now empty, remove the original_name entirely + if orig_name in self.imports_froms[module_name]: + self.imports_froms[module_name].remove(orig_name) + del self.symbol_map[module_name][orig_name] + + # Add the new mapping + if original_name not in self.imports_froms[module_name]: + self.imports_froms[module_name].append(original_name) + + if original_name not in self.symbol_map[module_name]: + self.symbol_map[module_name][original_name] = [] + + # Add the resolved_name if it's not already in the list + if resolved_name not in self.symbol_map[module_name][original_name]: + self.symbol_map[module_name][original_name].append(resolved_name) + + def append_obj(module, d, name, obj, autoload=False): in_module = hasattr(obj, "__module__") and obj.__module__ == module.__name__ if autoload: @@ -417,7 +540,9 @@ def append_obj(module, d, name, obj, autoload=False): return True -def superreload(module, reload=reload, old_objects=None, shell=None): +def superreload( + module, reload=reload, old_objects=None, shell=None, import_from_tracker=None +): """Enhanced version of the builtin reload function. superreload remembers objects previously in the module, and @@ -453,23 +578,39 @@ def superreload(module, reload=reload, old_objects=None, shell=None): try: module = reload(module) - except: + except Exception: # restore module dictionary on failed reload module.__dict__.update(old_dict) raise - # iterate over all objects and update functions & classes for name, new_obj in list(module.__dict__.items()): key = (module.__name__, name) if key not in old_objects: # here 'shell' acts both as a flag and as an output var + imports_froms = ( + import_from_tracker.imports_froms if import_from_tracker else None + ) + symbol_map = import_from_tracker.symbol_map if import_from_tracker else None if ( shell is None or name == "Enum" or not append_obj(module, old_objects, name, new_obj, True) + or ( + imports_froms + and module.__name__ in imports_froms + and "*" not in imports_froms[module.__name__] + and name not in imports_froms[module.__name__] + ) ): continue - shell.user_ns[name] = new_obj + + # Handle symbol mapping - now supporting multiple resolved names per original name + if symbol_map and name in symbol_map.get(module.__name__, {}): + resolved_names = symbol_map.get(module.__name__, {})[name] + for resolved_name in resolved_names: + shell.user_ns[resolved_name] = new_obj + else: + shell.user_ns[name] = new_obj new_refs = [] for old_ref in old_objects[key]: @@ -491,8 +632,6 @@ def superreload(module, reload=reload, old_objects=None, shell=None): # IPython connectivity # ------------------------------------------------------------------------------ -from IPython.core.magic import Magics, magics_class, line_magic - @magics_class class AutoreloadMagics(Magics): @@ -504,24 +643,87 @@ def __init__(self, *a, **kw): self.loaded_modules = set(sys.modules) @line_magic - def autoreload(self, parameter_s=""): + @magic_arguments.magic_arguments() + @magic_arguments.argument( + "mode", + type=str, + default="now", + nargs="?", + help="""blank or 'now' - Reload all modules (except those excluded by %%aimport) + automatically now. + + '0' or 'off' - Disable automatic reloading. + + '1' or 'explicit' - Reload only modules imported with %%aimport every + time before executing the Python code typed. + + '2' or 'all' - Reload all modules (except those excluded by %%aimport) + every time before executing the Python code typed. + + '3' or 'complete' - Same as 2/all, but also adds any new + objects in the module. + + By default, a newer autoreload algorithm that diffs the module's source code + with the previous version and only reloads changed parts is applied for modes + 2 and below. To use the original algorithm, add the `-` suffix to the mode, + e.g. '%autoreload 2-', or pass in --full. + """, + ) + @magic_arguments.argument( + "-p", + "--print", + action="store_true", + default=False, + help="Show autoreload activity using `print` statements", + ) + @magic_arguments.argument( + "-l", + "--log", + action="store_true", + default=False, + help="Show autoreload activity using the logger", + ) + @magic_arguments.argument( + "--hide-errors", + action="store_true", + default=False, + help="Hide autoreload errors", + ) + @magic_arguments.argument( + "--full", + action="store_true", + default=False, + help="Don't ever use new diffing algorithm", + ) + def autoreload(self, line=""): r"""%autoreload => Reload modules automatically - %autoreload + %autoreload or %autoreload now Reload all modules (except those excluded by %aimport) automatically now. - %autoreload 0 + %autoreload 0 or %autoreload off Disable automatic reloading. - %autoreload 1 - Reload all modules imported with %aimport every time before executing + %autoreload 1 or %autoreload explicit + Reload only modules imported with %aimport every time before executing the Python code typed. - %autoreload 2 + %autoreload 2 or %autoreload all Reload all modules (except those excluded by %aimport) every time before executing the Python code typed. + %autoreload 3 or %autoreload complete + Same as 2/all, but also but also adds any new objects in the module. See + unit test at IPython/extensions/tests/test_autoreload.py::test_autoload_newly_added_objects + + The optional arguments --print and --log control display of autoreload activity. The default + is to act silently; --print (or -p) will print out the names of modules that are being + reloaded, and --log (or -l) outputs them to the log at INFO level. + + The optional argument --hide-errors hides any errors that can happen when trying to + reload code. + Reloading Python modules in a reliable way is in general difficult, and unexpected things may occur. %autoreload tries to work around common pitfalls by replacing function code objects and @@ -548,21 +750,55 @@ def autoreload(self, parameter_s=""): autoreloaded. """ - if parameter_s == "": + args = magic_arguments.parse_argstring(self.autoreload, line) + mode = args.mode.lower() + + enable_deduperreload = not args.full + if mode.endswith("-"): + enable_deduperreload = False + mode = mode[:-1] + self._reloader.deduper_reloader.enabled = enable_deduperreload + + p = print + + logger = logging.getLogger("autoreload") + + l = logger.info + + def pl(msg): + p(msg) + l(msg) + + if args.print is False and args.log is False: + self._reloader._report = lambda msg: None + elif args.print is True: + if args.log is True: + self._reloader._report = pl + else: + self._reloader._report = p + elif args.log is True: + self._reloader._report = l + + self._reloader.hide_errors = args.hide_errors + + if mode == "" or mode == "now": self._reloader.check(True) - elif parameter_s == "0": + elif mode == "0" or mode == "off": self._reloader.enabled = False - elif parameter_s == "1": + elif mode == "1" or mode == "explicit": + self._reloader.enabled = True self._reloader.check_all = False + self._reloader.autoload_obj = False + elif mode == "2" or mode == "all": self._reloader.enabled = True - elif parameter_s == "2": self._reloader.check_all = True + self._reloader.autoload_obj = False + elif mode == "3" or mode == "complete": self._reloader.enabled = True - self._reloader.enabled = True - elif parameter_s == "3": self._reloader.check_all = True - self._reloader.enabled = True self._reloader.autoload_obj = True + else: + raise ValueError(f'Unrecognized autoreload mode "{mode}".') @line_magic def aimport(self, parameter_s="", stream=None): @@ -572,13 +808,14 @@ def aimport(self, parameter_s="", stream=None): List modules to automatically import and not to import. %aimport foo - Import module 'foo' and mark it to be autoreloaded for %autoreload 1 + Import module 'foo' and mark it to be autoreloaded for %autoreload explicit %aimport foo, bar - Import modules 'foo', 'bar' and mark them to be autoreloaded for %autoreload 1 + Import modules 'foo', 'bar' and mark them to be autoreloaded for %autoreload explicit - %aimport -foo - Mark module 'foo' to not be autoreloaded for %autoreload 1 + %aimport -foo, bar + Mark module 'foo' to not be autoreloaded for %autoreload explicit, all, or complete, and 'bar' + to be autoreloaded for mode explicit. """ modname = parameter_s if not modname: @@ -591,25 +828,46 @@ def aimport(self, parameter_s="", stream=None): else: stream.write("Modules to reload:\n%s\n" % " ".join(to_reload)) stream.write("\nModules to skip:\n%s\n" % " ".join(to_skip)) - elif modname.startswith("-"): - modname = modname[1:] - self._reloader.mark_module_skipped(modname) else: for _module in [_.strip() for _ in modname.split(",")]: - top_module, top_name = self._reloader.aimport_module(_module) + if _module.startswith("-"): + _module = _module[1:].strip() + self._reloader.mark_module_skipped(_module) + else: + if " as " in _module: + real_name, alias = [_.strip() for _ in _module.split(" as ")] + else: + real_name, alias = _module, None + top_module, top_name = self._reloader.aimport_module(real_name) + + # Inject module to user namespace + self.shell.push({alias if alias else top_name: top_module}) - # Inject module to user namespace - self.shell.push({top_name: top_module}) + def pre_run_cell(self, info): + # Store the execution info for later use in post_execute_hook + self._last_execution_info = info - def pre_run_cell(self): if self._reloader.enabled: try: self._reloader.check() - except: + except Exception: pass def post_execute_hook(self): - """Cache the modification times of any modules imported in this execution""" + """Cache the modification times of any modules imported in this execution and track imports""" + + # Track imports from the recently executed code if autoreload 3 is enabled + if self._reloader.enabled and self._reloader.autoload_obj: + # Use the stored execution info + if ( + hasattr(self, "_last_execution_info") + and self._last_execution_info + and self._last_execution_info.transformed_cell + ): + self._track_imports_from_code( + self._last_execution_info.transformed_cell + ) + newly_loaded_modules = set(sys.modules) - self.loaded_modules for modname in newly_loaded_modules: _, pymtime = self._reloader.filename_and_mtime(sys.modules[modname]) @@ -618,6 +876,36 @@ def post_execute_hook(self): self.loaded_modules.update(newly_loaded_modules) + def _track_imports_from_code(self, code: str) -> None: + """Track import statements from executed code""" + try: + tree = ast.parse(code) + + for node in ast.walk(tree): + # Handle "from X import Y" style imports + if isinstance(node, ast.ImportFrom): + mod = node.module + + # Skip relative imports that don't have a module name + if mod is None: + continue + + for name in node.names: + # name.name is going to be actual name that we want to import from module + # name.asname is Z in the case of from X import Y as Z + # we should update Z in the shell in this situation, so track it too. + original_name = name.name + resolved_name = name.asname if name.asname else name.name + + # Since the code executed successfully, we know this import is valid + self._reloader.import_from_tracker.add_import( + mod, original_name, resolved_name + ) + except (SyntaxError, ValueError): + # If there's a syntax error, skip import tracking + # (though this shouldn't happen since the code already executed successfully) + pass + def load_ipython_extension(ip): """Load the extension in IPython.""" diff --git a/IPython/core/tests/__init__.py b/IPython/extensions/deduperreload/__init__.py similarity index 100% rename from IPython/core/tests/__init__.py rename to IPython/extensions/deduperreload/__init__.py diff --git a/IPython/extensions/deduperreload/deduperreload.py b/IPython/extensions/deduperreload/deduperreload.py new file mode 100644 index 00000000000..33c69d02856 --- /dev/null +++ b/IPython/extensions/deduperreload/deduperreload.py @@ -0,0 +1,642 @@ +from __future__ import annotations +import ast +import builtins +import contextlib +import itertools +import logging +import os +import pickle +import platform +import sys +import textwrap +import tokenize +from types import ModuleType +from typing import TYPE_CHECKING, Any, NamedTuple, cast +from collections.abc import Generator, Iterable + +from IPython.extensions.deduperreload.deduperreload_patching import ( + DeduperReloaderPatchingMixin, +) + +if TYPE_CHECKING: + TDefinitionAst = ( + ast.FunctionDef + | ast.AsyncFunctionDef + | ast.Import + | ast.ImportFrom + | ast.Assign + | ast.AnnAssign + ) + + +def get_module_file_name(module: ModuleType | str) -> str | None: + """Returns the module's file path, or the empty string if it's inaccessible""" + if (mod := sys.modules.get(module) if isinstance(module, str) else module) is None: + return "" + return getattr(mod, "__file__", "") or "" + + +def compare_ast(node1: ast.AST | list[ast.AST], node2: ast.AST | list[ast.AST]) -> bool: + """Checks if node1 and node2 have identical AST structure/values, apart from some attributes""" + if type(node1) is not type(node2): + return False + + if isinstance(node1, ast.AST): + for k, v in node1.__dict__.items(): + if k in ( + "lineno", + "end_lineno", + "col_offset", + "end_col_offset", + "ctx", + "parent", + ): + continue + if not hasattr(node2, k) or not compare_ast(v, getattr(node2, k)): + return False + return True + + elif isinstance(node1, list) and isinstance( # type:ignore [redundant-expr] + node2, list + ): + return len(node1) == len(node2) and all( + compare_ast(n1, n2) for n1, n2 in zip(node1, node2) + ) + else: + # unreachable in practice: the `type(node1) is not type(node2)` check + # above guarantees both are the same (non-AST, non-list) type here + return node1 == node2 # type:ignore [comparison-overlap] + + +class DependencyNode(NamedTuple): + """ + Each node represents a function. + qualified_name: string which represents the namespace/name of the function + abstract_syntax_tree: subtree of the overall module which corresponds to this function + + qualified_name is of the structure: (namespace1, namespace2, ..., name) + + For example, foo() in the following would be represented as (A, B, foo): + + class A: + class B: + def foo(): + pass + """ + + qualified_name: tuple[str, ...] + abstract_syntax_tree: ast.AST + + +class GatherResult(NamedTuple): + import_defs: list[tuple[tuple[str, ...], ast.Import | ast.ImportFrom]] = [] + assign_defs: list[tuple[tuple[str, ...], ast.Assign | ast.AnnAssign]] = [] + function_defs: list[ + tuple[tuple[str, ...], ast.FunctionDef | ast.AsyncFunctionDef] + ] = [] + classes: dict[str, ast.ClassDef] = {} + unfixable: list[ast.AST] = [] + + @classmethod + def create(cls) -> GatherResult: + return cls([], [], [], {}, []) + + def all_defs(self) -> Iterable[tuple[tuple[str, ...], TDefinitionAst]]: + return itertools.chain(self.import_defs, self.assign_defs, self.function_defs) + + def inplace_merge(self, other: GatherResult) -> None: + self.import_defs.extend(other.import_defs) + self.assign_defs.extend(other.assign_defs) + self.function_defs.extend(other.function_defs) + self.classes.update(other.classes) + self.unfixable.extend(other.unfixable) + + +class ConstexprDetector(ast.NodeVisitor): + def __init__(self) -> None: + self.is_constexpr = True + self._allow_builtins_exceptions = True + + @contextlib.contextmanager + def disallow_builtins_exceptions(self) -> Generator[None]: + prev_allow = self._allow_builtins_exceptions + self._allow_builtins_exceptions = False + try: + yield + finally: + self._allow_builtins_exceptions = prev_allow + + def visit_Attribute(self, node: ast.Attribute) -> None: + with self.disallow_builtins_exceptions(): + self.visit(node.value) + + def visit_Name(self, node: ast.Name) -> None: + if self._allow_builtins_exceptions and hasattr(builtins, node.id): + return + self.is_constexpr = False + + def visit(self, node: ast.AST) -> None: + if not self.is_constexpr: + # can short-circuit if we've already detected that it's not a constexpr + return + super().visit(node) + + def __call__(self, node: ast.AST) -> bool: + self.is_constexpr = True + self.visit(node) + return self.is_constexpr + + +class AutoreloadTree: + """ + Recursive data structure to keep track of reloadable functions/methods. Each object corresponds to a specific scope level. + children: classes inside given scope, maps class name to autoreload tree for that class's scope + funcs_to_autoreload: list of function names that can be autoreloaded in given scope. + new_nested_classes: Classes getting added in new autoreload cycle + """ + + def __init__(self) -> None: + self.children: dict[str, AutoreloadTree] = {} + self.defs_to_reload: list[tuple[tuple[str, ...], ast.AST]] = [] + self.defs_to_delete: set[str] = set() + self.new_nested_classes: dict[str, ast.AST] = {} + + def traverse_prefixes(self, prefixes: list[str]) -> AutoreloadTree: + """ + Return ref to the AutoreloadTree at the namespace specified by prefixes + """ + cur = self + for prefix in prefixes: + if prefix not in cur.children: + cur.children[prefix] = AutoreloadTree() + cur = cur.children[prefix] + return cur + + +class DeduperReloader(DeduperReloaderPatchingMixin): + """ + This version of autoreload detects when we can leverage targeted recompilation of a subset of a module and patching + existing function/method objects to reflect these changes. + + Detects what functions/methods can be reloaded by recursively comparing the old/new AST of module-level classes, + module-level classes' methods, recursing through nested classes' methods. If other changes are made, original + autoreload algorithm is called directly. + """ + + def __init__(self) -> None: + self._to_autoreload: AutoreloadTree = AutoreloadTree() + self.source_by_modname: dict[str, str] = {} + self.dependency_graph: dict[tuple[str, ...], list[DependencyNode]] = {} + self._enabled = True + + @property + def enabled(self) -> bool: + return self._enabled and platform.python_implementation() == "CPython" + + @enabled.setter + def enabled(self, value: bool) -> None: + self._enabled = value + + def update_sources(self) -> None: + """ + Update dictionary source_by_modname with current modules' source codes. + """ + if not self.enabled: + return + for new_modname in sys.modules.keys() - self.source_by_modname.keys(): + new_module = sys.modules[new_modname] + if ( + (fname := get_module_file_name(new_module)) is None + or "site-packages" in fname + or "dist-packages" in fname + or not os.access(fname, os.R_OK) + ): + self.source_by_modname[new_modname] = "" + continue + # Skip binary files (e.g., .so, .pyd, .pyo) + if not fname.endswith(".py"): + self.source_by_modname[new_modname] = "" + continue + try: + # tokenize.open honors PEP 263 coding cookies and defaults + # to utf-8, like the import system does. + with tokenize.open(fname) as f: + self.source_by_modname[new_modname] = f.read() + except Exception as e: + logger = logging.getLogger("autoreload") + logger.exception( + f"Failed to read module file '{fname}' for module '{new_modname}': {type(e).__name__}" + ) + self.source_by_modname[new_modname] = "" + + constexpr_detector = ConstexprDetector() + + @staticmethod + def is_enum_subclass(node: ast.Module | ast.ClassDef) -> bool: + if isinstance(node, ast.Module): + return False + for base in node.bases: + if isinstance(base, ast.Name) and base.id == "Enum": + return True + elif ( + isinstance(base, ast.Attribute) + and base.attr == "Enum" + and isinstance(base.value, ast.Name) + and base.value.id == "enum" + ): + return True + return False + + @classmethod + def is_constexpr_assign( + cls, node: ast.AST, parent_node: ast.Module | ast.ClassDef + ) -> bool: + if not isinstance(node, (ast.Assign, ast.AnnAssign)) or node.value is None: + return False + if cls.is_enum_subclass(parent_node): + return False + for target in node.targets if isinstance(node, ast.Assign) else [node.target]: + if not isinstance(target, ast.Name): + return False + return cls.constexpr_detector(node.value) + + @classmethod + def _gather_children( + cls, body: list[ast.stmt], parent_node: ast.Module | ast.ClassDef + ) -> GatherResult: + """ + Given list of ast elements, return: + 1. dict mapping function names to their ASTs. + 2. dict mapping class names to their ASTs. + 3. list of any other ASTs. + """ + result = GatherResult.create() + for ast_node in body: + ast_elt: ast.expr | ast.stmt = ast_node + while isinstance(ast_elt, ast.Expr): + ast_elt = ast_elt.value + if isinstance(ast_elt, (ast.FunctionDef, ast.AsyncFunctionDef)): + result.function_defs.append(((ast_elt.name,), ast_elt)) + elif isinstance(ast_elt, (ast.Import, ast.ImportFrom)): + result.import_defs.append( + (tuple(name.asname or name.name for name in ast_elt.names), ast_elt) + ) + elif isinstance(ast_elt, ast.ClassDef): + result.classes[ast_elt.name] = ast_elt + elif isinstance(ast_elt, ast.If): + result.unfixable.append(ast_elt.test) + result.inplace_merge(cls._gather_children(ast_elt.body, parent_node)) + result.inplace_merge(cls._gather_children(ast_elt.orelse, parent_node)) + elif isinstance(ast_elt, (ast.AsyncWith, ast.With)): + result.unfixable.extend(ast_elt.items) + result.inplace_merge(cls._gather_children(ast_elt.body, parent_node)) + elif isinstance(ast_elt, ast.Try): + result.inplace_merge(cls._gather_children(ast_elt.body, parent_node)) + result.inplace_merge(cls._gather_children(ast_elt.orelse, parent_node)) + result.inplace_merge( + cls._gather_children(ast_elt.finalbody, parent_node) + ) + for handler in ast_elt.handlers: + if handler.type is not None: + result.unfixable.append(handler.type) + result.inplace_merge( + cls._gather_children(handler.body, parent_node) + ) + elif not isinstance(ast_elt, (ast.Constant, ast.Pass)): + if cls.is_constexpr_assign(ast_elt, parent_node): + assert isinstance(ast_elt, (ast.Assign, ast.AnnAssign)) + targets = ( + ast_elt.targets + if isinstance(ast_elt, ast.Assign) + else [ast_elt.target] + ) + result.assign_defs.append( + ( + tuple(cast(ast.Name, target).id for target in targets), + ast_elt, + ) + ) + else: + result.unfixable.append(ast_elt) + return result + + def detect_autoreload( + self, + old_node: ast.Module | ast.ClassDef, + new_node: ast.Module | ast.ClassDef, + prefixes: list[str] | None = None, + ) -> bool: + """ + Returns + ------- + `True` if we can run our targeted autoreload algorithm safely. + `False` if we should instead use IPython's original autoreload implementation. + """ + if not self.enabled: + return False + prefixes = prefixes or [] + + old_result = self._gather_children(old_node.body, old_node) + new_result = self._gather_children(new_node.body, new_node) + old_defs_by_name: dict[str, ast.AST] = { + name: ast_def for names, ast_def in old_result.all_defs() for name in names + } + new_defs_by_name: dict[str, ast.AST] = { + name: ast_def for names, ast_def in new_result.all_defs() for name in names + } + + if not compare_ast(old_result.unfixable, new_result.unfixable): + return False + + cur = self._to_autoreload.traverse_prefixes(prefixes) + for names, new_ast_def in new_result.all_defs(): + names_to_reload = [] + for name in names: + if new_defs_by_name[name] is not new_ast_def: + continue + if name not in old_defs_by_name or not compare_ast( + new_ast_def, old_defs_by_name[name] + ): + names_to_reload.append(name) + if names_to_reload: + cur.defs_to_reload.append((tuple(names), new_ast_def)) + cur.defs_to_delete |= set(old_defs_by_name.keys()) - set( + new_defs_by_name.keys() + ) + for name, new_ast_def_class in new_result.classes.items(): + if name not in old_result.classes: + cur.new_nested_classes[name] = new_ast_def_class + elif not compare_ast( + new_ast_def_class, old_result.classes[name] + ) and not self.detect_autoreload( + old_result.classes[name], new_ast_def_class, prefixes + [name] + ): + return False + return True + + def _check_dependents(self) -> bool: + """ + If a decorator function is modified, we should similarly reload the functions which are decorated by this + decorator. Iterate through the Dependency Graph to find such cases in the given AutoreloadTree. + """ + for node in self._check_dependents_inner(): + self._add_node_to_autoreload_tree(node) + return True + + def _add_node_to_autoreload_tree(self, node: DependencyNode) -> None: + """ + Given a node of the dependency graph, add decorator dependencies to the autoreload tree. + """ + if len(node.qualified_name) == 0: + return + cur = self._to_autoreload.traverse_prefixes(list(node.qualified_name[:-1])) + if node.abstract_syntax_tree is not None: + cur.defs_to_reload.append( + ((node.qualified_name[-1],), node.abstract_syntax_tree) + ) + + def _check_dependents_inner( + self, prefixes: list[str] | None = None + ) -> list[DependencyNode]: + prefixes = prefixes or [] + cur = self._to_autoreload.traverse_prefixes(prefixes) + ans = [] + for (func_name, *_), _ in cur.defs_to_reload: + node = tuple(prefixes + [func_name]) + ans.extend(self._gen_dependents(node)) + for class_name in cur.new_nested_classes: + ans.extend(self._check_dependents_inner(prefixes + [class_name])) + return ans + + def _gen_dependents(self, qualname: tuple[str, ...]) -> list[DependencyNode]: + ans = [] + if qualname not in self.dependency_graph: + return [] + for elt in self.dependency_graph[qualname]: + ans.extend(self._gen_dependents(elt.qualified_name)) + ans.append(elt) + return ans + + def _patch_namespace_inner( + self, ns: ModuleType | type, prefixes: list[str] | None = None + ) -> bool: + """ + This function patches module functions and methods. Specifically, only objects with their name in + self.to_autoreload will be considered for patching. If an object has been marked to be autoreloaded, + new_source_code gets executed in the old version's global environment. Then, replace the old function's + attributes with the new function's attributes. + """ + prefixes = prefixes or [] + cur = self._to_autoreload.traverse_prefixes(prefixes) + namespace_to_check = ns + for prefix in prefixes: + namespace_to_check = namespace_to_check.__dict__[prefix] + seen_names: set[str] = set() + for names, new_ast_def in cur.defs_to_reload: + if len(names) == 1 and names[0] in seen_names: + continue + seen_names.update(names) + local_env: dict[str, Any] = {} + if ( + isinstance(new_ast_def, (ast.FunctionDef, ast.AsyncFunctionDef)) + and (name := names[0]) in namespace_to_check.__dict__ + ): + assert len(names) == 1 + to_patch_to = namespace_to_check.__dict__[name] + if isinstance(to_patch_to, (staticmethod, classmethod)): + to_patch_to = to_patch_to.__func__ + # exec new source code using old function's (obj) globals environment. + func_code = textwrap.dedent(ast.unparse(new_ast_def)) + if is_method := (len(prefixes) > 0): + func_code = "class __autoreload_class__:\n" + textwrap.indent( + func_code, " " + ) + global_env = ns.__dict__ + if not isinstance(global_env, dict): + global_env = dict(global_env) + # Compile with correct filename to preserve in traceback + filename = ( + getattr(to_patch_to, "__code__", None) + and to_patch_to.__code__.co_filename + or "" + ) + func_asts = [ast.parse(func_code)] + if len(cast(ast.FunctionDef, func_asts[0].body[0]).decorator_list) > 0: + without_decorator_list = pickle.loads(pickle.dumps(func_asts[0])) + cast( + ast.FunctionDef, without_decorator_list.body[0] + ).decorator_list = [] + func_asts.insert(0, without_decorator_list) + for func_ast in func_asts: + compiled_code = compile( + func_ast, filename, mode="exec", dont_inherit=True + ) + exec(compiled_code, global_env, local_env) + # local_env contains the function exec'd from new version of function + if is_method: + to_patch_from = getattr(local_env["__autoreload_class__"], name) + else: + to_patch_from = local_env[name] + if isinstance(to_patch_from, (staticmethod, classmethod)): + to_patch_from = to_patch_from.__func__ + if isinstance(to_patch_to, property) and isinstance( + to_patch_from, property + ): + for attr in ("fget", "fset", "fdel"): + if ( + getattr(to_patch_to, attr) is None + or getattr(to_patch_from, attr) is None + ): + self.try_patch_attr(to_patch_to, to_patch_from, attr) + else: + self.patch_function( + getattr(to_patch_to, attr), + getattr(to_patch_from, attr), + is_method, + ) + elif not isinstance(to_patch_to, property) and not isinstance( + to_patch_from, property + ): + self.patch_function(to_patch_to, to_patch_from, is_method) + else: + raise ValueError( + "adding or removing property decorations not supported" + ) + else: + exec( + ast.unparse(new_ast_def), + ns.__dict__ | namespace_to_check.__dict__, + local_env, + ) + for name in names: + setattr(namespace_to_check, name, local_env[name]) + cur.defs_to_reload.clear() + for name in cur.defs_to_delete: + try: + delattr(namespace_to_check, name) + except (AttributeError, TypeError, ValueError): + # give up on deleting the attribute, let the stale one dangle + pass + cur.defs_to_delete.clear() + for class_name, class_ast_node in cur.new_nested_classes.items(): + local_env_class: dict[str, Any] = {} + exec( + ast.unparse(class_ast_node), + ns.__dict__ | namespace_to_check.__dict__, + local_env_class, + ) + setattr(namespace_to_check, class_name, local_env_class[class_name]) + cur.new_nested_classes.clear() + for class_name in cur.children.keys(): + if not self._patch_namespace(ns, prefixes + [class_name]): + return False + cur.children.clear() + return True + + def _patch_namespace( + self, ns: ModuleType | type, prefixes: list[str] | None = None + ) -> bool: + """ + Wrapper for patching all elements in a namespace as specified by the to_autoreload member variable. + Returns `true` if patching was successful, and `false` if unsuccessful. + """ + try: + return self._patch_namespace_inner(ns, prefixes=prefixes) + except Exception: + return False + + def maybe_reload_module(self, module: ModuleType) -> bool: + """ + Uses Deduperreload to try to update a module. + Returns `true` on success and `false` on failure. + """ + if not self.enabled: + return False + if not (modname := getattr(module, "__name__", None)): + return False + if (fname := get_module_file_name(module)) is None: + return False + try: + with tokenize.open(fname) as f: + new_source_code = f.read() + except Exception as e: + logger = logging.getLogger("autoreload") + logger.exception( + f"Failed to read module file '{fname}' for module '{modname}': {type(e).__name__}" + ) + return False + patched_flag = False + if old_source_code := self.source_by_modname.get(modname): + # get old/new module ast + try: + old_module_ast = ast.parse(old_source_code) + new_module_ast = ast.parse(new_source_code) + except Exception: + return False + # detect if we are able to use our autoreload algorithm + ctx = contextlib.suppress(Exception) + with ctx: + self._build_dependency_graph(new_module_ast) + if ( + self.detect_autoreload(old_module_ast, new_module_ast) + and self._check_dependents() + and self._patch_namespace(module) + ): + patched_flag = True + + self.source_by_modname[modname] = new_source_code + self._to_autoreload = AutoreloadTree() + return patched_flag + + def _separate_name( + self, + decorator: ast.Attribute | ast.Name | ast.Call | ast.expr, + accept_calls: bool, + ) -> list[str] | None: + """ + Generates a qualified name for a given decorator by finding its relative namespace. + """ + if isinstance(decorator, ast.Name): + return [decorator.id] + elif isinstance(decorator, ast.Call): + if accept_calls: + return self._separate_name(decorator.func, False) + else: + return None + if not isinstance(decorator, ast.Attribute): + return None + if pref := self._separate_name(decorator.value, False): + return pref + [decorator.attr] + else: + return None + + def _gather_dependents( + self, body: list[ast.stmt], body_prefixes: list[str] | None = None + ) -> bool: + body_prefixes = body_prefixes or [] + for ast_node in body: + ast_elt: ast.expr | ast.stmt = ast_node + if isinstance(ast_elt, ast.ClassDef): + self._gather_dependents(ast_elt.body, body_prefixes + [ast_elt.name]) + continue + if not isinstance(ast_elt, (ast.FunctionDef, ast.AsyncFunctionDef)): + continue + qualified_name = tuple(body_prefixes + [ast_elt.name]) + cur_dependency_node = DependencyNode(qualified_name, ast_elt) + for decorator in ast_elt.decorator_list: + decorator_path = self._separate_name(decorator, True) + if not decorator_path: + continue + decorator_path_tuple = tuple(decorator_path) + self.dependency_graph.setdefault(decorator_path_tuple, []).append( + cur_dependency_node + ) + return True + + def _build_dependency_graph(self, new_ast: ast.Module | ast.ClassDef) -> bool: + """ + Wrapper function for generating dependency graph given some AST. + Returns `true` on success. Returns `false` on failure. + Currently, only returns `true` as we do not block on failure to build this graph. + """ + return self._gather_dependents(new_ast.body) diff --git a/IPython/extensions/deduperreload/deduperreload_patching.py b/IPython/extensions/deduperreload/deduperreload_patching.py new file mode 100644 index 00000000000..8a6d3435933 --- /dev/null +++ b/IPython/extensions/deduperreload/deduperreload_patching.py @@ -0,0 +1,141 @@ +from __future__ import annotations +import ctypes +from typing import Any + +NOT_FOUND: object = object() +NULL: object = object() +_MAX_FIELD_SEARCH_OFFSET = 50 + +POINTER_N_BYTES = ctypes.sizeof(ctypes.c_void_p) + + +class DeduperReloaderPatchingMixin: + @staticmethod + def infer_field_offset( + obj: object, + field: str, + ) -> int: + field_value = getattr(obj, field, NOT_FOUND) + if field_value is NOT_FOUND: + return -1 + obj_addr = ctypes.c_void_p.from_buffer(ctypes.py_object(obj)).value + field_addr = ctypes.c_void_p.from_buffer(ctypes.py_object(field_value)).value + if obj_addr is None or field_addr is None: + return -1 + ret = -1 + for offset in range(1, _MAX_FIELD_SEARCH_OFFSET): + if ( + ctypes.cast( + obj_addr + POINTER_N_BYTES * offset, ctypes.POINTER(ctypes.c_void_p) + ).contents.value + == field_addr + ): + ret = offset + break + return ret + + @classmethod + def try_write_readonly_attr( + cls, + obj: object, + field: str, + new_value: object, + offset: int | None = None, + ) -> None: + prev_value = getattr(obj, field, NOT_FOUND) + if prev_value is NOT_FOUND: + return + if offset is None: + offset = cls.infer_field_offset(obj, field) + if offset == -1: + return + obj_addr = ctypes.c_void_p.from_buffer(ctypes.py_object(obj)).value + if new_value is NULL: + new_value_addr: int | None = 0 + else: + new_value_addr = ctypes.c_void_p.from_buffer( + ctypes.py_object(new_value) + ).value + if obj_addr is None or new_value_addr is None: + return + if prev_value is not None: + ctypes.pythonapi.Py_DecRef(ctypes.py_object(prev_value)) + if new_value not in (None, NULL): + ctypes.pythonapi.Py_IncRef(ctypes.py_object(new_value)) + ctypes.cast( + obj_addr + POINTER_N_BYTES * offset, ctypes.POINTER(ctypes.c_void_p) + ).contents.value = new_value_addr + + @classmethod + def try_patch_readonly_attr( + cls, + old: object, + new: object, + field: str, + new_is_value: bool = False, + offset: int = -1, + ) -> None: + old_value = getattr(old, field, NOT_FOUND) + new_value = new if new_is_value else getattr(new, field, NOT_FOUND) + if old_value is NOT_FOUND or new_value is NOT_FOUND: + return + elif old_value is new_value: + return + elif old_value is not None and offset < 0: + offset = cls.infer_field_offset(old, field) + elif offset < 0: + assert not new_is_value + assert new_value is not None + offset = cls.infer_field_offset(new, field) + cls.try_write_readonly_attr(old, field, new_value, offset=offset) + + @classmethod + def try_patch_attr( + cls, + old: object, + new: object, + field: str, + new_is_value: bool = False, + offset: int = -1, + ) -> None: + try: + setattr(old, field, new if new_is_value else getattr(new, field)) + except (AttributeError, TypeError, ValueError): + cls.try_patch_readonly_attr(old, new, field, new_is_value, offset) + + @classmethod + def patch_function( + cls, to_patch_to: Any, to_patch_from: Any, is_method: bool + ) -> None: + new_closure = [] + for freevar, closure_val in zip( + to_patch_from.__code__.co_freevars or [], to_patch_from.__closure__ or [] + ): + if ( + callable(closure_val.cell_contents) + and freevar in to_patch_to.__code__.co_freevars + ): + new_closure.append( + to_patch_to.__closure__[ + to_patch_to.__code__.co_freevars.index(freevar) + ] + ) + else: + new_closure.append(closure_val) + # lambdas may complain if there is more than one freevar + cls.try_patch_attr(to_patch_to, to_patch_from, "__code__") + offset = -1 + if to_patch_to.__closure__ is None and to_patch_from.__closure__ is not None: + offset = cls.infer_field_offset(to_patch_from, "__closure__") + if to_patch_to.__closure__ is not None or to_patch_from.__closure__ is not None: + cls.try_patch_readonly_attr( + to_patch_to, + tuple(new_closure) or NULL, + "__closure__", + new_is_value=True, + offset=offset, + ) + for attr in ("__defaults__", "__kwdefaults__", "__doc__", "__dict__"): + cls.try_patch_attr(to_patch_to, to_patch_from, attr) + if is_method: + cls.try_patch_readonly_attr(to_patch_to, to_patch_from, "__self__") diff --git a/IPython/extensions/storemagic.py b/IPython/extensions/storemagic.py index d9d00f14b9a..1f4a28eb9f7 100644 --- a/IPython/extensions/storemagic.py +++ b/IPython/extensions/storemagic.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ %store magic for lightweight persistence. @@ -25,7 +24,7 @@ def restore_aliases(ip, alias=None): staliases = ip.db.get('stored_aliases', {}) if alias is None: for k,v in staliases.items(): - #print "restore alias",k,v # dbg + # print("restore alias",k,v) # dbg #self.alias_table[k] = v ip.alias_manager.define_alias(k,v) else: @@ -43,7 +42,7 @@ def refresh_variables(ip): print("Unable to restore variable '%s', ignoring (use %%store -d to forget!)" % justkey) print("The error was:", sys.exc_info()[0]) else: - #print "restored",justkey,"=",obj #dbg + # print("restored",justkey,"=",obj) # dbg ip.user_ns[justkey] = obj @@ -70,7 +69,7 @@ class StoreMagics(Magics): ).tag(config=True) def __init__(self, shell): - super(StoreMagics, self).__init__(shell=shell) + super().__init__(shell=shell) self.shell.configurables.append(self) if self.autorestore: restore_data(self.shell) @@ -145,7 +144,7 @@ def store(self, parameter_s=''): if args: for arg in args: try: - obj = db['autorestore/' + arg] + obj = db["autorestore/" + arg] except KeyError: try: restore_aliases(ip, alias=arg) @@ -184,7 +183,7 @@ def store(self, parameter_s=''): fil = open(fnam, "w", encoding="utf-8") with fil: obj = ip.ev(args[0]) - print("Writing '%s' (%s) to file '%s'." % (args[0], + print("Writing '{}' ({}) to file '{}'.".format(args[0], obj.__class__.__name__, fnam)) if not isinstance (obj, str): @@ -212,25 +211,24 @@ def store(self, parameter_s=''): staliases = db.get('stored_aliases',{}) staliases[name] = cmd db['stored_aliases'] = staliases - print("Alias stored: %s (%s)" % (name, cmd)) + print("Alias stored: {} ({})".format(name, cmd)) return else: modname = getattr(inspect.getmodule(obj), '__name__', '') if modname == '__main__': print(textwrap.dedent("""\ - Warning:%s is %s + Warning:{} is {} Proper storage of interactively declared classes (or instances of those classes) is not possible! Only instances - of classes in real modules on file system can be %%store'd. - """ % (arg, obj) )) + of classes in real modules on file system can be %store'd. + """.format(arg, obj) )) return #pickled = pickle.dumps(obj) db[ 'autorestore/' + arg ] = obj - print("Stored '%s' (%s)" % (arg, obj.__class__.__name__)) + print("Stored '{}' ({})".format(arg, obj.__class__.__name__)) def load_ipython_extension(ip): """Load the extension in IPython.""" ip.register_magics(StoreMagics) - diff --git a/IPython/extensions/tests/test_autoreload.py b/IPython/extensions/tests/test_autoreload.py deleted file mode 100644 index 88637fbab9c..00000000000 --- a/IPython/extensions/tests/test_autoreload.py +++ /dev/null @@ -1,597 +0,0 @@ -"""Tests for autoreload extension. -""" -# ----------------------------------------------------------------------------- -# Copyright (c) 2012 IPython Development Team. -# -# Distributed under the terms of the Modified BSD License. -# -# The full license is in the file COPYING.txt, distributed with this software. -# ----------------------------------------------------------------------------- - -# ----------------------------------------------------------------------------- -# Imports -# ----------------------------------------------------------------------------- - -import os -import platform -import pytest -import sys -import tempfile -import textwrap -import shutil -import random -import time -from io import StringIO - -import IPython.testing.tools as tt - -from unittest import TestCase - -from IPython.extensions.autoreload import AutoreloadMagics -from IPython.core.events import EventManager, pre_run_cell -from IPython.testing.decorators import skipif_not_numpy - -if platform.python_implementation() == "PyPy": - pytest.skip( - "Current autoreload implementation is extremely slow on PyPy", - allow_module_level=True, - ) - -# ----------------------------------------------------------------------------- -# Test fixture -# ----------------------------------------------------------------------------- - -noop = lambda *a, **kw: None - - -class FakeShell: - def __init__(self): - self.ns = {} - self.user_ns = self.ns - self.user_ns_hidden = {} - self.events = EventManager(self, {"pre_run_cell", pre_run_cell}) - self.auto_magics = AutoreloadMagics(shell=self) - self.events.register("pre_run_cell", self.auto_magics.pre_run_cell) - - register_magics = set_hook = noop - - def run_code(self, code): - self.events.trigger("pre_run_cell") - exec(code, self.user_ns) - self.auto_magics.post_execute_hook() - - def push(self, items): - self.ns.update(items) - - def magic_autoreload(self, parameter): - self.auto_magics.autoreload(parameter) - - def magic_aimport(self, parameter, stream=None): - self.auto_magics.aimport(parameter, stream=stream) - self.auto_magics.post_execute_hook() - - -class Fixture(TestCase): - """Fixture for creating test module files""" - - test_dir = None - old_sys_path = None - filename_chars = "abcdefghijklmopqrstuvwxyz0123456789" - - def setUp(self): - self.test_dir = tempfile.mkdtemp() - self.old_sys_path = list(sys.path) - sys.path.insert(0, self.test_dir) - self.shell = FakeShell() - - def tearDown(self): - shutil.rmtree(self.test_dir) - sys.path = self.old_sys_path - - self.test_dir = None - self.old_sys_path = None - self.shell = None - - def get_module(self): - module_name = "tmpmod_" + "".join(random.sample(self.filename_chars, 20)) - if module_name in sys.modules: - del sys.modules[module_name] - file_name = os.path.join(self.test_dir, module_name + ".py") - return module_name, file_name - - def write_file(self, filename, content): - """ - Write a file, and force a timestamp difference of at least one second - - Notes - ----- - Python's .pyc files record the timestamp of their compilation - with a time resolution of one second. - - Therefore, we need to force a timestamp difference between .py - and .pyc, without having the .py file be timestamped in the - future, and without changing the timestamp of the .pyc file - (because that is stored in the file). The only reliable way - to achieve this seems to be to sleep. - """ - content = textwrap.dedent(content) - # Sleep one second + eps - time.sleep(1.05) - - # Write - with open(filename, "w", encoding="utf-8") as f: - f.write(content) - - def new_module(self, code): - code = textwrap.dedent(code) - mod_name, mod_fn = self.get_module() - with open(mod_fn, "w", encoding="utf-8") as f: - f.write(code) - return mod_name, mod_fn - - -# ----------------------------------------------------------------------------- -# Test automatic reloading -# ----------------------------------------------------------------------------- - - -def pickle_get_current_class(obj): - """ - Original issue comes from pickle; hence the name. - """ - name = obj.__class__.__name__ - module_name = getattr(obj, "__module__", None) - obj2 = sys.modules[module_name] - for subpath in name.split("."): - obj2 = getattr(obj2, subpath) - return obj2 - - -class TestAutoreload(Fixture): - def test_reload_enums(self): - mod_name, mod_fn = self.new_module( - textwrap.dedent( - """ - from enum import Enum - class MyEnum(Enum): - A = 'A' - B = 'B' - """ - ) - ) - self.shell.magic_autoreload("2") - self.shell.magic_aimport(mod_name) - self.write_file( - mod_fn, - textwrap.dedent( - """ - from enum import Enum - class MyEnum(Enum): - A = 'A' - B = 'B' - C = 'C' - """ - ), - ) - with tt.AssertNotPrints( - ("[autoreload of %s failed:" % mod_name), channel="stderr" - ): - self.shell.run_code("pass") # trigger another reload - - def test_reload_class_type(self): - self.shell.magic_autoreload("2") - mod_name, mod_fn = self.new_module( - """ - class Test(): - def meth(self): - return "old" - """ - ) - assert "test" not in self.shell.ns - assert "result" not in self.shell.ns - - self.shell.run_code("from %s import Test" % mod_name) - self.shell.run_code("test = Test()") - - self.write_file( - mod_fn, - """ - class Test(): - def meth(self): - return "new" - """, - ) - - test_object = self.shell.ns["test"] - - # important to trigger autoreload logic ! - self.shell.run_code("pass") - - test_class = pickle_get_current_class(test_object) - assert isinstance(test_object, test_class) - - # extra check. - self.shell.run_code("import pickle") - self.shell.run_code("p = pickle.dumps(test)") - - def test_reload_class_attributes(self): - self.shell.magic_autoreload("2") - mod_name, mod_fn = self.new_module( - textwrap.dedent( - """ - class MyClass: - - def __init__(self, a=10): - self.a = a - self.b = 22 - # self.toto = 33 - - def square(self): - print('compute square') - return self.a*self.a - """ - ) - ) - self.shell.run_code("from %s import MyClass" % mod_name) - self.shell.run_code("first = MyClass(5)") - self.shell.run_code("first.square()") - with self.assertRaises(AttributeError): - self.shell.run_code("first.cube()") - with self.assertRaises(AttributeError): - self.shell.run_code("first.power(5)") - self.shell.run_code("first.b") - with self.assertRaises(AttributeError): - self.shell.run_code("first.toto") - - # remove square, add power - - self.write_file( - mod_fn, - textwrap.dedent( - """ - class MyClass: - - def __init__(self, a=10): - self.a = a - self.b = 11 - - def power(self, p): - print('compute power '+str(p)) - return self.a**p - """ - ), - ) - - self.shell.run_code("second = MyClass(5)") - - for object_name in {"first", "second"}: - self.shell.run_code(f"{object_name}.power(5)") - with self.assertRaises(AttributeError): - self.shell.run_code(f"{object_name}.cube()") - with self.assertRaises(AttributeError): - self.shell.run_code(f"{object_name}.square()") - self.shell.run_code(f"{object_name}.b") - self.shell.run_code(f"{object_name}.a") - with self.assertRaises(AttributeError): - self.shell.run_code(f"{object_name}.toto") - - @skipif_not_numpy - def test_comparing_numpy_structures(self): - self.shell.magic_autoreload("2") - mod_name, mod_fn = self.new_module( - textwrap.dedent( - """ - import numpy as np - class MyClass: - a = (np.array((.1, .2)), - np.array((.2, .3))) - """ - ) - ) - self.shell.run_code("from %s import MyClass" % mod_name) - self.shell.run_code("first = MyClass()") - - # change property `a` - self.write_file( - mod_fn, - textwrap.dedent( - """ - import numpy as np - class MyClass: - a = (np.array((.3, .4)), - np.array((.5, .6))) - """ - ), - ) - - with tt.AssertNotPrints( - ("[autoreload of %s failed:" % mod_name), channel="stderr" - ): - self.shell.run_code("pass") # trigger another reload - - def test_autoload_newly_added_objects(self): - self.shell.magic_autoreload("3") - mod_code = """ - def func1(): pass - """ - mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code)) - self.shell.run_code(f"from {mod_name} import *") - self.shell.run_code("func1()") - with self.assertRaises(NameError): - self.shell.run_code("func2()") - with self.assertRaises(NameError): - self.shell.run_code("t = Test()") - with self.assertRaises(NameError): - self.shell.run_code("number") - - # ----------- TEST NEW OBJ LOADED -------------------------- - - new_code = """ - def func1(): pass - def func2(): pass - class Test: pass - number = 0 - from enum import Enum - class TestEnum(Enum): - A = 'a' - """ - self.write_file(mod_fn, textwrap.dedent(new_code)) - - # test function now exists in shell's namespace namespace - self.shell.run_code("func2()") - # test function now exists in module's dict - self.shell.run_code(f"import sys; sys.modules['{mod_name}'].func2()") - # test class now exists - self.shell.run_code("t = Test()") - # test global built-in var now exists - self.shell.run_code("number") - # test the enumerations gets loaded successfully - self.shell.run_code("TestEnum.A") - - # ----------- TEST NEW OBJ CAN BE CHANGED -------------------- - - new_code = """ - def func1(): return 'changed' - def func2(): return 'changed' - class Test: - def new_func(self): - return 'changed' - number = 1 - from enum import Enum - class TestEnum(Enum): - A = 'a' - B = 'added' - """ - self.write_file(mod_fn, textwrap.dedent(new_code)) - self.shell.run_code("assert func1() == 'changed'") - self.shell.run_code("assert func2() == 'changed'") - self.shell.run_code("t = Test(); assert t.new_func() == 'changed'") - self.shell.run_code("assert number == 1") - self.shell.run_code("assert TestEnum.B.value == 'added'") - - # ----------- TEST IMPORT FROM MODULE -------------------------- - - new_mod_code = """ - from enum import Enum - class Ext(Enum): - A = 'ext' - def ext_func(): - return 'ext' - class ExtTest: - def meth(self): - return 'ext' - ext_int = 2 - """ - new_mod_name, new_mod_fn = self.new_module(textwrap.dedent(new_mod_code)) - current_mod_code = f""" - from {new_mod_name} import * - """ - self.write_file(mod_fn, textwrap.dedent(current_mod_code)) - self.shell.run_code("assert Ext.A.value == 'ext'") - self.shell.run_code("assert ext_func() == 'ext'") - self.shell.run_code("t = ExtTest(); assert t.meth() == 'ext'") - self.shell.run_code("assert ext_int == 2") - - def _check_smoketest(self, use_aimport=True): - """ - Functional test for the automatic reloader using either - '%autoreload 1' or '%autoreload 2' - """ - - mod_name, mod_fn = self.new_module( - """ -x = 9 - -z = 123 # this item will be deleted - -def foo(y): - return y + 3 - -class Baz(object): - def __init__(self, x): - self.x = x - def bar(self, y): - return self.x + y - @property - def quux(self): - return 42 - def zzz(self): - '''This method will be deleted below''' - return 99 - -class Bar: # old-style class: weakref doesn't work for it on Python < 2.7 - def foo(self): - return 1 -""" - ) - - # - # Import module, and mark for reloading - # - if use_aimport: - self.shell.magic_autoreload("1") - self.shell.magic_aimport(mod_name) - stream = StringIO() - self.shell.magic_aimport("", stream=stream) - self.assertIn(("Modules to reload:\n%s" % mod_name), stream.getvalue()) - - with self.assertRaises(ImportError): - self.shell.magic_aimport("tmpmod_as318989e89ds") - else: - self.shell.magic_autoreload("2") - self.shell.run_code("import %s" % mod_name) - stream = StringIO() - self.shell.magic_aimport("", stream=stream) - self.assertTrue( - "Modules to reload:\nall-except-skipped" in stream.getvalue() - ) - self.assertIn(mod_name, self.shell.ns) - - mod = sys.modules[mod_name] - - # - # Test module contents - # - old_foo = mod.foo - old_obj = mod.Baz(9) - old_obj2 = mod.Bar() - - def check_module_contents(): - self.assertEqual(mod.x, 9) - self.assertEqual(mod.z, 123) - - self.assertEqual(old_foo(0), 3) - self.assertEqual(mod.foo(0), 3) - - obj = mod.Baz(9) - self.assertEqual(old_obj.bar(1), 10) - self.assertEqual(obj.bar(1), 10) - self.assertEqual(obj.quux, 42) - self.assertEqual(obj.zzz(), 99) - - obj2 = mod.Bar() - self.assertEqual(old_obj2.foo(), 1) - self.assertEqual(obj2.foo(), 1) - - check_module_contents() - - # - # Simulate a failed reload: no reload should occur and exactly - # one error message should be printed - # - self.write_file( - mod_fn, - """ -a syntax error -""", - ) - - with tt.AssertPrints( - ("[autoreload of %s failed:" % mod_name), channel="stderr" - ): - self.shell.run_code("pass") # trigger reload - with tt.AssertNotPrints( - ("[autoreload of %s failed:" % mod_name), channel="stderr" - ): - self.shell.run_code("pass") # trigger another reload - check_module_contents() - - # - # Rewrite module (this time reload should succeed) - # - self.write_file( - mod_fn, - """ -x = 10 - -def foo(y): - return y + 4 - -class Baz(object): - def __init__(self, x): - self.x = x - def bar(self, y): - return self.x + y + 1 - @property - def quux(self): - return 43 - -class Bar: # old-style class - def foo(self): - return 2 -""", - ) - - def check_module_contents(): - self.assertEqual(mod.x, 10) - self.assertFalse(hasattr(mod, "z")) - - self.assertEqual(old_foo(0), 4) # superreload magic! - self.assertEqual(mod.foo(0), 4) - - obj = mod.Baz(9) - self.assertEqual(old_obj.bar(1), 11) # superreload magic! - self.assertEqual(obj.bar(1), 11) - - self.assertEqual(old_obj.quux, 43) - self.assertEqual(obj.quux, 43) - - self.assertFalse(hasattr(old_obj, "zzz")) - self.assertFalse(hasattr(obj, "zzz")) - - obj2 = mod.Bar() - self.assertEqual(old_obj2.foo(), 2) - self.assertEqual(obj2.foo(), 2) - - self.shell.run_code("pass") # trigger reload - check_module_contents() - - # - # Another failure case: deleted file (shouldn't reload) - # - os.unlink(mod_fn) - - self.shell.run_code("pass") # trigger reload - check_module_contents() - - # - # Disable autoreload and rewrite module: no reload should occur - # - if use_aimport: - self.shell.magic_aimport("-" + mod_name) - stream = StringIO() - self.shell.magic_aimport("", stream=stream) - self.assertTrue(("Modules to skip:\n%s" % mod_name) in stream.getvalue()) - - # This should succeed, although no such module exists - self.shell.magic_aimport("-tmpmod_as318989e89ds") - else: - self.shell.magic_autoreload("0") - - self.write_file( - mod_fn, - """ -x = -99 -""", - ) - - self.shell.run_code("pass") # trigger reload - self.shell.run_code("pass") - check_module_contents() - - # - # Re-enable autoreload: reload should now occur - # - if use_aimport: - self.shell.magic_aimport(mod_name) - else: - self.shell.magic_autoreload("") - - self.shell.run_code("pass") # trigger reload - self.assertEqual(mod.x, -99) - - def test_smoketest_aimport(self): - self._check_smoketest(use_aimport=True) - - def test_smoketest_autoreload(self): - self._check_smoketest(use_aimport=False) diff --git a/IPython/extensions/tests/test_deduperreload.py b/IPython/extensions/tests/test_deduperreload.py new file mode 100755 index 00000000000..efce5d72536 --- /dev/null +++ b/IPython/extensions/tests/test_deduperreload.py @@ -0,0 +1,2310 @@ +#!/usr/bin/env python +from __future__ import annotations +import ast +import os +import platform +import pytest +import random +import shutil +import sys +import tempfile +import textwrap +import time +from types import ModuleType + +from IPython.extensions.autoreload import AutoreloadMagics + +from IPython.extensions.deduperreload.deduperreload import compare_ast, DeduperReloader + +if platform.python_implementation() != "CPython": + pytest.skip( + "We do not support non-CPython versions.", + allow_module_level=True, + ) + + +class DeduperTestReloader(DeduperReloader): + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self.exceptions_raised: list[Exception] = [] + + def _patch_namespace( + self, module: ModuleType | type, prefixes: list[str] | None = None + ) -> bool: + try: + assert super()._patch_namespace(module, prefixes) + return True + except Exception as e: + self.exceptions_raised.append(e) + return False + + +def is_nonempty_file(fname: str) -> bool: + return len(fname) > 0 + + +def squish_text(text: str) -> str: + """ + Turns text like this: + + ''' def foo(): + return "bar" + def baz(): + return "bat" + def bam(): + return "bat" + ''' + + into this: + + '''def foo(): + return "bar" + def baz(): + return "bat" + def bam(): + return "bat" + ''' + + The former is common when we are trying to use string templates + whose parameters are multiline and unaware of the existing indentation. + + :param text: a string with messed up indentation + :return: `text` but with indentation fixed + """ + prev_indentation = 0 + transformed_text_lines = [] + for line in text.strip("\n").splitlines(): + line_without_indentation = line.lstrip() + indentation = len(line) - len(line_without_indentation) + if indentation == 0: + indentation = prev_indentation + else: + prev_indentation = indentation + transformed_text_lines.append( + textwrap.indent(line_without_indentation, " " * indentation) + ) + return textwrap.dedent("\n".join(transformed_text_lines)) + + +# --------------------------------------------------------------------------- +# AutoreloadDetectionSuite +# --------------------------------------------------------------------------- + + +def test_compare_ast(): + code1 = squish_text( + """ + def factorial(n): + def fn(sdfsdf): + print(sdfsdf) + if n < 0: + return "Factorial is not defined for negative numbers." + elif n == 0 or n == 1: + return 1 + else: + result = 1 + for i in range(2, n + 1): + result *= i + return result + y = 12 + print(y) + print(1) + x = 1212121 + """ + ) + code2 = squish_text( + """ + def factorial(n): + def fn(sdfsdf): + print(sdfsdf+"!!!") + if n < 0: + return "Factorial is not defined for negative numbers." + elif n == 0 or n == 1: + return 1 + else: + result = 1 + for i in range(2, n + 1): + result *= i + return result + y = 12 + print(y) + print(1) + x = 1212121 + """ + ) + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert not compare_ast(ast_1, ast_2) + + +def test_compare_ast2(): + code1 = squish_text( + """ + def factorial(n): + def fn(sdfsdf): + print(sdfsdf) + if n < 0: + return "Factorial is not defined for negative numbers." + elif n == 0 or n == 1: + return 1 + else: + result = 1 + for i in range(2, n + 1): + result *= i + return result + y = 12 + print(y) + print(1) + x = 1212121 + """ + ) + code2 = squish_text( + """ + def factorial(n): + def fn(sdfsdf): + print(sdfsdf) + if n < 0: + return "Factorial is not defined for negative numbers." + elif n == 0 or n == 1: + return 1 + else: + result = 1 + for i in range(2, n + 1): + result *= i + return result + y = 12 + print(y) + print(1) + x = 1212121 + """ + ) + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert compare_ast(ast_1, ast_2) + + +def test_autoreload_no_changes(): + code1 = squish_text( + """ + def factorial(n): + print(n) + print(1) + x = 1212121 + """ + ) + code2 = squish_text( + """ + def factorial(n): + print(n) + print(1) + x = 1212121 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + + +def test_autoreload_static_assign_change_outside_function(): + code1 = squish_text( + """ + def factorial(n): + print(n) + print(1) + """ + ) + code2 = squish_text( + """ + def factorial(n): + print(n) + print(1) + x = 1212121 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_changes_inside_function(): + code1 = squish_text( + """ + def factorial(n): + print(n) + print(1) + """ + ) + code2 = squish_text( + """ + def factorial(n): + print(n + "edit!") + print(1) + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 1 + + +def test_autoreload_changes_inside_and_outside_function(): + code1 = squish_text( + """ + def factorial(n): + print(n) + print(1) + """ + ) + code2 = squish_text( + """ + def factorial(n): + print(n + "edit!") + print(2) + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert not deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_changes_inner_function(): + code1 = squish_text( + """ + def factorial(n): + def foo(): + x = 3 + return x + return foo + """ + ) + code2 = squish_text( + """ + def factorial(n): + def foo(): + x = 4 + return x + return foo + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 1 + + +def test_autoreload_changes_multiple_function(): + code1 = squish_text( + """ + def factorial(n): + def foo(): + x = 3 + return x + return foo + def bar(): + return 1 + """ + ) + code2 = squish_text( + """ + def factorial(n): + def foo(): + x = 4 + return x + return foo + def bar(): + return 2 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 2 + + +def test_autoreload_change_one_function_of_multiple(): + code1 = squish_text( + """ + def factorial(n): + def foo(): + x = 3 + return x + return foo + def bar(): + return 1 + """ + ) + code2 = squish_text( + """ + def factorial(n): + def foo(): + x = 4 + return x + return foo + def bar(): + return 1 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 1 + + +def test_autoreload_handling_moves(): + code1 = squish_text( + """ + def factorial(n): + return 1 + x = 1 + """ + ) + code2 = squish_text( + """ + x = 1 + def factorial(n): + return 1 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 0 + + +def test_autoreload_handling_function_moves_success(): + code1 = squish_text( + """ + def factorial(n): + return 1 + x = 1 + def foo(): + return 23 + x = 2 + """ + ) + code2 = squish_text( + """ + x = 1 + x = 2 + def foo(): + return 23 + def factorial(n): + return 1 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 0 + + +def test_autoreload_handling_function_moves_only(): + code1 = squish_text( + """ + def factorial(n): + return 1 + x = 1 + x = 2 + """ + ) + code2 = squish_text( + """ + x = 1 + x = 2 + def factorial(n): + return 1 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_handles_new_imports(): + code1 = squish_text( + """ + def factorial(n): + return 1 + x = 1 + """ + ) + code2 = squish_text( + """ + import ast + def factorial(n): + return 1 + x = 1 + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_async_function(): + code1 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(1) + """ + ) + code2 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(10) + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert len(deduperreloader._to_autoreload.defs_to_reload) == 1 + + +def test_autoreload_add_function(): + code1 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(1) + """ + ) + code2 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(1) + def add(x,y): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert list(d[0][0] for d in deduperreloader._to_autoreload.defs_to_reload) == [ + "add" + ] + + +def test_autoreload_add_function_ellipsis(): + code1 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(1) + """ + ) + code2 = squish_text( + """ + async def sleep(): + print(f'Time: {time.time() - start:.2f}') + await asyncio.sleep(1) + def add(x,y): + ... + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert list(d[0][0] for d in deduperreloader._to_autoreload.defs_to_reload) == [ + "add" + ] + + +# --------------------------------------------------------------------------- +# AutoreloadPatchingSuite — fixture +# --------------------------------------------------------------------------- + + +@pytest.fixture +def deduperreloader(): + return DeduperTestReloader() + + +def test_patching(deduperreloader): + code1 = squish_text( + """ + def foo(): + return 1 + """ + ) + code2 = squish_text( + """ + def foo(): + return 2 + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + deduperreloader._patch_namespace(mod) + assert mod.foo() == 2 + + +def test_patching_parameters(deduperreloader): + code1 = squish_text( + """ + def foo(n,s): + return n+s + """ + ) + code2 = squish_text( + """ + def foo(n): + return n + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + deduperreloader._patch_namespace(mod) + assert mod.foo(2) == 2 + + +def test_add_function(deduperreloader): + code1 = squish_text( + """ + def foo2(n): + return n + """ + ) + code2 = squish_text( + """ + def foo(n): + return 55 + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + deduperreloader._patch_namespace(mod) + assert mod.foo(2) == 55 + assert mod.foo2(2) == 2 + + +def test_two_operations(deduperreloader): + code1 = squish_text( + """ + def foo(n): + return 1 + """ + ) + code2 = squish_text( + """ + def foo(n): + return 55 + """ + ) + code3 = squish_text( + """ + def goo(): + return -1 + def foo(n): + x = 2 + return x+n + def bar(): + return 200 + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + assert mod.foo(2) == 1 + deduperreloader._patch_namespace(mod) + assert mod.foo(2) == 55 + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code3)) + ] + deduperreloader._patch_namespace(mod) + assert mod.foo(2) == 4 + + +def test_using_outside_param(deduperreloader): + code1 = squish_text( + """ + x=1 + def foo(n): + return 1 + """ + ) + code2 = squish_text( + """ + x=1 + def foo(n): + return 55+x + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + assert mod.foo(2) == 1 + deduperreloader._patch_namespace(mod) + assert mod.foo(2) == 56 + + +def test_importing_func(deduperreloader): + code1 = squish_text( + """ + from os import environ + def foo(n): + pass + """ + ) + code2 = squish_text( + """ + from os import environ + def foo(): + environ._data + return 1 + """ + ) + deduperreloader._to_autoreload.defs_to_reload = [ + (("foo",), ast.parse(code2)) + ] + mod = ModuleType("mod") + exec(code1, mod.__dict__) + deduperreloader._patch_namespace(mod) + assert mod.foo() == 1 + + +# --------------------------------------------------------------------------- +# ShellFixture — helper class and pytest fixture +# --------------------------------------------------------------------------- + + +class FakeShell: + def __init__(self): + self.ns = {} + self.user_ns = self.ns + self.user_ns_hidden = {} + self.auto_magics = AutoreloadMagics(shell=self) + + @staticmethod + def pre_run_cell(obj): + try_with_arg = False + try: + obj.pre_run_cell() + except TypeError: + try_with_arg = True + if try_with_arg: + obj.pre_run_cell(None) + + @staticmethod + def post_run_cell(obj): + try_with_arg = False + try: + obj.post_run_cell() + except TypeError: + try_with_arg = True + if try_with_arg: + obj.post_run_cell(None) + + def run_code(self, code): + self.pre_run_cell(self.auto_magics) + exec(code, self.user_ns) + self.auto_magics.post_execute_hook() + + def push(self, items): + self.ns.update(items) + + def magic_autoreload(self, parameter): + self.auto_magics.autoreload(parameter) + + +class _ShellFixtureHelper: + """Helper for creating test module files""" + + filename_chars = "abcdefghijklmopqrstuvwxyz0123456789" + + def __init__(self): + self.created_temp_modules = set() + self.test_dir = tempfile.mkdtemp() + self.old_sys_path = list(sys.path) + sys.path.insert(0, self.test_dir) + self.shell = FakeShell() + + def teardown(self): + for mod_name in self.created_temp_modules: + sys.modules.pop(mod_name, None) + shutil.rmtree(self.test_dir) + sys.path = self.old_sys_path + + def get_module(self): + module_name = "tmpmod_" + "".join(random.sample(self.filename_chars, 20)) + if module_name in sys.modules: + del sys.modules[module_name] + file_name = os.path.join(self.test_dir, module_name + ".py") + return module_name, file_name + + def write_file(self, filename, content): + """ + Write a file, and force a timestamp difference of at least one second + + Notes + ----- + Python's .pyc files record the timestamp of their compilation + with a time resolution of one second. + + Therefore, we need to force a timestamp difference between .py + and .pyc, without having the .py file be timestamped in the + future, and without changing the timestamp of the .pyc file + (because that is stored in the file). The only reliable way + to achieve this seems to be to sleep. + + Doesn't seem necessary on Darwin so we make this the exception. + """ + if platform.system().lower() != "darwin": + time.sleep(1.05) + with open(filename, "w", encoding="utf-8") as f: + f.write(squish_text(content)) + + def new_module(self, code): + mod_name, mod_fn = self.get_module() + with open(mod_fn, "w", encoding="utf-8") as f: + f.write(squish_text(code)) + self.created_temp_modules.add(mod_name) + return mod_name, mod_fn + + +@pytest.fixture +def shell_fixture(): + helper = _ShellFixtureHelper() + yield helper + helper.teardown() + + +# --------------------------------------------------------------------------- +# AutoreloadHookSuite +# --------------------------------------------------------------------------- + + +@pytest.mark.parametrize("autoreload_when", [ + "before_import", + "after_import", + "after_first_pass", +]) +def test_deduperreloader_basic(shell_fixture, autoreload_when): + """Test autoreload works regardless of when magic_autoreload("2") is called.""" + src_v1 = """ + x = 9 + def foo(y): + return y + 3 + """ + src_v2 = """ + x = 9 + def foo(y): + return y + 5 + """ + if autoreload_when == "before_import": + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module(src_v1) + shell_fixture.shell.run_code("import %s" % mod_name) + if autoreload_when == "after_import": + shell_fixture.shell.magic_autoreload("2") + shell_fixture.shell.run_code("pass") + if autoreload_when == "after_first_pass": + shell_fixture.shell.magic_autoreload("2") + shell_fixture.shell.run_code("pass") + shell_fixture.write_file(mod_fn, src_v2) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.foo(0) == 5 + + +def test_super(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class Foo: + def foo(self): + return 1 + class Bar(Foo): + def bar(self): + return super().foo() + 1 + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import Bar; bar = Bar()") + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class Foo: + def foo(self): + return 1 + class Bar(Foo): + def bar(self): + return super().foo() + 2 + """, + ) + shell_fixture.shell.run_code("result = bar.bar()") + # NOTE : only works on CPython, requires read-only patching. + if platform.python_implementation() == "CPython": + assert shell_fixture.shell.user_ns["result"] == 3 + + +def test_deduperreloader_need_to_default_back(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + def foo(y): + return y + 3 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + x = 200 + def foo(y): + return y + 5 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.foo(0) == 5 + + +def test_deduperreloader_failure(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + def foo(y): + return y + 3 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + broken broken broken + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.foo(0) == 3 + + +def test_deduperreloader_imported_mod(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + from os import environ + def foo(n): + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + from os import environ + def foo(): + environ._data + return 1 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.foo() == 1 + + +# --------------------------------------------------------------------------- +# AutoreloadClassMethodsDetectionSuite +# --------------------------------------------------------------------------- + + +def test_autoreload_method(): + code1 = squish_text( + """ + class C(n): + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C(n): + def foo(): + x = 1 + return x + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert "C" in deduperreloader._to_autoreload.children + assert ["foo"] == list( + d[0][0] for d in deduperreloader._to_autoreload.children["C"].defs_to_reload + ) + assert deduperreloader._to_autoreload.children["C"].children == {} + + +def test_autoreload_no_changes_class(): + code1 = squish_text( + """ + class D(n): + def foo(): + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class D(n): + def foo(): + pass + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert deduperreloader._to_autoreload.children == {} + + +def test_autoreload_add_function_class(): + code1 = squish_text( + """ + class C: + def foo(): + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + def foo(): + x = 1 + return x + def bar(): + return -1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert "C" in deduperreloader._to_autoreload.children + assert ["foo", "bar"] == list( + d[0][0] for d in deduperreloader._to_autoreload.children["C"].defs_to_reload + ) + assert len(deduperreloader._to_autoreload.children["C"].children) == 0 + + +def test_autoreload_remove_method(): + code1 = squish_text( + """ + class C: + def foo(): + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + pass + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_remove_class(): + code1 = squish_text( + """ + class C: + def foo(): + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_add_class_in_class(): + code1 = squish_text( + """ + class C: + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + class D: + pass + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_add_method_in_class_in_class(): + code1 = squish_text( + """ + class C: + class D: + x = 1 + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + class D: + x = 1 + def foo(): + return 1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert list(deduperreloader._to_autoreload.children.keys()) == ["C"] + assert deduperreloader._to_autoreload.children["C"].defs_to_reload == [] + assert list(deduperreloader._to_autoreload.children["C"].children.keys()) == [ + "D" + ] + assert list( + d[0][0] + for d in deduperreloader._to_autoreload.children["C"] + .children["D"] + .defs_to_reload + ) == ["foo"] + assert deduperreloader._to_autoreload.children["C"].children["D"].children == {} + + +def test_autoreload_add_var_and_method_in_class_in_class(): + code1 = squish_text( + """ + class C: + class D: + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + class D: + x = 1 + def foo(): + return 1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +def test_autoreload_add_method_in_class_in_class_pass(): + code1 = squish_text( + """ + class C: + class D: + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + class D: + def foo(): + return 1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert list(deduperreloader._to_autoreload.children.keys()) == ["C"] + assert deduperreloader._to_autoreload.children["C"].defs_to_reload == [] + assert list(deduperreloader._to_autoreload.children["C"].children.keys()) == [ + "D" + ] + assert list( + d[0][0] + for d in deduperreloader._to_autoreload.children["C"] + .children["D"] + .defs_to_reload + ) == ["foo"] + assert deduperreloader._to_autoreload.children["C"].children["D"].children == {} + + +def test_autoreload_add_method_in_class_in_class_more(): + code1 = squish_text( + """ + class C: + class D: + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + def bar(): + return -1 + class D: + def foo(): + return 1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + assert deduperreloader._to_autoreload.defs_to_reload == [] + assert list(deduperreloader._to_autoreload.children.keys()) == ["C"] + assert list( + d[0][0] for d in deduperreloader._to_autoreload.children["C"].defs_to_reload + ) == ["bar"] + assert list(deduperreloader._to_autoreload.children["C"].children.keys()) == [ + "D" + ] + assert list( + d[0][0] + for d in deduperreloader._to_autoreload.children["C"] + .children["D"] + .defs_to_reload + ) == ["foo"] + assert deduperreloader._to_autoreload.children["C"].children["D"].children == {} + + +def test_autoreload_add_method_in_class_in_class_with_members(): + code1 = squish_text( + """ + class C: + class D: + pass + def foo(): + pass + """ + ) + code2 = squish_text( + """ + class C: + def bar(): + return -1 + class D: + s = 2 + def foo(): + return 1 + def foo(): + pass + """ + ) + deduperreloader = DeduperTestReloader() + ast_1 = ast.parse(code1) + ast_2 = ast.parse(code2) + + assert deduperreloader.detect_autoreload(ast_1, ast_2) + + +# --------------------------------------------------------------------------- +# AutoreloadReliabilitySuite +# --------------------------------------------------------------------------- + + +def test_autoreload_class_basic(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + class C: + def foo(): + return 1 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + x = 9 + class C: + def foo(): + return 1 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 1 + + +def test_remove_overridden_method(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class A: + def foo(self): + return 1 + class B(A): + def foo(self): + return 42 + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import B; b = B()") + shell_fixture.shell.run_code("assert b.foo() == 42") + shell_fixture.write_file( + mod_fn, + """ + class A: + def foo(self): + return 1 + class B(A): + pass + """, + ) + shell_fixture.shell.run_code("assert b.foo() == 1") + + +def test_autoreload_class_use_outside_func(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + class C: + def foo(): + return 1 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + x = 9 + class C: + def foo(): + return 1+x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 10 + + +def test_autoreload_class_use_class_member(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + class C: + def foo(): + return 1 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def foo(): + return 1+C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 10 + + +def test_autoreload_class_pass(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + class C: + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def foo(): + return 1+C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 10 + + +def test_autoreload_class_ellipsis(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 9 + class C: + ... + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def foo(): + return 1+C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 10 + + +def test_autoreload_class_default_autoreload(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def foo(): + return 1+C.x + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 20 + def foo(): + return 1+C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.foo() == 21 + + +def test_autoreload_class_nested(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + class D: + def foo(): + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + class D: + def foo(): + return 10 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 10 + + +def test_autoreload_class_nested2(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def c(): + return 1 + class D: + def foo(): + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 1 + class D: + def foo(): + return 10 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 10 + assert mod.C.c() == 1 + + +def test_autoreload_class_nested3(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def c(): + return 1 + class D: + def foo(): + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + return 10 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 10 + assert mod.C.c() == 13 + + +def test_autoreload_new_class_added(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def c(): + return 1 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 13 + class D: + def c(): + return 1 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.c() == 13 + assert mod.D.c() == 1 + + +def test_autoreload_class_nested_default(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + return 10 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 10 + assert mod.C.c() == 13 + + +def test_autoreload_class_nested_using_members(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + return 10 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + return 10 + C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 19 + assert mod.C.c() == 13 + + +def test_autoreload_class_nested_using_members_ellipsis(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + ... + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + class C: + x = 9 + def c(): + return 13 + class D: + def foo(): + return 10 + C.x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.C.D.foo() == 19 + assert mod.C.c() == 13 + + +def test_method_decorators_no_changes(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.foo() == 42 + + shell_fixture.shell.run_code(f"assert {mod_name}.foo() == 42") + shell_fixture.write_file( + mod_file, + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """, + ) + shell_fixture.shell.run_code(f"assert {mod_name}.foo() == 42") + + +def test_method_decorators_no_changes1(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """ + ) + + shell_fixture.shell.run_code(f"from {mod_name} import foo") + shell_fixture.shell.run_code("assert foo() == 42") + shell_fixture.write_file( + mod_file, + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """, + ) + shell_fixture.shell.run_code("assert foo() == 42") + + +def test_method_classmethod_one_change(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def func(cls): + return 42 + cls.bar() + + func = Foo.func + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code(f"assert {mod_name}.func() == 42") + shell_fixture.write_file( + mod_file, + """ + class Foo: + @classmethod + def bar(cls): + return 1 + + @classmethod + def func(cls): + return 42 + cls.bar() + + func = Foo.func + """, + ) + shell_fixture.shell.run_code(f"assert {mod_name}.func() == 43") + + +def test_method_staticmethod_one_change(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @staticmethod + def bar(): + return 0 + + @staticmethod + def func(): + return 42 + Foo.bar() + + func = Foo.func + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import func") + shell_fixture.shell.run_code("assert func() == 42") + shell_fixture.write_file( + mod_file, + """ + class Foo: + @staticmethod + def bar(): + return 1 + + @staticmethod + def func(): + return 42 + Foo.bar() + + func = Foo.func + """, + ) + shell_fixture.shell.run_code("assert func() == 43") + + +def test_autoreload_class_default_args(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 42 + class Foo: + def foo(self, y): return y + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + x = 42 + class Foo: + def foo(self, y=x): return y + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + obj = mod.Foo() + assert obj.foo(2) == 2 + assert obj.foo() == 42 + + +def test_autoreload_class_change_default_args(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 42 + class Foo: + def foo(y): return y + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + shell_fixture.write_file( + mod_fn, + """ + x = 44 + class Foo: + def foo(y=x): return y + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + mod = sys.modules[mod_name] + assert mod.Foo.foo() == 44 + + +def test_autoreload_class_new_class(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 42 + class Foo: + def foo(y=x): return y + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + prev_foo = shell_fixture.shell.user_ns[mod_name].Foo.foo + shell_fixture.write_file( + mod_fn, + """ + x = 42 + class Foo: + def foo(y=x): return y + class C: + def foo(): return 200 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + assert prev_foo is shell_fixture.shell.user_ns[mod_name].Foo.foo + mod = sys.modules[mod_name] + assert mod.Foo.foo() == 42 + assert mod.C.foo() == 200 + + +def test_autoreload_overloaded_vars(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 42 + class Foo: + pass + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + mod = sys.modules[mod_name] + shell_fixture.write_file( + mod_fn, + """ + x = 44 + class Foo: + def foo(): + x = 2 + return x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + assert mod.Foo.foo() == 2 + + +def test_autoreload_overloaded_vars2(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + x = 42 + def foo(): + return x + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + mod = sys.modules[mod_name] + shell_fixture.write_file( + mod_fn, + """ + x = 44 + def foo(): + x = 2 + return x + """, + ) + shell_fixture.shell.run_code("pass") + assert mod_name in shell_fixture.shell.user_ns + assert mod.foo() == 2 + + +# --------------------------------------------------------------------------- +# DecoratorPatchingSuite +# --------------------------------------------------------------------------- + + +def test_modify_property(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @property + def foo(self): + return 42 + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import Foo") + shell_fixture.shell.run_code("foo = Foo()") + shell_fixture.shell.run_code("assert foo.foo == 42") + shell_fixture.write_file( + mod_file, + """ + class Foo: + @property + def foo(self): + return 43 + """, + ) + shell_fixture.shell.run_code("pass") + shell_fixture.shell.run_code("assert foo.foo == 43") + + +def test_method_decorator(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + def incremented(f): + return lambda *args: f(*args) + 1 + + class Foo: + @classmethod + @incremented + def foo(cls): + return 42 + + foo = Foo.foo + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import foo") + shell_fixture.shell.run_code("assert foo() == 43") + shell_fixture.write_file( + mod_file, + """ + def incremented(f): + return lambda *args: f(*args) + 1 + + class Foo: + @classmethod + def foo(cls): + return 42 + + foo = Foo.foo + """, + ) + shell_fixture.shell.run_code("assert foo() == 42") + + +def test_method_modified_decorator(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + def incremented(f): + return lambda *args: f(*args) + 1 + + class Foo: + @classmethod + @incremented + def foo(cls): + return 42 + + foo = Foo.foo + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import foo") + shell_fixture.shell.run_code("assert foo() == 43") + shell_fixture.write_file( + mod_file, + """ + def incremented(f): + return lambda *args: f(*args) + 0 + + class Foo: + @classmethod + @incremented + def foo(cls): + return 42 + + foo = Foo.foo + """, + ) + shell_fixture.shell.run_code("assert foo() == 42") + + +def test_function_decorators(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + def incremented(f): + return lambda *args: f(*args) + 1 + + @incremented + def foo(): + return 42 + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + mod = sys.modules[mod_name] + assert mod.foo() == 43 + shell_fixture.write_file( + mod_file, + """ + def incremented(f): + return lambda *args: f(*args) + 1 + + def foo(): + return 42 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod.foo() == 42 + shell_fixture.write_file( + mod_file, + """ + def incremented(v): + def deco(f): + return lambda *args: f(*args) + v + return deco + + @incremented(2) + def foo(): + return 43 + """, + ) + shell_fixture.shell.run_code("pass") + assert mod.foo() == 45 + + +def test_method_decorators_again(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + class Foo: + @classmethod + def bar(cls): + return 0 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """ + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + mod = sys.modules[mod_name] + assert mod.foo() == 42 + shell_fixture.write_file( + mod_file, + """ + class Foo: + @classmethod + def bar(cls): + return 1 + + @classmethod + def foo(cls): + return 42 + cls.bar() + + foo = Foo.foo + """, + ) + shell_fixture.shell.run_code("pass") + assert mod.Foo.foo() == 43 + assert mod.foo() == 43 + + +# This test verifies that the correct globals are used when patching a function +# decorated by a function from another module. For this example, we should always +# use .__dict__ as the global environment when patching foo, which comes +# from , and never .__dict__, which is what we would get +# if we use foo.__globals__ after it has been decorated. +def test_function_decorator_from_other_module(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + other_mod_name, _ = shell_fixture.new_module( + """ + import functools + + def incremented(f): + @functools.wraps(f) + def wrapper(*args, **kwargs): + return f(*args, **kwargs) + 1 + return wrapper + """ + ) + mod_name, mod_file = shell_fixture.new_module( + f""" + from {other_mod_name} import incremented as deco + @deco + def foo(): + return 42 + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import foo") + shell_fixture.shell.run_code("assert foo() == 43") + shell_fixture.write_file( + mod_file, + f""" + from {other_mod_name} import incremented as deco + @deco + def foo(): + return 43 + """, + ) + shell_fixture.shell.run_code("assert foo() == 44") + + +def test_decorators_with_freevars(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_file = shell_fixture.new_module( + """ + def decorate(func): + free_var_x = "x" + free_var_y = "y" + def wrapper(*args, **kwargs): + return func(*args, **kwargs), free_var_x, free_var_y + return wrapper + @decorate + def f(): + return "v1" + """ + ) + shell_fixture.shell.run_code(f"from {mod_name} import f") + mod = sys.modules[mod_name] + assert mod.f() == ("v1", "x", "y") + shell_fixture.write_file( + mod_file, + """ + def decorate(func): + free_var_ax = "ax" + free_var_by = "by" + def wrapper(*args, **kwargs): + return func(*args, **kwargs), free_var_ax, free_var_by + return wrapper + @decorate + def f(): + return "v2" + """, + ) + shell_fixture.shell.run_code("pass") + val = mod.f() + assert val == ("v2", "ax", "by"), val + + +# --------------------------------------------------------------------------- +# TestAutoreloadEnum +# --------------------------------------------------------------------------- + + +def test_reload_enums(shell_fixture): + shell_fixture.shell.magic_autoreload("2") + mod_name, mod_fn = shell_fixture.new_module( + """ + from enum import Enum + class MyEnum(Enum): + A = 'A' + B = 'B' + """, + ) + shell_fixture.shell.run_code("import %s" % mod_name) + shell_fixture.shell.run_code("pass") + mod = sys.modules[mod_name] + shell_fixture.write_file( + mod_fn, + """ + from enum import Enum + class MyEnum(Enum): + A = 'A' + B = 'B' + C = 'C' + """, + ) + shell_fixture.shell.run_code("pass") + assert mod.MyEnum.C.value == "C" diff --git a/IPython/extensions/tests/test_storemagic.py b/IPython/extensions/tests/test_storemagic.py deleted file mode 100644 index 3ac306bcddd..00000000000 --- a/IPython/extensions/tests/test_storemagic.py +++ /dev/null @@ -1,66 +0,0 @@ -import tempfile, os -from pathlib import Path - -from traitlets.config.loader import Config - - -def setup_module(): - ip.magic('load_ext storemagic') - -def test_store_restore(): - assert 'bar' not in ip.user_ns, "Error: some other test leaked `bar` in user_ns" - assert 'foo' not in ip.user_ns, "Error: some other test leaked `foo` in user_ns" - assert 'foobar' not in ip.user_ns, "Error: some other test leaked `foobar` in user_ns" - assert 'foobaz' not in ip.user_ns, "Error: some other test leaked `foobaz` in user_ns" - ip.user_ns['foo'] = 78 - ip.magic('alias bar echo "hello"') - ip.user_ns['foobar'] = 79 - ip.user_ns['foobaz'] = '80' - tmpd = tempfile.mkdtemp() - ip.magic('cd ' + tmpd) - ip.magic('store foo') - ip.magic('store bar') - ip.magic('store foobar foobaz') - - # Check storing - assert ip.db["autorestore/foo"] == 78 - assert "bar" in ip.db["stored_aliases"] - assert ip.db["autorestore/foobar"] == 79 - assert ip.db["autorestore/foobaz"] == "80" - - # Remove those items - ip.user_ns.pop('foo', None) - ip.user_ns.pop('foobar', None) - ip.user_ns.pop('foobaz', None) - ip.alias_manager.undefine_alias('bar') - ip.magic('cd -') - ip.user_ns['_dh'][:] = [] - - # Check restoring - ip.magic("store -r foo bar foobar foobaz") - assert ip.user_ns["foo"] == 78 - assert ip.alias_manager.is_alias("bar") - assert ip.user_ns["foobar"] == 79 - assert ip.user_ns["foobaz"] == "80" - - ip.magic("store -r") # restores _dh too - assert any(Path(tmpd).samefile(p) for p in ip.user_ns["_dh"]) - - os.rmdir(tmpd) - -def test_autorestore(): - ip.user_ns['foo'] = 95 - ip.magic('store foo') - del ip.user_ns['foo'] - c = Config() - c.StoreMagics.autorestore = False - orig_config = ip.config - try: - ip.config = c - ip.extension_manager.reload_extension("storemagic") - assert "foo" not in ip.user_ns - c.StoreMagics.autorestore = True - ip.extension_manager.reload_extension("storemagic") - assert ip.user_ns["foo"] == 95 - finally: - ip.config = orig_config diff --git a/IPython/external/__init__.py b/IPython/external/__init__.py index eedc338eb84..132a08401a5 100644 --- a/IPython/external/__init__.py +++ b/IPython/external/__init__.py @@ -2,6 +2,4 @@ This package contains all third-party modules bundled with IPython. """ -from typing import List - -__all__: List[str] = [] +__all__: list[str] = [] diff --git a/IPython/external/pickleshare.py b/IPython/external/pickleshare.py new file mode 100644 index 00000000000..6d1a53e2497 --- /dev/null +++ b/IPython/external/pickleshare.py @@ -0,0 +1,296 @@ +""" +Vendoring of pickleshare, reduced to used functionalities. + +--- + +PickleShare - a small 'shelve' like datastore with concurrency support + +Like shelve, a PickleShareDB object acts like a normal dictionary. Unlike +shelve, many processes can access the database simultaneously. Changing a +value in database is immediately visible to other processes accessing the +same database. + +Concurrency is possible because the values are stored in separate files. Hence +the "database" is a directory where *all* files are governed by PickleShare. + +Example usage:: + + from pickleshare import * + db = PickleShareDB('~/testpickleshare') + db.clear() + print "Should be empty:",db.items() + db['hello'] = 15 + db['aku ankka'] = [1,2,313] + db['paths/are/ok/key'] = [1,(5,46)] + print db.keys() + del db['aku ankka'] + +This module is certainly not ZODB, but can be used for low-load +(non-mission-critical) situations where tiny code size trumps the +advanced features of a "real" object database. + +Installation guide: pip install pickleshare + +Author: Ville Vainio +License: MIT open source license. + +""" + +__version__ = "0.7.5" + +from pathlib import Path + + +import os, stat, time + +import collections.abc as collections_abc +import pickle +import errno + + +def gethashfile(key): + return ("%02x" % abs(hash(key) % 256))[-2:] + + +_sentinel = object() + + +class PickleShareDB(collections_abc.MutableMapping): + """The main 'connection' object for PickleShare database""" + + def __init__(self, root): + """Return a db object that will manage the specied directory""" + if not isinstance(root, str): + root = str(root) + root = os.path.abspath(os.path.expanduser(root)) + self.root = Path(root) + if not self.root.is_dir(): + # catching the exception is necessary if multiple processes are concurrently trying to create a folder + # exists_ok keyword argument of mkdir does the same but only from Python 3.5 + try: + self.root.mkdir(parents=True) + except OSError as e: + if e.errno != errno.EEXIST: + raise + # cache has { 'key' : (obj, orig_mod_time) } + self.cache = {} + + def __getitem__(self, key): + """db['key'] reading""" + fil = self.root / key + try: + mtime = fil.stat()[stat.ST_MTIME] + except OSError: + raise KeyError(key) + + if fil in self.cache and mtime == self.cache[fil][1]: + return self.cache[fil][0] + try: + # The cached item has expired, need to read + with fil.open("rb") as f: + obj = pickle.loads(f.read()) + except Exception: + raise KeyError(key) + + self.cache[fil] = (obj, mtime) + return obj + + def __setitem__(self, key, value): + """db['key'] = 5""" + fil = self.root / key + parent = fil.parent + if parent and not parent.is_dir(): + parent.mkdir(parents=True) + # We specify protocol 2, so that we can mostly go between Python 2 + # and Python 3. We can upgrade to protocol 3 when Python 2 is obsolete. + with fil.open("wb") as f: + pickle.dump(value, f, protocol=2) + try: + self.cache[fil] = (value, fil.stat().st_mtime) + except OSError as e: + if e.errno != errno.ENOENT: + raise + + def hset(self, hashroot, key, value): + """hashed set""" + hroot = self.root / hashroot + if not hroot.is_dir(): + hroot.mkdir() + hfile = hroot / gethashfile(key) + d = self.get(hfile, {}) + d.update({key: value}) + self[hfile] = d + + def hget(self, hashroot, key, default=_sentinel, fast_only=True): + """hashed get""" + hroot = self.root / hashroot + hfile = hroot / gethashfile(key) + + d = self.get(hfile, _sentinel) + # print "got dict",d,"from",hfile + if d is _sentinel: + if fast_only: + if default is _sentinel: + raise KeyError(key) + + return default + + # slow mode ok, works even after hcompress() + d = self.hdict(hashroot) + + return d.get(key, default) + + def hdict(self, hashroot): + """Get all data contained in hashed category 'hashroot' as dict""" + hfiles = self.keys(hashroot + "/*") + hfiles.sort() + last = len(hfiles) and hfiles[-1] or "" + if last.endswith("xx"): + # print "using xx" + hfiles = [last] + hfiles[:-1] + + all = {} + + for f in hfiles: + # print "using",f + try: + all.update(self[f]) + except KeyError: + print("Corrupt", f, "deleted - hset is not threadsafe!") + del self[f] + + self.uncache(f) + + return all + + def hcompress(self, hashroot): + """Compress category 'hashroot', so hset is fast again + + hget will fail if fast_only is True for compressed items (that were + hset before hcompress). + + """ + hfiles = self.keys(hashroot + "/*") + all = {} + for f in hfiles: + # print "using",f + all.update(self[f]) + self.uncache(f) + + self[hashroot + "/xx"] = all + for f in hfiles: + p = self.root / f + if p.name == "xx": + continue + p.unlink() + + def __delitem__(self, key): + """del db["key"]""" + fil = self.root / key + self.cache.pop(fil, None) + try: + fil.unlink() + except OSError: + # notfound and permission denied are ok - we + # lost, the other process wins the conflict + pass + + def _normalized(self, p): + """Make a key suitable for user's eyes""" + return str(p.relative_to(self.root)).replace("\\", "/") + + def keys(self, globpat=None): + """All keys in DB, or all keys matching a glob""" + + if globpat is None: + files = self.root.rglob("*") + else: + files = self.root.glob(globpat) + return [self._normalized(p) for p in files if p.is_file()] + + def __iter__(self): + return iter(self.keys()) + + def __len__(self): + return len(self.keys()) + + def uncache(self, *items): + """Removes all, or specified items from cache + + Use this after reading a large amount of large objects + to free up memory, when you won't be needing the objects + for a while. + + """ + if not items: + self.cache = {} + for it in items: + self.cache.pop(it, None) + + def waitget(self, key, maxwaittime=60): + """Wait (poll) for a key to get a value + + Will wait for `maxwaittime` seconds before raising a KeyError. + The call exits normally if the `key` field in db gets a value + within the timeout period. + + Use this for synchronizing different processes or for ensuring + that an unfortunately timed "db['key'] = newvalue" operation + in another process (which causes all 'get' operation to cause a + KeyError for the duration of pickling) won't screw up your program + logic. + """ + + wtimes = [0.2] * 3 + [0.5] * 2 + [1] + tries = 0 + waited = 0 + while 1: + try: + val = self[key] + return val + except KeyError: + pass + + if waited > maxwaittime: + raise KeyError(key) + + time.sleep(wtimes[tries]) + waited += wtimes[tries] + if tries < len(wtimes) - 1: + tries += 1 + + def getlink(self, folder): + """Get a convenient link for accessing items""" + return PickleShareLink(self, folder) + + def __repr__(self): + return "PickleShareDB('%s')" % self.root + + +class PickleShareLink: + """A shortdand for accessing nested PickleShare data conveniently. + + Created through PickleShareDB.getlink(), example:: + + lnk = db.getlink('myobjects/test') + lnk.foo = 2 + lnk.bar = lnk.foo + 5 + + """ + + def __init__(self, db, keydir): + self.__dict__.update(locals()) + + def __getattr__(self, key): + return self.__dict__["db"][self.__dict__["keydir"] + "/" + key] + + def __setattr__(self, key, val): + self.db[self.keydir + "/" + key] = val + + def __repr__(self): + db = self.__dict__["db"] + keys = db.keys(self.__dict__["keydir"] + "/*") + return "".format( + self.__dict__["keydir"], + ";".join([Path(k).basename() for k in keys]), + ) diff --git a/IPython/external/qt_for_kernel.py b/IPython/external/qt_for_kernel.py index b3168f6e2e0..125f4e6d2ae 100644 --- a/IPython/external/qt_for_kernel.py +++ b/IPython/external/qt_for_kernel.py @@ -1,4 +1,4 @@ -""" Import Qt in a manner suitable for an IPython kernel. +"""Import Qt in a manner suitable for an IPython kernel. This is the import used for the `gui=qt` or `matplotlib=qt` initialization. @@ -23,6 +23,9 @@ else: use what QT_API says + Note that %gui's implementation will always set a `QT_API`, see + `IPython.terminal.pt_inputhooks.get_inputhook_name_and_func` + """ # NOTE: This is no longer an external, third-party module, and should be # considered part of IPython. For compatibility however, it is being kept in @@ -42,7 +45,6 @@ QT_API_PYQT5, QT_API_PYSIDE2, # QT4 - QT_API_PYQTv1, QT_API_PYQT, QT_API_PYSIDE, # default @@ -56,10 +58,6 @@ # QT5 QT_API_PYQT5, QT_API_PYSIDE2, - # QT4 - QT_API_PYQTv1, - QT_API_PYQT, - QT_API_PYSIDE, # default QT_API_PYQT_DEFAULT, ) @@ -98,7 +96,7 @@ def get_options(): if loaded is not None: return [loaded] - mpl = sys.modules.get('matplotlib', None) + mpl = sys.modules.get("matplotlib", None) if mpl is not None and tuple(mpl.__version__.split(".")) < ("1", "0", "2"): # 1.0.1 only supports PyQt4 v1 @@ -113,8 +111,6 @@ def get_options(): QT_API_PYSIDE6, QT_API_PYQT5, QT_API_PYSIDE2, - QT_API_PYQT, - QT_API_PYSIDE, ] elif qt_api not in _qt_apis: raise RuntimeError("Invalid Qt API %r, valid values are: %r" % diff --git a/IPython/external/qt_loaders.py b/IPython/external/qt_loaders.py index 975855ca6bc..52dc6f95fcf 100644 --- a/IPython/external/qt_loaders.py +++ b/IPython/external/qt_loaders.py @@ -8,8 +8,10 @@ This is used primarily by qt and qt_for_kernel, and shouldn't be accessed directly from the outside """ + import importlib.abc import sys +import os import types from functools import partial, lru_cache import operator @@ -24,6 +26,7 @@ QT_API_PYSIDE2 = 'pyside2' # Qt4 +# NOTE: Here for legacy matplotlib compatibility, but not really supported on the IPython side. QT_API_PYQT = "pyqt" # Force version 2 QT_API_PYQTv1 = "pyqtv1" # Force version 2 QT_API_PYSIDE = "pyside" @@ -66,7 +69,9 @@ def find_spec(self, fullname, path, target=None): """ Importing %s disabled by IPython, which has already imported an Incompatible QT Binding: %s - """ % (fullname, loaded_api())) + """ + % (fullname, loaded_api()) + ) ID = ImportDenier() @@ -134,7 +139,7 @@ def has_binding(api): for submod in required: try: - spec = find_spec('%s.%s' % (module_name, submod)) + spec = find_spec('{}.{}'.format(module_name, submod)) except ImportError: # Package (e.g. PyQt5) not found return False @@ -298,13 +303,25 @@ def import_pyside6(): ImportErrors raised within this function are non-recoverable """ + + def get_attrs(module): + return { + name: getattr(module, name) + for name in dir(module) + if not name.startswith("_") + } + from PySide6 import QtGui, QtCore, QtSvg, QtWidgets, QtPrintSupport # Join QtGui and QtWidgets for Qt4 compatibility. QtGuiCompat = types.ModuleType("QtGuiCompat") QtGuiCompat.__dict__.update(QtGui.__dict__) - QtGuiCompat.__dict__.update(QtWidgets.__dict__) - QtGuiCompat.__dict__.update(QtPrintSupport.__dict__) + if QtCore.__version_info__ < (6, 7): + QtGuiCompat.__dict__.update(QtWidgets.__dict__) + QtGuiCompat.__dict__.update(QtPrintSupport.__dict__) + else: + QtGuiCompat.__dict__.update(get_attrs(QtWidgets)) + QtGuiCompat.__dict__.update(get_attrs(QtPrintSupport)) return QtCore, QtGuiCompat, QtSvg, QT_API_PYSIDE6 @@ -365,23 +382,32 @@ def load_qt(api_options): commit_api(api) return result else: - raise ImportError(""" + # Clear the environment variable since it doesn't work. + if "QT_API" in os.environ: + del os.environ["QT_API"] + + raise ImportError( + """ Could not load requested Qt binding. Please ensure that - PyQt4 >= 4.7, PyQt5, PySide >= 1.0.3 or PySide2 is available, - and only one is imported per session. + PyQt4 >= 4.7, PyQt5, PyQt6, PySide >= 1.0.3, PySide2, or + PySide6 is available, and only one is imported per session. Currently-imported Qt library: %r - PyQt4 available (requires QtCore, QtGui, QtSvg): %s PyQt5 available (requires QtCore, QtGui, QtSvg, QtWidgets): %s - PySide >= 1.0.3 installed: %s + PyQt6 available (requires QtCore, QtGui, QtSvg, QtWidgets): %s PySide2 installed: %s + PySide6 installed: %s Tried to load: %r - """ % (loaded_api(), - has_binding(QT_API_PYQT), - has_binding(QT_API_PYQT5), - has_binding(QT_API_PYSIDE), - has_binding(QT_API_PYSIDE2), - api_options)) + """ + % ( + loaded_api(), + has_binding(QT_API_PYQT5), + has_binding(QT_API_PYQT6), + has_binding(QT_API_PYSIDE2), + has_binding(QT_API_PYSIDE6), + api_options, + ) + ) def enum_factory(QT_API, QtCore): diff --git a/IPython/lib/__init__.py b/IPython/lib/__init__.py index 94b8ade4ec9..a11f201f3da 100644 --- a/IPython/lib/__init__.py +++ b/IPython/lib/__init__.py @@ -1,11 +1,10 @@ -# encoding: utf-8 """ Extra capabilities for IPython """ -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Copyright (C) 2008-2011 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- diff --git a/IPython/lib/backgroundjobs.py b/IPython/lib/backgroundjobs.py index e7ad51eb677..d2aedc7fdc6 100644 --- a/IPython/lib/backgroundjobs.py +++ b/IPython/lib/backgroundjobs.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Manage background (threaded) jobs conveniently from an interactive shell. This module provides a BackgroundJobManager class. This is the main class @@ -33,20 +32,20 @@ import sys import threading -from IPython import get_ipython +from IPython.core.getipython import get_ipython from IPython.core.ultratb import AutoFormattedTB from logging import error, debug -class BackgroundJobManager(object): +class BackgroundJobManager: """Class to manage a pool of backgrounded threaded jobs. Below, we assume that 'jobs' is a BackgroundJobManager instance. - + Usage summary (see the method docstrings for details): jobs.new(...) -> start a new job - + jobs() or jobs.status() -> print status summary of all jobs jobs[N] -> returns job number N. @@ -58,7 +57,7 @@ class BackgroundJobManager(object): jobs.remove(N) -> remove (finished) job N jobs.flush() -> remove all finished jobs - + As a convenience feature, BackgroundJobManager instances provide the utility result and traceback methods which retrieve the corresponding information from the jobs list: @@ -167,7 +166,7 @@ def new(self, func_or_exp, *args, **kwargs): 4. There is no way, due to limitations in the Python threads library, to kill a thread once it has started.""" - + if callable(func_or_exp): kw = kwargs.get('kw',{}) job = BackgroundJobFunc(func_or_exp,*args,**kw) @@ -249,7 +248,7 @@ def _group_report(self,group,name): if group: print('%s jobs:' % name) for job in group: - print('%s : %s' % (job.num,job)) + print('{} : {}'.format(job.num,job)) print() return True @@ -261,10 +260,10 @@ def _group_flush(self,group,name): njobs = len(group) if njobs: plural = {1:''}.setdefault(njobs,'s') - print('Flushing %s %s job%s.' % (njobs,name,plural)) + print('Flushing {} {} job{}.'.format(njobs,name,plural)) group[:] = [] return True - + def _status_new(self): """Print the status of newly finished jobs. @@ -280,7 +279,7 @@ def _status_new(self): self._comp_report[:] = [] self._dead_report[:] = [] return new_comp or new_dead - + def status(self,verbose=0): """Print a status of all jobs currently being managed.""" @@ -387,33 +386,33 @@ def __init__(self): def _init(self): """Common initialization for all BackgroundJob objects""" - + for attr in ['call','strform']: assert hasattr(self,attr), "Missing attribute <%s>" % attr - + # The num tag can be set by an external job manager self.num = None - + self.status = BackgroundJobBase.stat_created self.stat_code = BackgroundJobBase.stat_created_c self.finished = False self.result = '' - + # reuse the ipython traceback handler if we can get to it, otherwise # make a new one try: make_tb = get_ipython().InteractiveTB.text - except: - make_tb = AutoFormattedTB(mode = 'Context', - color_scheme='NoColor', - tb_offset = 1).text + except Exception: + make_tb = AutoFormattedTB( + mode="Context", color_scheme="nocolor", tb_offset=1 + ).text # Note that the actual API for text() requires the three args to be # passed in, so we wrap it in a simple lambda. self._make_tb = lambda : make_tb(None, None, None) # Hold a formatted traceback if one is generated. self._tb = None - + threading.Thread.__init__(self) def __str__(self): @@ -424,13 +423,13 @@ def __repr__(self): def traceback(self): print(self._tb) - + def run(self): try: self.status = BackgroundJobBase.stat_running self.stat_code = BackgroundJobBase.stat_running_c self.result = self.call() - except: + except Exception: self.status = BackgroundJobBase.stat_dead self.stat_code = BackgroundJobBase.stat_dead_c self.finished = None @@ -453,14 +452,14 @@ def __init__(self, expression, glob=None, loc=None): # fail immediately if the given expression can't be compiled self.code = compile(expression,'','eval') - + glob = {} if glob is None else glob loc = {} if loc is None else loc self.expression = self.strform = expression self.glob = glob self.loc = loc self._init() - + def call(self): return eval(self.code,self.glob,self.loc) @@ -477,7 +476,7 @@ def __init__(self, func, *args, **kwargs): if not callable(func): raise TypeError( 'first argument to BackgroundJobFunc must be callable') - + self.func = func self.args = args self.kwargs = kwargs diff --git a/IPython/lib/clipboard.py b/IPython/lib/clipboard.py index 95a6b0a0a34..d34b31d21c4 100644 --- a/IPython/lib/clipboard.py +++ b/IPython/lib/clipboard.py @@ -1,14 +1,18 @@ """ Utilities for accessing the platform's clipboard. """ +from __future__ import annotations +import os import subprocess from IPython.core.error import TryNext -import IPython.utils.py3compat as py3compat +from IPython.utils.encoding import DEFAULT_ENCODING + class ClipboardEmpty(ValueError): pass + def win32_clipboard_get(): """ Get the current clipboard's text on Windows. @@ -25,13 +29,14 @@ def win32_clipboard_get(): except (TypeError, win32clipboard.error): try: text = win32clipboard.GetClipboardData(win32clipboard.CF_TEXT) - text = py3compat.cast_unicode(text, py3compat.DEFAULT_ENCODING) + text = text if isinstance(text, str) else text.decode(DEFAULT_ENCODING, "replace") except (TypeError, win32clipboard.error) as e: raise ClipboardEmpty from e finally: win32clipboard.CloseClipboard() return text + def osx_clipboard_get() -> str: """ Get the clipboard's text on OS X. """ @@ -40,9 +45,10 @@ def osx_clipboard_get() -> str: bytes_, stderr = p.communicate() # Text comes in with old Mac \r line endings. Change them to \n. bytes_ = bytes_.replace(b'\r', b'\n') - text = py3compat.decode(bytes_) + text = bytes_.decode(DEFAULT_ENCODING, "replace") return text + def tkinter_clipboard_get(): """ Get the clipboard's text using Tkinter. @@ -51,10 +57,10 @@ def tkinter_clipboard_get(): implementation that uses that toolkit. """ try: - from tkinter import Tk, TclError + from tkinter import Tk, TclError except ImportError as e: raise TryNext("Getting text from the clipboard on this platform requires tkinter.") from e - + root = Tk() root.withdraw() try: @@ -63,7 +69,35 @@ def tkinter_clipboard_get(): raise ClipboardEmpty from e finally: root.destroy() - text = py3compat.cast_unicode(text, py3compat.DEFAULT_ENCODING) + text = text if isinstance(text, str) else text.decode(DEFAULT_ENCODING, "replace") return text +def wayland_clipboard_get(): + """Get the clipboard's text under Wayland using wl-paste command. + + This requires Wayland and wl-clipboard installed and running. + """ + if os.environ.get("XDG_SESSION_TYPE") != "wayland": + raise TryNext("wayland is not detected") + + try: + with subprocess.Popen(["wl-paste"], stdout=subprocess.PIPE) as p: + raw, err = p.communicate() + if p.wait(): + raise TryNext(err) + except FileNotFoundError as e: + raise TryNext( + "Getting text from the clipboard under Wayland requires the wl-clipboard " + "extension: https://github.com/bugaevc/wl-clipboard" + ) from e + + if not raw: + raise ClipboardEmpty + + try: + text = raw.decode(DEFAULT_ENCODING, "replace") + except UnicodeDecodeError as e: + raise ClipboardEmpty from e + + return text diff --git a/IPython/lib/deepreload.py b/IPython/lib/deepreload.py index aaedab24255..062f87692d2 100644 --- a/IPython/lib/deepreload.py +++ b/IPython/lib/deepreload.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ Provides a reload() function that acts recursively. @@ -179,7 +178,7 @@ def import_submodule(mod, subname, fullname): m = importlib.reload(oldm) else: m = importlib.import_module(subname, mod) - except: + except Exception: # load_module probably removed name from modules because of # the error. Put back the original module object. if oldm: @@ -266,12 +265,12 @@ def deep_reload_hook(m): global modules_reloading try: return modules_reloading[name] - except: + except KeyError: modules_reloading[name] = m try: newm = importlib.reload(m) - except: + except Exception: sys.modules[name] = m raise finally: diff --git a/IPython/lib/demo.py b/IPython/lib/demo.py index 8c9ae905d49..27facd5d745 100644 --- a/IPython/lib/demo.py +++ b/IPython/lib/demo.py @@ -136,7 +136,7 @@ #################### EXAMPLE DEMO ############################### '''A simple interactive demo to illustrate the use of IPython's Demo class.''' - print 'Hello, welcome to an interactive IPython demo.' + print('Hello, welcome to an interactive IPython demo.') # The mark below defines a block boundary, which is a point where IPython will # stop execution and return to the interactive prompt. The dashes are actually @@ -152,21 +152,21 @@ # the mark below makes this block as silent # silent - print 'This is a silent block, which gets executed but not printed.' + print('This is a silent block, which gets executed but not printed.') # stop # auto - print 'This is an automatic block.' - print 'It is executed without asking for confirmation, but printed.' - z = x+y + print('This is an automatic block.') + print('It is executed without asking for confirmation, but printed.') + z = x + y - print 'z=',x + print('z =', x) # stop # This is just another normal block. - print 'z is now:', z + print('z is now:', z) - print 'bye!' + print('bye!') ################### END EXAMPLE DEMO ############################ """ @@ -188,7 +188,6 @@ from IPython.utils.text import marquee from IPython.utils import openpy -from IPython.utils import py3compat __all__ = ['Demo','IPythonDemo','LineDemo','IPythonLineDemo','DemoError'] class DemoError(Exception): pass @@ -196,7 +195,7 @@ class DemoError(Exception): pass def re_mark(mark): return re.compile(r'^\s*#\s+\s+%s\s*$' % mark,re.MULTILINE) -class Demo(object): +class Demo: re_stop = re_mark(r'-*\s?stop\s?-*') re_silent = re_mark('silent') @@ -405,7 +404,7 @@ def edit(self,index=None): filename = self.shell.mktempfile(self.src_blocks[index]) self.shell.hooks.editor(filename, 1) - with open(Path(filename), "r", encoding="utf-8") as f: + with open(Path(filename), encoding="utf-8") as f: new_block = f.read() # update the source and colored block self.src_blocks[index] = new_block @@ -475,7 +474,7 @@ def __call__(self,index=None): print(marquee('output:')) else: print(marquee('Press to quit, to execute...'), end=' ') - ans = py3compat.input().strip() + ans = input().strip() if ans: print(marquee('Block NOT executed')) return @@ -487,7 +486,7 @@ def __call__(self,index=None): finally: sys.argv = save_argv - except: + except Exception: if self.inside_ipython: self.ip_showtb(filename=self.fname) else: @@ -598,7 +597,7 @@ class IPythonLineDemo(IPythonDemo,LineDemo): pass -class ClearMixin(object): +class ClearMixin: """Use this mixin to make Demo classes with less visual clutter. Demos using this mixin will clear the screen before every block and use @@ -643,7 +642,7 @@ def slide(file_path, noclear=False, format_rst=True, formatter="terminal", while not demo.finished: demo() try: - py3compat.input('\n' + delimiter) + input('\n' + delimiter) except KeyboardInterrupt: exit(1) diff --git a/IPython/lib/display.py b/IPython/lib/display.py index 4481683c4a0..144ef6ead21 100644 --- a/IPython/lib/display.py +++ b/IPython/lib/display.py @@ -2,13 +2,12 @@ Authors : MinRK, gregcaporaso, dannystaple """ -from html import escape as html_escape from os.path import exists, isfile, splitext, abspath, join, isdir from os import walk, sep, fsdecode from IPython.core.display import DisplayObject, TextDisplayObject -from typing import Tuple, Iterable +from collections.abc import Iterable __all__ = ['Audio', 'IFrame', 'YouTubeVideo', 'VimeoVideo', 'ScribdDocument', 'FileLink', 'FileLinks', 'Code'] @@ -103,9 +102,9 @@ class Audio(DisplayObject): See Also -------- ipywidgets.Audio - - AUdio widget with more more flexibility and options. - + + Audio widget with more more flexibility and options. + """ _read_flags = 'rb' @@ -122,7 +121,7 @@ def __init__(self, data=None, filename=None, url=None, embed=None, rate=None, au self.embed = True self.autoplay = autoplay self.element_id = element_id - super(Audio, self).__init__(data=data, url=url, filename=filename) + super().__init__(data=data, url=url, filename=filename) if self.data is not None and not isinstance(self.data, bytes): if rate is None: @@ -133,7 +132,7 @@ def reload(self): """Reload the raw data from file or URL.""" import mimetypes if self.embed: - super(Audio, self).reload() + super().reload() if self.filename is not None: self.mimetype = mimetypes.guess_type(self.filename)[0] @@ -166,7 +165,7 @@ def _make_wav(data, rate, normalize): return val @staticmethod - def _validate_and_normalize_with_numpy(data, normalize) -> Tuple[bytes, int]: + def _validate_and_normalize_with_numpy(data, normalize) -> tuple[bytes, int]: import numpy as np data = np.array(data, dtype=float) @@ -181,7 +180,7 @@ def _validate_and_normalize_with_numpy(data, normalize) -> Tuple[bytes, int]: data = data.T.ravel() else: raise ValueError('Array audio input must be a 1D or 2D array') - + max_abs_value = np.max(np.abs(data)) normalization_factor = Audio._get_normalization_factor(max_abs_value, normalize) scaled = data / normalization_factor * 32767 @@ -240,7 +239,9 @@ def src_attr(self): return """data:{type};base64,{base64}""".format(type=self.mimetype, base64=data) elif self.url is not None: - return self.url + from html import escape as html_escape + + return html_escape(self.url) else: return "" @@ -249,14 +250,16 @@ def autoplay_attr(self): return 'autoplay="autoplay"' else: return '' - + def element_id_attr(self): if (self.element_id): - return 'id="{element_id}"'.format(element_id=self.element_id) + from html import escape as html_escape + + return f'id="{html_escape(self.element_id)}"' else: return '' -class IFrame(object): +class IFrame: """ Generic class to embed an iframe in an IPython notebook """ @@ -272,7 +275,9 @@ class IFrame(object): > """ - def __init__(self, src, width, height, extras: Iterable[str] = None, **kwargs): + def __init__( + self, src, width, height, extras: Iterable[str] | None = None, **kwargs + ): if extras is None: extras = [] @@ -284,15 +289,17 @@ def __init__(self, src, width, height, extras: Iterable[str] = None, **kwargs): def _repr_html_(self): """return the embed iframe""" + from html import escape as html_escape + if self.params: from urllib.parse import urlencode params = "?" + urlencode(self.params) else: params = "" return self.iframe.format( - src=self.src, - width=self.width, - height=self.height, + src=html_escape(str(self.src)), + width=html_escape(str(self.width)), + height=html_escape(str(self.height)), params=params, extras=" ".join(self.extras), ) @@ -319,26 +326,26 @@ class YouTubeVideo(IFrame): Other parameters can be provided as documented at https://developers.google.com/youtube/player_parameters#Parameters - + When converting the notebook using nbconvert, a jpeg representation of the video will be inserted in the document. """ def __init__(self, id, width=400, height=300, allow_autoplay=False, **kwargs): self.id=id - src = "https://www.youtube.com/embed/{0}".format(id) + src = f"https://www.youtube.com/embed/{id}" if allow_autoplay: extras = list(kwargs.get("extras", [])) + ['allow="autoplay"'] kwargs.update(autoplay=1, extras=extras) - super(YouTubeVideo, self).__init__(src, width, height, **kwargs) + super().__init__(src, width, height, **kwargs) def _repr_jpeg_(self): # Deferred import from urllib.request import urlopen try: - return urlopen("https://img.youtube.com/vi/{id}/hqdefault.jpg".format(id=self.id)).read() - except IOError: + return urlopen(f"https://img.youtube.com/vi/{self.id}/hqdefault.jpg").read() + except OSError: return None class VimeoVideo(IFrame): @@ -347,8 +354,8 @@ class VimeoVideo(IFrame): """ def __init__(self, id, width=400, height=300, **kwargs): - src="https://player.vimeo.com/video/{0}".format(id) - super(VimeoVideo, self).__init__(src, width, height, **kwargs) + src=f"https://player.vimeo.com/video/{id}" + super().__init__(src, width, height, **kwargs) class ScribdDocument(IFrame): """ @@ -363,10 +370,10 @@ class ScribdDocument(IFrame): """ def __init__(self, id, width=400, height=300, **kwargs): - src="https://www.scribd.com/embeds/{0}/content".format(id) - super(ScribdDocument, self).__init__(src, width, height, **kwargs) + src=f"https://www.scribd.com/embeds/{id}/content" + super().__init__(src, width, height, **kwargs) -class FileLink(object): +class FileLink: """Class for embedding a local file link in an IPython session, based on path e.g. to embed a link that was generated in the IPython notebook as my/data.txt @@ -410,6 +417,8 @@ def __init__(self, self.result_html_suffix = result_html_suffix def _format_path(self): + from html import escape as html_escape + fp = ''.join([self.url_prefix, html_escape(self.path)]) return ''.join([self.result_html_prefix, self.html_link_str % \ @@ -510,12 +519,15 @@ def __init__(self, self.recursive = recursive - def _get_display_formatter(self, - dirname_output_format, - fname_output_format, - fp_format, - fp_cleaner=None): - """ generate built-in formatter function + def _get_display_formatter( + self, + dirname_output_format, + fname_output_format, + fp_format, + fp_cleaner=None, + escape_names=False, + ): + """generate built-in formatter function this is used to define both the notebook and terminal built-in formatters as they only differ by some wrapper text for each entry @@ -531,7 +543,16 @@ def _get_display_formatter(self, fp_format: string to use for formatting filepaths, must contain exactly two "%s" and the dirname will be substituted for the first and fname will be substituted for the second + escape_names: whether directory and file names must be HTML-escaped + before being substituted, as they are for the notebook formatter """ + if escape_names: + from html import escape as html_escape + + escape = html_escape + else: + escape = str + def f(dirname, fnames, included_suffixes=None): result = [] # begin by figuring out which filenames, if any, @@ -550,18 +571,18 @@ def f(dirname, fnames, included_suffixes=None): else: # otherwise print the formatted directory name followed by # the formatted filenames - dirname_output_line = dirname_output_format % dirname + dirname_output_line = dirname_output_format % escape(dirname) result.append(dirname_output_line) for fname in display_fnames: - fp = fp_format % (dirname,fname) + fp = fp_format % (escape(dirname), escape(fname)) if fp_cleaner is not None: fp = fp_cleaner(fp) try: # output can include both a filepath and a filename... - fname_output_line = fname_output_format % (fp, fname) + fname_output_line = fname_output_format % (fp, escape(fname)) except TypeError: # ... or just a single filepath - fname_output_line = fname_output_format % fname + fname_output_line = fname_output_format % escape(fname) result.append(fname_output_line) return result return f @@ -586,10 +607,13 @@ def fp_cleaner(fp): else: fp_cleaner = None - return self._get_display_formatter(dirname_output_format, - fname_output_format, - fp_format, - fp_cleaner) + return self._get_display_formatter( + dirname_output_format, + fname_output_format, + fp_format, + fp_cleaner, + escape_names=True, + ) def _get_terminal_display_formatter(self, spacer=" "): diff --git a/IPython/lib/editorhooks.py b/IPython/lib/editorhooks.py index d8bd6ac81bc..41d982798e3 100644 --- a/IPython/lib/editorhooks.py +++ b/IPython/lib/editorhooks.py @@ -10,9 +10,8 @@ import subprocess import sys -from IPython import get_ipython +from IPython.core.getipython import get_ipython from IPython.core.error import TryNext -from IPython.utils import py3compat def install_editor(template, wait=False): @@ -25,7 +24,7 @@ def install_editor(template, wait=False): Parameters ---------- - template : basestring + template : str run_template acts as a template for how your editor is invoked by the shell. It should contain '{filename}', which will be replaced on invocation with the file name, and '{line}', $line by line number @@ -55,7 +54,7 @@ def call_editor(self, filename, line=0): if proc.wait() != 0: raise TryNext() if wait: - py3compat.input("Press Enter when done editing:") + input("Press Enter when done editing:") get_ipython().set_hook('editor', call_editor) get_ipython().editor = template @@ -63,27 +62,27 @@ def call_editor(self, filename, line=0): # in these, exe is always the path/name of the executable. Useful # if you don't have the editor directory in your path -def komodo(exe=u'komodo'): +def komodo(exe='komodo'): """ Activestate Komodo [Edit] """ - install_editor(exe + u' -l {line} {filename}', wait=True) + install_editor(exe + ' -l {line} {filename}', wait=True) -def scite(exe=u"scite"): +def scite(exe="scite"): """ SciTE or Sc1 """ - install_editor(exe + u' {filename} -goto:{line}') + install_editor(exe + ' {filename} -goto:{line}') -def notepadplusplus(exe=u'notepad++'): +def notepadplusplus(exe='notepad++'): """ Notepad++ http://notepad-plus.sourceforge.net """ - install_editor(exe + u' -n{line} {filename}') + install_editor(exe + ' -n{line} {filename}') -def jed(exe=u'jed'): +def jed(exe='jed'): """ JED, the lightweight emacsish editor """ - install_editor(exe + u' +{line} {filename}') + install_editor(exe + ' +{line} {filename}') -def idle(exe=u'idle'): +def idle(exe='idle'): """ Idle, the editor bundled with python Parameters @@ -97,13 +96,13 @@ def idle(exe=u'idle'): # i'm not sure if this actually works. Is this idle.py script # guaranteed to be executable? exe = os.path.join(p, 'idle.py') - install_editor(exe + u' {filename}') + install_editor(exe + ' {filename}') -def mate(exe=u'mate'): +def mate(exe='mate'): """ TextMate, the missing editor""" # wait=True is not required since we're using the -w flag to mate - install_editor(exe + u' -w -l {line} {filename}') + install_editor(exe + ' -w -l {line} {filename}') # ########################################## @@ -111,17 +110,17 @@ def mate(exe=u'mate'): # ########################################## -def emacs(exe=u'emacs'): - install_editor(exe + u' +{line} {filename}') +def emacs(exe='emacs'): + install_editor(exe + ' +{line} {filename}') -def gnuclient(exe=u'gnuclient'): - install_editor(exe + u' -nw +{line} {filename}') +def gnuclient(exe='gnuclient'): + install_editor(exe + ' -nw +{line} {filename}') -def crimson_editor(exe=u'cedt.exe'): - install_editor(exe + u' /L:{line} {filename}') +def crimson_editor(exe='cedt.exe'): + install_editor(exe + ' /L:{line} {filename}') -def kate(exe=u'kate'): - install_editor(exe + u' -u -l {line} {filename}') +def kate(exe='kate'): + install_editor(exe + ' -u -l {line} {filename}') diff --git a/IPython/lib/guisupport.py b/IPython/lib/guisupport.py index cfd325e9da8..a3d0f74944c 100644 --- a/IPython/lib/guisupport.py +++ b/IPython/lib/guisupport.py @@ -1,4 +1,3 @@ -# coding: utf-8 """ Support for creating GUI apps and starting event loops. @@ -106,21 +105,21 @@ def start_event_loop_wx(app=None): app._in_event_loop = True #----------------------------------------------------------------------------- -# qt4 +# Qt #----------------------------------------------------------------------------- def get_app_qt4(*args, **kwargs): - """Create a new qt4 app or return an existing one.""" + """Create a new Qt app or return an existing one.""" from IPython.external.qt_for_kernel import QtGui app = QtGui.QApplication.instance() if app is None: if not args: - args = ([''],) + args = ([""],) app = QtGui.QApplication(*args, **kwargs) return app def is_event_loop_running_qt4(app=None): - """Is the qt4 event loop running.""" + """Is the qt event loop running.""" # New way: check attribute on shell instance ip = get_ipython() if ip is not None: @@ -128,17 +127,17 @@ def is_event_loop_running_qt4(app=None): # Old way: check attribute on QApplication singleton if app is None: - app = get_app_qt4(['']) + app = get_app_qt4([""]) if hasattr(app, '_in_event_loop'): return app._in_event_loop else: - # Does qt4 provide a other way to detect this? + # Does qt provide a other way to detect this? return False def start_event_loop_qt4(app=None): - """Start the qt4 event loop in a consistent manner.""" + """Start the qt event loop in a consistent manner.""" if app is None: - app = get_app_qt4(['']) + app = get_app_qt4([""]) if not is_event_loop_running_qt4(app): app._in_event_loop = True app.exec_() diff --git a/IPython/lib/latextools.py b/IPython/lib/latextools.py index 27aeef5b0eb..18516438d34 100644 --- a/IPython/lib/latextools.py +++ b/IPython/lib/latextools.py @@ -1,10 +1,9 @@ -# -*- coding: utf-8 -*- """Tools for handling LaTeX.""" # Copyright (c) IPython Development Team. # Distributed under the terms of the Modified BSD License. -from io import BytesIO, open +from io import BytesIO import os import tempfile import shutil @@ -12,13 +11,12 @@ from base64 import encodebytes import textwrap -from pathlib import Path, PurePath +from pathlib import Path from IPython.utils.process import find_cmd, FindCmdError from traitlets.config import get_config from traitlets.config.configurable import SingletonConfigurable from traitlets import List, Bool, Unicode -from IPython.utils.py3compat import cast_unicode class LaTeXTool(SingletonConfigurable): @@ -58,8 +56,9 @@ def _config_default(self): ).tag(config=True) -def latex_to_png(s, encode=False, backend=None, wrap=False, color='Black', - scale=1.0): +def latex_to_png( + s: str, encode=False, backend=None, wrap=False, color="Black", scale=1.0 +): """Render a LaTeX string to PNG. Parameters @@ -80,7 +79,7 @@ def latex_to_png(s, encode=False, backend=None, wrap=False, color='Black', None is returned when the backend cannot be used. """ - s = cast_unicode(s) + assert isinstance(s, str) allowed_backends = LaTeXTool.instance().backends if backend is None: backend = allowed_backends[0] @@ -97,11 +96,11 @@ def latex_to_png(s, encode=False, backend=None, wrap=False, color='Black', color = "RGB {}".format(" ".join([str(int(x, 16)) for x in textwrap.wrap(color[1:], 2)])) except ValueError as e: - raise ValueError('Invalid color specification {}.'.format(color)) from e + raise ValueError(f'Invalid color specification {color}.') from e else: - raise ValueError('Invalid color specification {}.'.format(color)) + raise ValueError(f'Invalid color specification {color}.') else: - raise ValueError('No such backend {0}'.format(backend)) + raise ValueError(f'No such backend {backend}') bin_data = f(s, wrap, color, scale) if encode and bin_data: bin_data = encodebytes(bin_data) @@ -119,7 +118,7 @@ def latex_to_png_mpl(s, wrap, color='Black', scale=1.0): # mpl mathtext doesn't support display math, force inline s = s.replace('$$', '$') if wrap: - s = u'${0}$'.format(s) + s = f'${s}$' try: prop = font_manager.FontProperties(size=12) @@ -144,44 +143,55 @@ def latex_to_png_dvipng(s, wrap, color='Black', scale=1.0): find_cmd('dvipng') except FindCmdError: return None + + startupinfo = None + if os.name == "nt": + # prevent popup-windows + startupinfo = subprocess.STARTUPINFO() + startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW + try: workdir = Path(tempfile.mkdtemp()) - tmpfile = workdir.joinpath("tmp.tex") - dvifile = workdir.joinpath("tmp.dvi") - outfile = workdir.joinpath("tmp.png") + tmpfile = "tmp.tex" + dvifile = "tmp.dvi" + outfile = "tmp.png" - with tmpfile.open("w", encoding="utf8") as f: + with workdir.joinpath(tmpfile).open("w", encoding="utf8") as f: f.writelines(genelatex(s, wrap)) - with open(os.devnull, 'wb') as devnull: - subprocess.check_call( - ["latex", "-halt-on-error", "-interaction", "batchmode", tmpfile], - cwd=workdir, stdout=devnull, stderr=devnull) - - resolution = round(150*scale) - subprocess.check_call( - [ - "dvipng", - "-T", - "tight", - "-D", - str(resolution), - "-z", - "9", - "-bg", - "Transparent", - "-o", - outfile, - dvifile, - "-fg", - color, - ], - cwd=workdir, - stdout=devnull, - stderr=devnull, - ) - - with outfile.open("rb") as f: + subprocess.check_call( + ["latex", "-halt-on-error", "-interaction", "batchmode", tmpfile], + cwd=workdir, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, + startupinfo=startupinfo, + ) + + resolution = round(150 * scale) + subprocess.check_call( + [ + "dvipng", + "-T", + "tight", + "-D", + str(resolution), + "-z", + "9", + "-bg", + "Transparent", + "-o", + outfile, + dvifile, + "-fg", + color, + ], + cwd=workdir, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, + startupinfo=startupinfo, + ) + + with workdir.joinpath(outfile).open("rb") as f: return f.read() except subprocess.CalledProcessError: return None @@ -211,7 +221,7 @@ def genelatex(body, wrap): if breqn: packages = packages + ['breqn'] for pack in packages: - yield r'\usepackage{{{0}}}'.format(pack) + yield fr'\usepackage{{{pack}}}' yield r'\pagestyle{empty}' if lt.preamble: yield lt.preamble @@ -221,13 +231,13 @@ def genelatex(body, wrap): yield body yield r'\end{dmath*}' elif wrap: - yield u'$${0}$$'.format(body) + yield f'$${body}$$' else: yield body - yield u'\\end{document}' + yield '\\end{document}' -_data_uri_template_png = u"""

""" +_data_uri_template_png = """

""" def latex_to_html(s, alt='image'): """Render LaTeX to HTML with embedded PNG data using data URIs. @@ -242,5 +252,3 @@ def latex_to_html(s, alt='image'): base64_data = latex_to_png(s, encode=True).decode('ascii') if base64_data: return _data_uri_template_png % (base64_data, alt) - - diff --git a/IPython/lib/lexers.py b/IPython/lib/lexers.py index 0c9b6e1bc7e..da22950a93c 100644 --- a/IPython/lib/lexers.py +++ b/IPython/lib/lexers.py @@ -1,526 +1,31 @@ -# -*- coding: utf-8 -*- """ -Defines a variety of Pygments lexers for highlighting IPython code. - -This includes: - - IPythonLexer, IPython3Lexer - Lexers for pure IPython (python + magic/shell commands) - - IPythonPartialTracebackLexer, IPythonTracebackLexer - Supports 2.x and 3.x via keyword `python3`. The partial traceback - lexer reads everything but the Python code appearing in a traceback. - The full lexer combines the partial lexer with an IPython lexer. - - IPythonConsoleLexer - A lexer for IPython console sessions, with support for tracebacks. - - IPyLexer - A friendly lexer which examines the first line of text and from it, - decides whether to use an IPython lexer or an IPython console lexer. - This is probably the only lexer that needs to be explicitly added - to Pygments. +The IPython lexers are now a separate package, ipython-pygments-lexers. +Importing from here is deprecated and may break in the future. """ -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Copyright (c) 2013, the IPython Development Team. # # Distributed under the terms of the Modified BSD License. # # The full license is in the file COPYING.txt, distributed with this software. -#----------------------------------------------------------------------------- - -# Standard library -import re - -# Third party -from pygments.lexers import ( - BashLexer, HtmlLexer, JavascriptLexer, RubyLexer, PerlLexer, PythonLexer, - Python3Lexer, TexLexer) -from pygments.lexer import ( - Lexer, DelegatingLexer, RegexLexer, do_insertions, bygroups, using, -) -from pygments.token import ( - Generic, Keyword, Literal, Name, Operator, Other, Text, Error, +# ----------------------------------------------------------------------------- + +from ipython_pygments_lexers import ( + IPythonLexer, + IPython3Lexer, + IPythonPartialTracebackLexer, + IPythonTracebackLexer, + IPythonConsoleLexer, + IPyLexer, ) -from pygments.util import get_bool_opt - -# Local - -line_re = re.compile('.*?\n') - -__all__ = ['build_ipy_lexer', 'IPython3Lexer', 'IPythonLexer', - 'IPythonPartialTracebackLexer', 'IPythonTracebackLexer', - 'IPythonConsoleLexer', 'IPyLexer'] - - -def build_ipy_lexer(python3): - """Builds IPython lexers depending on the value of `python3`. - - The lexer inherits from an appropriate Python lexer and then adds - information about IPython specific keywords (i.e. magic commands, - shell commands, etc.) - - Parameters - ---------- - python3 : bool - If `True`, then build an IPython lexer from a Python 3 lexer. - - """ - # It would be nice to have a single IPython lexer class which takes - # a boolean `python3`. But since there are two Python lexer classes, - # we will also have two IPython lexer classes. - if python3: - PyLexer = Python3Lexer - name = 'IPython3' - aliases = ['ipython3'] - doc = """IPython3 Lexer""" - else: - PyLexer = PythonLexer - name = 'IPython' - aliases = ['ipython2', 'ipython'] - doc = """IPython Lexer""" - - ipython_tokens = [ - (r'(?s)(\s*)(%%capture)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%debug)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?is)(\s*)(%%html)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(HtmlLexer))), - (r'(?s)(\s*)(%%javascript)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(JavascriptLexer))), - (r'(?s)(\s*)(%%js)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(JavascriptLexer))), - (r'(?s)(\s*)(%%latex)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(TexLexer))), - (r'(?s)(\s*)(%%perl)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PerlLexer))), - (r'(?s)(\s*)(%%prun)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%pypy)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%python)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%python2)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PythonLexer))), - (r'(?s)(\s*)(%%python3)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(Python3Lexer))), - (r'(?s)(\s*)(%%ruby)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(RubyLexer))), - (r'(?s)(\s*)(%%time)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%timeit)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%writefile)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r'(?s)(\s*)(%%file)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), - (r"(?s)(\s*)(%%)(\w+)(.*)", bygroups(Text, Operator, Keyword, Text)), - (r'(?s)(^\s*)(%%!)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(BashLexer))), - (r"(%%?)(\w+)(\?\??)$", bygroups(Operator, Keyword, Operator)), - (r"\b(\?\??)(\s*)$", bygroups(Operator, Text)), - (r'(%)(sx|sc|system)(.*)(\n)', bygroups(Operator, Keyword, - using(BashLexer), Text)), - (r'(%)(\w+)(.*\n)', bygroups(Operator, Keyword, Text)), - (r'^(!!)(.+)(\n)', bygroups(Operator, using(BashLexer), Text)), - (r'(!)(?!=)(.+)(\n)', bygroups(Operator, using(BashLexer), Text)), - (r'^(\s*)(\?\??)(\s*%{0,2}[\w\.\*]*)', bygroups(Text, Operator, Text)), - (r'(\s*%{0,2}[\w\.\*]*)(\?\??)(\s*)$', bygroups(Text, Operator, Text)), - ] - - tokens = PyLexer.tokens.copy() - tokens['root'] = ipython_tokens + tokens['root'] - - attrs = {'name': name, 'aliases': aliases, 'filenames': [], - '__doc__': doc, 'tokens': tokens} - - return type(name, (PyLexer,), attrs) - - -IPython3Lexer = build_ipy_lexer(python3=True) -IPythonLexer = build_ipy_lexer(python3=False) - - -class IPythonPartialTracebackLexer(RegexLexer): - """ - Partial lexer for IPython tracebacks. - - Handles all the non-python output. - - """ - name = 'IPython Partial Traceback' - - tokens = { - 'root': [ - # Tracebacks for syntax errors have a different style. - # For both types of tracebacks, we mark the first line with - # Generic.Traceback. For syntax errors, we mark the filename - # as we mark the filenames for non-syntax tracebacks. - # - # These two regexps define how IPythonConsoleLexer finds a - # traceback. - # - ## Non-syntax traceback - (r'^(\^C)?(-+\n)', bygroups(Error, Generic.Traceback)), - ## Syntax traceback - (r'^( File)(.*)(, line )(\d+\n)', - bygroups(Generic.Traceback, Name.Namespace, - Generic.Traceback, Literal.Number.Integer)), - - # (Exception Identifier)(Whitespace)(Traceback Message) - (r'(?u)(^[^\d\W]\w*)(\s*)(Traceback.*?\n)', - bygroups(Name.Exception, Generic.Whitespace, Text)), - # (Module/Filename)(Text)(Callee)(Function Signature) - # Better options for callee and function signature? - (r'(.*)( in )(.*)($.*$\n)', - bygroups(Name.Namespace, Text, Name.Entity, Name.Tag)), - # Regular line: (Whitespace)(Line Number)(Python Code) - (r'(\s*?)(\d+)(.*?\n)', - bygroups(Generic.Whitespace, Literal.Number.Integer, Other)), - # Emphasized line: (Arrow)(Line Number)(Python Code) - # Using Exception token so arrow color matches the Exception. - (r'(-*>?\s?)(\d+)(.*?\n)', - bygroups(Name.Exception, Literal.Number.Integer, Other)), - # (Exception Identifier)(Message) - (r'(?u)(^[^\d\W]\w*)(:.*?\n)', - bygroups(Name.Exception, Text)), - # Tag everything else as Other, will be handled later. - (r'.*\n', Other), - ], - } - - -class IPythonTracebackLexer(DelegatingLexer): - """ - IPython traceback lexer. - - For doctests, the tracebacks can be snipped as much as desired with the - exception to the lines that designate a traceback. For non-syntax error - tracebacks, this is the line of hyphens. For syntax error tracebacks, - this is the line which lists the File and line number. - - """ - # The lexer inherits from DelegatingLexer. The "root" lexer is an - # appropriate IPython lexer, which depends on the value of the boolean - # `python3`. First, we parse with the partial IPython traceback lexer. - # Then, any code marked with the "Other" token is delegated to the root - # lexer. - # - name = 'IPython Traceback' - aliases = ['ipythontb'] - - def __init__(self, **options): - self.python3 = get_bool_opt(options, 'python3', False) - if self.python3: - self.aliases = ['ipython3tb'] - else: - self.aliases = ['ipython2tb', 'ipythontb'] - - if self.python3: - IPyLexer = IPython3Lexer - else: - IPyLexer = IPythonLexer - - DelegatingLexer.__init__(self, IPyLexer, - IPythonPartialTracebackLexer, **options) - -class IPythonConsoleLexer(Lexer): - """ - An IPython console lexer for IPython code-blocks and doctests, such as: - - .. code-block:: rst - - .. code-block:: ipythonconsole - - In [1]: a = 'foo' - - In [2]: a - Out[2]: 'foo' - - In [3]: print(a) - foo - - - Support is also provided for IPython exceptions: - - .. code-block:: rst - - .. code-block:: ipythonconsole - - In [1]: raise Exception - Traceback (most recent call last): - ... - Exception - - """ - name = 'IPython console session' - aliases = ['ipythonconsole'] - mimetypes = ['text/x-ipython-console'] - - # The regexps used to determine what is input and what is output. - # The default prompts for IPython are: - # - # in = 'In [#]: ' - # continuation = ' .D.: ' - # template = 'Out[#]: ' - # - # Where '#' is the 'prompt number' or 'execution count' and 'D' - # D is a number of dots matching the width of the execution count - # - in1_regex = r'In \[[0-9]+\]: ' - in2_regex = r' \.\.+\.: ' - out_regex = r'Out\[[0-9]+\]: ' - - #: The regex to determine when a traceback starts. - ipytb_start = re.compile(r'^(\^C)?(-+\n)|^( File)(.*)(, line )(\d+\n)') - - def __init__(self, **options): - """Initialize the IPython console lexer. - - Parameters - ---------- - python3 : bool - If `True`, then the console inputs are parsed using a Python 3 - lexer. Otherwise, they are parsed using a Python 2 lexer. - in1_regex : RegexObject - The compiled regular expression used to detect the start - of inputs. Although the IPython configuration setting may have a - trailing whitespace, do not include it in the regex. If `None`, - then the default input prompt is assumed. - in2_regex : RegexObject - The compiled regular expression used to detect the continuation - of inputs. Although the IPython configuration setting may have a - trailing whitespace, do not include it in the regex. If `None`, - then the default input prompt is assumed. - out_regex : RegexObject - The compiled regular expression used to detect outputs. If `None`, - then the default output prompt is assumed. - - """ - self.python3 = get_bool_opt(options, 'python3', False) - if self.python3: - self.aliases = ['ipython3console'] - else: - self.aliases = ['ipython2console', 'ipythonconsole'] - - in1_regex = options.get('in1_regex', self.in1_regex) - in2_regex = options.get('in2_regex', self.in2_regex) - out_regex = options.get('out_regex', self.out_regex) - - # So that we can work with input and output prompts which have been - # rstrip'd (possibly by editors) we also need rstrip'd variants. If - # we do not do this, then such prompts will be tagged as 'output'. - # The reason can't just use the rstrip'd variants instead is because - # we want any whitespace associated with the prompt to be inserted - # with the token. This allows formatted code to be modified so as hide - # the appearance of prompts, with the whitespace included. One example - # use of this is in copybutton.js from the standard lib Python docs. - in1_regex_rstrip = in1_regex.rstrip() + '\n' - in2_regex_rstrip = in2_regex.rstrip() + '\n' - out_regex_rstrip = out_regex.rstrip() + '\n' - - # Compile and save them all. - attrs = ['in1_regex', 'in2_regex', 'out_regex', - 'in1_regex_rstrip', 'in2_regex_rstrip', 'out_regex_rstrip'] - for attr in attrs: - self.__setattr__(attr, re.compile(locals()[attr])) - - Lexer.__init__(self, **options) - - if self.python3: - pylexer = IPython3Lexer - tblexer = IPythonTracebackLexer - else: - pylexer = IPythonLexer - tblexer = IPythonTracebackLexer - - self.pylexer = pylexer(**options) - self.tblexer = tblexer(**options) - - self.reset() - - def reset(self): - self.mode = 'output' - self.index = 0 - self.buffer = u'' - self.insertions = [] - - def buffered_tokens(self): - """ - Generator of unprocessed tokens after doing insertions and before - changing to a new state. - - """ - if self.mode == 'output': - tokens = [(0, Generic.Output, self.buffer)] - elif self.mode == 'input': - tokens = self.pylexer.get_tokens_unprocessed(self.buffer) - else: # traceback - tokens = self.tblexer.get_tokens_unprocessed(self.buffer) - - for i, t, v in do_insertions(self.insertions, tokens): - # All token indexes are relative to the buffer. - yield self.index + i, t, v - - # Clear it all - self.index += len(self.buffer) - self.buffer = u'' - self.insertions = [] - - def get_mci(self, line): - """ - Parses the line and returns a 3-tuple: (mode, code, insertion). - - `mode` is the next mode (or state) of the lexer, and is always equal - to 'input', 'output', or 'tb'. - - `code` is a portion of the line that should be added to the buffer - corresponding to the next mode and eventually lexed by another lexer. - For example, `code` could be Python code if `mode` were 'input'. - - `insertion` is a 3-tuple (index, token, text) representing an - unprocessed "token" that will be inserted into the stream of tokens - that are created from the buffer once we change modes. This is usually - the input or output prompt. - - In general, the next mode depends on current mode and on the contents - of `line`. - - """ - # To reduce the number of regex match checks, we have multiple - # 'if' blocks instead of 'if-elif' blocks. - - # Check for possible end of input - in2_match = self.in2_regex.match(line) - in2_match_rstrip = self.in2_regex_rstrip.match(line) - if (in2_match and in2_match.group().rstrip() == line.rstrip()) or \ - in2_match_rstrip: - end_input = True - else: - end_input = False - if end_input and self.mode != 'tb': - # Only look for an end of input when not in tb mode. - # An ellipsis could appear within the traceback. - mode = 'output' - code = u'' - insertion = (0, Generic.Prompt, line) - return mode, code, insertion - - # Check for output prompt - out_match = self.out_regex.match(line) - out_match_rstrip = self.out_regex_rstrip.match(line) - if out_match or out_match_rstrip: - mode = 'output' - if out_match: - idx = out_match.end() - else: - idx = out_match_rstrip.end() - code = line[idx:] - # Use the 'heading' token for output. We cannot use Generic.Error - # since it would conflict with exceptions. - insertion = (0, Generic.Heading, line[:idx]) - return mode, code, insertion - - - # Check for input or continuation prompt (non stripped version) - in1_match = self.in1_regex.match(line) - if in1_match or (in2_match and self.mode != 'tb'): - # New input or when not in tb, continued input. - # We do not check for continued input when in tb since it is - # allowable to replace a long stack with an ellipsis. - mode = 'input' - if in1_match: - idx = in1_match.end() - else: # in2_match - idx = in2_match.end() - code = line[idx:] - insertion = (0, Generic.Prompt, line[:idx]) - return mode, code, insertion - - # Check for input or continuation prompt (stripped version) - in1_match_rstrip = self.in1_regex_rstrip.match(line) - if in1_match_rstrip or (in2_match_rstrip and self.mode != 'tb'): - # New input or when not in tb, continued input. - # We do not check for continued input when in tb since it is - # allowable to replace a long stack with an ellipsis. - mode = 'input' - if in1_match_rstrip: - idx = in1_match_rstrip.end() - else: # in2_match - idx = in2_match_rstrip.end() - code = line[idx:] - insertion = (0, Generic.Prompt, line[:idx]) - return mode, code, insertion - - # Check for traceback - if self.ipytb_start.match(line): - mode = 'tb' - code = line - insertion = None - return mode, code, insertion - - # All other stuff... - if self.mode in ('input', 'output'): - # We assume all other text is output. Multiline input that - # does not use the continuation marker cannot be detected. - # For example, the 3 in the following is clearly output: - # - # In [1]: print 3 - # 3 - # - # But the following second line is part of the input: - # - # In [2]: while True: - # print True - # - # In both cases, the 2nd line will be 'output'. - # - mode = 'output' - else: - mode = 'tb' - - code = line - insertion = None - - return mode, code, insertion - - def get_tokens_unprocessed(self, text): - self.reset() - for match in line_re.finditer(text): - line = match.group() - mode, code, insertion = self.get_mci(line) - - if mode != self.mode: - # Yield buffered tokens before transitioning to new mode. - for token in self.buffered_tokens(): - yield token - self.mode = mode - - if insertion: - self.insertions.append((len(self.buffer), [insertion])) - self.buffer += code - - for token in self.buffered_tokens(): - yield token - -class IPyLexer(Lexer): - r""" - Primary lexer for all IPython-like code. - - This is a simple helper lexer. If the first line of the text begins with - "In \[[0-9]+\]:", then the entire text is parsed with an IPython console - lexer. If not, then the entire text is parsed with an IPython lexer. - - The goal is to reduce the number of lexers that are registered - with Pygments. - - """ - name = 'IPy session' - aliases = ['ipy'] - - def __init__(self, **options): - self.python3 = get_bool_opt(options, 'python3', False) - if self.python3: - self.aliases = ['ipy3'] - else: - self.aliases = ['ipy2', 'ipy'] - - Lexer.__init__(self, **options) - - self.IPythonLexer = IPythonLexer(**options) - self.IPythonConsoleLexer = IPythonConsoleLexer(**options) - def get_tokens_unprocessed(self, text): - # Search for the input prompt anywhere...this allows code blocks to - # begin with comments as well. - if re.match(r'.*(In \[[0-9]+\]:)', text.strip(), re.DOTALL): - lex = self.IPythonConsoleLexer - else: - lex = self.IPythonLexer - for token in lex.get_tokens_unprocessed(text): - yield token +__all__ = [ + "IPython3Lexer", + "IPythonLexer", + "IPythonPartialTracebackLexer", + "IPythonTracebackLexer", + "IPythonConsoleLexer", + "IPyLexer", +] diff --git a/IPython/lib/pretty.py b/IPython/lib/pretty.py index 72f143522df..6ae5813c989 100644 --- a/IPython/lib/pretty.py +++ b/IPython/lib/pretty.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ Python advanced pretty printer. This pretty printer is intended to replace the old `pprint` python module which does not allow developers @@ -103,10 +102,14 @@ def _repr_pretty_(self, p, cycle): from collections import deque from inspect import signature from io import StringIO -from warnings import warn -from IPython.utils.decorators import undoc -from IPython.utils.py3compat import PYPY +# Allow pretty-printing of functions with PEP-649 annotations +if sys.version_info >= (3, 14): + from annotationlib import Format + from functools import partial + + signature = partial(signature, annotation_format=Format.FORWARDREF) + __all__ = ['pretty', 'pprint', 'PrettyPrinter', 'RepresentationPrinter', 'for_type', 'for_type_by_name', 'RawText', 'RawStringLiteral', 'CallExpression'] @@ -126,14 +129,6 @@ def _safe_getattr(obj, attr, default=None): except Exception: return default -@undoc -class CUnicodeIO(StringIO): - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - warn(("CUnicodeIO is deprecated since IPython 6.0. " - "Please use io.StringIO instead."), - DeprecationWarning, stacklevel=2) - def _sorted_for_pprint(items): """ Sort the given items for pretty printing. Since some predictable @@ -170,7 +165,8 @@ def pprint(obj, verbose=False, max_width=79, newline='\n', max_seq_length=MAX_SE sys.stdout.write(newline) sys.stdout.flush() -class _PrettyPrinterBase(object): + +class _PrettyPrinterBase: @contextmanager def indent(self, indent): @@ -405,8 +401,16 @@ def pretty(self, obj): meth = cls._repr_pretty_ if callable(meth): return meth(obj, self, cycle) - if cls is not object \ - and callable(cls.__dict__.get('__repr__')): + if ( + cls is not object + # check if cls defines __repr__ + and "__repr__" in cls.__dict__ + # check if __repr__ is callable. + # Note: we need to test getattr(cls, '__repr__') + # instead of cls.__dict__['__repr__'] + # in order to work with descriptors like partialmethod, + and callable(_safe_getattr(cls, "__repr__", None)) + ): return _repr_pprint(obj, self, cycle) return _default_pprint(obj, self, cycle) @@ -433,7 +437,7 @@ class is not in the registry. Successful matches will be moved to the return printer -class Printable(object): +class Printable: def output(self, stream, output_width): return output_width @@ -485,7 +489,7 @@ def __init__(self, depth): self.want_break = False -class GroupQueue(object): +class GroupQueue: def __init__(self, *groups): self.queue = [] @@ -532,7 +536,7 @@ def _repr_pretty_(self, p, cycle): class CallExpression: """ Object which emits a line-wrapped call expression in the form `__name(*args, **kwargs)` """ def __init__(__self, __name, *args, **kwargs): - # dunders are to avoid clashes with kwargs, as python's name manging + # dunders are to avoid clashes with kwargs, as python's name managing # will kick in. self = __self self.name = __name @@ -546,7 +550,7 @@ def inner(*args, **kwargs): return inner def _repr_pretty_(self, p, cycle): - # dunders are to avoid clashes with kwargs, as python's name manging + # dunders are to avoid clashes with kwargs, as python's name managing # will kick in. started = False @@ -700,7 +704,9 @@ def _super_pprint(obj, p, cycle): p.pretty(obj.__thisclass__) p.text(',') p.breakable() - if PYPY: # In PyPy, super() objects don't have __self__ attributes + import platform + + if platform.python_implementation() == "PyPy": # In PyPy, super() objects don't have __self__ attributes dself = obj.__repr__.__self__ p.pretty(None if dself is obj else dself) else: @@ -715,8 +721,15 @@ def __init__(self, value): def _repr_pretty_(self, p, cycle): done_one = False - for flag in ('TEMPLATE', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL', - 'UNICODE', 'VERBOSE', 'DEBUG'): + for flag in ( + "IGNORECASE", + "LOCALE", + "MULTILINE", + "DOTALL", + "UNICODE", + "VERBOSE", + "DEBUG", + ): if self.value & getattr(re, flag): if done_one: p.text('|') @@ -801,12 +814,13 @@ def _exception_pprint(obj, p, cycle): """Base pprint for all exceptions.""" name = getattr(obj.__class__, '__qualname__', obj.__class__.__name__) if obj.__class__.__module__ not in ('exceptions', 'builtins'): - name = '%s.%s' % (obj.__class__.__module__, name) + name = '{}.{}'.format(obj.__class__.__module__, name) p.pretty(CallExpression(name, *getattr(obj, 'args', ()))) #: the exception base +_exception_base: type try: _exception_base = BaseException except NameError: @@ -841,24 +855,15 @@ def _exception_pprint(obj, p, cycle): if _env_type is not dict: _type_pprinters[_env_type] = _dict_pprinter_factory('environ{', '}') -try: - # In PyPy, types.DictProxyType is dict, setting the dictproxy printer - # using dict.setdefault avoids overwriting the dict printer - _type_pprinters.setdefault(types.DictProxyType, - _dict_pprinter_factory('dict_proxy({', '})')) - _type_pprinters[types.ClassType] = _type_pprint - _type_pprinters[types.SliceType] = _repr_pprint -except AttributeError: # Python 3 - _type_pprinters[types.MappingProxyType] = \ - _dict_pprinter_factory('mappingproxy({', '})') - _type_pprinters[slice] = _repr_pprint +_type_pprinters[types.MappingProxyType] = _dict_pprinter_factory("mappingproxy({", "})") +_type_pprinters[slice] = _repr_pprint _type_pprinters[range] = _repr_pprint _type_pprinters[bytes] = _repr_pprint #: printers for types specified by name -_deferred_type_pprinters = { -} +_deferred_type_pprinters: dict = {} + def for_type(typ, func): """ @@ -908,6 +913,8 @@ def _deque_pprint(obj, p, cycle): cls_ctor = CallExpression.factory(obj.__class__.__name__) if cycle: p.pretty(cls_ctor(RawText("..."))) + elif obj.maxlen is not None: + p.pretty(cls_ctor(list(obj), maxlen=obj.maxlen)) else: p.pretty(cls_ctor(list(obj))) @@ -916,7 +923,7 @@ def _counter_pprint(obj, p, cycle): if cycle: p.pretty(cls_ctor(RawText("..."))) elif len(obj): - p.pretty(cls_ctor(dict(obj))) + p.pretty(cls_ctor(dict(obj.most_common()))) else: p.pretty(cls_ctor()) @@ -937,7 +944,8 @@ def _userlist_pprint(obj, p, cycle): if __name__ == '__main__': from random import randrange - class Foo(object): + + class Foo: def __init__(self): self.foo = 1 self.bar = re.compile(r'\s+') diff --git a/IPython/lib/tests/test_backgroundjobs.py b/IPython/lib/tests/test_backgroundjobs.py deleted file mode 100644 index fc76ff198ec..00000000000 --- a/IPython/lib/tests/test_backgroundjobs.py +++ /dev/null @@ -1,85 +0,0 @@ -"""Tests for pylab tools module. -""" -#----------------------------------------------------------------------------- -# Copyright (c) 2011, the IPython Development Team. -# -# Distributed under the terms of the Modified BSD License. -# -# The full license is in the file COPYING.txt, distributed with this software. -#----------------------------------------------------------------------------- - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- - -# Stdlib imports -import time - -# Our own imports -from IPython.lib import backgroundjobs as bg - -#----------------------------------------------------------------------------- -# Globals and constants -#----------------------------------------------------------------------------- -t_short = 0.0001 # very short interval to wait on jobs - -#----------------------------------------------------------------------------- -# Local utilities -#----------------------------------------------------------------------------- -def sleeper(interval=t_short, *a, **kw): - args = dict(interval=interval, - other_args=a, - kw_args=kw) - time.sleep(interval) - return args - -def crasher(interval=t_short, *a, **kw): - time.sleep(interval) - raise Exception("Dead job with interval %s" % interval) - -#----------------------------------------------------------------------------- -# Classes and functions -#----------------------------------------------------------------------------- - -def test_result(): - """Test job submission and result retrieval""" - jobs = bg.BackgroundJobManager() - j = jobs.new(sleeper) - j.join() - assert j.result["interval"] == t_short - - -def test_flush(): - """Test job control""" - jobs = bg.BackgroundJobManager() - j = jobs.new(sleeper) - j.join() - assert len(jobs.completed) == 1 - assert len(jobs.dead) == 0 - jobs.flush() - assert len(jobs.completed) == 0 - - -def test_dead(): - """Test control of dead jobs""" - jobs = bg.BackgroundJobManager() - j = jobs.new(crasher) - j.join() - assert len(jobs.completed) == 0 - assert len(jobs.dead) == 1 - jobs.flush() - assert len(jobs.dead) == 0 - - -def test_longer(): - """Test control of longer-running jobs""" - jobs = bg.BackgroundJobManager() - # Sleep for long enough for the following two checks to still report the - # job as running, but not so long that it makes the test suite noticeably - # slower. - j = jobs.new(sleeper, 0.1) - assert len(jobs.running) == 1 - assert len(jobs.completed) == 0 - j.join() - assert len(jobs.running) == 0 - assert len(jobs.completed) == 1 diff --git a/IPython/lib/tests/test_clipboard.py b/IPython/lib/tests/test_clipboard.py deleted file mode 100644 index 802f753a339..00000000000 --- a/IPython/lib/tests/test_clipboard.py +++ /dev/null @@ -1,19 +0,0 @@ -from IPython.core.error import TryNext -from IPython.lib.clipboard import ClipboardEmpty -from IPython.testing.decorators import skip_if_no_x11 - -@skip_if_no_x11 -def test_clipboard_get(): - # Smoketest for clipboard access - we can't easily guarantee that the - # clipboard is accessible and has something on it, but this tries to - # exercise the relevant code anyway. - try: - a = get_ipython().hooks.clipboard_get() - except ClipboardEmpty: - # Nothing in clipboard to get - pass - except TryNext: - # No clipboard access API available - pass - else: - assert isinstance(a, str) diff --git a/IPython/lib/tests/test_deepreload.py b/IPython/lib/tests/test_deepreload.py deleted file mode 100644 index 5da606cb8b7..00000000000 --- a/IPython/lib/tests/test_deepreload.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- -"""Test suite for the deepreload module.""" - -# Copyright (c) IPython Development Team. -# Distributed under the terms of the Modified BSD License. - -import types -from pathlib import Path - -import pytest -from tempfile import TemporaryDirectory - -from IPython.lib.deepreload import modules_reloading -from IPython.lib.deepreload import reload as dreload -from IPython.utils.syspathcontext import prepended_to_syspath - - -def test_deepreload(): - "Test that dreload does deep reloads and skips excluded modules." - with TemporaryDirectory() as tmpdir: - with prepended_to_syspath(tmpdir): - tmpdirpath = Path(tmpdir) - with open(tmpdirpath / "A.py", "w", encoding="utf-8") as f: - f.write("class Object:\n pass\nok = True\n") - with open(tmpdirpath / "B.py", "w", encoding="utf-8") as f: - f.write("import A\nassert A.ok, 'we are fine'\n") - import A - import B - - # Test that A is not reloaded. - obj = A.Object() - dreload(B, exclude=["A"]) - assert isinstance(obj, A.Object) is True - - # Test that an import failure will not blow-up us. - A.ok = False - with pytest.raises(AssertionError, match="we are fine"): - dreload(B, exclude=["A"]) - assert len(modules_reloading) == 0 - assert not A.ok - - # Test that A is reloaded. - obj = A.Object() - A.ok = False - dreload(B) - assert A.ok - assert isinstance(obj, A.Object) is False - - -def test_not_module(): - pytest.raises(TypeError, dreload, "modulename") - - -def test_not_in_sys_modules(): - fake_module = types.ModuleType("fake_module") - with pytest.raises(ImportError, match="not in sys.modules"): - dreload(fake_module) diff --git a/IPython/lib/tests/test_display.py b/IPython/lib/tests/test_display.py deleted file mode 100644 index f5ed34c912b..00000000000 --- a/IPython/lib/tests/test_display.py +++ /dev/null @@ -1,272 +0,0 @@ -"""Tests for IPython.lib.display. - -""" -#----------------------------------------------------------------------------- -# Copyright (c) 2012, the IPython Development Team. -# -# Distributed under the terms of the Modified BSD License. -# -# The full license is in the file COPYING.txt, distributed with this software. -#----------------------------------------------------------------------------- - -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- -from tempfile import NamedTemporaryFile, mkdtemp -from os.path import split, join as pjoin, dirname -import pathlib -from unittest import TestCase, mock -import struct -import wave -from io import BytesIO - -# Third-party imports -import pytest - -try: - import numpy -except ImportError: - pass - -# Our own imports -from IPython.lib import display - -from IPython.testing.decorators import skipif_not_numpy - -#----------------------------------------------------------------------------- -# Classes and functions -#----------------------------------------------------------------------------- - -#-------------------------- -# FileLink tests -#-------------------------- - -def test_instantiation_FileLink(): - """FileLink: Test class can be instantiated""" - fl = display.FileLink('example.txt') - # TODO: remove if when only Python >= 3.6 is supported - fl = display.FileLink(pathlib.PurePath('example.txt')) - -def test_warning_on_non_existent_path_FileLink(): - """FileLink: Calling _repr_html_ on non-existent files returns a warning""" - fl = display.FileLink("example.txt") - assert fl._repr_html_().startswith("Path (example.txt)") - - -def test_existing_path_FileLink(): - """FileLink: Calling _repr_html_ functions as expected on existing filepath - """ - tf = NamedTemporaryFile() - fl = display.FileLink(tf.name) - actual = fl._repr_html_() - expected = "%s
" % (tf.name, tf.name) - assert actual == expected - - -def test_existing_path_FileLink_repr(): - """FileLink: Calling repr() functions as expected on existing filepath - """ - tf = NamedTemporaryFile() - fl = display.FileLink(tf.name) - actual = repr(fl) - expected = tf.name - assert actual == expected - - -def test_error_on_directory_to_FileLink(): - """FileLink: Raises error when passed directory - """ - td = mkdtemp() - pytest.raises(ValueError, display.FileLink, td) - -#-------------------------- -# FileLinks tests -#-------------------------- - -def test_instantiation_FileLinks(): - """FileLinks: Test class can be instantiated - """ - fls = display.FileLinks('example') - -def test_warning_on_non_existent_path_FileLinks(): - """FileLinks: Calling _repr_html_ on non-existent files returns a warning""" - fls = display.FileLinks("example") - assert fls._repr_html_().startswith("Path (example)") - - -def test_existing_path_FileLinks(): - """FileLinks: Calling _repr_html_ functions as expected on existing dir - """ - td = mkdtemp() - tf1 = NamedTemporaryFile(dir=td) - tf2 = NamedTemporaryFile(dir=td) - fl = display.FileLinks(td) - actual = fl._repr_html_() - actual = actual.split('\n') - actual.sort() - # the links should always have forward slashes, even on windows, so replace - # backslashes with forward slashes here - expected = ["%s/
" % td, - " %s
" %\ - (tf2.name.replace("\\","/"),split(tf2.name)[1]), - " %s
" %\ - (tf1.name.replace("\\","/"),split(tf1.name)[1])] - expected.sort() - # We compare the sorted list of links here as that's more reliable - assert actual == expected - - -def test_existing_path_FileLinks_alt_formatter(): - """FileLinks: Calling _repr_html_ functions as expected w/ an alt formatter - """ - td = mkdtemp() - tf1 = NamedTemporaryFile(dir=td) - tf2 = NamedTemporaryFile(dir=td) - def fake_formatter(dirname,fnames,included_suffixes): - return ["hello","world"] - fl = display.FileLinks(td,notebook_display_formatter=fake_formatter) - actual = fl._repr_html_() - actual = actual.split('\n') - actual.sort() - expected = ["hello","world"] - expected.sort() - # We compare the sorted list of links here as that's more reliable - assert actual == expected - - -def test_existing_path_FileLinks_repr(): - """FileLinks: Calling repr() functions as expected on existing directory """ - td = mkdtemp() - tf1 = NamedTemporaryFile(dir=td) - tf2 = NamedTemporaryFile(dir=td) - fl = display.FileLinks(td) - actual = repr(fl) - actual = actual.split('\n') - actual.sort() - expected = ['%s/' % td, ' %s' % split(tf1.name)[1],' %s' % split(tf2.name)[1]] - expected.sort() - # We compare the sorted list of links here as that's more reliable - assert actual == expected - - -def test_existing_path_FileLinks_repr_alt_formatter(): - """FileLinks: Calling repr() functions as expected w/ alt formatter - """ - td = mkdtemp() - tf1 = NamedTemporaryFile(dir=td) - tf2 = NamedTemporaryFile(dir=td) - def fake_formatter(dirname,fnames,included_suffixes): - return ["hello","world"] - fl = display.FileLinks(td,terminal_display_formatter=fake_formatter) - actual = repr(fl) - actual = actual.split('\n') - actual.sort() - expected = ["hello","world"] - expected.sort() - # We compare the sorted list of links here as that's more reliable - assert actual == expected - - -def test_error_on_file_to_FileLinks(): - """FileLinks: Raises error when passed file - """ - td = mkdtemp() - tf1 = NamedTemporaryFile(dir=td) - pytest.raises(ValueError, display.FileLinks, tf1.name) - - -def test_recursive_FileLinks(): - """FileLinks: Does not recurse when recursive=False - """ - td = mkdtemp() - tf = NamedTemporaryFile(dir=td) - subtd = mkdtemp(dir=td) - subtf = NamedTemporaryFile(dir=subtd) - fl = display.FileLinks(td) - actual = str(fl) - actual = actual.split('\n') - assert len(actual) == 4, actual - fl = display.FileLinks(td, recursive=False) - actual = str(fl) - actual = actual.split('\n') - assert len(actual) == 2, actual - -def test_audio_from_file(): - path = pjoin(dirname(__file__), 'test.wav') - display.Audio(filename=path) - -class TestAudioDataWithNumpy(TestCase): - - @skipif_not_numpy - def test_audio_from_numpy_array(self): - test_tone = get_test_tone() - audio = display.Audio(test_tone, rate=44100) - assert len(read_wav(audio.data)) == len(test_tone) - - @skipif_not_numpy - def test_audio_from_list(self): - test_tone = get_test_tone() - audio = display.Audio(list(test_tone), rate=44100) - assert len(read_wav(audio.data)) == len(test_tone) - - @skipif_not_numpy - def test_audio_from_numpy_array_without_rate_raises(self): - self.assertRaises(ValueError, display.Audio, get_test_tone()) - - @skipif_not_numpy - def test_audio_data_normalization(self): - expected_max_value = numpy.iinfo(numpy.int16).max - for scale in [1, 0.5, 2]: - audio = display.Audio(get_test_tone(scale), rate=44100) - actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) - assert actual_max_value == expected_max_value - - @skipif_not_numpy - def test_audio_data_without_normalization(self): - max_int16 = numpy.iinfo(numpy.int16).max - for scale in [1, 0.5, 0.2]: - test_tone = get_test_tone(scale) - test_tone_max_abs = numpy.max(numpy.abs(test_tone)) - expected_max_value = int(max_int16 * test_tone_max_abs) - audio = display.Audio(test_tone, rate=44100, normalize=False) - actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) - assert actual_max_value == expected_max_value - - def test_audio_data_without_normalization_raises_for_invalid_data(self): - self.assertRaises( - ValueError, - lambda: display.Audio([1.001], rate=44100, normalize=False)) - self.assertRaises( - ValueError, - lambda: display.Audio([-1.001], rate=44100, normalize=False)) - -def simulate_numpy_not_installed(): - try: - import numpy - return mock.patch('numpy.array', mock.MagicMock(side_effect=ImportError)) - except ModuleNotFoundError: - return lambda x:x - -@simulate_numpy_not_installed() -class TestAudioDataWithoutNumpy(TestAudioDataWithNumpy): - # All tests from `TestAudioDataWithNumpy` are inherited. - - @skipif_not_numpy - def test_audio_raises_for_nested_list(self): - stereo_signal = [list(get_test_tone())] * 2 - self.assertRaises(TypeError, lambda: display.Audio(stereo_signal, rate=44100)) - - -@skipif_not_numpy -def get_test_tone(scale=1): - return numpy.sin(2 * numpy.pi * 440 * numpy.linspace(0, 1, 44100)) * scale - -def read_wav(data): - with wave.open(BytesIO(data)) as wave_file: - wave_data = wave_file.readframes(wave_file.getnframes()) - num_samples = wave_file.getnframes() * wave_file.getnchannels() - return struct.unpack('<%sh' % num_samples, wave_data) - -def test_code_from_file(): - c = display.Code(filename=__file__) - assert c._repr_html_().startswith(' -

In [34]: from scipy.special import jn

In [35]: x = linspace(0,4*pi)

In [36]: for i in range(6):

...: plot(x,jn(i,x))

In [37]: 1/0

---------------------------------------------------------------------------

ZeroDivisionError Traceback (most recent call last)

/Users/minrk/<ipython-input-37-05c9758a9c21> in <module>()

----> 1 1/0

ZeroDivisionError: integer division or modulo by zero

In [38]:

\ No newline at end of file diff --git a/docs/source/interactive/figs/jn.xhtml b/docs/source/interactive/figs/jn.xhtml deleted file mode 100644 index f802a0a2a58..00000000000 --- a/docs/source/interactive/figs/jn.xhtml +++ /dev/null @@ -1,375 +0,0 @@ - - - - -

Python 2.6.1 (r261:67515, Feb 11 2010, 00:51:29)

Type "copyright", "credits" or "license" for more information.

IPython 0.11.alpha1.git -- An enhanced Interactive Python.

? -> Introduction and overview of IPython's features.

%quickref -> Quick reference.

help -> Python's own help system.

object? -> Details about 'object', use 'object??' for extra details.

%guiref -> A brief reference about the graphical user interface.

In [1]: from scipy.special import jn

In [2]: x = linspace(0,4*pi)

In [3]: for n in range(6):

...: plot(x,jn(n,x))

...:

In [4]:

\ No newline at end of file diff --git a/docs/source/interactive/index.rst b/docs/source/interactive/index.rst index 6684eb51bfb..586209136d4 100644 --- a/docs/source/interactive/index.rst +++ b/docs/source/interactive/index.rst @@ -8,7 +8,7 @@ tutorial, though some sections might make slightly more sense if you have alread done some work in the classic Python REPL. .. note:: - + Some part of this documentation are more than a decade old so might be out of date, we welcome any report of inaccuracy, and Pull Requests that make that up to date. diff --git a/docs/source/interactive/magics.rst b/docs/source/interactive/magics.rst index b61bcdc7f85..6efa02fca8c 100644 --- a/docs/source/interactive/magics.rst +++ b/docs/source/interactive/magics.rst @@ -13,11 +13,11 @@ Built-in magic commands other languages. Here is the help auto-generated from the docstrings of all the available Magics -functions that IPython ships with. +functions that IPython ships with. You can create and register your own Magics with IPython. You can find many user -defined Magics on `PyPI `_. Feel free to publish your own and -use the ``Framework :: IPython`` trove classifier. +defined Magics on `PyPI `_. Feel free to publish your own and +use the ``Framework :: IPython`` trove classifier. .. include:: magics-generated.txt diff --git a/docs/source/interactive/plotting.rst b/docs/source/interactive/plotting.rst index f473bd00160..e53791a1752 100644 --- a/docs/source/interactive/plotting.rst +++ b/docs/source/interactive/plotting.rst @@ -8,60 +8,68 @@ show rich output. This means that object that can be representing as image, sounds, animation, (etc...) can be shown this way if the frontend support it. In order for this to be possible, you need to use the ``display()`` function, -that should be available by default on IPython 5.4+ and 6.1+, or that you can -import with ``from IPython.display import display``. Then use ``display()`` instead of ``print()``, and if possible your object will be displayed -with a richer representation. In the terminal of course, there won't be much -difference as object are most of the time represented by text, but in notebook -and similar interface you will get richer outputs. +which you can import with ``from IPython.display import display``. Then use +``display()`` instead of ``print()``, and if possible your object +will be displayed with a richer representation. In the terminal of course, there +won't be much difference as objects are most of the time represented by text, +but in notebook and similar interface you will get richer outputs. +.. _matplotlib_magic: + Plotting -------- .. note:: - Starting with IPython 5.0 and matplotlib 2.0 you can avoid the use of - IPython's specific magic and use + You can avoid the use of IPython's specific magic and use ``matplotlib.pyplot.ion()``/``matplotlib.pyplot.ioff()`` which have the advantages of working outside of IPython as well. -One major feature of the IPython kernel is the ability to display plots that -are the output of running code cells. The IPython kernel is designed to work +One major feature of the IPython kernel is the ability to display plots that +are the output of running code cells. The IPython kernel is designed to work seamlessly with the matplotlib_ plotting library to provide this functionality. To set this up, before any plotting or import of matplotlib is performed you -must execute the ``%matplotlib`` :ref:`magic command `. This +may execute the ``%matplotlib`` :ref:`magic command `. This performs the necessary behind-the-scenes setup for IPython to work correctly hand in hand with ``matplotlib``; it does *not*, however, actually execute any Python ``import`` commands, that is, no names are added to the namespace. -If the ``%matplotlib`` magic is called without an argument, the -output of a plotting command is displayed using the default ``matplotlib`` -backend in a separate window. Alternatively, the backend can be explicitly -requested using, for example:: - - %matplotlib gtk +If you do not use the ``%matplotlib`` magic or you call it without an argument, +the output of a plotting command is displayed using the default ``matplotlib`` +backend, which may be different depending on Operating System and whether +running within Jupyter or not. -A particularly interesting backend, provided by IPython, is the ``inline`` -backend. This is available only for the Jupyter Notebook and the -Jupyter QtConsole. It can be invoked as follows:: +Alternatively, the backend can be explicitly requested using, for example:: - %matplotlib inline + %matplotlib qt -With this backend, the output of plotting commands is displayed *inline* within -frontends like the Jupyter notebook, directly below the code cell that produced -it. The resulting plots will then also be stored in the notebook document. +The argument passed to the ``%matplotlib`` magic command may be the name of any +backend understood by ``matplotlib`` or it may the name of a GUI loop such as +``qt`` or ``osx``, in which case an appropriate backend supporting that GUI +loop will be selected. To obtain a full list of all backends and GUI loops +understood by ``matplotlib`` use ``%matplotlib --list``. -.. seealso:: +There are some specific backends that are used in the Jupyter ecosystem: - `Plotting with Matplotlib`_ example notebook +- The ``inline`` backend is provided by IPython and can be used in Jupyter Lab, + Notebook and QtConsole; it is the default backend when using Jupyter. The + outputs of plotting commands are displayed *inline* within frontends like + Jupyter Notebook, directly below the code cells that produced them. + The resulting plots will then also be stored in the notebook document. +- The ``notebook`` or ``nbagg`` backend is built into ``matplotlib`` and can be + used with Jupyter ``notebook <7`` and ``nbclassic``. Plots are interactive so + they can be zoomed and panned. -The matplotlib_ library also ships with ``%matplotlib notebook`` command that -allows interactive figures if your environment allows it. +- The ``ipympl`` or ``widget`` backend is for use with Jupyter ``lab`` and + ``notebook >=7``. It is in a separate ``ipympl`` module that must be + installed using ``pip`` or ``conda`` in the usual manner. Plots are + interactive so they can be zoomed and panned. -See the matplotlib_ documentation for more information. +See the matplotlib_ documentation for more information, in particular the +section on backends. .. include:: ../links.txt diff --git a/docs/source/interactive/python-ipython-diff.rst b/docs/source/interactive/python-ipython-diff.rst index 564c1c5ab88..0265f2f34c1 100644 --- a/docs/source/interactive/python-ipython-diff.rst +++ b/docs/source/interactive/python-ipython-diff.rst @@ -152,13 +152,7 @@ This allows to execute simple commands when present in beginning of the line: In[1]: !pwd /User/home/ -Change directory: - -.. code-block:: ipython - - In[1]: !cd /var/etc - -Or edit file: +Edit file: .. code-block:: ipython @@ -198,6 +192,10 @@ You can combine the different possibilities in for loops, conditions, functions. !cp $file {file.split('.')[0] + '.bak'} +Each ``!`` gets executed in a separate shell, so changing directory by ``!cd`` or env vars ``!export FOO=bar`` will have no effect. +Use instead the built-in magics ``%cd DIR/`` (there are also ``%pushd DIR/``, ``%dirs``, ``%popd``) and ``%env FOO=bar``. + + Magics ------ @@ -218,10 +216,10 @@ Magics support assignment: .. code-block:: ipython In [1]: results = %timeit -r1 -n1 -o list(range(1000)) - 1 loops, best of 1: 21.1 µs per loop + 62.1 µs ± 0 ns per loop (mean ± std. dev. of 1 run, 1 loop each) In [2]: results - Out[2]: + Magics with double percent signs (``%%``) can spread over multiple lines, but they do not support assignments: diff --git a/docs/source/interactive/reference.rst b/docs/source/interactive/reference.rst index 8eed5348fd3..42baab42317 100644 --- a/docs/source/interactive/reference.rst +++ b/docs/source/interactive/reference.rst @@ -23,8 +23,8 @@ will only execute one file and ignore your configuration setup. Please note that some of the configuration options are not available at the command line, simply because they are not practical here. Look into your configuration files for details on those. There are separate configuration files -for each profile, and the files look like :file:`ipython_config.py` or -:file:`ipython_config_{frontendname}.py`. Profile directories look like +for each profile, and the files look like :file:`ipython_config.py` (or +:file:`ipython_kernel_config.py` for the kernel). Profile directories look like :file:`profile_{profilename}` and are typically installed in the :envvar:`IPYTHONDIR` directory, which defaults to :file:`$HOME/.ipython`. For Windows users, :envvar:`HOME` resolves to :file:`C:\\Users\\{YourUserName}` in @@ -44,7 +44,7 @@ the command-line by passing the full class name and a corresponding value; type <...snip...> --matplotlib= (InteractiveShellApp.matplotlib) Default: None - Choices: ['auto', 'gtk', 'gtk3', 'gtk4', 'inline', 'nbagg', 'notebook', 'osx', 'qt', 'qt4', 'qt5', 'tk', 'wx'] + Choices: ['auto', 'gtk3', 'gtk4', 'inline', 'nbagg', 'notebook', 'osx', 'qt', 'qt5', 'qt6', 'tk', 'wx'] Configure matplotlib for interactive use with the default matplotlib backend. <...snip...> @@ -117,7 +117,7 @@ The following uses the builtin :magic:`timeit` in cell mode:: ...: min(x) ...: max(x) ...: - 1000 loops, best of 3: 438 us per loop + 518 µs ± 4.39 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each) In this case, ``x = range(10000)`` is called as the line argument, and the block with ``min(x)`` and ``max(x)`` is called as the cell body. The @@ -345,8 +345,8 @@ exclamation marks (``!!ls``) or the :magic:`sx` magic command without an assignm The captured list in this example has some convenience features. ``myfiles.n`` or ``myfiles.s`` returns a string delimited by newlines or spaces, respectively. ``myfiles.p`` -produces `path objects `_ from the list items. -See :ref:`string_lists` for details. +produces :class:`pathlib.Path` objects for the list items which exist on the +filesystem. See :ref:`string_lists` for details. IPython also allows you to expand the value of python variables when making system calls. Wrap variables or expressions in {braces}:: @@ -422,7 +422,7 @@ to parse visually. See the magic :magic:`xmode` and :magic:`colors` functions for details. These features are basically a terminal version of Ka-Ping Yee's cgitb -module, now part of the standard Python library. +module, formerly part of the standard Python library. .. _input_caching: @@ -552,7 +552,10 @@ but this will work:: In [5]: /zip (1,2,3),(4,5,6) ------> zip ((1,2,3),(4,5,6)) - Out[5]: [(1, 4), (2, 5), (3, 6)] + Out[5]: + + In [6]: list(_) + Out[6]: [(1, 4), (2, 5), (3, 6)] IPython tells you that it has altered your command line by displaying the new command line preceded by ``--->``. @@ -623,13 +626,13 @@ code snippet:: a = 42 IPython.embed() -and within the IPython shell, you reassign `a` to `23` to do further testing of +and within the IPython shell, you reassign `a` to `23` to do further testing of some sort, you can then exit:: >>> IPython.embed() - Python 3.6.2 (default, Jul 17 2017, 16:44:45) + Python 3.12.0 (default, Oct 10 2023, 12:00:00) Type 'copyright', 'credits' or 'license' for more information - IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help. + IPython 9.0.0 -- An enhanced Interactive Python. Type '?' for help. In [1]: a = 23 @@ -641,9 +644,9 @@ Once you exit and print `a`, the value 23 will be shown:: In: print(a) 23 -It's important to note that the code run in the embedded IPython shell will -*not* change the state of your code and variables, **unless** the shell is -contained within the global namespace. In the above example, `a` is changed +It's important to note that the code run in the embedded IPython shell will +*not* change the state of your code and variables, **unless** the shell is +contained within the global namespace. In the above example, `a` is changed because this is true. To further exemplify this, consider the following example:: @@ -657,7 +660,7 @@ To further exemplify this, consider the following example:: Now if call the function and complete the state changes as we did above, the value `42` will be printed. Again, this is because it's not in the global -namespace:: +namespace:: do() @@ -665,9 +668,9 @@ Running a file with the above code can lead to the following session:: >>> do() 42 - Python 3.6.2 (default, Jul 17 2017, 16:44:45) + Python 3.12.0 (default, Oct 10 2023, 12:00:00) Type 'copyright', 'credits' or 'license' for more information - IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help. + IPython 9.0.0 -- An enhanced Interactive Python. Type '?' for help. In [1]: a = 23 @@ -700,9 +703,14 @@ your Python programs for this to work (detailed examples follow later):: embed() # this call anywhere in your program will start IPython -You can also embed an IPython *kernel*, for use with qtconsole, etc. via -``IPython.embed_kernel()``. This should work the same way, but you can -connect an external frontend (``ipython qtconsole`` or ``ipython console``), +You can also embed an IPython *kernel*, for use with qtconsole, etc. via:: + + from ipykernel.embed import embed_kernel + + embed_kernel() + +This should work the same way, but you can connect an external frontend +(``jupyter qtconsole`` or ``jupyter console``), rather than interacting with it in the terminal. You can run embedded instances even in code which is itself being run at @@ -717,7 +725,7 @@ them separately, for example with different options for data presentation. If you close and open the same instance multiple times, its prompt counters simply continue from each execution to the next. -Please look at the docstrings in the :mod:`~IPython.frontend.terminal.embed` +Please look at the docstrings in the :mod:`~IPython.terminal.embed` module for more details on the use of this system. The following sample file illustrating how to use the embedding @@ -815,6 +823,65 @@ And less context on shallower Stack Trace: (5)foo() ----> 5 return 1/x+foo(x-1) +Module Ignoring Commands +------------------------ + +IPython's debugger provides commands to ignore specific modules when navigating +through stack frames. This is particularly useful when debugging applications +that use frameworks or libraries where you want to skip over their internal +code and focus on your application logic. + +The module ignoring system supports wildcard patterns using Python's ``fnmatch`` +syntax, allowing you to ignore groups of related modules with a single pattern. + +ignore_module +++++++++++++++++++++++++++++ + +Add a module to the list of modules to skip when navigating frames. When a module +is ignored, the debugger will automatically skip over frames from that module when +using the ``next``, ``step``, ``continue``, ``up`` and ``down`` commands. + +**Usage:** + +.. code:: + + ipdb> ignore_module threading + ipdb> ignore_module __main__ + ipdb> ignore_module asyncio.* # Ignore all asyncio submodules + ipdb> ignore_module *.tests # Ignore all test modules + ipdb> ignore_module django.* # Ignore all django modules + ipdb> ignore_module # List currently ignored modules + Currently ignored modules: ['__main__', 'asyncio.*', 'django.*', 'threading'] + +**Wildcard Pattern Examples:** + +- ``asyncio.*`` - Matches ``asyncio.tasks``, ``asyncio.events``, etc. +- ``*.tests`` - Matches ``myapp.tests``, ``utils.tests``, etc. +- ``test_*`` - Matches ``test_models``, ``test_views``, etc. +- ``django.*`` - Matches all Django framework modules +- ``*pytest*`` - Matches any module containing "pytest" + +**Common use cases:** + +- Ignore framework code (e.g., ``django.*``, ``flask.*``, ``asyncio.*``) +- Skip standard library modules (e.g., ``threading``, ``multiprocessing``, ``logging.*``) +- Hide main module frames (``__main__``) to focus on function implementations +- Skip test framework internals (``*pytest*``, ``unittest.*``) + +unignore_module ++++++++++++++++++++++++++++++ + +Remove a module from the list of modules to skip when navigating frames. This +allows the debugger to step into frames from the specified module again. + +**Usage:** + +.. code:: + + ipdb> unignore_module threading + ipdb> unignore_module asyncio.* # Remove the pattern + ipdb> unignore_module # List currently ignored modules + Currently ignored modules: ['__main__'] Post-mortem debugging --------------------- @@ -837,12 +904,13 @@ put the following lines toward the top of your 'main' routine:: import sys from IPython.core import ultratb sys.excepthook = ultratb.FormattedTB(mode='Verbose', - color_scheme='Linux', call_pdb=1) + theme_name='linux', call_pdb=1) -The mode keyword can be either 'Verbose' or 'Plain', giving either very -detailed or normal tracebacks respectively. The color_scheme keyword can -be one of 'NoColor', 'Linux' (default) or 'LightBG'. These are the same -options which can be set in IPython with ``--colors`` and ``--xmode``. +The mode keyword can be 'Plain', 'Context', 'Verbose' or 'Minimal', giving +increasingly detailed tracebacks. The theme_name keyword can be the name of +any IPython theme, e.g. 'nocolor', 'linux' (default), 'lightbg' or 'neutral'. +These are the same options which can be set in IPython with ``--theme`` and +the :magic:`xmode` magic. This will give any of your programs detailed, colored tracebacks with automatic invocation of pdb. @@ -892,7 +960,7 @@ GUI event loop support ====================== IPython has excellent support for working interactively with Graphical User -Interface (GUI) toolkits, such as wxPython, PyQt4/PySide, PyGTK and Tk. This is +Interface (GUI) toolkits, such as wxPython, PyQt/PySide, PyGTK and Tk. This is implemented by running the toolkit's event loop while IPython is waiting for input. @@ -902,7 +970,7 @@ For users, enabling GUI event loop integration is simple. You simple use the %gui [GUINAME] With no arguments, ``%gui`` removes all GUI support. Valid ``GUINAME`` -arguments include ``wx``, ``qt``, ``qt5``, ``gtk``, ``gtk3`` ``gtk4``, and +arguments include ``wx``, ``qt``, ``qt5``, ``qt6``, ``gtk3`` ``gtk4``, and ``tk``. Thus, to use wxPython interactively and create a running :class:`wx.App` @@ -936,37 +1004,13 @@ PyQt and PySide .. attempt at explanation of the complete mess that is Qt support When you use ``--gui=qt`` or ``--matplotlib=qt``, IPython can work with either -PyQt4 or PySide. There are three options for configuration here, because -PyQt4 has two APIs for QString and QVariant: v1, which is the default on -Python 2, and the more natural v2, which is the only API supported by PySide. -v2 is also the default for PyQt4 on Python 3. IPython's code for the QtConsole -uses v2, but you can still use any interface in your code, since the -Qt frontend is in a different process. - -The default will be to import PyQt4 without configuration of the APIs, thus -matching what most applications would expect. It will fall back to PySide if -PyQt4 is unavailable. - -If specified, IPython will respect the environment variable ``QT_API`` used -by ETS. ETS 4.0 also works with both PyQt4 and PySide, but it requires -PyQt4 to use its v2 API. So if ``QT_API=pyside`` PySide will be used, -and if ``QT_API=pyqt`` then PyQt4 will be used *with the v2 API* for -QString and QVariant, so ETS codes like MayaVi will also work with IPython. - -If you launch IPython in matplotlib mode with ``ipython --matplotlib=qt``, -then IPython will ask matplotlib which Qt library to use (only if QT_API is -*not set*), via the 'backend.qt4' rcParam. If matplotlib is version 1.0.1 or -older, then IPython will always use PyQt4 without setting the v2 APIs, since -neither v2 PyQt nor PySide work. +PyQt or PySide. ``qt`` implies "use the latest version available", and it favors +PyQt over PySide. To request a specific version, use ``qt5`` or ``qt6``. -.. warning:: - - Note that this means for ETS 4 to work with PyQt4, ``QT_API`` *must* be set - to work with IPython's qt integration, because otherwise PyQt4 will be - loaded in an incompatible mode. - - It also means that you must *not* have ``QT_API`` set if you want to - use ``--gui=qt`` with code that requires PyQt4 API v1. +If specified, IPython will respect the environment variable ``QT_API``. If +``QT_API`` is not specified and you launch IPython in matplotlib mode with +``ipython --matplotlib=qt`` then IPython will ask matplotlib which Qt library +to use. See the matplotlib_ documentation on ``QT_API`` for further details. .. _matplotlib_support: @@ -976,19 +1020,16 @@ Plotting with matplotlib matplotlib_ provides high quality 2D and 3D plotting for Python. matplotlib_ can produce plots on screen using a variety of GUI toolkits, including Tk, -PyGTK, PyQt4 and wxPython. It also provides a number of commands useful for +PyGTK, PyQt6 and wxPython. It also provides a number of commands useful for scientific computing, all with a syntax compatible with that of the popular Matlab program. To start IPython with matplotlib support, use the ``--matplotlib`` switch. If IPython is already running, you can run the :magic:`matplotlib` magic. If no arguments are given, IPython will automatically detect your choice of -matplotlib backend. You can also request a specific backend with -``%matplotlib backend``, where ``backend`` must be one of: 'tk', 'qt', 'wx', -'gtk', 'osx'. In the web notebook and Qt console, 'inline' is also a valid -backend value, which produces static figures inlined inside the application -window instead of matplotlib's interactive figures that live in separate -windows. +matplotlib backend. For information on matplotlib backends see +:ref:`matplotlib_magic`. + .. _interactive_demos: diff --git a/docs/source/interactive/shell.rst b/docs/source/interactive/shell.rst index 0ea125cb9ef..eaa5d690677 100644 --- a/docs/source/interactive/shell.rst +++ b/docs/source/interactive/shell.rst @@ -1,10 +1,10 @@ -.. _ipython_as_shell: .. note:: This page has been kept for historical reason. You most likely want to use `Xonsh `__ instead of this. +.. _ipython_as_shell: ========================= IPython as a system shell @@ -81,7 +81,7 @@ See :ref:`custom_prompts`. String lists ============ -String lists (IPython.utils.text.SList) are handy way to process output +String lists (:any:`IPython.utils.text.SList`) are handy way to process output from system commands. They are produced by ``var = !cmd`` syntax. First, we acquire the output of 'ls -l':: @@ -199,7 +199,7 @@ Now we can just remove these files by doing 'rm $junk.s'. The .n, .s, .p properties ------------------------- -Properties of `SList `_ wrapper +Properties of :py:class:`SList ` wrapper provide a convenient ways to use contained text in different formats: * ``.n`` returns (original) string with lines separated by a newline @@ -211,4 +211,3 @@ provide a convenient ways to use contained text in different formats: You went too far scroll back up. You most likely want to use `Xonsh `__ instead of this. - diff --git a/docs/source/interactive/tips.rst b/docs/source/interactive/tips.rst index 33436cea24b..d35e21e53c0 100644 --- a/docs/source/interactive/tips.rst +++ b/docs/source/interactive/tips.rst @@ -5,10 +5,8 @@ IPython Tips & Tricks ===================== The `IPython cookbook -`_ details more things -you can do with IPython. - -.. This is not in the current version: +`_ details more +things you can do with IPython. Embed IPython in your programs @@ -99,4 +97,3 @@ Continuing with the example above, this should illustrate this idea:: This section was written after a contribution by Alexander Belchenko on the IPython user list. - diff --git a/docs/source/interactive/tutorial.rst b/docs/source/interactive/tutorial.rst index 947d6ad4905..1f87cdbdabf 100644 --- a/docs/source/interactive/tutorial.rst +++ b/docs/source/interactive/tutorial.rst @@ -12,16 +12,15 @@ information, check the :ref:`tips page `, or look at examples in the If you haven't done that yet see :ref:`how to install ipython `. -If you've never used Python before, you might want to look at `the official -tutorial `_ or an alternative, `Dive into -Python `_. +If you've never used Python before, you might want to look at the official +:external+python:doc:`Python tutorial `. Start IPython by issuing the ``ipython`` command from your shell, you should be greeted by the following:: - Python 3.6.0 + Python 3.12.0 Type 'copyright', 'credits' or 'license' for more information - IPython 6.0.0.dev -- An enhanced Interactive Python. Type '?' for help. + IPython 9.0.0 -- An enhanced Interactive Python. Type '?' for help. In [1]: @@ -67,8 +66,8 @@ the position of the cursor by using :kbd:`Ctrl-o`. The four most helpful commands ============================== -The four most helpful commands, as well as their brief description, is shown -to you in a banner, every time you start IPython: +Four commands are especially helpful; the banner shown every time you start +IPython points you to the first one (``?``): ========== ========================================================= command description @@ -87,11 +86,11 @@ structure of any object you're dealing with. Simply type ``object_name.`` to view the object's attributes. Besides Python objects and keywords, tab completion also works on file and directory names. -Starting with IPython 6.0, if ``jedi`` is installed, IPython will try to pull -completions from Jedi as well. This allows to not only inspect currently -existing objects, but also to infer completion statically without executing -code. There is nothing particular needed to get this to work, simply use tab -completion on more complex expressions like the following:: +IPython also pulls completions from ``jedi`` (installed as one of its +dependencies). This allows to not only inspect currently existing objects, but also to +infer completion statically without executing code. There is nothing particular +needed to get this to work, simply use tab completion on more complex +expressions like the following:: >>> data = ['Number of users', 123456] ... data[0]. @@ -120,25 +119,25 @@ IPython has a set of predefined 'magic functions' that you can call with a command line style syntax. There are two kinds of magics, line-oriented and cell-oriented. **Line magics** are prefixed with the ``%`` character and work much like OS command-line calls: they get as an argument the rest of the line, -where arguments are passed without parentheses or quotes. **Lines magics** can +where arguments are passed without parentheses or quotes. **Line magics** can return results and can be used in the right hand side of an assignment. **Cell magics** are prefixed with a double ``%%``, and they are functions that get as an argument not only the rest of the line, but also the lines below it in a separate argument. Magics are useful as convenient functions where Python syntax is not the most -natural one, or when one want to embed invalid python syntax in their work flow. +natural one, or when one want to embed invalid python syntax in their work flow. The following examples show how to call the built-in :magic:`timeit` magic, both in line and cell mode:: In [1]: %timeit range(1000) - 100000 loops, best of 3: 7.76 us per loop + 179 ns ± 2.66 ns per loop (mean ± std. dev. of 7 runs, 10000000 loops each) In [2]: %%timeit x = range(10000) ...: max(x) - ...: - 1000 loops, best of 3: 223 us per loop + ...: + 264 µs ± 1 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each) The built-in magics include: @@ -171,8 +170,6 @@ read its docstring. To see all the available magic functions, call the magics works and how to define your own, and :doc:`magics` for a list of built-in magics. - `Cell magics`_ example notebook - Running and Editing ------------------- @@ -221,12 +218,12 @@ You can use the ``%history`` magic function to examine past input and output. Input history from previous sessions is saved in a database, and IPython can be configured to save output history. -Several other magic functions can use your input history, including ``%edit``, +Several other magic functions can use your input history, including ``%edit``, ``%rerun``, ``%recall``, ``%macro``, ``%save`` and ``%pastebin``. You can use a standard format to refer to lines:: %pastebin 3 18-20 ~1/1-5 - + This will take line 3 and lines 18 to 20 from the current session, and lines 1-5 from the previous session. @@ -236,7 +233,7 @@ System shell commands To run any command at the system shell, simply prefix it with ``!``, e.g.:: !ping www.bbc.co.uk - + You can capture the output into a Python list, e.g.: ``files = !ls``. To pass the values of Python variables or expressions to system commands, prefix them with $: ``!grep -rF $pattern ipython/*`` or wrap in `{braces}`. See :ref:`our diff --git a/docs/source/links.txt b/docs/source/links.txt index 642389cbf09..bdcf66e4ecb 100644 --- a/docs/source/links.txt +++ b/docs/source/links.txt @@ -2,14 +2,14 @@ and name substitutions. It may be included in many files, therefore it should only contain link targets and name substitutions. Try grepping for "^\.\. _" to find plausible - candidates for this list. + candidates for this list. NOTE: this file must have an extension *opposite* to that of the main reST files in the manuals, so that we can include it with ".. include::" directives, but without triggering warnings from Sphinx for not being listed in any toctree. Since IPython uses .txt for the main files, this one will use .rst. - + NOTE: reST targets are __not_case_sensitive__, so only one target definition is needed for ipython, IPython, etc. @@ -18,80 +18,50 @@ .. Main IPython links .. _ipython: https://ipython.org -.. _`ipython manual`: https://ipython.org/documentation.html -.. _ipython_github: http://github.com/ipython/ipython/ -.. _nbviewer: http://nbviewer.ipython.org +.. _ipython_github: https://github.com/ipython/ipython/ +.. _nbviewer: https://nbviewer.org -.. _ZeroMQ: http://zeromq.org +.. _ZeroMQ: https://zeromq.org .. Documentation tools and related links -.. _graphviz: http://www.graphviz.org -.. _Sphinx: http://sphinx.pocoo.org -.. _`Sphinx reST`: http://sphinx.pocoo.org/rest.html -.. _sampledoc: http://matplotlib.org/sampledoc -.. _reST: http://docutils.sourceforge.net/rst.html -.. _docutils: http://docutils.sourceforge.net -.. _lyx: http://www.lyx.org +.. _graphviz: https://www.graphviz.org +.. _Sphinx: https://www.sphinx-doc.org +.. _`Sphinx reST`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _sampledoc: https://matplotlib.org/sampledoc +.. _reST: https://docutils.sourceforge.io/rst.html +.. _docutils: https://docutils.sourceforge.io +.. _lyx: https://www.lyx.org .. _pep8: https://peps.python.org/pep-0008/ .. Licenses -.. _GPL: http://www.gnu.org/licenses/gpl.html -.. _BSD: http://www.opensource.org/licenses/bsd-license.php -.. _LGPL: http://www.gnu.org/copyleft/lesser.html +.. _GPL: https://www.gnu.org/licenses/gpl.html +.. _BSD: https://opensource.org/licenses/BSD-3-Clause +.. _LGPL: https://www.gnu.org/copyleft/lesser.html .. Other python projects -.. _numpy: http://numpy.scipy.org -.. _scipy: http://www.scipy.org -.. _scipy_conference: http://conference.scipy.org -.. _matplotlib: http://matplotlib.org -.. _pythonxy: https://code.google.com/p/pythonxy/ -.. _ETS: http://code.enthought.com/projects/tool-suite.php -.. _EPD: http://www.enthought.com/products/epd.php -.. _python: http://www.python.org -.. _mayavi: http://code.enthought.com/projects/mayavi -.. _sympy: http://code.google.com/p/sympy -.. _sage: http://sagemath.org -.. _pydy: http://code.google.com/p/pydy -.. _vpython: http://vpython.org -.. _cython: http://cython.org -.. _software carpentry: http://software-carpentry.org +.. _numpy: https://numpy.org +.. _scipy: https://www.scipy.org +.. _scipy_conference: https://conference.scipy.org +.. _matplotlib: https://matplotlib.org +.. _python: https://www.python.org +.. _mayavi: https://docs.enthought.com/mayavi/mayavi/ +.. _sympy: https://www.sympy.org +.. _sage: https://www.sagemath.org +.. _pydy: https://www.pydy.org +.. _vpython: https://vpython.org +.. _cython: https://cython.org +.. _software carpentry: https://software-carpentry.org .. Not so python scientific computing tools -.. _matlab: http://www.mathworks.com -.. _VTK: http://vtk.org +.. _matlab: https://www.mathworks.com +.. _VTK: https://vtk.org .. Other organizations -.. _enthought: http://www.enthought.com -.. _kitware: http://www.kitware.com -.. _netlib: http://netlib.org +.. _enthought: https://www.enthought.com +.. _kitware: https://www.kitware.com +.. _netlib: https://netlib.org .. Other tools and projects -.. _indefero: http://www.indefero.net -.. _git: http://git-scm.com -.. _github: http://github.com -.. _Markdown: http://daringfireball.net/projects/markdown/syntax - -.. _Running Code in the IPython Notebook: notebook_p1_ -.. _notebook_p1: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%25201%2520-%2520Running%2520Code.ipynb - -.. _Basic Output: notebook_p2_ -.. _notebook_p2: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%202%20-%20Basic%20Output.ipynb - -.. _Plotting with Matplotlib: notebook_p3_ -.. _notebook_p3: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%203%20-%20Plotting%20with%20Matplotlib.ipynb - -.. _Markdown Cells: notebook_p4_ -.. _notebook_p4: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%204%20-%20Markdown%20Cells.ipynb - -.. _Rich Display System: notebook_p5_ -.. _notebook_p5: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Part%205%20-%20Rich%20Display%20System.ipynb - -.. _notebook_custom_display: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Custom%20Display%20Logic.ipynb - -.. _Frontend/Kernel Model: notebook_two_proc_ -.. _notebook_two_proc: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Frontend-Kernel%20Model.ipynb - -.. _Cell magics: notebook_cell_magics_ -.. _notebook_cell_magics: http://nbviewer.ipython.org/urls/raw.github.com/ipython/ipython/1.x/examples/notebooks/Cell%20Magics.ipynb - - +.. _git: https://git-scm.com +.. _github: https://github.com +.. _Markdown: https://daringfireball.net/projects/markdown/syntax diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 2c5920e35e9..73901a2b7bb 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -38,19 +38,19 @@ amongst others: tries to be a very efficient environment both for Python code development and for exploration of problems using Python objects (in situations like data analysis). - + 2. Serve as an embeddable, ready to use interpreter for your own programs. An interactive IPython shell can be started with a single call from inside another program, providing access to the current namespace. This can be very useful both for debugging purposes and for situations where a blend of batch-processing and interactive exploration are needed. - + 3. Offer a flexible framework which can be used as the base environment for working with other systems, with Python as the underlying bridge language. Specifically scientific environments like Mathematica, IDL and Matlab inspired its design, but similar ideas can be useful in many fields. - + 4. Allow interactive testing of threaded graphical toolkits. IPython has support for interactive, non-blocking control of GTK, Qt, WX, GLUT, and OS X applications via special threading flags. The normal Python @@ -63,7 +63,7 @@ Main features of the interactive shell definition prototypes, source code, source files and other details of any object accessible to the interpreter with a single keystroke (:samp:`?`, and using :samp:`??` provides additional detail). - + * Searching through modules and namespaces with :samp:`*` wildcards, both when using the :samp:`?` system and via the :samp:`%psearch` command. @@ -85,7 +85,7 @@ Main features of the interactive shell * Alias facility for defining your own system aliases. * Complete system shell access. Lines starting with :samp:`!` are passed - directly to the system shell, and using :samp:`!!` or :samp:`var = !cmd` + directly to the system shell, and using :samp:`!!` or :samp:`var = !cmd` captures shell output into python variables for further use. * The ability to expand python variables when calling the system shell. In a @@ -167,21 +167,20 @@ Main features of the interactive shell * Simple timing information. You can use the :samp:`%timeit` command to get the execution time of a Python statement or expression. This machinery is intelligent enough to do more repetitions for commands that finish very - quickly in order to get a better estimate of their running time. + quickly in order to get a better estimate of their running time. -.. sourcecode:: ipython + .. sourcecode:: ipython In [1]: %timeit 1+1 - 10000000 loops, best of 3: 25.5 ns per loop + 7.88 ns ± 0.0494 ns per loop (mean ± std. dev. of 7 runs, 100000000 loops each) In [2]: %timeit [math.sin(x) for x in range(5000)] - 1000 loops, best of 3: 719 µs per loop + 608 µs ± 5.57 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each) -.. + .. To get the timing information for more than one expression, use the :samp:`%%timeit` cell magic command. - * Doctest support. The special :samp:`%doctest_mode` command toggles a mode to use doctest-compatible prompts, so you can use IPython sessions as @@ -218,17 +217,12 @@ which will be something like ``--existing kernel-19732.json`` but with different numbers which correspond to the Process ID of the kernel. You can read more about using `jupyter qtconsole -`_, and +`_, and `jupyter notebook `_. There is also a :ref:`message spec ` which documents the protocol for communication between kernels and clients. -.. seealso:: - - `Frontend/Kernel Model`_ example notebook - - Interactive parallel computing ============================== @@ -239,18 +233,14 @@ This functionality is optional and now part of the `ipyparallel Portability and Python requirements ----------------------------------- -Version 7.0+ supports Python 3.4 and higher. -Versions 6.x support Python 3.3 and higher. -Versions 2.0 to 5.x work with Python 2.7.x releases and Python 3.3 and higher. -Version 1.0 additionally worked with Python 2.6 and 3.2. -Version 0.12 was the first version to fully support Python 3. +IPython requires Python 3.11 or newer. IPython is known to work on the following operating systems: * Linux - * Most other Unix-like OSs (AIX, Solaris, BSD, etc.) - * Mac OS X - * Windows (CygWin, XP, Vista, etc.) + * macOS + * Windows + * Most other Unix-like OSs (BSD, Solaris, etc.) See :ref:`here ` for instructions on how to install IPython. diff --git a/docs/source/sphinx.toml b/docs/source/sphinx.toml new file mode 100644 index 00000000000..b9f2b3edd62 --- /dev/null +++ b/docs/source/sphinx.toml @@ -0,0 +1,41 @@ +[sphinx] +templates_path = ["_templates"] +master_doc = "index" +project = "IPython" +copyright = "The IPython Development Team" +github_project_url = "https://github.com/ipython/ipython" +exclude_patterns = ["**.ipynb_checkpoints"] +pygments_style = "sphinx" +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.doctest", + "sphinx.ext.inheritance_diagram", + "sphinx.ext.intersphinx", + "sphinx.ext.graphviz", + "sphinx.ext.extlinks", # for easy GitHub links + "sphinxcontrib.jquery", + "IPython.sphinxext.ipython_console_highlighting", + "IPython.sphinxext.ipython_directive", + "sphinx.ext.napoleon", # to preprocess docstrings + "magics", + "configtraits", +] +default_role = "literal" +modindex_common_prefix = ["IPython."] + +[sphinx.source_suffix] +".rst" = "restructuredtext" + +[html] +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] +html_favicon = "_static/favicon.ico" +html_last_updated_fmt = "%b %d, %Y" +htmlhelp_basename = "ipythondoc" +html_additional_pages = [ + ["interactive/htmlnotebook", "notebook_redirect.html"], + ["interactive/notebook", "notebook_redirect.html"], + ["interactive/nbconvert", "notebook_redirect.html"], + ["interactive/public_server", "notebook_redirect.html"] +] diff --git a/docs/source/sphinxext.rst b/docs/source/sphinxext.rst index 093e04a90fc..49c46ecf8b7 100644 --- a/docs/source/sphinxext.rst +++ b/docs/source/sphinxext.rst @@ -242,6 +242,7 @@ the inputs:: .. ipython:: :suppress: + :okexcept: In [144]: from matplotlib.pylab import * @@ -249,6 +250,7 @@ the inputs:: .. ipython:: :suppress: + :okexcept: In [144]: from matplotlib.pylab import * @@ -396,6 +398,7 @@ If you don't see the next code block then the options work. .. ipython:: python :suppress: + :okexcept: ioff() ion() @@ -484,7 +487,7 @@ Configuration Options ipython_savefig_dir The directory in which to save the figures. This is relative to the - Sphinx source directory. The default is `html_static_path`. + Sphinx source directory. The default is ``savefig``. ipython_rgxin @@ -508,7 +511,7 @@ ipython_promptin ipython_promptout The string to represent the IPython prompt in the generated ReST. The - default is `'Out [%d]:'`. This expects that the line numbers are used + default is `'Out[%d]:'`. This expects that the line numbers are used in the prompt. @@ -516,4 +519,3 @@ Automatically generated documentation ===================================== .. automodule:: IPython.sphinxext.ipython_directive - diff --git a/docs/source/whatsnew/development.rst b/docs/source/whatsnew/development.rst index 502b0e0bbab..cd827b459d7 100644 --- a/docs/source/whatsnew/development.rst +++ b/docs/source/whatsnew/development.rst @@ -11,11 +11,6 @@ This document describes in-flight development work. `docs/source/whatsnew/pr` folder -Released .... ...., 2019 - - -Need to be updated: - .. toctree:: :maxdepth: 2 :glob: @@ -23,8 +18,6 @@ Need to be updated: pr/* - - .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT. Backwards incompatible changes diff --git a/docs/source/whatsnew/github-stats-0.11.rst b/docs/source/whatsnew/github-stats-0.11.rst index 2f647ce7414..a5ee93ecf6e 100644 --- a/docs/source/whatsnew/github-stats-0.11.rst +++ b/docs/source/whatsnew/github-stats-0.11.rst @@ -51,9 +51,9 @@ Pull requests (226): * `542 `_: issue 440 * `533 `_: Remove unused configobj and validate libraries from externals. * `538 `_: fix various tests on Windows -* `540 `_: support `-pylab` flag with deprecation warning +* `540 `_: support ``-pylab`` flag with deprecation warning * `537 `_: Docs update -* `536 `_: `setup.py install` depends on setuptools on Windows +* `536 `_: ``setup.py install`` depends on setuptools on Windows * `480 `_: Get help mid-command * `462 `_: Str and Bytes traitlets * `534 `_: Handle unicode properly in IPython.zmq.iostream @@ -282,7 +282,7 @@ Regular issues (285): * `371 `_: segfault in qtconsole when kernel quits * `377 `_: Failure: error (nothing to repeat) * `544 `_: Ipython qtconsole pylab config issue. -* `543 `_: RuntimeError in completer +* `543 `_: RuntimeError in completer * `440 `_: %run filename autocompletion "The kernel heartbeat has been inactive ... " error * `541 `_: log_level is broken in the ipython Application * `369 `_: windows source install doesn't create scripts correctly @@ -384,7 +384,7 @@ Regular issues (285): * `326 `_: Update docs and examples for parallel stuff to reflect movement away from Twisted * `341 `_: FIx Parallel Magics for newparallel * `338 `_: Usability improvements to Qt console -* `142 `_: unexpected auto-indenting when variables names that start with 'pass' +* `142 `_: unexpected auto-indenting when variables names that start with 'pass' * `296 `_: Automatic PDB via %pdb doesn't work * `337 `_: exit( and quit( in Qt console produces phantom signature/docstring popup, even though quit() or exit() raises NameError * `318 `_: %debug broken in master: invokes missing save_history() method @@ -399,7 +399,7 @@ Regular issues (285): * `328 `_: %run script.ipy raises "ERROR! Session/line number was not unique in database." * `7 `_: Update the changes doc to reflect the kernel config work * `303 `_: Users should be able to scroll a notebook w/o moving the menu/buttons -* `322 `_: Embedding an interactive IPython shell +* `322 `_: Embedding an interactive IPython shell * `321 `_: %debug broken in master * `287 `_: Crash when using %macros in sqlite-history branch * `55 `_: Can't edit files whose names begin with numbers @@ -470,7 +470,7 @@ Regular issues (285): * `140 `_: malloc error during tab completion of numpy array member functions starting with 'c' * `153 `_: ipy_vimserver traceback on Windows * `154 `_: using ipython in Slicer3 show how os.environ['HOME'] is not defined -* `185 `_: show() blocks in pylab mode with ipython 0.10.1 +* `185 `_: show() blocks in pylab mode with ipython 0.10.1 * `189 `_: Crash on tab completion * `274 `_: bashism in sshx.sh * `276 `_: Calling `sip.setapi` does not work if app has already imported from PyQt4 @@ -492,8 +492,8 @@ Regular issues (285): * `45 `_: Autosave history for robustness * `162 `_: make command history persist in ipythonqt * `161 `_: make ipythonqt exit without dialog when exit() is called -* `263 `_: [ipython + numpy] Some test errors -* `256 `_: reset docstring ipython 0.10 +* `263 `_: [ipython + numpy] Some test errors +* `256 `_: reset docstring ipython 0.10 * `258 `_: allow caching to avoid matplotlib object references * `248 `_: Can't open and read files after upgrade from 0.10 to 0.10.0 * `247 `_: ipython + Stackless diff --git a/docs/source/whatsnew/github-stats-0.12.rst b/docs/source/whatsnew/github-stats-0.12.rst index ac2b56c099b..df0879d7086 100644 --- a/docs/source/whatsnew/github-stats-0.12.rst +++ b/docs/source/whatsnew/github-stats-0.12.rst @@ -120,7 +120,7 @@ Pull requests (257): * `1120 `_: updated vim-ipython (pending) * `1150 `_: BUG: Scrolling pager in vsplit on Mac OSX tears. * `1149 `_: #1148 (win32 arg_split) -* `1147 `_: Put qtconsole forground when launching +* `1147 `_: Put qtconsole foreground when launching * `1146 `_: allow saving notebook.py next to notebook.ipynb * `1128 `_: fix pylab StartMenu item * `1140 `_: Namespaces for embedding @@ -178,7 +178,7 @@ Pull requests (257): * `956 `_: Generate "All magics..." menu live * `1038 `_: Notebook: don't change cell when selecting code using shift+up/down. * `987 `_: Add Tooltip to notebook. -* `1028 `_: Cleaner minimum version comparison +* `1028 `_: Cleaner minimum version comparison * `998 `_: defer to stdlib for path.get_home_dir() * `1033 `_: update copyright to 2011/20xx-2011 * `1032 `_: Intercept avoid closing websocket on Firefox @@ -269,7 +269,7 @@ Pull requests (257): * `857 `_: make sdist flags work again (e.g. --manifest-only) * `835 `_: Add Tab key to list of keys that scroll down the paging widget. * `859 `_: Fix for issue #800 -* `848 `_: Python3 setup.py install failiure +* `848 `_: Python3 setup.py install failure * `845 `_: Tests on Python 3 * `802 `_: DOC: extensions: add documentation for the bundled extensions * `830 `_: contiguous stdout/stderr in notebook @@ -298,7 +298,7 @@ Pull requests (257): * `784 `_: Parse user code to AST using compiler flags. * `783 `_: always use StringIO, never cStringIO * `782 `_: flush stdout/stderr on displayhook call -* `622 `_: Make pylab import all configurable +* `622 `_: Make pylab import all configurable * `745 `_: Don't assume history requests succeed in qtconsole * `725 `_: don't assume cursor.selectedText() is a string * `778 `_: don't override execfile on Python 2 @@ -431,7 +431,7 @@ Regular issues (258): * `1017 `_: Add small example about ipcluster/ssh startup * `1041 `_: Proxy Issues * `967 `_: KernelManagers don't use zmq eventloop properly -* `1055 `_: "All Magics" display on Ubuntu +* `1055 `_: "All Magics" display on Ubuntu * `1054 `_: ipython explodes on syntax error * `1051 `_: ipython3 set_next_input() failure * `693 `_: "run -i" no longer works after %reset in terminal @@ -444,7 +444,7 @@ Regular issues (258): * `1044 `_: run -p doesn't work in python 3 * `1010 `_: emacs freezes when ipython-complete is called * `82 `_: Update devel docs with discussion about good changelogs -* `116 `_: Update release management scipts and release.revision for git +* `116 `_: Update release management scripts and release.revision for git * `1022 `_: Pylab banner shows up with first cell to execute * `787 `_: Keyboard selection of multiple lines in the notebook behaves inconsistently * `1037 `_: notepad + jsonlib: TypeError: Only whitespace may be used for indentation. @@ -456,7 +456,7 @@ Regular issues (258): * `684 `_: %Store eliminated in configuration and magic commands in 0.11 * `1026 `_: BUG: wrong default parameter in ask_yes_no * `880 `_: Better error message if %paste fails -* `1024 `_: autopx magic broken +* `1024 `_: autopx magic broken * `822 `_: Unicode bug in Itpl when expanding shell variables in syscalls with ! * `1009 `_: Windows: regression in cd magic handling of paths * `833 `_: Crash python with matplotlib and unequal length arrays @@ -513,7 +513,7 @@ Regular issues (258): * `919 `_: Pop-up segfault when moving cursor out of qtconsole window * `181 `_: cls command does not work on windows * `917 `_: documentation typos -* `818 `_: %run does not work with non-ascii characeters in path +* `818 `_: %run does not work with non-ascii characters in path * `907 `_: Errors in custom completer functions can crash IPython * `867 `_: doc: notebook password authentication howto * `211 `_: paste command not working diff --git a/docs/source/whatsnew/github-stats-0.13.rst b/docs/source/whatsnew/github-stats-0.13.rst index cdb9415432b..6aea1e9160c 100644 --- a/docs/source/whatsnew/github-stats-0.13.rst +++ b/docs/source/whatsnew/github-stats-0.13.rst @@ -78,7 +78,7 @@ The following 62 authors contributed 1760 commits. We closed a total of 1115 issues, 373 pull requests and 742 regular issues; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (373): @@ -149,7 +149,7 @@ Pull Requests (373): * :ghpull:`1937`: add %save -f * :ghpull:`1935`: add version checking to pyreadline import test * :ghpull:`1849`: Octave magics -* :ghpull:`1759`: github, merge PR(s) just by number(s) +* :ghpull:`1759`: github, merge PR(s) just by number(s) * :ghpull:`1931`: Win py3fixes * :ghpull:`1933`: oinspect.find_file: Additional safety if file cannot be found. * :ghpull:`1932`: Fix adding functions to CommandChainDispatcher with equal priority on Py 3 @@ -294,7 +294,7 @@ Pull Requests (373): * :ghpull:`1643`: handle jpg/jpeg in the qtconsole * :ghpull:`1652`: add patch_pyzmq() for backporting a few changes from newer pyzmq * :ghpull:`1650`: DOC: moving files with SSH launchers -* :ghpull:`1357`: add IPython.embed_kernel() +* :ghpull:`1357`: add IPython.embed_kernel() * :ghpull:`1640`: Finish up embed_kernel * :ghpull:`1651`: Remove bundled Itpl module * :ghpull:`1634`: incremental improvements to SSH launchers @@ -492,7 +492,7 @@ Issues (742): * :ghissue:`2033`: ipython parallel pushing and pulling recarrays * :ghissue:`2034`: fix&test push/pull recarrays * :ghissue:`2028`: Reduce unhelpful information shown by pinfo -* :ghissue:`1992`: Tab completion fails with many spaces in filename +* :ghissue:`1992`: Tab completion fails with many spaces in filename * :ghissue:`1885`: handle too old wx * :ghissue:`2030`: check wxPython version in inputhook * :ghissue:`2024`: Make interactive_usage a bit more rst friendly @@ -588,7 +588,7 @@ Issues (742): * :ghissue:`1572`: pyreadline version dependency not correctly checked * :ghissue:`1935`: add version checking to pyreadline import test * :ghissue:`1849`: Octave magics -* :ghissue:`1759`: github, merge PR(s) just by number(s) +* :ghissue:`1759`: github, merge PR(s) just by number(s) * :ghissue:`1931`: Win py3fixes * :ghissue:`1646`: Meaning of restart parameter in client.shutdown() unclear * :ghissue:`1933`: oinspect.find_file: Additional safety if file cannot be found. @@ -729,7 +729,7 @@ Issues (742): * :ghissue:`1062`: warning message in IPython.extensions test * :ghissue:`1807`: add missing cython exclusion in iptest * :ghissue:`1805`: Fixed a vcvarsall.bat error on win32/Py2.7 when trying to compile with m... -* :ghissue:`1803`: MPI parallel %px bug +* :ghissue:`1803`: MPI parallel %px bug * :ghissue:`1804`: Fixed a vcvarsall.bat error on win32/Py2.7 when trying to compile with mingw. * :ghissue:`1492`: Drag target very small if IPython Dashboard has no notebooks * :ghissue:`1562`: Offer a method other than drag-n-drop to upload notebooks @@ -862,7 +862,7 @@ Issues (742): * :ghissue:`1520`: kernel crash when showing tooltip (?) * :ghissue:`1652`: add patch_pyzmq() for backporting a few changes from newer pyzmq * :ghissue:`1650`: DOC: moving files with SSH launchers -* :ghissue:`1357`: add IPython.embed_kernel() +* :ghissue:`1357`: add IPython.embed_kernel() * :ghissue:`1640`: Finish up embed_kernel * :ghissue:`1651`: Remove bundled Itpl module * :ghissue:`1634`: incremental improvements to SSH launchers @@ -953,7 +953,7 @@ Issues (742): * :ghissue:`1237`: Kernel status and logout button overlap * :ghissue:`1319`: Running a cell with ctrl+Enter selects text in cell * :ghissue:`1571`: module member autocomplete should respect __all__ -* :ghissue:`1566`: ipython3 doesn't run in Win7 with Python 3.2 +* :ghissue:`1566`: ipython3 doesn't run in Win7 with Python 3.2 * :ghissue:`1568`: fix PR #1567 * :ghissue:`1567`: Fix: openssh_tunnel did not parse port in `server` * :ghissue:`1565`: fix AsyncResult.abort @@ -1091,7 +1091,7 @@ Issues (742): * :ghissue:`1362`: Don't log complete contents of history replies, even in debug * :ghissue:`888`: ReST support in notebooks * :ghissue:`1205`: notebook stores HTML escaped text in the file -* :ghissue:`1351`: add IPython.embed_kernel() +* :ghissue:`1351`: add IPython.embed_kernel() * :ghissue:`1243`: magic commands without % are not completed properly in htmlnotebook * :ghissue:`1347`: fix weird magic completion in notebook * :ghissue:`1355`: notebook.html extends layout.html now diff --git a/docs/source/whatsnew/github-stats-1.0.rst b/docs/source/whatsnew/github-stats-1.0.rst index 4aeb36eecf3..086dce7bf38 100644 --- a/docs/source/whatsnew/github-stats-1.0.rst +++ b/docs/source/whatsnew/github-stats-1.0.rst @@ -91,12 +91,12 @@ Pull Requests (38): * :ghissue:`4721`: purge_results with jobid crashing - looking for insight * :ghissue:`4602`: "ipcluster stop" fails after "ipcluster start --daemonize" using python3.3 * :ghissue:`3386`: Magic %paste not working in Python 3.3.2. TypeError: Type str doesn't support the buffer API -* :ghissue:`4485`: Incorrect info in "Messaging in IPython" documentation. +* :ghissue:`4485`: Incorrect info in "Messaging in IPython" documentation. * :ghissue:`4351`: /parallel/apps/launcher.py error * :ghissue:`4334`: NotebookApp.webapp_settings static_url_prefix causes crash * :ghissue:`4039`: Celltoolbar example issue -* :ghissue:`4256`: IPython no longer handles unicode file names -* :ghissue:`4122`: Nbconvert [windows]: Inconsistent line endings in markdown cells exported to latex +* :ghissue:`4256`: IPython no longer handles unicode file names +* :ghissue:`4122`: Nbconvert [windows]: Inconsistent line endings in markdown cells exported to latex * :ghissue:`3819`: nbconvert add extra blank line to code block on Windows. * :ghissue:`4203`: remove spurious print statement from parallel annoted functions * :ghissue:`4200`: Notebook: merging a heading cell and markdown cell cannot be undone @@ -211,7 +211,7 @@ Issues (18): * :ghissue:`4134`: multi-line parser fails on ''' in comment, qtconsole and notebook. * :ghissue:`3998`: sample custom.js needs to be updated * :ghissue:`4078`: StoreMagic.autorestore not working in 1.0.0 -* :ghissue:`3990`: Buitlin `input` doesn't work over zmq +* :ghissue:`3990`: Builtin `input` doesn't work over zmq * :ghissue:`4015`: nbconvert fails to convert all the content of a notebook * :ghissue:`4059`: Issues with Ellipsis literal in Python 3 * :ghissue:`4103`: Wrong default argument of DirectView.clear @@ -219,7 +219,7 @@ Issues (18): * :ghissue:`4005`: IPython.start_kernel doesn't work. * :ghissue:`4020`: IPython parallel map fails on numpy arrays * :ghissue:`3945`: nbconvert: commandline tests fail Win7x64 Py3.3 -* :ghissue:`3977`: unable to complete remote connections for two-process +* :ghissue:`3977`: unable to complete remote connections for two-process * :ghissue:`3980`: nbconvert rst output lacks needed blank lines * :ghissue:`3968`: TypeError: super() argument 1 must be type, not classobj (Python 2.6.6) @@ -389,7 +389,7 @@ The following 155 authors contributed 4258 commits. We closed a total of 1484 issues, 793 pull requests and 691 regular issues; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (793): @@ -540,10 +540,10 @@ Pull Requests (793): * :ghpull:`3585`: don't blacklist builtin names * :ghpull:`3647`: Fix `frontend` deprecation warnings in several examples * :ghpull:`3649`: fix AsyncResult.get_dict for single result -* :ghpull:`3648`: Fix store magic test +* :ghpull:`3648`: Fix store magic test * :ghpull:`3650`: Fix, config_file_name was ignored * :ghpull:`3640`: Gcf.get_active() can return None -* :ghpull:`3571`: Added shorcuts to split cell, merge cell above and merge cell below. +* :ghpull:`3571`: Added shortcuts to split cell, merge cell above and merge cell below. * :ghpull:`3635`: Added missing slash to print-pdf call. * :ghpull:`3487`: Drop patch for compatibility with pyreadline 1.5 * :ghpull:`3338`: Allow filename with extension in find_cmd in Windows. @@ -752,7 +752,7 @@ Pull Requests (793): * :ghpull:`2979`: CM configurable Take 2 * :ghpull:`3215`: Updates storemagic extension to allow for specifying variable name to load * :ghpull:`3181`: backport If-Modified-Since fix from tornado -* :ghpull:`3200`: IFrame (VimeoVideo, ScribdDocument, ...) +* :ghpull:`3200`: IFrame (VimeoVideo, ScribdDocument, ...) * :ghpull:`3186`: Fix small inconsistency in nbconvert: etype -> ename * :ghpull:`3212`: Fix issue #2563, "core.profiledir.check_startup_dir() doesn't work inside py2exe'd installation" * :ghpull:`3211`: Fix inheritance_diagram Sphinx extension for Sphinx 1.2 @@ -928,7 +928,7 @@ Pull Requests (793): * :ghpull:`2396`: create a ipynbv3 json schema and a validator * :ghpull:`2757`: check for complete pyside presence before trying to import * :ghpull:`2782`: Allow the %run magic with '-b' to specify a file. -* :ghpull:`2778`: P3K: fix DeprecationWarning under Python 3.x +* :ghpull:`2778`: P3K: fix DeprecationWarning under Python 3.x * :ghpull:`2776`: remove non-functional View.kill method * :ghpull:`2755`: can interactively defined classes * :ghpull:`2774`: Removing unused code in the notebook MappingKernelManager. @@ -984,7 +984,7 @@ Pull Requests (793): * :ghpull:`2572`: Make 'Paste Above' the default paste behavior. * :ghpull:`2574`: Fix #2244 * :ghpull:`2582`: Fix displaying history when output cache is disabled. -* :ghpull:`2591`: Fix for Issue #2584 +* :ghpull:`2591`: Fix for Issue #2584 * :ghpull:`2526`: Don't kill paramiko tunnels when receiving ^C * :ghpull:`2559`: Add psource, pfile, pinfo2 commands to ipdb. * :ghpull:`2546`: use 4 Pythons to build 4 Windows installers @@ -1025,7 +1025,7 @@ Pull Requests (793): * :ghpull:`2468`: Tell git to ignore __pycache__ directories. * :ghpull:`2421`: Some notebook tweaks. * :ghpull:`2291`: Remove old plugin system -* :ghpull:`2127`: Ability to build toolbar in JS +* :ghpull:`2127`: Ability to build toolbar in JS * :ghpull:`2445`: changes for ironpython * :ghpull:`2420`: Pass ipython_dir to __init__() method of TerminalInteractiveShell's superclass. * :ghpull:`2432`: Revert #1831, the `__file__` injection in safe_execfile / safe_execfile_ipy. @@ -1190,8 +1190,8 @@ Pull Requests (793): Issues (691): -* :ghissue:`3940`: Install process documentation overhaul -* :ghissue:`3946`: The PDF option for `--post` should work with lowercase +* :ghissue:`3940`: Install process documentation overhaul +* :ghissue:`3946`: The PDF option for `--post` should work with lowercase * :ghissue:`3957`: Notebook help page broken in Firefox * :ghissue:`3894`: nbconvert test failure * :ghissue:`3887`: 1.0.0a1 shows blank screen in both firefox and chrome (windows 7) @@ -1222,7 +1222,7 @@ Issues (691): * :ghissue:`3874`: Up/Down keys don't work to "Search previous command history" (besides Ctrl-p/Ctrl-n) * :ghissue:`3853`: CodeMirror locks up in the notebook * :ghissue:`3862`: can only connect to an ipcluster started with v1.0.0-dev (master branch) using an older ipython (v0.13.2), but cannot connect using ipython (v1.0.0-dev) -* :ghissue:`3869`: custom css not working. +* :ghissue:`3869`: custom css not working. * :ghissue:`2960`: Keyboard shortcuts * :ghissue:`3795`: ipcontroller process goes to 100% CPU, ignores connection requests * :ghissue:`3553`: Ipython and pylab crashes in windows and canopy @@ -1244,7 +1244,7 @@ Issues (691): * :ghissue:`3810`: Printing the contents of an image file messes up shell text * :ghissue:`3702`: `nbconvert`: Default help message should be that of --help * :ghissue:`3735`: Nbconvert 1.0.0a1 does not take into account the pdf extensions in graphs -* :ghissue:`3719`: Bad strftime format, for windows, in nbconvert exporter +* :ghissue:`3719`: Bad strftime format, for windows, in nbconvert exporter * :ghissue:`3786`: Zmq errors appearing with `Ctrl-C` in console/qtconsole * :ghissue:`3019`: disappearing scrollbar on tooltip in Chrome 24 on Ubuntu 12.04 * :ghissue:`3785`: ipdb completely broken in Qt console @@ -1256,7 +1256,7 @@ Issues (691): * :ghissue:`3724`: ipcluster only running on one cpu * :ghissue:`1592`: better message for unsupported nbformat * :ghissue:`2049`: Can not stop "ipython kernel" on windows -* :ghissue:`3757`: Need direct entry point to given notebook +* :ghissue:`3757`: Need direct entry point to given notebook * :ghissue:`3745`: ImportError: cannot import name check_linecache_ipython * :ghissue:`3701`: `nbconvert`: Final output file should be in same directory as input file * :ghissue:`3738`: history -o works but history with -n produces identical results @@ -1274,7 +1274,7 @@ Issues (691): * :ghissue:`3542`: note new dependencies in docs / setup.py * :ghissue:`2556`: [pagedown] do not target_blank anchor link * :ghissue:`3684`: bad message when %pylab fails due import *other* than matplotlib -* :ghissue:`3682`: ipython notebook pylab inline import_all=False +* :ghissue:`3682`: ipython notebook pylab inline import_all=False * :ghissue:`3596`: MathjaxUtils race condition? * :ghissue:`1540`: Comment/uncomment selection in notebook * :ghissue:`2702`: frozen setup: permission denied for default ipython_dir @@ -1283,7 +1283,7 @@ Issues (691): * :ghissue:`481`: IPython terminal issue with Qt4Agg on XP SP3 * :ghissue:`2664`: How to preserve user variables from import clashing? * :ghissue:`3436`: enable_pylab(import_all=False) still imports np -* :ghissue:`2630`: lib.pylabtools.figsize : NameError when using Qt4Agg backend and %pylab magic. +* :ghissue:`2630`: lib.pylabtools.figsize : NameError when using Qt4Agg backend and %pylab magic. * :ghissue:`3154`: Notebook: no event triggered when a Cell is created * :ghissue:`3579`: Nbconvert: SVG are not transformed to PDF anymore * :ghissue:`3604`: MathJax rendering problem in `%%latex` cell @@ -1291,10 +1291,10 @@ Issues (691): * :ghissue:`3245`: SyntaxError: encoding declaration in Unicode string * :ghissue:`3639`: %pylab inline in IPYTHON notebook throws "RuntimeError: Cannot activate multiple GUI eventloops" * :ghissue:`3663`: frontend deprecation warnings -* :ghissue:`3661`: run -m not behaving like python -m +* :ghissue:`3661`: run -m not behaving like python -m * :ghissue:`3597`: re-do PR #3531 - allow markdown in Header cell * :ghissue:`3053`: Markdown in header cells is not rendered -* :ghissue:`3655`: IPython finding its way into pasted strings. +* :ghissue:`3655`: IPython finding its way into pasted strings. * :ghissue:`3620`: uncaught errors in HTML output * :ghissue:`3646`: get_dict() error * :ghissue:`3004`: `%load_ext rmagic` fails when legacy ipy_user_conf.py is installed (in ipython 0.13.1 / OSX 10.8) @@ -1329,11 +1329,11 @@ Issues (691): * :ghissue:`3544`: IPython.lib test failure on Windows * :ghissue:`3352`: Install Sphinx extensions * :ghissue:`2971`: [notebook]user needs to press ctrl-c twice to stop notebook server should be put into terminal window -* :ghissue:`2413`: ipython3 qtconsole fails to install: ipython 0.13 has no such extra feature 'qtconsole' +* :ghissue:`2413`: ipython3 qtconsole fails to install: ipython 0.13 has no such extra feature 'qtconsole' * :ghissue:`2618`: documentation is incorrect for install process * :ghissue:`2595`: mac 10.8 qtconsole export history * :ghissue:`2586`: cannot store aliases -* :ghissue:`2714`: ipython qtconsole print unittest messages in console instead his own window. +* :ghissue:`2714`: ipython qtconsole print unittest messages in console instead his own window. * :ghissue:`2669`: cython magic failing to work with openmp. * :ghissue:`3256`: Vagrant pandas instance of IPython Notebook does not respect additional plotting arguments * :ghissue:`3010`: cython magic fail if cache dir is deleted while in session @@ -1404,7 +1404,7 @@ Issues (691): * :ghissue:`3448`: Please include MathJax fonts with IPython Notebook * :ghissue:`3519`: IPython Parallel map mysteriously turns pandas Series into numpy ndarray * :ghissue:`3345`: IPython embedded shells ask if I want to exit, but I set confirm_exit = False -* :ghissue:`3509`: IPython won't close without asking "Are you sure?" in Firefox +* :ghissue:`3509`: IPython won't close without asking "Are you sure?" in Firefox * :ghissue:`3471`: Notebook jinja2/markupsafe dependencies in manual * :ghissue:`3502`: Notebook broken in master * :ghissue:`3302`: autoreload does not work in ipython 0.13.x, python 3.3 @@ -1425,7 +1425,7 @@ Issues (691): * :ghissue:`2790`: %paste and %cpaste not removing "..." lines * :ghissue:`3480`: Testing fails because iptest.py cannot be found * :ghissue:`2580`: will not run within PIL build directory -* :ghissue:`2797`: RMagic, Dataframe Conversion Problem +* :ghissue:`2797`: RMagic, Dataframe Conversion Problem * :ghissue:`2838`: Empty lines disappear from triple-quoted literals. * :ghissue:`3050`: Broken link on IPython.core.display page * :ghissue:`3473`: Config not passed down to subcommands @@ -1446,11 +1446,11 @@ Issues (691): * :ghissue:`3156`: update pretty to use Python 3 style for sets * :ghissue:`3197`: Can't escape multiple dollar signs in a markdown cell * :ghissue:`3309`: `Image()` signature/doc improvements -* :ghissue:`3415`: Bug in IPython/external/path/__init__.py +* :ghissue:`3415`: Bug in IPython/external/path/__init__.py * :ghissue:`3446`: Feature suggestion: Download matplotlib figure to client browser * :ghissue:`3295`: autoexported notebooks: only export explicitly marked cells * :ghissue:`3442`: Notebook: Summary table extracted from markdown headers -* :ghissue:`3438`: Zooming notebook in chrome is broken in master +* :ghissue:`3438`: Zooming notebook in chrome is broken in master * :ghissue:`1378`: Implement autosave in notebook * :ghissue:`3437`: Highlighting matching parentheses * :ghissue:`3435`: module search segfault @@ -1505,7 +1505,7 @@ Issues (691): * :ghissue:`3260`: Js error in savewidget * :ghissue:`3247`: scrollbar in notebook when not needed? * :ghissue:`3243`: notebook: option to view json source from browser -* :ghissue:`3265`: 404 errors when running IPython 1.0dev +* :ghissue:`3265`: 404 errors when running IPython 1.0dev * :ghissue:`3257`: setup.py not finding submodules * :ghissue:`3253`: Incorrect Qt and PySide version comparison * :ghissue:`3248`: Cell magics broken in Qt console @@ -1534,7 +1534,7 @@ Issues (691): * :ghissue:`3176`: Particular equation not rendering (notebook) * :ghissue:`1133`: [notebook] readonly and upload files/UI * :ghissue:`2975`: [notebook] python file and cell toolbar -* :ghissue:`3017`: SciPy.weave broken in IPython notebook/ qtconsole +* :ghissue:`3017`: SciPy.weave broken in IPython notebook/ qtconsole * :ghissue:`3161`: paste macro not reading spaces correctly * :ghissue:`2835`: %paste not working on WinXpSP3/ipython-0.13.1.py2-win32-PROPER.exe/python27 * :ghissue:`2628`: Make transformers work for lines following decorators @@ -1567,7 +1567,7 @@ Issues (691): * :ghissue:`2834`: url regexp only finds one link * :ghissue:`3091`: qtconsole breaks doctest.testmod() in Python 3.3 * :ghissue:`3074`: SIGUSR1 not available on Windows -* :ghissue:`2996`: registration::purging stalled registration high occurrence in small clusters +* :ghissue:`2996`: registration::purging stalled registration high occurrence in small clusters * :ghissue:`3065`: diff-ability of notebooks * :ghissue:`3067`: Crash with pygit2 * :ghissue:`3061`: Bug handling Ellipsis @@ -1634,7 +1634,7 @@ Issues (691): * :ghissue:`2722`: IPC transport option not taking effect ? * :ghissue:`2473`: Better error messages in ipengine/ipcontroller * :ghissue:`2836`: Cannot send builtin module definitions to IP engines -* :ghissue:`2833`: Any reason not to use super() ? +* :ghissue:`2833`: Any reason not to use super() ? * :ghissue:`2781`: Cannot interrupt infinite loops in the notebook * :ghissue:`2150`: clippath_demo.py in matplotlib example does not work with inline backend * :ghissue:`2634`: Numbered list in notebook markdown cell renders with Roman numerals instead of numbers @@ -1655,10 +1655,10 @@ Issues (691): * :ghissue:`2297`: ipdb with separate kernel/client pushing stdout to kernel process only * :ghissue:`2180`: Have [kernel busy] overridden only by [kernel idle] * :ghissue:`1188`: Pylab with OSX backend keyboard focus issue and hang -* :ghissue:`2107`: test_octavemagic.py[everything] fails +* :ghissue:`2107`: test_octavemagic.py[everything] fails * :ghissue:`1212`: Better understand/document browser compatibility * :ghissue:`1585`: Refactor notebook templates to use Jinja2 and make each page a separate directory -* :ghissue:`1443`: xticks scaling factor partially obscured with qtconsole and inline plotting +* :ghissue:`1443`: xticks scaling factor partially obscured with qtconsole and inline plotting * :ghissue:`1209`: can't make %result work as in doc. * :ghissue:`1200`: IPython 0.12 Windows install fails on Vista * :ghissue:`1127`: Interactive test scripts for Qt/nb issues @@ -1798,7 +1798,7 @@ Issues (691): * :ghissue:`2361`: client doesn't use connection file's 'location' in disambiguating 'interface' * :ghissue:`2357`: failing traceback in terminal ipython for first exception * :ghissue:`2343`: Installing in a python 3.3b2 or python 3.3rc1 virtual environment. -* :ghissue:`2315`: Failure in test: "Test we're not loading modules on startup that we shouldn't." +* :ghissue:`2315`: Failure in test: "Test we're not loading modules on startup that we shouldn't." * :ghissue:`2351`: Multiple Notebook Apps: cookies not port specific, clash with each other * :ghissue:`2350`: running unittest from qtconsole prints output to terminal * :ghissue:`2303`: remote tracebacks broken since 952d0d6 (PR #2223) @@ -1831,9 +1831,9 @@ Issues (691): * :ghissue:`1456`: ERROR: Internal Python error in the inspect module. * :ghissue:`2221`: Avoid importing from IPython.parallel in core * :ghissue:`2213`: Can't trigger startup code in Engines -* :ghissue:`1464`: Strange behavior for backspace with lines ending with more than 4 spaces in notebook +* :ghissue:`1464`: Strange behavior for backspace with lines ending with more than 4 spaces in notebook * :ghissue:`2187`: NaN in object_info_reply JSON causes parse error -* :ghissue:`214`: system command requiring administrative privileges +* :ghissue:`214`: system command requiring administrative privileges * :ghissue:`2195`: Unknown option `no-edit` in git-mpr * :ghissue:`2201`: Add documentation build to tools/test_pr.py * :ghissue:`2205`: Command-line option for default Notebook output collapsing behavior @@ -1852,7 +1852,7 @@ Issues (691): * :ghissue:`2139`: 00_notebook_tour Image example broken on master * :ghissue:`2143`: Add a %%cython_annotate magic * :ghissue:`2135`: Running IPython from terminal -* :ghissue:`2093`: Makefile for building Sphinx documentation on Windows +* :ghissue:`2093`: Makefile for building Sphinx documentation on Windows * :ghissue:`2122`: Bug in pretty printing * :ghissue:`2120`: Notebook "Make a Copy..." keeps opening duplicates in the same tab * :ghissue:`1997`: password cannot be used with url prefix @@ -1860,7 +1860,7 @@ Issues (691): * :ghissue:`2121`: ipdb does not support input history in qtconsole * :ghissue:`2114`: %logstart doesn't log * :ghissue:`2085`: %ed magic fails in qtconsole -* :ghissue:`2119`: IPython fails to run on MacOS Lion +* :ghissue:`2119`: IPython fails to run on MacOS Lion * :ghissue:`2052`: %pylab inline magic does not work on windows * :ghissue:`2111`: Ipython won't start on W7 * :ghissue:`2112`: Strange internal traceback diff --git a/docs/source/whatsnew/github-stats-2.0.rst b/docs/source/whatsnew/github-stats-2.0.rst index 5033994e1e1..f82a6e4b43b 100644 --- a/docs/source/whatsnew/github-stats-2.0.rst +++ b/docs/source/whatsnew/github-stats-2.0.rst @@ -26,7 +26,7 @@ The following 7 authors contributed 35 commits. * Thomas Kluyver We closed 10 issues and merged 6 pull requests; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (10): @@ -45,7 +45,7 @@ Pull Requests (10): Issues (6): * :ghissue:`7272`: qtconsole problems with pygments -* :ghissue:`7049`: Cause TypeError: 'NoneType' object is not callable in qtconsole +* :ghissue:`7049`: Cause TypeError: 'NoneType' object is not callable in qtconsole * :ghissue:`6877`: Qt console doesn't work with pygments 2.0rc1 * :ghissue:`6689`: Problem with string containing two or more question marks * :ghissue:`6702`: Cell numbering after ``ClearOutput`` preprocessor @@ -83,7 +83,7 @@ The following 6 authors contributed 31 commits. * Thomas Kluyver We closed 16 issues and merged 9 pull requests; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (16): @@ -141,7 +141,7 @@ The following 13 authors contributed 36 commits. * Zahari We closed 23 issues and merged 11 pull requests; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (23): @@ -230,7 +230,7 @@ The following 35 authors contributed 145 commits. * zah We closed a total of 129 issues, 92 pull requests and 37 regular issues; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py --milestone 2.1`): Pull Requests (92): @@ -331,7 +331,7 @@ Pull Requests (92): Issues (37): * :ghissue:`5364`: Horizontal scrollbar hides cell's last line on Firefox -* :ghissue:`5192`: horisontal scrollbar overlaps output or touches next cell +* :ghissue:`5192`: horizontal scrollbar overlaps output or touches next cell * :ghissue:`5840`: Third-party Windows kernels don't get interrupt signal * :ghissue:`2412`: print history to file using qtconsole and notebook * :ghissue:`5703`: Notebook doesn't render with "ask me every time" cookie setting in Firefox @@ -355,12 +355,12 @@ Issues (37): * :ghissue:`5566`: Function name printing should use ``__qualname__`` instead of ``__name__`` (Python 3) * :ghissue:`5676`: "bookmark -l" not working in ipython 2.0 * :ghissue:`5555`: Differentiate more clearly between Notebooks and Folders in new UI -* :ghissue:`5590`: Marked double escape +* :ghissue:`5590`: Marked double escape * :ghissue:`5514`: import tab-complete fail with ipython 2.0 shell * :ghissue:`4012`: Notebook: link to markdown formatting reference * :ghissue:`5611`: Typo in 'storemagic' documentation * :ghissue:`5589`: Kernel start fails when using --browser argument -* :ghissue:`5491`: Bug in Windows ipconfig ip address regular expression +* :ghissue:`5491`: Bug in Windows ipconfig ip address regular expression * :ghissue:`5579`: rmagic extension throws 'Error while parsing the string.' when last line is comment * :ghissue:`5518`: Ipython2 will not open ipynb in example directory * :ghissue:`5561`: New widget documentation has missing notebook link @@ -476,7 +476,7 @@ The following 94 authors contributed 3949 commits. We closed a total of 1121 issues, 687 pull requests and 434 regular issues; -this is the full list (generated with the script +this is the full list (generated with the script :file:`tools/github_stats.py`): Pull Requests (687): @@ -592,7 +592,7 @@ Pull Requests (687): * :ghpull:`5209`: make input_area css generic to cells * :ghpull:`5246`: less %pylab, more cowbell! * :ghpull:`4895`: Improvements to %run completions -* :ghpull:`5243`: Add Javscript to base display priority list. +* :ghpull:`5243`: Add JavaScript to base display priority list. * :ghpull:`5175`: Audit .html() calls take #2 * :ghpull:`5146`: Dual mode bug fixes. * :ghpull:`5207`: Children fire event @@ -818,7 +818,7 @@ Pull Requests (687): * :ghpull:`4713`: Fix saving kernel history in Python 2 * :ghpull:`4744`: don't use lazily-evaluated rc.ids in wait_for_idle * :ghpull:`4740`: %env can't set variables -* :ghpull:`4737`: check every link when detecting virutalenv +* :ghpull:`4737`: check every link when detecting virtualenv * :ghpull:`4738`: don't inject help into user_ns * :ghpull:`4739`: skip html nbconvert tests when their dependencies are missing * :ghpull:`4730`: Fix stripping continuation prompts when copying from Qt console @@ -854,7 +854,7 @@ Pull Requests (687): * :ghpull:`4671`: Fix docstrings in utils.text * :ghpull:`4669`: add missing help strings to HistoryManager configurables * :ghpull:`4668`: Make non-ASCII docstring unicode -* :ghpull:`4650`: added a note about sharing of nbconvert tempates +* :ghpull:`4650`: added a note about sharing of nbconvert templates * :ghpull:`4646`: Fixing various output related things: * :ghpull:`4665`: check for libedit in readline on OS X * :ghpull:`4606`: Make running PYTHONSTARTUP optional @@ -916,7 +916,7 @@ Pull Requests (687): * :ghpull:`4444`: Css cleaning * :ghpull:`4523`: Use username and password for MongoDB on ShiningPanda * :ghpull:`4510`: Update whatsnew from PR files -* :ghpull:`4441`: add `setup.py jsversion` +* :ghpull:`4441`: add ``setup.py jsversion`` * :ghpull:`4518`: Fix for race condition in url file decoding. * :ghpull:`4497`: don't automatically unpack datetime objects in the message spec * :ghpull:`4506`: wait for empty queues as well as load-balanced tasks @@ -1020,7 +1020,7 @@ Pull Requests (687): * :ghpull:`4318`: fix initial sys.path * :ghpull:`4315`: Explicitly state what version of Pandoc is supported in docs/install * :ghpull:`4316`: underscore missing on notebook_p4 -* :ghpull:`4295`: Implement boundary option for load magic (#1093) +* :ghpull:`4295`: Implement boundary option for load magic (#1093) * :ghpull:`4300`: traits defauts are strings not object * :ghpull:`4297`: Remove an unreachable return statement. * :ghpull:`4260`: Use subprocess for system_raw @@ -1050,7 +1050,7 @@ Pull Requests (687): * :ghpull:`4214`: engine ID metadata should be unicode, not bytes * :ghpull:`4232`: no highlight if no language specified * :ghpull:`4218`: Fix display of SyntaxError when .py file is modified -* :ghpull:`4207`: add `setup.py css` command +* :ghpull:`4207`: add ``setup.py css`` command * :ghpull:`4224`: clear previous callbacks on execute * :ghpull:`4180`: Iptest refactoring * :ghpull:`4105`: JS output area misaligned @@ -1285,7 +1285,7 @@ Issues (434): * :ghissue:`5160`: TemporaryWorkingDirectory incompatible with python3.4 * :ghissue:`5140`: WIP: %kernels magic * :ghissue:`4987`: Widget lifecycle problems -* :ghissue:`5129`: UCS package break latex export on non-ascii +* :ghissue:`5129`: UCS package break latex export on non-ascii * :ghissue:`4986`: Cell horizontal scrollbar is missing in FF but not in Chrome * :ghissue:`4685`: nbconvert ignores image size metadata * :ghissue:`5155`: Notebook logout button does not work (source typo) @@ -1356,7 +1356,7 @@ Issues (434): * :ghissue:`4972`: Work around problem in doctest discovery in Python 3.4 with PyQt * :ghissue:`4892`: IPython.qt test failure with python3.4 * :ghissue:`4863`: BUG: cannot create an OBJECT array from memory buffer -* :ghissue:`4704`: Subcommand `profile` ignores --ipython-dir +* :ghissue:`4704`: Subcommand `profile` ignores --ipython-dir * :ghissue:`4845`: Add Origin Checking. * :ghissue:`4870`: ipython_directive, report except/warn in block and add :okexcept: :okwarning: options to suppress * :ghissue:`4956`: Shift-Enter does not move to next cell @@ -1390,7 +1390,7 @@ Issues (434): * :ghissue:`4907`: Test for traceback depth fails on Windows * :ghissue:`4906`: Test for IPython.embed() fails on Windows * :ghissue:`4912`: Skip some Windows io failures -* :ghissue:`3700`: stdout/stderr should be flushed printing exception output... +* :ghissue:`3700`: stdout/stderr should be flushed printing exception output... * :ghissue:`1181`: greedy completer bug in terminal console * :ghissue:`2032`: check for a few places we should be using DEFAULT_ENCODING * :ghissue:`4882`: Too many files open when starting and stopping kernel repeatedly @@ -1440,7 +1440,7 @@ Issues (434): * :ghissue:`4732`: Accents in notebook names and in command-line (nbconvert) * :ghissue:`4752`: link broken in docs/examples * :ghissue:`4835`: running ipython on python files adds an extra traceback frame -* :ghissue:`4792`: repr_html exception warning on qtconsole with pandas #4745 +* :ghissue:`4792`: repr_html exception warning on qtconsole with pandas #4745 * :ghissue:`4834`: function tooltip issues * :ghissue:`4808`: Docstrings in Notebook not displayed properly and introspection * :ghissue:`4846`: Remove some leftover traces of irunner @@ -1466,7 +1466,7 @@ Issues (434): * :ghissue:`4717`: hang in parallel.Client when using SSHAgent * :ghissue:`4544`: Clarify the requirement for pyreadline on Windows * :ghissue:`3451`: revisit REST /new handler to avoid systematic crawling. -* :ghissue:`2922`: File => Save as '.py' saves magic as code +* :ghissue:`2922`: File => Save as '.py' saves magic as code * :ghissue:`4728`: Copy/Paste stripping broken in version > 0.13.x in QTConsole * :ghissue:`4539`: Nbconvert: Latex to PDF conversion fails on notebooks with accented letters * :ghissue:`4721`: purge_results with jobid crashing - looking for insight @@ -1476,7 +1476,7 @@ Issues (434): * :ghissue:`1680`: qtconsole should support --no-banner and custom banner * :ghissue:`4689`: IOStream IP address configurable * :ghissue:`4698`: Missing "if __name__ == '__main__':" check in /usr/bin/ipython -* :ghissue:`4191`: NBConvert: markdown inline and locally referenced files have incorrect file location for latex +* :ghissue:`4191`: NBConvert: markdown inline and locally referenced files have incorrect file location for latex * :ghissue:`2865`: %%!? does not display the shell execute docstring * :ghissue:`1551`: Notebook should be saved before printing * :ghissue:`4612`: remove `Configurable.created` ? @@ -1501,13 +1501,13 @@ Issues (434): * :ghissue:`3043`: can't restart pdb session in ipython * :ghissue:`4524`: Fix bug with non ascii passwords in notebook login * :ghissue:`1866`: problems rendering an SVG? -* :ghissue:`4520`: unicode error when trying Audio('data/Bach Cello Suite #3.wav') +* :ghissue:`4520`: unicode error when trying Audio('data/Bach Cello Suite #3.wav') * :ghissue:`4493`: Qtconsole cannot print an ISO8601 date at nanosecond precision -* :ghissue:`4502`: intermittent parallel test failure test_purge_everything +* :ghissue:`4502`: intermittent parallel test failure test_purge_everything * :ghissue:`4495`: firefox 25.0: notebooks report "Notebook save failed", .py script save fails, but .ipynb save succeeds * :ghissue:`4245`: nbconvert latex: code highlighting causes error * :ghissue:`4486`: Test for whether inside virtualenv does not work if directory is symlinked -* :ghissue:`4485`: Incorrect info in "Messaging in IPython" documentation. +* :ghissue:`4485`: Incorrect info in "Messaging in IPython" documentation. * :ghissue:`4447`: Ipcontroller broken in current HEAD on windows * :ghissue:`4241`: Audio display object * :ghissue:`4463`: Error on empty c.Session.key @@ -1521,7 +1521,7 @@ Issues (434): * :ghissue:`4388`: Make writing configurable magics easier * :ghissue:`852`: Notebook should be saved before downloading * :ghissue:`3708`: ipython profile locate should also work -* :ghissue:`1349`: `?` may generate hundreds of cell +* :ghissue:`1349`: `?` may generate hundreds of cell * :ghissue:`4381`: Using hasattr for trait_names instead of just looking for it directly/using __dir__? * :ghissue:`4361`: Crash Ultratraceback/ session history * :ghissue:`3044`: IPython notebook autocomplete for filename string converts multiple spaces to a single space @@ -1552,13 +1552,13 @@ Issues (434): * :ghissue:`3866`: Vertical offsets in LaTeX output for nbconvert * :ghissue:`3631`: xkcd mode for the IPython notebook * :ghissue:`4243`: Test exclusions not working on Windows -* :ghissue:`4256`: IPython no longer handles unicode file names +* :ghissue:`4256`: IPython no longer handles unicode file names * :ghissue:`3656`: Audio displayobject * :ghissue:`4223`: Double output on Ctrl-enter-enter -* :ghissue:`4184`: nbconvert: use r pygmentize backend when highlighting "%%R" cells +* :ghissue:`4184`: nbconvert: use r pygmentize backend when highlighting "%%R" cells * :ghissue:`3851`: Adds an explicit newline for pretty-printing. * :ghissue:`3622`: Drop fakemodule -* :ghissue:`4122`: Nbconvert [windows]: Inconsistent line endings in markdown cells exported to latex +* :ghissue:`4122`: Nbconvert [windows]: Inconsistent line endings in markdown cells exported to latex * :ghissue:`3819`: nbconvert add extra blank line to code block on Windows. * :ghissue:`4203`: remove spurious print statement from parallel annoted functions * :ghissue:`4200`: Notebook: merging a heading cell and markdown cell cannot be undone @@ -1566,10 +1566,10 @@ Issues (434): * :ghissue:`4024`: nbconvert markdown issues * :ghissue:`3903`: on Windows, 'ipython3 nbconvert "C:/blabla/first_try.ipynb" --to slides' gives an unexpected result, and '--post serve' fails * :ghissue:`4095`: Catch js error in append html in stream/pyerr -* :ghissue:`1880`: Add parallelism to test_pr +* :ghissue:`1880`: Add parallelism to test_pr * :ghissue:`4085`: nbconvert: Fix sphinx preprocessor date format string for Windows * :ghissue:`4156`: Specifying --gui=tk at the command line -* :ghissue:`4146`: Having to prepend 'files/' to markdown image paths is confusing +* :ghissue:`4146`: Having to prepend 'files/' to markdown image paths is confusing * :ghissue:`3818`: nbconvert can't handle Heading with Chinese characters on Japanese Windows OS. * :ghissue:`4134`: multi-line parser fails on ''' in comment, qtconsole and notebook. * :ghissue:`3998`: sample custom.js needs to be updated @@ -1597,7 +1597,7 @@ Issues (434): * :ghissue:`3937`: make tab visible in codemirror and light red background * :ghissue:`3935`: No feedback for mixed tabs and spaces * :ghissue:`3933`: nbconvert: Post-processor tests -* :ghissue:`3977`: unable to complete remote connections for two-process +* :ghissue:`3977`: unable to complete remote connections for two-process * :ghissue:`3939`: minor checkpoint cleanup * :ghissue:`3955`: complete on % for magic in notebook * :ghissue:`3954`: all magics should be listed when completing on % diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst index 542bc07de81..448395c9f25 100644 --- a/docs/source/whatsnew/index.rst +++ b/docs/source/whatsnew/index.rst @@ -19,8 +19,9 @@ What's new in IPython .. only:: ipydev Development version in-progress features: - + .. toctree:: + :maxdepth: 1 development @@ -33,6 +34,7 @@ development work they do here in a user friendly format. .. toctree:: :maxdepth: 1 + version9 version8 github-stats-8 version7 @@ -61,13 +63,6 @@ development work they do here in a user friendly format. version0.8 .. - this makes a hidden toctree that keeps sphinx from complaining about - documents included nowhere when building docs for stable - We place it at the end as it will still be reachable via prev/next links. - -.. only:: ipystable - - .. toctree:: - :hidden: - - development + The development.rst is included in the ipydev toctree above. + For stable builds, it's automatically excluded by the only directive, + so no hidden toctree is needed here. diff --git a/docs/source/whatsnew/pr/end-shortcut-accept-suggestion.rst b/docs/source/whatsnew/pr/end-shortcut-accept-suggestion.rst deleted file mode 100644 index c04998e8f3f..00000000000 --- a/docs/source/whatsnew/pr/end-shortcut-accept-suggestion.rst +++ /dev/null @@ -1,7 +0,0 @@ -Added shortcut for accepting auto suggestion -============================================ - -Added End key shortcut for accepting auto-suggestion -This binding works in Vi mode too, provided -TerminalInteractiveShell.emacs_bindings_in_vi_insert_mode is set to be True. - diff --git a/docs/source/whatsnew/pr/faster-startup-round-2.rst b/docs/source/whatsnew/pr/faster-startup-round-2.rst new file mode 100644 index 00000000000..c904f0fd0fe --- /dev/null +++ b/docs/source/whatsnew/pr/faster-startup-round-2.rst @@ -0,0 +1,39 @@ +More startup work moved off the critical path +--------------------------------------------- + +A second pass over what IPython does before it can show a prompt, on top of the +lazy imports and lazy magic registration. Nothing here is visible in normal +use; it is all work that used to happen on every start and is now either +avoided or postponed until something actually needs it. + +* Resolving a theme's base pygments style no longer imports + :mod:`pygments.styles`, and with it the pygments plugin machinery, + :mod:`importlib.metadata` and :mod:`email`. Only the base style's ``styles`` + mapping was ever used, so for the builtin styles IPython's own themes are + based on the defining module is read directly. Styles that are not builtin -- + including any provided by a pygments plugin -- still resolve exactly as + before. + +* Detecting whether the terminal speaks the kitty graphics protocol no longer + imports psutil on Linux. The walk up the process tree needs each ancestor's + name and parent pid, and ``/proc//stat`` has both. macOS still uses + psutil. This one only ever showed up in an actual terminal: a headless + ``ipython -c ...`` stops at the ``isatty`` check before reaching it. Setting + ``IPYTHON_KITTY_GRAPHICS`` still skips detection entirely. + +* The prompt style is built the first time it is drawn rather than each of the + several times it is invalidated while a shell is being set up, and not at all + for a run that never draws a prompt. + +* More single-use imports moved to their use sites: :mod:`platform`, + :mod:`pprint`, :mod:`textwrap`, :mod:`html`, :mod:`mimetypes`, + :mod:`locale`, :mod:`glob` and :mod:`runpy`. The AST operator tables the + terminal shortcut filters need moved out of + :mod:`IPython.core.guarded_eval` into a module of their own, so evaluating + a shortcut's filter expression no longer imports the whole guarded + evaluation machinery (and ``typing_extensions``). They are still importable + from :mod:`IPython.core.guarded_eval`. + +Together this takes another ~13% off starting an interactive ``ipython`` in a +real terminal, ~9% off ``ipython -c pass``, and another ~43 modules off an +interactive start, on top of the previous rounds. diff --git a/docs/source/whatsnew/pr/kitty-graphics-force.rst b/docs/source/whatsnew/pr/kitty-graphics-force.rst new file mode 100644 index 00000000000..583fee3baab --- /dev/null +++ b/docs/source/whatsnew/pr/kitty-graphics-force.rst @@ -0,0 +1,20 @@ +Forcing kitty graphics support on or off +---------------------------------------- + +IPython decides whether the terminal understands the `kitty graphics protocol +`__ by walking up the +process tree looking for a known terminal emulator. That guess can be wrong -- +for instance inside ``tmux``, a container, or an emulator not on the list -- and +it is not free: it imports ``psutil`` and inspects the process tree on every +startup that has a tty. + +The ``IPYTHON_KITTY_GRAPHICS`` environment variable now states the answer +outright and skips the detection entirely:: + + IPYTHON_KITTY_GRAPHICS=1 ipython # my terminal does support it + IPYTHON_KITTY_GRAPHICS=0 ipython # it does not; do not even look + +Accepted values are ``1``/``true`` and ``0``/``false``, case-insensitive. +Leaving it unset, or setting it to the empty string, keeps the existing +autodetection. Any other value is ignored with a warning, so a typo cannot +silently turn graphics off. diff --git a/docs/source/whatsnew/pr/lazy-builtin-magics.rst b/docs/source/whatsnew/pr/lazy-builtin-magics.rst new file mode 100644 index 00000000000..234a94995df --- /dev/null +++ b/docs/source/whatsnew/pr/lazy-builtin-magics.rst @@ -0,0 +1,25 @@ +IPython's own magics are now declared lazily. Starting a shell used to import +all fifteen modules under :mod:`IPython.core.magics` and instantiate every +:class:`~IPython.core.magic.Magics` class in them, even though a session +typically uses a handful of magics at most. Only the magic *names* are now known +up front, from a hand-maintained table in ``IPython.core.magics._table``, and the +module implementing a magic is imported the first time it is looked up. This +takes roughly 25 ms off ``import IPython`` and shell startup. + +This reuses :attr:`~IPython.core.magic.MagicsManager.lazy_magics`, which already +existed for extensions, so third-party code can declare its magics the same way:: + + shell.magics_manager.register_lazy("my_magic", "my_package.magics:MyMagics") + +Its values may now be either ``"package.module"``, loaded as an IPython extension +as before, or ``"package.module:MagicsClass"``, imported and registered directly. +Unlike before, a magic declared through +:meth:`~IPython.core.magic.MagicsManager.register_lazy` shows up in ``%lsmagic`` +and in completion right away rather than only after its first use. + +Until a magic is loaded, ``shell.magics_manager.magics[kind][name]`` holds a +:class:`~IPython.core.magic.LazyMagic` placeholder. Calling it, or reading any +attribute of it, loads and delegates to the real magic, so existing code that +reaches into that table keeps working. A magics class only appears in +``shell.configurables`` once loaded; ``%config`` loads everything first, so the +list of configurable classes it shows is unchanged. diff --git a/docs/source/whatsnew/version0.10.rst b/docs/source/whatsnew/version0.10.rst index 1ffbaa2e465..d88132f0193 100644 --- a/docs/source/whatsnew/version0.10.rst +++ b/docs/source/whatsnew/version0.10.rst @@ -25,14 +25,14 @@ Highlights of this release: hence plots were blocking with GTK. Since this is the default matplotlib backend on Unix systems, this was a major annoyance for many users. Many thanks to Paul Ivanov for helping resolve this issue. - + - Fix IOError bug on Windows when used with -gthread. - Work robustly if $HOME is missing from environment. - Better POSIX support in ssh scripts (remove bash-specific idioms). - Improved support for non-ascii characters in log files. - Work correctly in environments where GTK can be imported but not started (such as a linux text console without X11). - + For this release we merged 24 commits, contributed by the following people (please let us know if we omitted your name and we'll gladly fix this in the notes for the future): @@ -250,7 +250,7 @@ New features * The developer guidelines in the documentation have been updated to explain our workflow using :command:`bzr` and Launchpad. - + * Fully refactored :command:`ipcluster` command line program for starting IPython clusters. This new version is a complete rewrite and 1) is fully cross platform (we now use Twisted's process management), 2) has much @@ -268,7 +268,7 @@ New features * sh profile: easy way to give 'title' to prompt: assign to variable '_prompt_title'. It looks like this:: - + [~]|1> _prompt_title = 'sudo!' sudo![~]|2> @@ -284,7 +284,7 @@ Bug fixes * Fix #368719, removed top-level debian/ directory to make the job of Debian packagers easier. - + * Fix #291143 by including man pages contributed by Stephan Peijnik from the Debian project. @@ -333,7 +333,7 @@ Bug fixes * Many other small bug fixes not listed here by number (see the bzr log for more info). - + Backwards incompatible changes ------------------------------ @@ -357,4 +357,3 @@ Backwards incompatible changes * Remove ipy_leo.py. You can use :command:`easy_install ipython-extension` to get it. (done to decouple it from ipython release cycle) - diff --git a/docs/source/whatsnew/version0.11.rst b/docs/source/whatsnew/version0.11.rst index fc35ae57a49..3fc9a127ca7 100644 --- a/docs/source/whatsnew/version0.11.rst +++ b/docs/source/whatsnew/version0.11.rst @@ -84,7 +84,7 @@ A quick summary of the major changes (see below for details): demonstration`__ of the features it provides. .. __: http://pirsquared.org/blog/2011/07/28/vim-ipython/ - + * **Integration into Microsoft Visual Studio**. Thanks to the work of the Microsoft `Python Tools for Visual Studio`__ team, this version of IPython has been integrated into Microsoft Visual Studio's Python tools open source @@ -114,7 +114,7 @@ A quick summary of the major changes (see below for details): * **Pasting of code with prompts**. IPython now intelligently strips out input prompts , be they plain Python ones (``>>>`` and ``...``) or IPython ones (``In [N]:`` and ``...:``). More details :ref:`here `. - + Authors and support ------------------- @@ -154,7 +154,7 @@ cycle from several institutions: .. __: http://modular.math.washington.edu/grants/compmath09 -- Microsoft's team working on `Python Tools for Visual Studio`__ developed the +- Microsoft's team working on `Python Tools for Visual Studio`__ developed the integratron of IPython into the Python plugin for Visual Studio 2010. .. __: http://pytools.codeplex.com @@ -200,14 +200,14 @@ requests and 285 regular issues (:ref:`a full list with links pull requests are a fantastic mechanism for reviewing code and building a shared ownership of the project, and we are making enthusiastic use of it. -.. Note:: +.. note:: This undercounts the number of issues closed in this development cycle, since we only moved to github for issue tracking in May 2010, but we have no way of collecting statistics on the number of issues closed in the old Launchpad bug tracker prior to that. - + .. _qtconsole_011: Qt Console @@ -309,7 +309,7 @@ be started by calling ``ipython qtconsole``. The protocol is :ref:`documented `. The parallel computing framework has also been rewritten using ZMQ. The -protocol is described :ref:`here `, and the code is in the +protocol is described in the ipyparallel documentation, and the code is in the new :mod:`IPython.parallel` module. .. _python3_011: @@ -414,7 +414,7 @@ Additional new features * The embedded shell has been refactored into a truly standalone subclass of :class:`InteractiveShell` called :class:`InteractiveShellEmbed`. All - embedding logic has been taken out of the base class and put into the + embedding logic has been taken out of the base class and put into the embedded subclass. * Added methods of :class:`~IPython.core.interactiveshell.InteractiveShell` to @@ -476,7 +476,7 @@ Additional new features resolution is done at a single point, when the parent :class:`~traitlets.HasTraitlets` is instantiated. -* :mod:`IPython.utils.ipstruct` has been refactored to be a subclass of +* :mod:`IPython.utils.ipstruct` has been refactored to be a subclass of dict. It also now has full docstrings and doctests. * Created a Traits like implementation in :mod:`traitlets`. This @@ -563,7 +563,7 @@ Backwards incompatible changes longer needed because of the new capabilities in :mod:`IPython.lib.inputhook`. -* New top-level sub-packages have been created: :mod:`IPython.core`, +* New top-level sub-packages have been created: :mod:`IPython.core`, :mod:`IPython.lib`, :mod:`IPython.utils`, :mod:`IPython.deathrow`, :mod:`IPython.quarantine`. All existing top-level modules have been moved to appropriate sub-packages. All internal import statements diff --git a/docs/source/whatsnew/version0.12.rst b/docs/source/whatsnew/version0.12.rst index 5d27504d4bc..ff060fa1fa8 100644 --- a/docs/source/whatsnew/version0.12.rst +++ b/docs/source/whatsnew/version0.12.rst @@ -87,11 +87,11 @@ You can see all the relevant options with:: and just like the Qt console, you can start the notebook server with pylab support by using:: - + ipython notebook --pylab for floating matplotlib windows or:: - + ipython notebook --pylab inline for plotting support with automatically inlined figures. Note that it is now @@ -117,7 +117,7 @@ have embedded an IPython kernel. This is also something that we have wanted for a long time, and which is a culmination (as a team effort) of the work started last year during the 2010 Google Summer of Code project. - + Tabbed QtConsole ~~~~~~~~~~~~~~~~ @@ -167,7 +167,7 @@ the area where PyPy still lags most behind. But for everyday interactive use at the terminal, with this release and PyPy 1.7, things seem to work quite well from our admittedly limited testing. - + Other important new features ---------------------------- @@ -287,7 +287,7 @@ Backwards incompatible changes The full path will still work, and is necessary for using custom launchers not in IPython's launcher module. - + Further, MPIExec launcher names are now prefixed with just MPI, to better match other batch launchers, and be generally more intuitive. The MPIExec names are deprecated, but continue to work. @@ -361,7 +361,7 @@ had commits from the following 45 contributors, a mix of new and regular names * Timo Paulssen * Valentin Haenel * Yaroslav Halchenko - + .. note:: This list was generated with the output of diff --git a/docs/source/whatsnew/version0.13.rst b/docs/source/whatsnew/version0.13.rst index 63140125a5a..3ecd18218ae 100644 --- a/docs/source/whatsnew/version0.13.rst +++ b/docs/source/whatsnew/version0.13.rst @@ -114,13 +114,13 @@ can merge it for full production use as soon as possible. JavaScript refactoring ~~~~~~~~~~~~~~~~~~~~~~ - + All the client-side JavaScript has been decoupled to ease reuse of parts of the machinery without having to build a full-blown notebook. This will make it much easier to communicate with an IPython kernel from existing web pages and to integrate single cells into other sites, without loading the full notebook document-like UI. :ghpull:`1711`. - + This refactoring also enables the possibility of writing dynamic javascript widgets that are returned from Python code and that present an interactive view to the user, with callbacks in Javascript executing calls to the Kernel. This @@ -131,7 +131,7 @@ An example of this capability has been provided as a proof of concept in parallel engines, acting as a mini-console for parallel debugging and introspection. - + Improved tooltips ~~~~~~~~~~~~~~~~~ @@ -163,16 +163,16 @@ many bug fixes and minor changes to add polish and robustness throughout: example: ``ipython notebook path/`` will automatically set ``path/`` as the notebook directory, and ``ipython notebook path/foo.ipynb`` will further start with the ``foo.ipynb`` notebook opened. :ghpull:`1686`. - + * If a notebook directory is specified with ``--notebook-dir`` (or with the corresponding configuration flag ``NotebookManager.notebook_dir``), all kernels start in this directory. * Fix codemirror clearing of cells with ``Ctrl-Z``; :ghpull:`1965`. - + * Text (markdown) cells now line wrap correctly in the notebook, making them much easier to edit :ghpull:`1330`. - + * PNG and JPEG figures returned from plots can be interactively resized in the notebook, by dragging them from their lower left corner. :ghpull:`1832`. @@ -189,12 +189,12 @@ many bug fixes and minor changes to add polish and robustness throughout: * Using ``Ctrl-S`` (or ``Cmd-S`` on a Mac) actually saves the notebook rather than providing the fairly useless browser html save dialog. :ghpull:`1334`. - + * Allow accessing local files from the notebook (in urls), by serving any local file as the url ``files/``. This makes it possible to, for example, embed local images in a notebook. :ghpull:`1211`. - + Cell magics ----------- @@ -209,19 +209,19 @@ simple functions without the need for object orientation. Please see the All builtin magics now exist in a few subclasses that group together related functionality, and the new :mod:`IPython.core.magics` package has been created to organize this into smaller files. - + This cleanup was the last major piece of deep refactoring needed from the original 2001 codebase. - + We have also introduced a new type of magic function, prefixed with `%%` instead of `%`, which operates at the whole-cell level. A cell magic receives two arguments: the line it is called on (like a line magic) and the body of the cell below it. - + Cell magics are most natural in the notebook, but they also work in the terminal and qt console, with the usual approach of using a blank line to signal cell termination. - + For example, to time the execution of several statements:: %%timeit x = 0 # setup @@ -242,32 +242,32 @@ interpreter installed: * ``%%!``: run cell body with the underlying OS shell; this is similar to prefixing every line in the cell with ``!``. - + * ``%%bash``: run cell body under bash. - + * ``%%capture``: capture the output of the code in the cell (and stderr as well). Useful to run codes that produce too much output that you don't even want scrolled. - + * ``%%file``: save cell body as a file. - + * ``%%perl``: run cell body using Perl. - + * ``%%prun``: run cell body with profiler (cell extension of ``%prun``). - + * ``%%python3``: run cell body using Python 3. - + * ``%%ruby``: run cell body using Ruby. - + * ``%%script``: run cell body with the script specified in the first line. - + * ``%%sh``: run cell body using sh. - + * ``%%sx``: run cell with system shell and capture process output (cell extension of ``%sx``). - + * ``%%system``: run cell with system shell (``%%!`` is an alias to this). - + * ``%%timeit``: time the execution of the cell (extension of ``%timeit``). This is what some of the script-related magics look like in action: @@ -277,7 +277,7 @@ This is what some of the script-related magics look like in action: :alt: Cluster management from the notebook dashboard :align: center :target: ../_images/ipy_013_notebook_script_cells.png - + In addition, we have also a number of :ref:`extensions ` that provide specialized magics. These typically require additional software to run and must be manually loaded via ``%load_ext ``, but are @@ -359,7 +359,7 @@ or select a completion with the arrow keys (:ghpull:`1851`). In the notebook, completions are now sourced both from object introspection and analysis of surrounding code, so limited completions can be offered for -variables defined in the current cell, or while the kernel is busy +variables defined in the current cell, or while the kernel is busy (:ghpull:`1711`). @@ -390,13 +390,13 @@ polish has gone into it, here are a few highlights: * Allow for restarting kernels without clearing the qtconsole, while leaving a visible indication that the kernel has restarted. :ghpull:`1681`. - + * Allow the native display of jpeg images in the qtconsole. :ghpull:`1643`. .. _spyder: https://code.google.com/p/spyderlib - + Parallel -------- @@ -433,25 +433,25 @@ modes, and in cell mode finer control has been added about how to collate output from multiple engines. :ghpull:`1768`. There have also been incremental improvements to the SSH launchers: - + * add to_send/fetch steps for moving connection files around. - + * add SSHProxyEngineSetLauncher, for invoking to `ipcluster engines` on a remote host. This can be used to start a set of engines via PBS/SGE/MPI *remotely*. - + This makes the SSHLauncher usable on machines without shared filesystems. A number of 'sugar' methods/properties were added to AsyncResult that are quite useful (:ghpull:`1548`) for everday work: - + * ``ar.wall_time`` = received - submitted * ``ar.serial_time`` = sum of serial computation time * ``ar.elapsed`` = time since submission (wall_time if done) * ``ar.progress`` = (int) number of sub-tasks that have completed * ``len(ar)`` = # of tasks * ``ar.wait_interactive()``: prints progress - + Added :meth:`.Client.spin_thread` / :meth:`~.Client.stop_spin_thread` for running spin in a background thread, to keep zmq queue clear. This can be used to ensure that timing information is as accurate as possible (at the cost of @@ -494,7 +494,7 @@ consequences: %%px %%R ... R code goes here - + * It is possible to embed not only an interactive shell with the :func:`IPython.embed` call as always, but now you can also embed a *kernel* with :func:`IPython.embed_kernel()`. Embedding an IPython kernel in an @@ -509,7 +509,7 @@ In addition, having a single core object through our entire architecture also makes the project conceptually cleaner, easier to maintain and more robust. This took a lot of work to get in place, but we are thrilled to have this major piece of architecture finally where we'd always wanted it to be. - + Official Public API ------------------- @@ -532,28 +532,28 @@ instructions to install them on Mac OSX. This is a first draft of our icons, and we encourage contributions from users with graphic talent to improve them in the future. - + New top-level `locate` command ------------------------------ Add `locate` entry points; these would be useful for quickly locating IPython directories and profiles from other (non-Python) applications. :ghpull:`1762`. - + Examples:: - + $> ipython locate /Users/me/.ipython - + $> ipython locate profile foo /Users/me/.ipython/profile_foo - + $> ipython locate profile /Users/me/.ipython/profile_default - + $> ipython locate profile dne [ProfileLocate] Profile u'dne' not found. - + Other new features and improvements ----------------------------------- @@ -617,13 +617,13 @@ Other new features and improvements * ``clear_output`` improvements, which allow things like progress bars and other simple animations to work well in the notebook (:ghpull:`1563`): - + * `clear_output()` clears the line, even in terminal IPython, the QtConsole and plain Python as well, by printing `\r` to streams. - + * `clear_output()` avoids the flicker in the notebook by adding a delay, and firing immediately upon the next actual display message. - + * `display_javascript` hides its `output_area` element, so using display to run a bunch of javascript doesn't result in ever-growing vertical space. @@ -631,7 +631,7 @@ Other new features and improvements supplant proper installation (as users should do), it helps ad-hoc calling of IPython from inside a virtualenv. :ghpull:`1388`. - + Major Bugs fixed ---------------- diff --git a/docs/source/whatsnew/version0.8.rst b/docs/source/whatsnew/version0.8.rst index 38d5ed06b29..34b3b3b4c42 100644 --- a/docs/source/whatsnew/version0.8.rst +++ b/docs/source/whatsnew/version0.8.rst @@ -12,23 +12,22 @@ across several platforms. Release 0.8.3 ============= - + * pydb is now disabled by default (due to %run -d problems). You can enable it by passing -pydb command line argument to IPython. Note that setting it in config file won't work. - + Release 0.8.2 ============= -* %pushd/%popd behave differently; now "pushd /foo" pushes CURRENT directory - and jumps to /foo. The current behaviour is closer to the documented +* %pushd/%popd behave differently; now "pushd /foo" pushes CURRENT directory + and jumps to /foo. The current behaviour is closer to the documented behaviour, and should not trip anyone. - + Older releases ============== Changes in earlier releases of IPython are described in the older file ``ChangeLog``. Please refer to this document for details. - diff --git a/docs/source/whatsnew/version0.9.rst b/docs/source/whatsnew/version0.9.rst index 81ebba1cac8..339046c46bf 100644 --- a/docs/source/whatsnew/version0.9.rst +++ b/docs/source/whatsnew/version0.9.rst @@ -81,11 +81,11 @@ New features :mod:`IPython.kernel`, :mod:`IPython.kernel.core`, :mod:`traitlets.config`, :mod:`IPython.tools` and :mod:`IPython.testing`. -* As part of merging in the `ipython1-dev` stuff, the `setup.py` script and +* As part of merging in the `ipython1-dev` stuff, the ``setup.py`` script and friends have been completely refactored. Now we are checking for dependencies using the approach that matplotlib uses. -* The documentation has been completely reorganized to accept the +* The documentation has been completely reorganized to accept the documentation from `ipython1-dev`. * We have switched to using Foolscap for all of our network protocols in @@ -114,7 +114,7 @@ New features Last part of dir name is checked first. If no matches for that are found, look at the whole path. - + Bug fixes --------- @@ -135,7 +135,7 @@ Bug fixes * Greedy ``cd`` completion has been disabled again (it was enabled in 0.8.4) as it caused problems on certain platforms. - + Backwards incompatible changes ------------------------------ @@ -161,16 +161,16 @@ Backwards incompatible changes `'basic'` to `'b'`. * IPython has a larger set of dependencies if you want all of its capabilities. - See the `setup.py` script for details. + See the ``setup.py`` script for details. -* The constructors for :class:`IPython.kernel.client.MultiEngineClient` and +* The constructors for :class:`IPython.kernel.client.MultiEngineClient` and :class:`IPython.kernel.client.TaskClient` no longer take the (ip,port) tuple. Instead they take the filename of a file that contains the FURL for that client. If the FURL file is in your IPYTHONDIR, it will be found automatically and the constructor can be left empty. -* The asynchronous clients in :mod:`IPython.kernel.asyncclient` are now created - using the factory functions :func:`get_multiengine_client` and +* The asynchronous clients in :mod:`IPython.kernel.asyncclient` are now created + using the factory functions :func:`get_multiengine_client` and :func:`get_task_client`. These return a `Deferred` to the actual client. * The command line options to `ipcontroller` and `ipengine` have changed to @@ -197,20 +197,20 @@ New features * Initial draft of a process daemon in :mod:`ipython1.daemon`. This has not been merged into IPython and is still in `ipython1-dev`. - + * The ``TaskController`` now has methods for getting the queue status. * The ``TaskResult`` objects not have information about how long the task took to run. - -* We are attaching additional attributes to exceptions ``(_ipython_*)`` that + +* We are attaching additional attributes to exceptions ``(_ipython_*)`` that we use to carry additional info around. - + * New top-level module :mod:`asyncclient` that has asynchronous versions (that return deferreds) of the client classes. This is designed to users who want to run their own Twisted reactor. - -* All the clients in :mod:`client` are now based on Twisted. This is done by + +* All the clients in :mod:`client` are now based on Twisted. This is done by running the Twisted reactor in a separate thread and using the :func:`blockingCallFromThread` function that is in recent versions of Twisted. @@ -221,12 +221,12 @@ New features * Gather/scatter are now implemented in the client to reduce the work load of the controller and improve performance. -* Complete rewrite of the IPython docuementation. All of the documentation +* Complete rewrite of the IPython documentation. All of the documentation from the IPython website has been moved into docs/source as restructured - text documents. PDF and HTML documentation are being generated using + text documents. PDF and HTML documentation are being generated using Sphinx. -* New developer oriented documentation: development guidelines and roadmap. +* New developer oriented documentation: development guidelines and roadmap. * Traditional ``ChangeLog`` has been changed to a more useful ``changes.txt`` file that is organized by release and is meant to provide something more @@ -237,14 +237,14 @@ Bug fixes * Created a proper ``MANIFEST.in`` file to create source distributions. -* Fixed a bug in the ``MultiEngine`` interface. Previously, multi-engine - actions were being collected with a :class:`DeferredList` with - ``fireononeerrback=1``. This meant that methods were returning - before all engines had given their results. This was causing extremely odd - bugs in certain cases. To fix this problem, we have 1) set - ``fireononeerrback=0`` to make sure all results (or exceptions) are in - before returning and 2) introduced a :exc:`CompositeError` exception - that wraps all of the engine exceptions. This is a huge change as it means +* Fixed a bug in the ``MultiEngine`` interface. Previously, multi-engine + actions were being collected with a :class:`DeferredList` with + ``fireononeerrback=1``. This meant that methods were returning + before all engines had given their results. This was causing extremely odd + bugs in certain cases. To fix this problem, we have 1) set + ``fireononeerrback=0`` to make sure all results (or exceptions) are in + before returning and 2) introduced a :exc:`CompositeError` exception + that wraps all of the engine exceptions. This is a huge change as it means that users will have to catch :exc:`CompositeError` rather than the actual exception. @@ -264,12 +264,12 @@ Backwards incompatible changes argument that defaults to ``'all'``. * The :attr:`MultiEngineClient.magicTargets` has been renamed to - :attr:`MultiEngineClient.targets`. + :attr:`MultiEngineClient.targets`. * All methods in the MultiEngine interface now accept the optional keyword argument ``block``. -* Renamed :class:`RemoteController` to :class:`MultiEngineClient` and +* Renamed :class:`RemoteController` to :class:`MultiEngineClient` and :class:`TaskController` to :class:`TaskClient`. * Renamed the top-level module from :mod:`api` to :mod:`client`. @@ -278,6 +278,5 @@ Backwards incompatible changes exception that wraps the user's exceptions, rather than just raising the raw user's exception. -* Changed the ``setupNS`` and ``resultNames`` in the ``Task`` class to ``push`` +* Changed the ``setupNS`` and ``resultNames`` in the ``Task`` class to ``push`` and ``pull``. - diff --git a/docs/source/whatsnew/version1.0.rst b/docs/source/whatsnew/version1.0.rst index 3e8afdb1dfc..6b2b6e544ee 100644 --- a/docs/source/whatsnew/version1.0.rst +++ b/docs/source/whatsnew/version1.0.rst @@ -72,7 +72,7 @@ We also have added: Which is a *library* function for getting the current IPython instance, -and will return ``None`` if no IPython instance is running. +and will return :py:data:`None` if no IPython instance is running. This is the official way to check whether your code is called from inside an IPython session. If you want to check for IPython without unnecessarily importing IPython, use this function: @@ -135,7 +135,7 @@ Backwards incompatible changes - For all kernel managers, the ``sub_channel`` attribute has been renamed to ``iopub_channel``. - Users on Python versions before 2.6.6, 2.7.1 or 3.2 will now need to call - :func:`IPython.utils.doctestreload.doctest_reload` to make doctests run + :func:`IPython.utils.doctestreload.doctest_reload` to make doctests run correctly inside IPython. Python releases since those versions are unaffected. For details, see :ghpull:`3068` and `Python issue 8048 `_. - The ``InteractiveShell.cache_main_mod()`` method has been removed, and @@ -275,7 +275,7 @@ whether this tradeoff is appropriate for their application. Parallel -------- -IPython.parallel has had some refactoring as well. +IPython.parallel has had some refactoring as well. There are many improvements and fixes, but these are the major changes: - Connections have been simplified. All ports and the serialization in use @@ -299,4 +299,3 @@ Various fixes, including improved performance with lots of text output, and better drag and drop support. The initial window size of the qtconsole is now configurable via ``IPythonWidget.width`` and ``IPythonWidget.height``. - diff --git a/docs/source/whatsnew/version2.0.rst b/docs/source/whatsnew/version2.0.rst index abdbaedbd04..3aca6a62b1e 100644 --- a/docs/source/whatsnew/version2.0.rst +++ b/docs/source/whatsnew/version2.0.rst @@ -175,8 +175,6 @@ IPython previously supported Python 3 by running 2to3 during setup. We have now switched to a single codebase which runs natively on Python 2.7 and 3.3. -For notes on how to maintain this, see :doc:`/development/pycompat`. - Selecting matplotlib figure formats ----------------------------------- @@ -235,8 +233,7 @@ New IPython console lexer ------------------------- The IPython console lexer has been rewritten and now supports tracebacks -and customized input/output prompts. See the :ref:`new lexer docs ` -for details. +and customized input/output prompts. DisplayFormatter changes ------------------------ diff --git a/docs/source/whatsnew/version3.rst b/docs/source/whatsnew/version3.rst index f230943b5ae..e1dac6b0056 100644 --- a/docs/source/whatsnew/version3.rst +++ b/docs/source/whatsnew/version3.rst @@ -281,7 +281,7 @@ Backwards incompatible changes * The notebook format has been updated from version 3 to version 4. Read-only support for v4 notebooks has been backported to IPython 2.4. Notable changes: - + * heading cells are removed in favor or markdown headings * notebook outputs and output messages are more consistent with each other * use :func:`IPython.nbformat.read` and :func:`~IPython.nbformat.write` @@ -289,16 +289,16 @@ Backwards incompatible changes instead of the deprecated :mod:`IPython.nbformat.current` APIs. You can downgrade a notebook to v3 via ``nbconvert``:: - + ipython nbconvert --to notebook --nbformat 3 - + which will create :file:`notebook.v3.ipynb`, a copy of the notebook in v3 format. * :func:`IPython.core.oinspect.getsource` call specification has changed: * `oname` keyword argument has been added for property source formatting - * `is_binary` keyword argument has been dropped, passing ``True`` had - previously short-circuited the function to return ``None`` unconditionally + * `is_binary` keyword argument has been dropped, passing :py:data:`True` had + previously short-circuited the function to return :py:data:`None` unconditionally * Removed the octavemagic extension: it is now available as ``oct2py.ipython``. diff --git a/docs/source/whatsnew/version3_widget_migration.rst b/docs/source/whatsnew/version3_widget_migration.rst index 1daeb7e91b5..869f6a2f56b 100644 --- a/docs/source/whatsnew/version3_widget_migration.rst +++ b/docs/source/whatsnew/version3_widget_migration.rst @@ -11,7 +11,7 @@ Upgrading Notebooks "Widget" suffix was removed from the end of the class name. i.e. ``ButtonWidget`` is now ``Button``. 3. ``ContainerWidget`` was renamed to ``Box``. -4. ``PopupWidget`` was removed from IPython, because bootstrapjs was +4. ``PopupWidget`` was removed from IPython, because bootstrapjs was problematic (creates global variables, etc.). If you use the ``PopupWidget``, try using a ``Box`` widget instead. If your notebook can't live without the popup functionality, subclass the ``Box`` diff --git a/docs/source/whatsnew/version4.rst b/docs/source/whatsnew/version4.rst index 6150a8668cd..c4fbd6176d1 100644 --- a/docs/source/whatsnew/version4.rst +++ b/docs/source/whatsnew/version4.rst @@ -81,4 +81,3 @@ IPython highlights: `reload` into the interactive namespace have been deprecated, and will be removed in future versions. You should now explicitly import `reload` from `IPython.lib.deepreload` to use it. - diff --git a/docs/source/whatsnew/version5.rst b/docs/source/whatsnew/version5.rst index 61b6ca0aeb3..2e96f1f46a3 100644 --- a/docs/source/whatsnew/version5.rst +++ b/docs/source/whatsnew/version5.rst @@ -101,7 +101,7 @@ series which is Python 3 only. It backports most of the new exposed API additions made in IPython 6.0 and 6.1 and avoid having to write conditional logics depending of the version of IPython. -Please upgrade to pip 9 or greater before upgrading IPython. +Please upgrade to pip 9 or greater before upgrading IPython. Failing to do so on Python 2 may lead to a broken IPython install. Configurable TerminalInteractiveShell @@ -121,7 +121,7 @@ Define ``_repr_mimebundle_`` Object can now define `_repr_mimebundle_` in place of multiple `_repr_*_` methods and return a full mimebundle. This greatly simplify many implementation and allow to publish custom mimetypes (like geojson, plotly, dataframes....). -See the ``Custom Display Logic`` example notebook for more informations. +See the ``Custom Display Logic`` example notebook for more information. Execution Heuristics -------------------- @@ -160,10 +160,10 @@ Miscs * ``_mp_main_`` is not reloaded which fixes issues with multiprocessing. :ghpull:`10523` * Use user colorscheme in Pdb as well :ghpull:`10479` -* Faster shutdown. :ghpull:`10408` +* Faster shutdown. :ghpull:`10408` * Fix a crash in reverse search. :ghpull:`10371` * added ``Completer.backslash_combining_completions`` boolean option to - deactivate backslash-tab completion that may conflict with windows path. + deactivate backslash-tab completion that may conflict with windows path. IPython 5.3 =========== @@ -224,7 +224,7 @@ Released on January 29th, 2017. Remarkable changes and fixes: :ghpull:`10050` * Fixes OS X event loop issues at startup, :ghpull:`10150` * Deprecate the ``%autoindent`` magic. :ghpull:`10176` -* Emit a :any:`DeprecationWarning` when setting the deprecated +* Emit a :py:exc:`DeprecationWarning` when setting the deprecated ``limit_to_all`` option of the completer. :ghpull:`10198` * The :cellmagic:`capture` magic can now capture the result of a cell (from an expression on the last line), as well as printed and displayed output. diff --git a/docs/source/whatsnew/version6.rst b/docs/source/whatsnew/version6.rst index cb3b42dd2f4..153efe9db08 100644 --- a/docs/source/whatsnew/version6.rst +++ b/docs/source/whatsnew/version6.rst @@ -22,7 +22,7 @@ IPython 6.4.0 Everything new in :ref:`IPython 5.7 ` * Fix display object not emitting metadata :ghpull:`11106` -* Comments failing Jedi test :ghpull:`11110` +* Comments failing Jedi test :ghpull:`11110` .. _whatsnew631: @@ -199,7 +199,7 @@ You should be able to update by using: .. note:: If your pip version is greater than or equal to pip 9.0.1 you will automatically get - the most recent version of IPython compatible with your system: on Python 2 you + the most recent version of IPython compatible with your system: on Python 2 you will get the latest IPython 5.x bugfix, while in Python 3 you will get the latest 6.x stable version. @@ -210,8 +210,8 @@ The completer Completion API has seen an overhaul, and the new completer has plenty of improvements both from the end users of terminal IPython and for consumers of the API. -This new API is capable of pulling completions from :any:`jedi`, thus allowing -type inference on non-executed code. If :any:`jedi` is installed, completions like +This new API is capable of pulling completions from :mod:`jedi`, thus allowing +type inference on non-executed code. If :mod:`jedi` is installed, completions like the following are now possible without code evaluation: >>> data = ['Number of users', 123_456] @@ -220,7 +220,7 @@ the following are now possible without code evaluation: That is to say, IPython is now capable of inferring that `data[0]` is a string, and will suggest completions like `.capitalize`. The completion power of IPython will increase with new Jedi releases, and a number of bug-fixes and more completions -are already available on the development version of :any:`jedi` if you are curious. +are already available on the development version of :mod:`jedi` if you are curious. With the help of prompt toolkit, types of completions can be shown in the completer interface: @@ -244,7 +244,7 @@ Extra patches and updates will be needed to the :mod:`ipykernel` package for this feature to be available to other clients like Jupyter Notebook, Lab, Nteract, Hydrogen... -The use of Jedi should be barely noticeable on recent machines, but +The use of Jedi should be barely noticeable on recent machines, but can be slower on older ones. To tweak the performance, the amount of time given to Jedi to compute type inference can be adjusted with ``c.IPCompleter.jedi_compute_type_timeout``. The objects whose type were not @@ -280,7 +280,7 @@ of advantages. Most of the newly written code make use of `optional function typ annotation `_ leading to clearer code and better documentation. -The total size of the repository has also decreased by about 1500 lines (for the +The total size of the repository has also decreased by about 1500 lines (for the first time excluding the big split for 4.0). The decrease is potentially a bit more for the sour as some documents like this one are append only and are about 300 lines long. @@ -335,7 +335,7 @@ Functions Deprecated in 6.x Development cycle - ``IPython.utils.warn`` was deprecated in IPython 4.0, and has now been removed. - instead of ``IPython.utils.warn`` inbuilt :any:`warnings` module is used. + instead of ``IPython.utils.warn`` inbuilt :mod:`warnings` module is used. - The function `IPython.core.oinspect.py:call_tip` is unused, was marked as diff --git a/docs/source/whatsnew/version7.rst b/docs/source/whatsnew/version7.rst index 4dea95d6c78..b3920cae09e 100644 --- a/docs/source/whatsnew/version7.rst +++ b/docs/source/whatsnew/version7.rst @@ -2,6 +2,26 @@ 7.x Series ============ +.. _version 7.34: + +IPython 7.34 +============ + +This version contains a single fix: fix uncaught BdbQuit exceptions on ipdb +exit :ghpull:`13668` + + +.. _version 7.33: + +IPython 7.33 +============ + + - Allow IPython hooks to receive current cell ids when frontend support it. See + :ghpull:`13600` + + - ``?`` does not trigger the insertion of a new cell anymore as most frontend + allow proper multiline edition. :ghpull:`13625` + .. _version 7.32: @@ -171,7 +191,7 @@ Virtualenv handling fixes: - init_virtualenv now uses Pathlib :ghpull:`12548` - Fix Improper path comparison of virtualenv directories :ghpull:`13140` - - Fix virtual environment user warning for lower case pathes :ghpull:`13094` + - Fix virtual environment user warning for lower case paths :ghpull:`13094` - Adapt to all sorts of drive names for cygwin :ghpull:`13153` New Features: @@ -221,6 +241,7 @@ such that it allows autoplay. the HTML allowing it. It also could get blocked by some browser extensions. Try it out! + :: In [1]: from IPython.display import YouTubeVideo @@ -289,7 +310,7 @@ Of particular interest are the following Pull-requests: Pastebin magic expiry days option --------------------------------- -The Pastebin magic now has ``-e`` option to determine +The Pastebin magic now has ``-e`` option to determine the number of days for paste expiration. For example the paste that created with ``%pastebin -e 20 1`` magic will be available for next 20 days. @@ -527,7 +548,7 @@ information in ipdb using "context" command. :ghpull:`12826` Other notable changes in IPython 7.21 ------------------------------------- -- Fix some issues on new osx-arm64 :ghpull:`12804`, :ghpull:`12807`. +- Fix some issues on new osx-arm64 :ghpull:`12804`, :ghpull:`12807`. - Compatibility with Xeus-Python for debugger protocol, :ghpull:`12809` - Misc docs fixes for compatibility and uniformity with Numpydoc. :ghpull:`12824` @@ -568,7 +589,7 @@ issues and pushing 8.0 forward. Here are thus some of the changes for IPython 7.20. - Support for PyQt5 >= 5.11 :ghpull:`12715` - - ``%reset`` remove imports more agressively :ghpull:`12718` + - ``%reset`` remove imports more aggressively :ghpull:`12718` - fix the ``%conda`` magic :ghpull:`12739` - compatibility with Jedi 0.18, and bump minimum Jedi version. :ghpull:`12793` @@ -847,11 +868,11 @@ IPython. Increase Tab Completion Menu Height ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In terminal IPython it is possible to increase the hight of the tab-completion +In terminal IPython it is possible to increase the height of the tab-completion menu. To do so set the value of :configtrait:`TerminalInteractiveShell.space_for_menu`, this will reserve more space at the bottom of the screen for various kind of menus in IPython including -tab completion and searching in history. +tab completion and searching in history. Autoformat Code in the terminal ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -868,7 +889,7 @@ IPython 7.14 ============ IPython 7.14 is a minor release that fix a couple of bugs and prepare -compatibility with new or future versions of some libraries. +compatibility with new or future versions of some libraries. Important changes: ------------------ @@ -904,10 +925,10 @@ and should already been imported from ``IPython.display`` by users and external libraries. Trying to import those from ``IPython.core.display`` is still possible but will trigger a deprecation warning in later versions of IPython and will become errors in the -future. +future. This will simplify compatibility with other Python kernels (like Xeus-Python), -and simplify code base. +and simplify code base. @@ -1029,7 +1050,7 @@ IPython has decided to follow the informational `NEP 29 policy as to which version of (C)Python and NumPy are supported. We thus dropped support for Python 3.5, and cleaned up a number of code path -that were Python-version dependant. If you are on 3.5 or earlier pip should +that were Python-version dependent. If you are on 3.5 or earlier pip should automatically give you the latest compatible version of IPython so you do not need to pin to a given version. @@ -1096,7 +1117,7 @@ progressively enable these features by default in the next few releases, and contribution is welcomed. We welcome any feedback on the API. See :ref:`shell_mimerenderer` for more -informations. +information. This is originally based on work form in :ghpull:`10610` from @stephanh42 started over two years ago, and still a lot need to be done. @@ -1348,10 +1369,9 @@ Miscellaneous IPython 7.3.0 ============= -.. _whatsnew720: IPython 7.3.0 bring several bug fixes and small improvements that you will -described bellow. +described below. The biggest change to this release is the implementation of the ``%conda`` and ``%pip`` magics, that will attempt to install packages in the **current @@ -1361,7 +1381,7 @@ into remote environment. Installing using pip/conda from the command line is still the prefer method. The ``%pip`` magic was already present, but was only printing a warning; now it -will actually forward commands to pip. +will actually forward commands to pip. Misc bug fixes and improvements: @@ -1373,6 +1393,8 @@ Misc bug fixes and improvements: - Re-initialize posix aliases after a ``%reset`` :ghpull:`11528` - Allow the IPython command line to run ``*.ipynb`` files :ghpull:`11529` +.. _whatsnew720: + IPython 7.2.0 ============= @@ -1403,8 +1425,7 @@ and we're now proud to have code contributed by Chris in IPython. OSMagics.cd_force_quiet configuration option -------------------------------------------- -You can set this option to force the %cd magic to behave as if ``-q`` was passed: -:: +You can set this option to force the %cd magic to behave as if ``-q`` was passed:: In [1]: cd / / @@ -1435,7 +1456,7 @@ unwillingly relying on a bug in CPython. New Core Dev: - - We welcome Jonathan Slenders to the commiters. Jonathan has done a fantastic + - We welcome Jonathan Slenders to the committers. Jonathan has done a fantastic work on prompt_toolkit, and we'd like to recognise his impact by giving him commit rights. :ghissue:`11397` @@ -1584,10 +1605,10 @@ Make sure you have pip > 9.0 before upgrading. You should be able to update by r pip install ipython --upgrade --pre -Or, if you have conda installed: +Or, if you have conda installed: .. code:: - + conda install ipython @@ -1705,7 +1726,7 @@ Autoreload Improvement The magic :magic:`%autoreload 2 ` now captures new methods added to classes. Earlier, only methods existing as of the initial import were being -tracked and updated. +tracked and updated. This new feature helps dual environment development - Jupyter+IDE - where the code gradually moves from notebook cells to package files as it gets @@ -1768,7 +1789,7 @@ in future versions: - ``IPython.utils.io.raw_print_err`` - ``IPython.utils.io.raw_print`` - + Backwards incompatible changes ------------------------------ diff --git a/docs/source/whatsnew/version8.rst b/docs/source/whatsnew/version8.rst index 6ad4da1855a..17b53cb93c6 100644 --- a/docs/source/whatsnew/version8.rst +++ b/docs/source/whatsnew/version8.rst @@ -2,27 +2,1589 @@ 8.x Series ============ +.. _version 8.37: + +IPython 8.37 +============ + +This release includes fixes for the tab completer and LLM completer backported from IPython 9.4: + +- :ghpull:`14910` Eliminate startup delay when LLM completion provider is configured +- :ghpull:`14898` Fix attribute completion for expressions with comparison operators + +.. _version 8.36: + +IPython 8.36 +============ + +This is a small release with minor changes in the context passed to the LLM completion +provider and a fix for interruption of execution magics: + +- :ghpull:`14890` Fixed interruption of ``%%time`` and ``%%debug`` magics +- :ghpull:`14877` Removed spurious empty lines from ``prefix`` passed to LLM, and separated part after cursor into the ``suffix`` + +.. _version 8.35: + +IPython 8.35 +============ + +This small early April release includes a few backports of bug fixes for tab and LLM completions: + +- :ghpull:`14838` Fixed tab-completion of global variables in lines with a dot when jedi is off +- :ghpull:`14846` Fixed LLM request number always being set to zero and removed spurious logging +- :ghpull:`14851` Passes current input history to LLMs + + +.. _version 8.34: + +IPython 8.34 +============ + +This tiny beginning of March release included two bug fixes: + +- :ghpull:`14823` Fixed right arrow incorrectly accepting invisible auto-suggestions +- :ghpull:`14828` Fixed Qt backend crash + +along with a backport of improved documentation and configurability of LLM completions. + +.. _version 8.33: + +IPython 8.33 +============ + +This small end of February release included a few backports of bug fixes and minor enhancements: + +- :ghpull:`14717` Fixed auto-suggestion on Prompt Toolkit < 3.0.49 +- :ghpull:`14738` Fixed Python 3.13 compatibility of ``local_ns`` +- :ghpull:`14700` Improved Qt object management and performance +- :ghpull:`14790` Better documentation and configurability of LLM completions + + +.. _version 8.32: + +IPython 8.32 +============ + +Medium release of IPython for this end of January and this new year 2025. +This is now a different branch than the main branch, and will only accumulate +bugfixes and small improvements and requested backports, while 9.0 forges ahead. + + +We'll note 4 bugfixes and an and unstable preview feature. + +- :ghpull:`14640` Fixes an error were a warning about virtualenvs was incorrectly triggered. + +- :ghpull:`14684` Fixes an issue on Python 3.12+ with post mortem debugging. +- :ghpull:`14693` Fixes a bug where magics were ignoring SIGINT +- :ghpull:`14695` Fixes an issue where magics would not display all subprocess output. + + +As a preview feature, look into the ``examples`` folder on how to configure +autosuggestion using a large language model. This is not yet ready for +production use, has only partial documentation and can change without warning, +but should allow you to hook in a Jupyter-ai LLM provider to suggest code in the +CLI (currently only via a keyboard shortcut). See :ghpull:`14623` for more details +until further documentation is available in 9.0. + + +As usual you can find the full list of PRs on GitHub under `the 8.32 +`__ milestone. + +For something completely different +---------------------------------- + +`Dora Rudolfine Richter `__ +1892–1966 was a German trans woman and the first known person to undergo +complete male-to-female gender-affirming surgery. After fleeing Nazi Germany, +she lived in Czechoslovakia where she obtained her full legal name change in +April 1934. She moved back to Germany in 1946 with the expulsion of Germans from +Czechoslovakia where she lived until her death at the age of 74 in April 1966. + +Thanks +------ + +Thanks to everyone who helped with the 8.32 release and working toward 9.0. + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries, in particular the work around LLM +integration. + +.. _version 8.31: + +IPython 8.31 +============ + +Small release for this end of December; This release contains only two notable changes: + + - :ghpull:`14594` Fix completion in tuples, where the completion was + suggesting tuples methods instead of methods and attributes of the current + element. + - :ghpull:`14598` Fix pdb issue with Python 3.13.1, this fix is not perfect + (see :ghissue:`14620`) but should be sufficient for now. + + +As usual you can find the full list of PRs on GitHub under `the 8.31 +`__ milestone. + + +Road to 9.0 +----------- + +The current main branch is now on it's way to be 9.0; do not expect many new +features but a large codebase refactor, and cleanup with many deprecated code +removed, and more aggressive codestyle enforcement. + +For something completely different +---------------------------------- + +`Emmy Noether `__ was a German +mathematician who made groundbreaking contributions to abstract algebra and +theoretical physics. Her work on Noether's theorem, which describes the +relationship between symmetries and conservation laws, has had a profound impact +on the development of modern physics. Noether's work was largely overlooked +during her lifetime, but her legacy as one of the most important mathematicians +of the 20th century has been recognized and celebrated in recent years. + +Thanks +------ + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.30: + +IPython 8.30 +============ + +Small release for this end of november; + + - :ghpull:`14579` improve the documentatation for custom IPython formatters, and how + you can register formatters for custom mime types. + - :ghpull:`14580` fix a bug in which commands that were not assigned a shortcut + could not be assigned one. + - :ghpull:`12690` fix a bug in which a single ``/`` on an empty line would not be + an error. This is due to the ``autocall`` behavior that we are thinking of + deprecating. + +The rest of the PRs are mostly maintenance and documentation improvements. + +As usual you can find the full list of PRs on GitHub under `the 8.30 +`__ milestone. + + +For something completely different +---------------------------------- + +`Ada Lovelace `__ is considered the +first computer programmer. In the 1840s, she wrote what is recognized as the +first algorithm intended to be processed by a machine - Charles Babbage's +proposed Analytical Engine. Her notes included what would today be called a +computer program, making her the first programmer in history. She also uniquely +understood that computers could go beyond mere calculation and could be used to +create music or art - a visionary insight that was far ahead of her time. +Despite living in an era when women had limited access to scientific education, +she made groundbreaking contributions that laid the foundation for modern +computing. + +Thanks +------ + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.29: + +IPython 8.29 +============ + +Medium release for this end of october; + + - Misc Python 3.13 compatibility :ghpull:`14536`, :ghpull:`14559` + - Add a ``uv`` line magic :ghpull:`14537` + - Add support for WEBP to ``IPython.display.Image``. :ghpull:`14526` + - And many more bugfixes and quality of life improvements. + +As usual you can find the full list of PRs on GitHub under `the 8.29 +`__ milestone. + +Preparing for 9.0 +----------------- + +IPython 3.13 was released earlier this month, and this means that according to +`Spec-0 `__, support for 3.10 +will end soon. + +There have been many minor version of IPython 8.x, so it is likely that one of +the next version will simply bump to 9.0 and remove a lot of code mark as +deprecated, and documentation/examples not relevant for terminal IPython. + +The frequency of release and my time reviewing will also likely decrease more +than it has already. + + +For something completely different +---------------------------------- + +`Rosalind Franklin `__ made +some of the biggest contribution to the discovery of the helix structure of DNA. +Unfortunately her work was `not recognized +`__ + +Thanks +------ + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.28: + +IPython 8.28 +============ + +Slight delay of this September release as I was busy at Pydata Paris last week. +Not many user visible changes for this release, a couple of bug fixes and +workaround: + + - :ghpull:`14480` AssertionError: assert _xterm_term_title_saved in WSL – It is + unclear why the terminal title is not saved in WSL, if you've WSL experience + we'd love your feedback and help to not just ignore an error + - :ghpull:`14510` Fix use of pyside6 >= 6.7.0 + - :ghpull:`14518` Make values public (_tb_highlight & _tb_highlight_style) + - :ghpull:`14515` Use environment variable to identify conda / mamba + + +As usual you can find the full list of PRs on GitHub under `the 8.28 +`__ milestone. + +For something completely different +---------------------------------- + +One of the first works of Science Fiction (`Frankenstein +`__), was written by `Mary Shelley +`__ when she was 18, before being +published in London on 1 January 1818 when she was 20. This is often overlooked, +and the role of founders of science fiction attribute to Edgar Allan Poe and +Jules Verne despite being published later. + +Thanks +------ + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.27: + +IPython 8.27 +============ + +New release of IPython after a month off (not enough changes). We can see a few +important changes for this release. + + - autocall was being call getitem, :ghpull:`14486` + - Only copy files in startup dir if we just created it. :ghpull:`14497` + - Fix some tests on Python 3.13 RC1 :ghpull:`14504`; this one I guess make this + the first IPython release officially compatible with Python 3.13; you will + need the most recent ``executing`` and ``stack_data``, we won't pin to avoid + forcing user of older Python version to upgrade. + + +As usual you can find the full list of PRs on GitHub under `the 8.27 +`__ milestone. + +Thanks +------ + +Many thanks to `@Kleirre `__ our June intern for +doing her first contribution to open source, doing the releases notes and +release. I guess you didn't even notice it was not me who released :-). I wish +her all the best in her future endeavor and look forward for her work in +astrophysics. + +Thanks as well to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.26: + +IPython 8.26 +============ + +Hey, the release of IPython for this month is here! (I know you were waiting for it) + +- :ghpull:`14453` bugfix for call to structured_traceback + +- :ghpull:`14466` fixed honoring custom repr for NamedTuple if assigned by partialmethod + +- :ghpull:`14451` Convert matplotlib gui name in enable_gui + +As usual you can find the full list of PRs on GitHub under `the 8.26 +`__ milestone. + +Thanks +------ + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.25: + +IPython 8.25 +============ + +Mostly internal changes for this end of may release of IPython. + +We'll count about a dozen PRs for this moth, with small bugfixes related to +matplotlib fixes. + +Of notable interest, + + - :ghpull:`14426` replaces the unicode micro symbol with greek letter mu, + visually identical but should fix nfkc normalisations issues. + + - :ghpull:`14444` introduces ``intersphinx_registry`` as a new dependency + which is recommended only to build documentation. + +As usual you can find the full list of PRs on GitHub under `the 8.25 +`__ milestone. + +Thanks +------ + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.24: + +IPython 8.24 +============ + +Back on regular release schedule, as usual month releases are relatively tiny. + +The biggest change is the move of the matplotlib backend handling from IPython +to matplotlib. :ghpull:`14371` :ghpull:`14403`. + +We will note: + + - pytest 8 compatibility :ghpull:`14413` + - ``typing-extension`` now needs 4.6 or newer. It was already the case, but not + explicated. :ghpull:`14380` + - Attempt to speed running code under debugger in some cases. :ghpull:`14386` + :ghpull:`14418`. + - Multiple fixes to documentation for ipyparallel, simple_prompt and emacs + :ghpull:`14384` :ghpull:`14404` :ghpull:`14407` + - Maintenance and cleanup of debugger :ghpull:`14387` :ghpull:`14393` + +As usual you can find the full list of PRs on GitHub under `the 8.24 +`__ milestone. + +Thanks +------ + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.23: + +IPython 8.23 +============ + +Super tiny release of IPython on Sunday – a bit later than usual, which is also +`🏳️‍⚧️ International Transgender Day of Visibility🏳️‍⚧️ +`_ – +so a though for you on this day, you matter and you are valid [1]_. + +This is a minuscule release with only 5 Pull requests. + +Main change is :ghpull:`14357` which improve inference from return type +annotations in completer and the introduction of the optional target +``ipython[matplotlib]`` to explicitly request the matplotlib optional +dependencies. + +As usual you can find the full list of PRs on GitHub under `the 8.23 +`__ milestone. + +Thanks +------ + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.22: + +IPython 8.22, 8.22.1 and 8.22.2 +=============================== + +Quick release of IPython for this short month of February, with quite a bit of +activity with more than 15 PRs. + +I am not going to details all the changes, but among other we have : + + - More compatibility with emscripten :ghpull:`14316`, :ghpull:`14318`, + - Test more downstream project to avoid breakage :ghpull:`14317` + - Fix recently introduced bug with the ``store`` magic. + - Fix issues with multiple call to ``matplotlib.pyplot.switch_backend`` + - Fix crashing IPython when some tracebacks encounter dynamically evaluated + code. + +IPython 8.22.1 increase the minimal traitlets version, and 8.22.2 fix a critical +bug on emscripten preventing to use some magics like ``%matplotlib`` on +jupyter-light. + +API changes +----------- + +One of the largest change is the update the mimehooks and inspector API, see +:ghpull:`14342`. It should be backward compatible, but many hooks now receive a +single object with many fields allowing us flexibility to update the API later. + + +Packaging changes +----------------- + +Thanks to `@mkoppe `__, we are slowly getting rid of +setup.py finally migrating to ``pyproject.toml``. There is still quite a bit of +work, and please open an issue if you encounter any problem. + + +Deprecation +----------- + +A number of unused functions have been marked deprecated or pending deprecation. +Please let us know if you encounter any of those deprecation messages for us to +adjust the removal timeline. + + +Thanks +------ + +Many thanks to `@mkoppe `__ and `@krassowski +`__ for their multiple contributions and codebase +cleanup. + +As usual you can find the full list of PRs on GitHub under `the 8.22 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.21: + +IPython 8.21 +============ + +More substantial release of IPython slightly out of schedule as it was not +possible for me to make a release last Friday. + +Few new features are present, but the codebase has been cleaned, and a couple +of API are _considered_ for deprecation. They are not deprecated yet, but as +they do not seem to be quite used, they may emit a warning, in which case please +comment on the relevant issue to inform me of _which_ project use those feature +and how you use them. Depending on the feedback I might change the timeline for +deprecation. + +This release saw 14 PRs, with more outside contribution than usual, +I'll note in particular PRs related to making IPython work on emscripten. + +I also want to point that we are _trying_ to keep compatibility with Python 3.13, +but it's a cat and mouse game. Plus I am low on time, so I would appreciate any +help with that. + +Deprecations +------------ + + - :ghpull:`14307` Pending Deprecation of + ``ColorSchemeTable.set_active_scheme(...)``'s ``case_sensitive`` Parameter. + - :ghpull:`14305` Pending Deprecation of constructing ``ColorScheme`` via + ``kwargs``, in favor passing a single dict. + + +Fixes +----- + + - :ghpull:`14284` TerminalIPythonApp's would warn that ``auto_create`` option is not + recognized. + - :ghpull:`14286` Fix a crash with ``NotOneValueFound`` when rendering complex + tracebacks. + + - :ghpull:`14287` Partial Python 3.13 compatibility + - :ghpull:`14290` Docs/Typos. + +Changes +~~~~~~~ + + - :ghpull:`14289` ``ipdb.set_trace()`` now accepts ``header=`` for better + compatibility with ``pdb.set_trace()`` + + - :ghpull:`14300` and :ghpull:`14301` Add hooking ability to produce + mimebundle. + +We'll outline :ghpull:`14300`, it is now possible to extend the ``?/??`` +operator to return more mimetypes to render richer help in frontends that +support it. In particular you could send a json representation of the help that +could be displayed in a customizable way. + +Miscellaneous +------------- + + - :ghpull:`14291` Misc Refactor of Color handling + - :ghpull:`14295` Misc test skip on problematic Pypy versions. + + +Thanks +~~~~~~ + +Special thanks to all our contributors, and to the Pypy team that was extremely +reactive in helping to investigate a fixing a rare unicode+windows bug. + +As usual you can find the full list of PRs on GitHub under `the 8.21 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.20: + +IPython 8.20 +============ + +Quick IPython release in this beginning of 2024, barely 2 weeks after the previous +release. + +This is mostly to fix a backward compatibility issue, I would have done a patch +release earlier if I could. As a few other cleanup are also part of this +release, this will get a minor version bump. + + +The crux of this release is :ghpull:`14274` (Inspect continuation prompt +signature and pass only viable arguments), the rest of the changes are mostly +type annotation, and a few compatibility issues with Python 3.13 that are +getting addressed. + +Python 3.13 compatibility is still not complete (help welcomed). + +As usual you can find the full list of PRs on GitHub under `the 8.20 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.19: + +IPython 8.19 +============ + +New release of IPython a bit before the end of the month, and end of the year. + +Mostly cleanup and deprecation, due to upstream deprecation and removal. + +Remove of Python 3.9 support +---------------------------- + +A bit later than originally plan, IPython 8.19 does not support Python 3.9 +anymore, as well as the few conditional code that were executing only on Python +3.9. :ghpull:`14254` + +We used the opportunity to deprecate ``IPython.utils.tz`` :ghpull:`14256`, due +to upstream deprecation of some timezone utilities. It will be removed at a later +date. + +We now also run CI on Python 3.12 (what I likely should have done before), but +running on too many Python version uses a lot of CI time. + +Absolute and relative Line Numbers in Prompts +--------------------------------------------- + +Thanks to the contribution of ``cohml``, IPython CLI now support absolute and +relative line numbers in both vi and emacs prompt, use for example +``c.TerminalInteractiveShell.prompt_line_number_format='{line: 4d}/{rel_line:+03d} | '`` +configuration option to display both in a custom format. + +Miscellaneous +------------- + +In addition to various bugfixes, I unpinned pytest, let me know if there are any +issues and we'll re-pin. + +See you in 2024 +--------------- + +As usual you can find the full list of PRs on GitHub under `the 8.19 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.18: + +IPython 8.18 and 8.18.1 +======================= + +8.18.1 is identical to 8.18 but pin ``prompt_toolkit`` to greater than ``3.0.41`` + +Small release of IPython that fixes a small number of inconveniences. + + - :ghpull:`14251` Fix a memory leak in qt event loop integration by setting + the Loop parent to None. + - :ghpull:`14252` Pickleshare was made an optional dependency in 8.17, this + leads to warnings in some installations when using modules completions. The + warning has been silenced. + - :ghpull:`14241` Update event loop code for compatibility with more recent + ``prompt_toolkit`` due to deprecations in Python 3.12. + - :ghpull:`14245` Fix doc example on Pygments styles + - :ghpull:`14238` Remove dependency on app_nope, this is actually only a + dependency of IPykernel. + +As usual you can find the full list of PRs on GitHub under `the 8.18 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.17.1: +.. _version 8.17: + +IPython 8.17, 8.17.1 +==================== + +Medium-sized release of IPython that includes some cleanup (backcall, python2 leftovers) +and some refactoring improvements (typing, pathlib) and a fix on completion. + + - :ghpull:`14216` remove backcall dependency + - :ghpull:`14217` make pickleshare dependency optional + - :ghpull:`14185` support completion based on type annotations of calls + +Reverted in 8.17.1: + + - :ghpull:`14190` remove support for python 2 in lexers (reverted in 8.17.1 as it is imported by qtconsole/spyder) + + +Mamba and Micromamba magic commands +------------------------------------ + +In addition to the ``%conda`` magic command for calling ``conda`` in IPython, +the ``%mamba`` and ``%micromamba`` magic commands now +call ``mamba`` and ``micromamba`` if they are on ``sys.path``. + +.. code:: + + %mamba install pkgname + %micromamba install pkgname + %conda install pkgname + %pip install pkgname + + %mamba --help + %micromamba --help + %conda --help + %pip --help # works w/ JupyterLite + !pip --help + + +:ghpull:`14191` + +---- + +As usual you can find the full list of PRs on GitHub under `the 8.17 +`__ milestone. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.16: +.. _version 8.16.1: + +IPython 8.16, 8.16.1 +==================== + +Small double release of IPython (with the 8.12.3 release notes just below). +Mostly bug fixes and cleanups, and type annotations. Of interest for users: + + - :ghpull:`14153` Fix a bug of the new iPdb chained traceback where some + Exception would not have any traceback. (see upstream fix in CPython for more + details). + - :ghpull:`14168` Fix case with spurious message about event loops when using + matplotlib. + +This PR is in 8.16.0 but reverted in 8.16.1, we'll rework the fix for 8.17 + + - :ghpull:`14163` Fix an error where semicolon would not suppress output. + +As usual you can find the full list of PRs on GitHub under `the 8.16 +`__ and `8.16.1 milestone +`__. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.12.3: + +IPython 8.12.3 +============== + +Tiny release of 8.12.3 that backport a small number of fixes for users still +using Python 3.8. + + - :ghpull:`14080` add passthrough filter shortcuts + - :ghpull:`14169` Fix `InteractiveShellEmbed` + +.. _version 8.15: + +IPython 8.15 +============ + +Medium release of IPython after a couple of month hiatus, and a bit +off-schedule. + +Among other, IPython 8.15: + + - Improve compatibility with future version of Python 3.12/3.13 + :ghpull:`14107`, :ghpull:`14139`, + - Improve support for ``ExceptionGroups``, :ghpull:`14108` + - Fix hangs in ``%gui osx``, :ghpull:`14125` + - Fix memory lead with ``%reset``, :ghpull:`14133` + - Unstable config option to modify traceback highlighting that is sometime hard + to read :ghpull:`14138` + - Support ``.`` in ``ipdb`` as an argument to the ``list`` command + :ghpull:`14121` + - Workroud ``parso`` showing warning message when the default logger level is + changed :ghpull:`14119` + - Fix multiple issues with matplotlib interactive mode, qt5/qt6 :ghpull:`14128` + +Support for PEP-678 Exception Notes +----------------------------------- + +Ultratb now shows :pep:`678` notes, improving your debugging experience on +Python 3.11+ or with libraries such as Pytest and Hypothesis. + +Native fallback for displaying ExceptionGroup +--------------------------------------------- +ExceptionGroups are now displayed with ``traceback.print_exc``, as a temporary fix until UltraTB properly supports displaying child exceptions. + + +We have two larger features: + +AST-based macros +---------------- + +:ghpull:`14100` introduce a new and efficient way to modify each execution block +(cell) using an template-ast-based transform. Unlike IPython pre and post code +execution hooks, this actually transform the code that is execute with as +minimal as possible overhead. While it was already technically possible to +register ast transformers for IPython this was far from evident. + +This should make it trivial to hook into IPython to implement custom hooks, that +for example time or profile your code, catch exceptions to provide error +messages for students or do any other kind of transformations. + +In addition to programmatic API there is also a magic to quickly register +hooks:: + + In [1]: %%code_wrap before_after + ...: print('before') + ...: __code__ + ...: print('after') + ...: __ret__ + +This mean that for any subsequent execution code will be executed. +You can modify the above to print the date, compute the execution time, +retry the code in a for loop.... + + +Allow IPdb/Pdb to move between chained exceptions +------------------------------------------------- + +The main change is the addition of the ability to move between chained +exceptions when using IPdb, this feature was also contributed to upstream Pdb +and is thus native to CPython in Python 3.13+ Though ipdb should support this +feature in older version of Python. I invite you to look at the `CPython changes +and docs `__ for more details. + +In short, once in post-mortem debugger (``%debug``), you can use the ipdb +``exceptions`` command to switch exceptions, for example: + +.. code-block:: ipython + + In [1]: def foo(x): + ...: try: + ...: bar(x) + ...: except Exception as e: + ...: raise ValueError("foo (): bar failed") from e + ...: + ...: def bar(x): + ...: 1 / X + ...: + + In [2]: foo(0) + --------------------------------------------------------------------------- + NameError Traceback (most recent call last) + Cell In[1], line 3, in foo(x) + 2 try: + ----> 3 bar(x) + 4 except Exception as e: + + Cell In[1], line 9, in bar(x) + 8 def bar(x): + ----> 9 1 / X + + NameError: name 'X' is not defined + + The above exception was the direct cause of the following exception: + + ValueError Traceback (most recent call last) + Cell In[2], line 1 + ----> 1 foo(0) + + Cell In[1], line 5, in foo(x) + 3 bar(x) + 4 except Exception as e: + ----> 5 raise ValueError("foo (): bar failed") from e + + ValueError: foo (): bar failed + + In [3]: %debug + > (5)foo() + 3 bar(x) + 4 except Exception as e: + ----> 5 raise ValueError("foo (): bar failed") from e + +In previous ipdb you could not go into the bar error, now from within pdb you +can use ``exceptions``: + +.. code-block:: ipython + + ipdb> exceptions + 0 NameError("name 'X' is not defined") + > 1 ValueError('foo (): bar failed') + + ipdb> exceptions 0 + > (9)bar() + 6 + 7 + 8 def bar(x): + ----> 9 1 / X + 10 + + ipdb> + +In particular I want to thank the `D.E. Shaw group `__ +for suggesting and funding the two largest feature as well as many bug fixes of +this release. + +As usual you can find the full list of PRs on GitHub under `the 8.15 milestone +`__. + + + +.. _version 8.14: + +IPython 8.14 +============ + +Small release of IPython. + + - :ghpull:`14080` fixes some shortcuts issues. + - :ghpull:`14056` Add option to ``%autoreload`` to hide errors when reloading code. This will be the default for spyder + user is my understanding. + - :ghpull:`14039` (and :ghpull:`14040`) to show exception notes in tracebacks. + + - :ghpull:`14076` Add option to EventManager to prevent printing + + +SPEC 0 and SPEC 4 +----------------- + +You've heard about the NEPs, (NumPy enhancement Proposal), having a NEP for something non-numpy specific was sometime confusing. +Long live the `SPECs `_. + +We are now trying to follow SPEC 0 (aka old NEP 29) for support of upstream libraries. + +We also now try to follow SPEC 4 (test and publish nightly on a centralized nightly repository). +We encourage you to do so as well in order to report breakage, and contribute to the SPEC process ! + + +Python 3.12 compatibility ? +--------------------------- + +Python 3.12 changed its tokenizer to have better support for f-strings and allow arbitrary expression. +This is a great new feature and performance improvement in Python 3.12. + +Unfortunately this means the new tokenizer does not support incomplete or invalid Python which will +break many features of IPython. Thus compatibility of IPython with Python 3.12 is not guaranteed. +It is unclear to which extent IPython is affected, and whether we can/should try to still support magics, shell +escape (``! ....``), ..., as well as how to do it if we can. + +In addition even if we there is technical feasibility to do so, it is no clear we have the resources to do it. +We are thus looking for your help if you can _test_ on Python 3.12 to see to which extent this affects users and which +features are critical. + +We are not going to pin IPython to Python ``<3.12`` as otherwise on install pip would downgrade/resolve to IPython 8.13, +so if you plan to update to Python 3.12 after its release, we encourage for extra care. + + +.. _version 8.13.1: +.. _version 8.13.2: +.. _version 8.12.2: + +IPython 8.13.1, 8.13.2 and 8.12.2 +================================= + +3 quick in succession patch release of IPython in addition to IPython 8.13.0 +having been yanked. + +IPython 8.13.0 was improperly tagged as still compatible with Python 3.8, and +still had some mention of compatibility with 3.8. IPython 8.13.1 is identical to +8.13 but with the exception of being correctly tagged. This release and yank was +mostly done to fix CI. + +IPython 8.12.2 and 8.13.2 contain UI fixes, with respect to right arrow not +working in some case in the terminal, and 8.12.2 contain also a requested +backport of :ghpull:`14029` (Allow safe access to the ``__getattribute__`` +method of modules) for tab completion. + +.. _version 8.13: + +IPython 8.13 +============ + +As usual for the end of the month, minor release of IPython. This release is +significant in that it not only has a number of bugfixes, but also drop support +for Python 3.8 as per NEP 29 (:ghpull:`14023`). + +All the critical bugfixes have been backported onto the 8.12.1 release (see +below). In addition to that went into 8.12.1 you'll find: + + - Pretty representation for ``Counter`` has been fixed to match the Python one + and be in decreasing order. :ghpull:`14032` + - Module completion is better when jedi is disabled :ghpull:`14029`. + - Improvement of ``%%bash`` magic that would get stuck :ghpull:`14019` + + +We hope you enjoy this release an will maybe see you at JupyterCon in less than +two weeks. + +As usual you can find the full list of PRs on GitHub under `the 8.13 milestone +`__. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.12.1: + +IPython 8.12.1 +============== + +This is the twin release of IPython 8.13 that contain only critical UI and bug +fixes. The next minor version of IPython has dropped support for Python 3.8 – as +per Nep 29 and this IPython 8.12.x will now only receive bugfixes. + + + - :ghpull:`14004` Fix a bug introduced in IPython 8.12 that crash when + inspecting some docstrings. + - :ghpull:`14010` Fix fast traceback code that was not working in some case. + - :ghpull:`14014` Fix ``%page`` magic broken in some case. + - :ghpull:`14026`, :ghpull:`14027` Tweak default shortcut with respect to + autosuggestions. + - :ghpull:`14033` add back the ability to use ``.get()`` on OInfo object for + backward compatibility with h5py (this will be re-deprecated later, and h5py + will also get a fix). + +As usual you can find the full list of PRs on GitHub under `the 8.12.1 milestone +`__. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.12.0: + +IPython 8.12 +============ + +Hopefully slightly early release for IPython 8.12. Last Thursday of the month, +even if I guess it's likely already Friday somewhere in the pacific ocean. + +A number of PRs and bug fixes this month with close to 20 PRs merged ! + + +The IPython repo reached :ghpull:`14000` !! Actually the PR that create those exact release +note is :ghpull:`14000`. Ok, more issues and PR is not always better, and I'd +love to have more time to close issues and Pull Requests. + +Let's note that in less than 2 month JupyterCon is back, in Paris please visit +`jupytercon.com `__, and looking forward to see you +there. + +Packagers should take note that ``typing_extension`` is now a mandatory dependency +for Python versions ``<3.10``. + + + +Let's note also that according to `NEP29 +`__, It is soon time to +stop support for Python 3.8 that will be release more than 3 and 1/2 years ago:: + + On Apr 14, 2023 drop support for Python 3.8 (initially released on Oct 14, 2019) + +Thus I am likely to stop advertising support for Python 3.8 in the next +release at the end of April. + + +Here are some miscellaneous updates of interest: + + - :ghpull:`13957` brings updates to the Qt integration, particularly for Qt6. + - :ghpull:`13960` fixes the %debug magic command to give access to the local + scope. + - :ghpull:`13964` fixes some crashes with the new fast traceback code. Note that + there are still some issues with the fast traceback code, and I a, likely + to fix and tweak behavior. + - :ghpull:`13973` We are slowly migrating IPython internals to use proper type + objects/dataclasses instead of dictionaries to allow static typing checks. + These are technically public API and could lead to breakage, so please let us + know if that's the case and I'll mitigate. + - :ghpull:`13990`, :ghpull:`13991`, :ghpull:`13994` all improve keybinding and + shortcut configurability. + +As usual you can find the full list of PRs on GitHub under `the 8.12 milestone +`__. + +We want to thank the D.E. Shaw group for requesting and sponsoring the work on +the following big feature. We had productive discussions on how to best expose +this feature + +Dynamic documentation dispatch +------------------------------ + +We are experimenting with dynamic documentation dispatch for object attribute. +See :ghissue:`13860`. The goal is to allow object to define documentation for +their attributes, properties, even when those are dynamically defined with +`__getattr__`. + +In particular when those objects are base types it can be useful to show the +documentation + + +.. code-block:: ipython + + + In [1]: class User: + ...: + ...: __custom_documentations__ = { + ...: "first": "The first name of the user.", + ...: "last": "The last name of the user.", + ...: } + ...: + ...: first:str + ...: last:str + ...: + ...: def __init__(self, first, last): + ...: self.first = first + ...: self.last = last + ...: + ...: @property + ...: def full(self): + ...: """`self.first` and `self.last` joined by a space.""" + ...: return self.first + " " + self.last + ...: + ...: + ...: user = Person('Jane', 'Doe') + + In [2]: user.first? + Type: str + String form: Jane + Length: 4 + Docstring: the first name of a the person object, a str + Class docstring: + .... + + In [3]: user.last? + Type: str + String form: Doe + Length: 3 + Docstring: the last name, also a str + ... + + +We can see here the symmetry with IPython looking for the docstring on the +properties: + +.. code-block:: ipython + + + In [4]: user.full? + HERE + Type: property + String form: + Docstring: first and last join by a space + + +Note that while in the above example we use a static dictionary, libraries may +decide to use a custom object that define ``__getitem__``, we caution against +using objects that would trigger computation to show documentation, but it is +sometime preferable for highly dynamic code that for example export an API as +object. + + + +.. _version 8.11.0: + +IPython 8.11 +============ + +Back on almost regular monthly schedule for IPython with end-of-month +really-late-Friday release to make sure some bugs are properly fixed. +Small addition of with a few new features, bugfix and UX improvements. + +This is a non-exhaustive list, but among other you will find: + +Faster Traceback Highlighting +----------------------------- + +Resurrection of pre-IPython-8 traceback highlighting code. + +Really long and complicated files were slow to highlight in traceback with +IPython 8 despite upstream improvement that make many case better. Therefore +starting with IPython 8.11 when one of the highlighted file is more than 10 000 +line long by default, we'll fallback to a faster path that does not have all the +features of highlighting failing AST nodes. + +This can be configures by setting the value of +``IPython.code.ultratb.FAST_THRESHOLD`` to an arbitrary low or large value. + + +Autoreload verbosity +-------------------- + +We introduce more descriptive names for the ``%autoreload`` parameter: + +- ``%autoreload now`` (also ``%autoreload``) - perform autoreload immediately. +- ``%autoreload off`` (also ``%autoreload 0``) - turn off autoreload. +- ``%autoreload explicit`` (also ``%autoreload 1``) - turn on autoreload only for modules + whitelisted by ``%aimport`` statements. +- ``%autoreload all`` (also ``%autoreload 2``) - turn on autoreload for all modules except those + blacklisted by ``%aimport`` statements. +- ``%autoreload complete`` (also ``%autoreload 3``) - all the features of ``all`` but also adding new + objects from the imported modules (see + IPython/extensions/tests/test_autoreload.py::test_autoload_newly_added_objects). + +The original designations (e.g. "2") still work, and these new ones are case-insensitive. + +Additionally, the option ``--print`` or ``-p`` can be added to the line to print the names of +modules being reloaded. Similarly, ``--log`` or ``-l`` will output the names to the logger at INFO +level. Both can be used simultaneously. + +The parsing logic for ``%aimport`` is now improved such that modules can be whitelisted and +blacklisted in the same line, e.g. it's now possible to call ``%aimport os, -math`` to include +``os`` for ``%autoreload explicit`` and exclude ``math`` for modes ``all`` and ``complete``. + +Terminal shortcuts customization +-------------------------------- + +Previously modifying shortcuts was only possible by hooking into startup files +and practically limited to adding new shortcuts or removing all shortcuts bound +to a specific key. This release enables users to override existing terminal +shortcuts, disable them or add new keybindings. + +For example, to set the :kbd:`right` to accept a single character of auto-suggestion +you could use:: + + my_shortcuts = [ + { + "command": "IPython:auto_suggest.accept_character", + "new_keys": ["right"] + } + ] + %config TerminalInteractiveShell.shortcuts = my_shortcuts + +You can learn more in :std:configtrait:`TerminalInteractiveShell.shortcuts` +configuration reference. + +Miscellaneous +------------- + + - ``%gui`` should now support PySide6. :ghpull:`13864` + - Cli shortcuts can now be configured :ghpull:`13928`, see above. + (note that there might be an issue with prompt_toolkit 3.0.37 and shortcut configuration). + + - Capture output should now respect ``;`` semicolon to suppress output. + :ghpull:`13940` + - Base64 encoded images (in jupyter frontend), will not have trailing newlines. + :ghpull:`13941` + +As usual you can find the full list of PRs on GitHub under `the 8.11 milestone +`__. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.10.0: + +IPython 8.10 +============ + +Out of schedule release of IPython with minor fixes to patch a potential CVE-2023-24816. +This is a really low severity CVE that you most likely are not affected by unless: + + - You are on windows. + - You have a custom build of Python without ``_ctypes`` + - You cd or start IPython or Jupyter in untrusted directory which names may be + valid shell commands. + +You can read more on `the advisory +`__. + +In addition to fixing this CVE we also fix a couple of outstanding bugs and issues. + +As usual you can find the full list of PRs on GitHub under `the 8.10 milestone +`__. + +In Particular: + + - bump minimum numpy to `>=1.21` version following NEP29. :ghpull:`13930` + - fix for compatibility with MyPy 1.0. :ghpull:`13933` + - fix nbgrader stalling when IPython's ``showtraceback`` function is + monkeypatched. :ghpull:`13934` + + + +As this release also contains those minimal changes in addition to fixing the +CVE I decided to bump the minor version anyway. + +This will not affect the normal release schedule, so IPython 8.11 is due in +about 2 weeks. + +.. _version 8.9.0: + +IPython 8.9.0 +============= + +Second release of IPython in 2023, last Friday of the month, we are back on +track. This is a small release with a few bug-fixes, and improvements, mostly +with respect to terminal shortcuts. + + +The biggest improvement for 8.9 is a drastic amelioration of the +auto-suggestions sponsored by D.E. Shaw and implemented by the more and more +active contributor `@krassowski `__. + +- ``right`` accepts a single character from suggestion +- ``ctrl+right`` accepts a semantic token (macos default shortcuts take + precedence and need to be disabled to make this work) +- ``backspace`` deletes a character and resumes hinting autosuggestions +- ``ctrl-left`` accepts suggestion and moves cursor left one character. +- ``backspace`` deletes a character and resumes hinting autosuggestions +- ``down`` moves to suggestion to later in history when no lines are present below the cursors. +- ``up`` moves to suggestion from earlier in history when no lines are present above the cursor. + +This is best described by the Gif posted by `@krassowski +`__, and in the PR itself :ghpull:`13888`. + +.. image:: ../_images/autosuggest.gif + +Please report any feedback in order for us to improve the user experience. +In particular we are also working on making the shortcuts configurable. + +If you are interested in better terminal shortcuts, I also invite you to +participate in issue `13879 +`__. + + +As we follow `NEP29 +`__, next version of +IPython will officially stop supporting numpy 1.20, and will stop supporting +Python 3.8 after April release. + +As usual you can find the full list of PRs on GitHub under `the 8.9 milestone +`__. + + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.8.0: + +IPython 8.8.0 +============= + +First release of IPython in 2023 as there was no release at the end of +December. + +This is an unusually big release (relatively speaking) with more than 15 Pull +Requests merged. + +Of particular interest are: + + - :ghpull:`13852` that replaces the greedy completer and improves + completion, in particular for dictionary keys. + - :ghpull:`13858` that adds ``py.typed`` to ``setup.cfg`` to make sure it is + bundled in wheels. + - :ghpull:`13869` that implements tab completions for IPython options in the + shell when using `argcomplete `. I + believe this also needs a recent version of Traitlets. + - :ghpull:`13865` makes the ``inspector`` class of `InteractiveShell` + configurable. + - :ghpull:`13880` that removes minor-version entrypoints as the minor version + entry points that would be included in the wheel would be the one of the + Python version that was used to build the ``whl`` file. + +In no particular order, the rest of the changes update the test suite to be +compatible with Pygments 2.14, various docfixes, testing on more recent python +versions and various updates. + +As usual you can find the full list of PRs on GitHub under `the 8.8 milestone +`__. + +Many thanks to @krassowski for the many PRs and @jasongrout for reviewing and +merging contributions. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.7.0: + +IPython 8.7.0 +============= + + +Small release of IPython with a couple of bug fixes and new features for this +month. Next month is the end of year, it is unclear if there will be a release +close to the new year's eve, or if the next release will be at the end of January. + +Here are a few of the relevant fixes, +as usual you can find the full list of PRs on GitHub under `the 8.7 milestone +`__. + + + - :ghpull:`13834` bump the minimum prompt toolkit to 3.0.11. + - IPython shipped with the ``py.typed`` marker now, and we are progressively + adding more types. :ghpull:`13831` + - :ghpull:`13817` add configuration of code blacks formatting. + + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.6.0: + +IPython 8.6.0 +============= + +Back to a more regular release schedule (at least I try), as Friday is +already over by more than 24h hours. This is a slightly bigger release with a +few new features that contain no less than 25 PRs. + +We'll notably found a couple of non negligible changes: + +The ``install_ext`` and related functions have been removed after being +deprecated for years. You can use pip to install extensions. ``pip`` did not +exist when ``install_ext`` was introduced. You can still load local extensions +without installing them. Just set your ``sys.path`` for example. :ghpull:`13744` + +IPython now has extra entry points that use the major *and minor* version of +python. For some of you this means that you can do a quick ``ipython3.10`` to +launch IPython from the Python 3.10 interpreter, while still using Python 3.11 +as your main Python. :ghpull:`13743` + +The completer matcher API has been improved. See :ghpull:`13745`. This should +improve the type inference and improve dict keys completions in many use case. +Thanks ``@krassowski`` for all the work, and the D.E. Shaw group for sponsoring +it. + +The color of error nodes in tracebacks can now be customized. See +:ghpull:`13756`. This is a private attribute until someone finds the time to +properly add a configuration option. Note that with Python 3.11 that also shows +the relevant nodes in traceback, it would be good to leverage this information +(plus the "did you mean" info added on attribute errors). But that's likely work +I won't have time to do before long, so contributions welcome. + +As we follow NEP 29, we removed support for numpy 1.19 :ghpull:`13760`. + + +The ``open()`` function present in the user namespace by default will now refuse +to open the file descriptors 0,1,2 (stdin, out, err), to avoid crashing IPython. +This mostly occurs in teaching context when incorrect values get passed around. + + +The ``?``, ``??``, and corresponding ``pinfo``, ``pinfo2`` magics can now find +objects inside arrays. That is to say, the following now works:: + + + >>> def my_func(*arg, **kwargs):pass + >>> container = [my_func] + >>> container[0]? + + +If ``container`` define a custom ``getitem``, this __will__ trigger the custom +method. So don't put side effects in your ``getitems``. Thanks to the D.E. Shaw +group for the request and sponsoring the work. + + +As usual you can find the full list of PRs on GitHub under `the 8.6 milestone +`__. + +Thanks to all hacktoberfest contributors, please contribute to +`closember.org `__. + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + +.. _version 8.5.0: + +IPython 8.5.0 +============= + +First release since a couple of month due to various reasons and timing preventing +me for sticking to the usual monthly release the last Friday of each month. This +is of non negligible size as it has more than two dozen PRs with various fixes +an bug fixes. + +Many thanks to everybody who contributed PRs for your patience in review and +merges. + +Here is a non-exhaustive list of changes that have been implemented for IPython +8.5.0. As usual you can find the full list of issues and PRs tagged with `the +8.5 milestone +`__. + + - Added a shortcut for accepting auto suggestion. The End key shortcut for + accepting auto-suggestion This binding works in Vi mode too, provided + ``TerminalInteractiveShell.emacs_bindings_in_vi_insert_mode`` is set to be + ``True`` :ghpull:`13566`. + + - No popup in window for latex generation when generating latex (e.g. via + `_latex_repr_`) no popup window is shows under Windows. :ghpull:`13679` + + - Fixed error raised when attempting to tab-complete an input string with + consecutive periods or forward slashes (such as "file:///var/log/..."). + :ghpull:`13675` + + - Relative filenames in Latex rendering : + The `latex_to_png_dvipng` command internally generates input and output file + arguments to `latex` and `dvipis`. These arguments are now generated as + relative files to the current working directory instead of absolute file + paths. This solves a problem where the current working directory contains + characters that are not handled properly by `latex` and `dvips`. There are + no changes to the user API. :ghpull:`13680` + + - Stripping decorators bug: Fixed bug which meant that ipython code blocks in + restructured text documents executed with the ipython-sphinx extension + skipped any lines of code containing python decorators. :ghpull:`13612` + + - Allow some modules with frozen dataclasses to be reloaded. :ghpull:`13732` + - Fix paste magic on wayland. :ghpull:`13671` + - show maxlen in deque's repr. :ghpull:`13648` + +Restore line numbers for Input +------------------------------ + +Line number information in tracebacks from input are restored. +Line numbers from input were removed during the transition to v8 enhanced traceback reporting. + +So, instead of:: + + --------------------------------------------------------------------------- + ZeroDivisionError Traceback (most recent call last) + Input In [3], in () + ----> 1 myfunc(2) + + Input In [2], in myfunc(z) + 1 def myfunc(z): + ----> 2 foo.boo(z-1) + + File ~/code/python/ipython/foo.py:3, in boo(x) + 2 def boo(x): + ----> 3 return 1/(1-x) + + ZeroDivisionError: division by zero + +The error traceback now looks like:: + + --------------------------------------------------------------------------- + ZeroDivisionError Traceback (most recent call last) + Cell In [3], line 1 + ----> 1 myfunc(2) + + Cell In [2], line 2, in myfunc(z) + 1 def myfunc(z): + ----> 2 foo.boo(z-1) + + File ~/code/python/ipython/foo.py:3, in boo(x) + 2 def boo(x): + ----> 3 return 1/(1-x) + + ZeroDivisionError: division by zero + +or, with xmode=Plain:: + + Traceback (most recent call last): + Cell In [12], line 1 + myfunc(2) + Cell In [6], line 2 in myfunc + foo.boo(z-1) + File ~/code/python/ipython/foo.py:3 in boo + return 1/(1-x) + ZeroDivisionError: division by zero + +:ghpull:`13560` + +New setting to silence warning if working inside a virtual environment +---------------------------------------------------------------------- + +Previously, when starting IPython in a virtual environment without IPython installed (so IPython from the global environment is used), the following warning was printed: + + Attempting to work in a virtualenv. If you encounter problems, please install IPython inside the virtualenv. + +This warning can be permanently silenced by setting ``c.InteractiveShell.warn_venv`` to ``False`` (the default is ``True``). + +:ghpull:`13706` + +------- + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + + +.. _version 8.4.0: + +IPython 8.4.0 +============= + +As for 7.34, this version contains a single fix: fix uncaught BdbQuit exceptions on ipdb +exit :ghpull:`13668`, and a single typo fix in documentation: :ghpull:`13682` + +Thanks to the `D. E. Shaw group `__ for sponsoring +work on IPython and related libraries. + .. _version 8.3.0: IPython 8.3.0 -------------- +============= - :ghpull:`13625`, using ``?``, ``??``, ``*?`` will not call ``set_next_input`` as most frontend allow proper multiline editing and it was - causing issues for many users of multi-cell frontends. + causing issues for many users of multi-cell frontends. This has been backported to 7.33 - :ghpull:`13600`, ``pre_run_*``-hooks will now have a ``cell_id`` attribute on - the info object when frontend provide it. + the info object when frontend provides it. This has been backported to 7.33 - :ghpull:`13624`, fixed :kbd:`End` key being broken after accepting an - autosuggestion. + auto-suggestion. + + - :ghpull:`13657` fixed an issue where history from different sessions would be mixed. .. _version 8.2.0: IPython 8.2.0 -------------- +============= IPython 8.2 mostly bring bugfixes to IPython. @@ -35,8 +1597,8 @@ IPython 8.2 mostly bring bugfixes to IPython. - 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 +I am still trying to fix and investigate :ghissue:`13598`, which seems to be +random, and would appreciate help if you find a reproducible minimal case. I've tried to make various changes to the codebase to mitigate it, but a proper fix will be difficult without understanding the cause. @@ -50,9 +1612,9 @@ Thanks to the `D. E. Shaw group `__ 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 @@ -62,10 +1624,10 @@ 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 +updates a few behaviors that were problematic with the 8.0 as with many new major release. Note that beyond the changes listed here, IPython 8.1.0 also contains all the @@ -83,7 +1645,7 @@ features listed in :ref:`version 7.32`. :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 + ``TerminalInteractiveShell.autoformatter="yapf"`` to re-enable auto formatting with black, or switch to yapf. - Fix and issue where ``display`` was not defined. @@ -116,8 +1678,8 @@ 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 +Many thanks to all the contributors to this release, many of the above fixed issues and +new features were done by first time contributors, showing there is still plenty of easy contribution possible in IPython . You can find all individual contributions to this milestone `on github `__. @@ -130,7 +1692,7 @@ 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. @@ -138,7 +1700,7 @@ 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. +dependent 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 @@ -174,20 +1736,20 @@ Further details can be read on the `GitHub Advisory `__ for the full list of pull requests. -Please feel free to send pull requests to updates those notes after release, +Please feel free to send pull requests to update those notes after release, I have likely forgotten a few things reviewing 250+ PRs. Dependencies changes/downstream packaging @@ -202,8 +1764,8 @@ looking for help to do so. - 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 + - ``iptest``/``iptest3`` cli entrypoints do not exist anymore. + - the minimum officially supported ``numpy`` version has been bumped, but this should not have much effect on packaging. @@ -224,7 +1786,7 @@ deprecation warning: - 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. +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 @@ -256,7 +1818,7 @@ by mypy. Featured changes ---------------- -Here is a features list of changes in IPython 8.0. This is of course non-exhaustive. +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 @@ -304,7 +1866,7 @@ The error traceback is now correctly formatted, showing the cell number in which ZeroDivisionError: division by zero -The ``stack_data`` package has been integrated, which provides smarter information in the traceback; +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:: @@ -344,7 +1906,7 @@ and IPython 8.0 is capable of telling you where the index error occurs:: ----> 3 return x[0][i][0] ^^^^^^^ -The corresponding locations marked here with ``^`` will show up highlighted in +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 @@ -519,8 +2081,8 @@ 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`):: +it will still work, even though each line is prefixed with prompts (``In``, +``Out``):: In [1]: 2 * 2 == 4 Out[1]: True @@ -541,7 +2103,7 @@ Previously, this was not the case for the Vi-mode prompts:: 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``, +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 @@ -568,8 +2130,8 @@ when followed with :kbd:`F2`), send it to `dpaste.org `_ using 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 +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 @@ -594,7 +2156,7 @@ 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. +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 @@ -615,14 +2177,14 @@ 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 ``__ +You can find all relevant issues and PRs with `the SDG 2021 tag `__ 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. +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'" @@ -1065,3 +2627,7 @@ The following attribute/methods have been removed:: - IPython.terminal.ipapp.LocateIPythonApp.initialize_subcommand - IPython.terminal.ipapp.TerminalIPythonApp.deprecated_subcommands - IPython.terminal.ipapp.TerminalIPythonApp.initialize_subcommand + +------ + +.. [1] If this make you uncomfortable feel free to not use IPython 8.23. diff --git a/docs/source/whatsnew/version9.rst b/docs/source/whatsnew/version9.rst new file mode 100644 index 00000000000..b62e6671075 --- /dev/null +++ b/docs/source/whatsnew/version9.rst @@ -0,0 +1,1177 @@ +============ + 9.x Series +============ + +.. _version 9.16: + +IPython 9.16 +------------ + +Summary +~~~~~~~ + +This release contains two security-hardening fixes — HTML-attribute escaping in +the display objects and closing an arbitrary-code-execution path in completion — +a new ``cell_meta`` field on +:class:`~IPython.core.interactiveshell.ExecutionInfo`, several completion, autoreload, +and path-handling fixes, and two backwards-incompatible changes (:magic:`lsmagic` +default output and the removal of long-deprecated APIs). It also includes a +large amount of internal typing, test, and CI modernization. + +- :ghpull:`15337` Resolve attribute annotations under the policy in :func:`~IPython.core.guarded_eval.eval_node` +- :ghpull:`15335` Make :magic:`lsmagic` return plain text by default +- :ghpull:`15334` Escape URLs and file names interpolated into display HTML attributes +- :ghpull:`15332` Add yakuake to the list of Kitty-compatible terminals +- :ghpull:`15330` Add version information to deprecation warnings +- :ghpull:`15317` Only substitute ``~`` in :func:`~IPython.utils.path.compress_user` on a path-component boundary +- :ghpull:`15314` Refactor banner property logic +- :ghpull:`15310` Deprecation cleanup and decorator-dependency removal +- :ghpull:`15289` Make caller locals visible to nested scopes in embedded shells +- :ghpull:`15288` Limit file completions to path contexts +- :ghpull:`15287` Centralize image format handling +- :ghpull:`15285` Disable path elision in tab-completion with ``min_elide=0`` +- :ghpull:`15276` Make :class:`~IPython.display.Image` with ``retina=True`` work with WebP +- :ghpull:`15275` Fix memory leak and error handling in the LLM autosuggester +- :ghpull:`15274` Reload ``__kwdefaults__``, ``__annotations__``, and ``__type_params__`` in autoreload +- :ghpull:`15273` Close the history database during shell shutdown +- :ghpull:`15266` Add test covering ``%%timeit`` cell magic output format with multiline code +- :ghpull:`15260` Fix doctest prompt stripping regression +- :ghpull:`15071` Add ``cell_meta`` to :class:`~IPython.core.interactiveshell.ExecutionInfo` and pass it through :meth:`~IPython.core.interactiveshell.InteractiveShell.run_cell` + +In addition, this release lands a broad sweep of internal maintenance: strict +``mypy`` type checking and many new annotations, ``pyupgrade``/modernized type +annotations, additional ``ruff`` rules, narrowed bare ``except:`` clauses, +removal of the deprecated ``IPython.utils.py3compat`` module, new test coverage, +and a number of test-suite resource-leak and CI fixes. + + +Security Hardening +~~~~~~~~~~~~~~~~~~~ + +Two fixes close paths that could execute unintended code or inject markup: + +- Values passed to the display objects were interpolated unescaped into quoted + HTML attributes, so a quote character could close the attribute and have the + remainder parsed as markup. :class:`~IPython.display.Image` and + :class:`~IPython.display.Video` (``src``), :class:`~IPython.display.IFrame` + and its :class:`~IPython.display.YouTubeVideo`/:class:`~IPython.display.VimeoVideo`/:class:`~IPython.display.ScribdDocument` + subclasses (``src``, ``width``, ``height``, reachable through the id argument), + :class:`~IPython.display.Audio` (url and ``element_id``), and the + :class:`~IPython.display.FileLinks` formatter (names read off disk) now escape + these values. For example ``YouTubeVideo('abc">" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "vincent.initialize_notebook()" - ] - }, - { - "cell_type": "code", - "execution_count": 14, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "text/html": [ - "

\n", - "\n", - "\n", - " " - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "line = vincent.Line(price[['AAPL', 'IBM', 'YHOO', 'MSFT']], width=600, height=300)\n", - "line.axis_titles(x='Date', y='Price')\n", - "line.legend(title='Ticker')\n", - "display(line)" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.2" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/IPython Kernel/Trapezoid Rule.ipynb b/examples/IPython Kernel/Trapezoid Rule.ipynb deleted file mode 100644 index 5ccd13f9164..00000000000 --- a/examples/IPython Kernel/Trapezoid Rule.ipynb +++ /dev/null @@ -1,971 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Basic Numerical Integration: the Trapezoid Rule" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "A simple illustration of the trapezoid rule for definite integration:\n", - "\n", - "$$\n", - "\\int_{a}^{b} f(x)\\, dx \\approx \\frac{1}{2} \\sum_{k=1}^{N} \\left( x_{k} - x_{k-1} \\right) \\left( f(x_{k}) + f(x_{k-1}) \\right).\n", - "$$\n", - "
\n", - "First, we define a simple function and sample it between 0 and 10 at 200 points" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "%matplotlib inline\n", - "import numpy as np\n", - "import matplotlib.pyplot as plt" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "def f(x):\n", - " return (x-3)*(x-5)*(x-7)+85\n", - "\n", - "x = np.linspace(0, 10, 200)\n", - "y = f(x)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Choose a region to integrate over and take only a few points in that region" - ] - }, - { - "cell_type": "code", - "execution_count": 3, - "metadata": { - "collapsed": true - }, - "outputs": [], - "source": [ - "a, b = 1, 8 # the left and right boundaries\n", - "N = 5 # the number of points\n", - "xint = np.linspace(a, b, N)\n", - "yint = f(xint)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Plot both the function and the area below it in the trapezoid approximation" - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "image/png": [ - "iVBORw0KGgoAAAANSUhEUgAABKcAAAL7CAYAAAAoHObLAAAABHNCSVQICAgIfAhkiAAAAAlwSFlz\n", - "AAAWJQAAFiUBSVIk8AAAIABJREFUeJzs3Xl8Y3d97//3kSxvs9mzL8lMMjOZSSaTPZokJBOI5tfS\n", - "ABfK0hPWtKUXSOlKi4ByS2+BB8tFQG9a2gu0hVLupeRQthZStggCpSwKEBISkkkyOvKMxx7b0pHs\n", - "sbXr/P6QBpQztmexrWPZr+fjcR6yP9+vdD55KCTkPd/v9xiu6woAAAAAAADwQ8DvBgAAAAAAALB8\n", - "EU4BAAAAAADAN4RTAAAAAAAA8A3hFAAAAAAAAHxDOAUAAAAAAADfEE4BAAAAAADAN4RTAAAAAAAA\n", - "8A3hFAAAAAAAAHxDOAUAAAAAAADfEE4BAAAAAADAN4RTAAAAAAAA8A3hFAAAAAAAAHxDOAUAAAAA\n", - "AADfEE4BAAAAAADANx1z/QDTNLdK+rKkiyzL6j+L+V+S9BxJb7As6+5pxl8i6c2S9kqalHS/pLda\n", - "lnVkrr0CAAAAAABgcZnTyinTNPdL+r6kKyW5ZzH/v0m6vvHrafNN03y9pHskPSDp5ZKiknZL+q5p\n", - "mjvm0isAAAAAAAAWn/NeOWWa5iFJn5X0mKQvSHrVGeZ3S/orSW+R9LFpxrdJer+kd1uW9bam+udU\n", - "D6s+KOnF59svAAAAAAAAFp+5rJy6U9KPJB2SlDmL+W+WlLYs659m+byypPc0Fy3LmpL0XknPN01z\n", - "83l3CwAAAAAAgEVnLuHUXZJutyxr8kwTTdO8WNKbJP3hLNOeJen+Rhjlda+koKRbzqNPAAAAAAAA\n", - "LFLnHU5ZlpW3LKt0ltP/t6R/tSzrB7PM2a36FsHp7jWm+uqsXefWJQAAAAAAABazOT+t70xM07xd\n", - "0m2S9pxhar+k7CzjWUnr5qsvAAAAAAAA+G9OT+s7E9M0uyT9taR3WZY1fIbpqyTlZxmfkrRmvnoD\n", - "AAAAAACA/xY0nJL0xsbrB89i7oSknlnGeyXl5twRAAAAAAAAFo0F29ZnmmafpLdK+mNJ60zT9E5Z\n", - "3Xj63kTjUPWMpL5ZPnKNpPS59nHfffe55/oeAAAAAAAAnNmhQ4eMuX7GQq6c6lN9JdRHJB33XJL0\n", - "jsbPf9r4/SlJl073QaZprlf9vKkjC9gvAAAAAAAAWmwhD0QflnS7JO/KJUPSf0j6sKQvSHqyUf+W\n", - "pLeYptlrWdaU5z3PkVST9J3zbWY+kjy0B9M0Xcuy+L6XCb7v5YXve3nh+15e+L6XF77v5YXve3nh\n", - "+14+5nOn2oKFU5ZlFSR9dbqxxha/xyzL+lpT+Z8lvU3SWyT9RdPc3kbt387iUHUAAAAAAAC0kYVc\n", - "OXVOLMsaNE3zTZLuNk1znaSvSFot6Y8krZX0Bj/7AwAAAAAAwPybrzOnXJ2+fe+cWZb1IUkvl3SD\n", - "pE+p/pS/pKSbLctKzfXzAQAAAAAAsLjMy8opy7LeLunt5zB/xlDMsqx7JN0zH30BAAAAAABgcVvI\n", - "p/UBAAAAAAAAsyKcAgAAAAAAgG8IpwAAAAAAAOAbwikAAAAAAAD4hnAKAAAAAAAAviGcAgAAAAAA\n", - "gG8Ip7AUvd3vBtBSfN/LC9/38sL3vbzwfS8vfN/LC9/38sL3jXNmuK7rdw8L6r777nMl6dChQ4bf\n", - "vQAAAAAAACwF85m3sHIKAAAAAAAAviGcAgAAAAAAgG8IpwAAAAAAAOAbwikAAAAAAAD4hnAKAAAA\n", - "AAAAviGcAgAAAAAAgG8IpwAAAAAAAOAbwikAAAAAAAD4hnAKAAAAAAAAviGcAgAAAAAAgG8IpwAA\n", - "AAAAAOAbwikAAAAAAAD4hnAKAAAAAAAAviGcAgAAAAAAgG8IpwAAAAAAAOAbwikAAAAAAAD4hnAK\n", - "AAAAAAAAviGcAgAAAAAAwFkLx+LGfH4e4RQAAAAAAADOxXPm88MIpwAAAAAAAHBWwrF4SNIH5vMz\n", - "CacAAAAAAABwtu6StHc+P5BwCgAAAAAAAGcUjsXXS3rHfH8u4RQAAAAAAADOxjsl9c33hxJOAQAA\n", - "AAAAYFbhWPwqSa9diM8mnAIAAAAAAMCMwrG4IeluLVCORDgFAAAAAACA2bxE0jMX6sMJpwAAAAAA\n", - "ADCtcCzeK+n9nvJX5vMehFMAAAAAAACYSVTS9qbfK5LeMJ83IJwCAAAAAADAacKx+HZJb/aU/zoR\n", - "jTw2n/chnAIAAAAAAMB0YpJ6mn4flfSO+b4J4RQAAAAAAACeJhyL3yrJ9JTfmohGcvN9L8IpAAAA\n", - "AAAA/EI4Fu+Q9Nee8o8lfXwh7kc4BQAAAAAAgGa/K+kqT+0PE9FIdSFuRjgFAAAAAAAASVI4Ft8k\n", - "6Z2e8v9LRCPfXah7Ek4BAAAAAADglPdKWtP0+4Sk6ELekHAKAAAAAAAACsfiN0n6LU/5LxPRyNBC\n", - "3pdwCgAAAAAAYJkLx+JBSX/rKT8i6W8W+t6EUwAAAAAAAHidpGs8td9LRCPlhb4x4RQAAAAAAMAy\n", - "Fo7FN0h6l6f8L4lo5P5W3J9wCgAAAAAAYHl7r6S+pt9PSnpjq25OOAUAAAAAALBMhWPxGyW92lN+\n", - "eyIaOd6qHginAAAAAAAAlqHGIegf8pR/LunuVvZBOAUAAAAAALA8/a6k6zy132/FIejNCKcAAAAA\n", - "AACWmXAsvkWnH4JuJaKReKt7IZwCAAAAAABYfj4oaXXT7xOS3uBHI4RTAAAAAAAAy0g4Fv8VSS/1\n", - "lP+8lYegNyOcAgAAAAAAWCbCsXi3pL/zlH8yTa1lCKcAAAAAAACWj7dI2t30uyvprkQ0UvGpH8Ip\n", - "AAAAAACA5SAci18i6c885Q8nopEf+tHPKYRTAAAAAAAAS1w4FjdU37rX2VQekfRWfzr6JcIpAAAA\n", - "AACApe8OSf+fp/YniWgk60czzQinAAAAAAAAlrBwLL5G0l95ynFJn/KhndMQTgEAAAAAACxt75W0\n", - "uen3kqTXJ6IR16d+noZwCgAAAAAAYIkKx+K3SLrLU35fIhp53I9+pkM4BQAAAAAAsASFY/EuSR/1\n", - "lJ+Q9C4f2pkR4RQAAAAAAMDS9CZJl3lqr0tEIwU/mpkJ4RQAAAAAAMASE47F90r6c0/544lo5Jt+\n", - "9DMbwikAAAAAAIAlJByLB1TfztfZVB6V9EZ/Opod4RQAAAAAAMDS8mpJt3pqf5SIRjJ+NHMmhFMA\n", - "AAAAAABLRDgW3ywp5il/RdKnfWjnrBBOAQAAAAAALB3/W1Jf0+9Tkl6fiEZcn/o5I8IpAAAAAACA\n", - "JSAciz9X0h2e8l8kopGkH/2cLcIpAAAAAACANheOxVdL+rCn/BNJd/vQzjkhnAIAAAAAAGh/75N0\n", - "QdPvNUmvSUQjFZ/6OWuEUwAAAAAAAG0sHIs/S9LrPOX3J6KRH/nQzjkjnAIAAAAAAGhT4Vi8V9I/\n", - "eMpPSPrL1ndzfginAAAAAAAA2tc7JO3y1H4nEY3k/WjmfBBOAQAAAAAAtKFwLH5A0hs85b9NRCPf\n", - "8aOf80U4BQAAAAAA0GbCsXiXpI/p6dnOgKQ/86ej80c4BQAAAAAA0H7eKulyT+21iWhkwo9m5oJw\n", - "CgAAAAAAoI2EY/ErVQ+nmn0iEY181Y9+5opwCgAAAAAAoE2EY/GQ6tv5OprKJyT9iT8dzR3hFAAA\n", - "AAAAQPt4s6TrPLXXJ6KRjB/NzAfCKQAAAAAAgDYQjsWvkvQXnvJnEtHI5/zoZ74QTgEAAAAAACxy\n", - "4Vi8U9I/SQo1lUckvd6XhuZRx5mnzM40za2SvizpIsuy+qcZNyS9WtLvSdojKS/pW5LeaVnWQ9PM\n", - "f4nqS9T2SpqUdL+kt1qWdWSuvQIAAAAAALSpt0q62lO7KxGNjPnRzHya08op0zT3S/q+pCsluTNM\n", - "+2tJH5X0Q0kvlfSnki6S9D3TNMOez3u9pHskPSDp5ZKiknZL+q5pmjvm0isAAAAAAEA7Csfi10r6\n", - "H57ypxLRyOf96Ge+nffKKdM0D0n6rKTHJH1B0qummXOV6ium/qdlWe9sqt8j6ceS/pekSKO2TdL7\n", - "Jb3bsqy3Nc39nOph1Qclvfh8+wUAAAAAAGg3Tdv5vE/n+0NfGloAc1k5daekH0k6JGmmE+FDkj6g\n", - "+uqpX7Asqyjp85Ju8HxeWdJ7PHOnJL1X0vNN09w8h34BAAAAAADazdskXeGpvS4RjaT9aGYhzOXM\n", - "qbskVS3LKpmmOe0Ey7IeUH3V03S6JJWafn+WpPsbYZTXvZKCkm6R9K/n2zAAAAAAAEC7CMfi10v6\n", - "M0/5k4lo5It+9LNQznvllGVZecuySmeeeTrTNLsk3SHp203l3apvEZzuXmOqr87adT73AwAAAAAA\n", - "aCfhWLxb0idUX6xzypCkP/Kno4Uz56f1naf3SbpA9QPST+mXlJ3lPVlJ6xayKQAAAAAAgEXi3ZL2\n", - "eWqvSUQjjh/NLKQ5Pa3vfJim+ceS/kDSBy3L+q+moVWS8rO8dUrSmoXsDQAAAAAAwG/hWPw2SW/w\n", - "lD+eiEa+7Ec/C62l4ZRpmq9S/YD0L0p6k2d4QlLPLG/vlZRboNYAAAAAAAB8F47F16i+na+ZLemP\n", - "W99Na7QsnDJN879J+pik+yTdYVlWzTMlI6lvlo9YI2nJnEQPAAAAAAAwjb+WdGHT766k30xEI+M+\n", - "9bPgWhJOmaZ5UNI9kv5L0vNnOEj9KUmXzvD+9aqfN3VkwZoEAAAAAADwUTgWf7GkOz3lDySikW9P\n", - "N3+pWPBwyjTNqyX9u6SHJD3XsqzCDFO/JemZpmn2TjP2HEk1Sd9ZkCYBAAAAAAB8FI7Ft0j6iKf8\n", - "M0lv86GdllrQcMo0zd2SviopKenZlmWdnGX6P0sKSXqL5zN6G7V/syxreKF6BQAAAAAA8EM4Fjck\n", - "/YPqu8ZOKUt6ZSIamWmRz5LRscCfb6l+yPm7JV1jmuZ0c75nWVbRsqxB0zTfJOlu0zTXSfqKpNWS\n", - "/kjSWp1+Sj0AAAAAAMBS8BrVd401+4tENPJTP5pptfkKp9zG5dUvaYXq503N9L6LJQ1IkmVZHzJN\n", - "c1RSVPU9llOqb/d7mWVZqXnqFQAAAAAAYFEIx+KXSPqgp/xdSTEf2vGF4brTZUpLx3333edK0qFD\n", - "hwy/ewEAAAAAADglHIuHVH943PVN5UlJVyWikaf86erszGfe0pKn9QEAAAAAAOA0b9fTgylJesNi\n", - "D6bmG+EUAAAAAABAi4Vj8WfJ81A4SZ9X/WD0ZYVwCgAAAAAAoIXCsXi/pE9Kat4Sd1zSaxLRyNI+\n", - "f2kahFMAAAAAAAAtEo7FDUkfkXRBU9mVdGciGkn705W/CKcAAAAAAABa57ck/Yan9v5ENHKfD70s\n", - "CoRTAAAAAAAALRCOxS+R9Dee8o8l/bkP7SwahFMAAAAAAAALLByLhyT9P0krmsp5Sa9IRCMlf7pa\n", - "HAinAAAAAAAAFt47JYU9tT9ORCOP+dHMYkI4BQAAAAAAsIDCsfizJb3ZU/68pL/3oZ1Fh3AKAAAA\n", - "AABggYRj8S2SPukpD0p6TSIacX1oadEhnAIAAAAAAFgA4Vg8qHowtaGpXJP08kQ0kvanq8WHcAoA\n", - "AAAAAGBhvFnSIU/t7Ylo5Nt+NLNYEU4BAAAAAADMs3AsfrOkd3jK35L0rtZ3s7gRTgEAAAAAAMyj\n", - "cCy+VtK/SAo2lcckvSIRjVT96WrxIpwCAAAAAACYJ+FY3JD0j5Iu9Az9ZiIaOe5DS4se4RQAAAAA\n", - "AMD8+X1Jv+6pfSARjdzrRzPtgHAKAAAAAABgHoRj8QOSPuApJyS91Yd22gbhFAAAAAAAwBw1zpmy\n", - "JIWayuOSXpqIRkr+dNUeCKcAAAAAAADmIByLByR9QtIOz9CrE9HIER9aaiuEUwAAAAAAAHPzRknP\n", - "89TuTkQjn/WjmXZDOAUAAAAAAHCewrH4rZLe7Sn/QNKbfGinLRFOAQAAAAAAnIdwLL5R0qclBZvK\n", - "GUkm50ydPcIpAAAAAACAcxSOxYOSPiVpi2foVYloZMCHltoW4RQAAAAAAMC5+wtJhzy19ySikXv9\n", - "aKadEU4BAAAAAACcg3As/lzVw6lm909Tw1kgnAIAAAAAADhL4Vh8l6T/6ymfkPSyRDRS8aGltkc4\n", - "BQAAAAAAcBbCsXivpM9J6msqVyW9NBGNDPnTVfsjnAIAAAAAADiDcCxuSPqopCs9Q29KRCPfan1H\n", - "SwfhFAAAAAAAwJn9vqRXeGr3SPorH3pZUginAAAAAAAAZhGOxW+W9EFP+VFJ/z0Rjbg+tLSkEE4B\n", - "AAAAAADMIByLb5b0GUkdTeUJSS9KRCMn/elqaSGcAgAAAAAAmEY4Fu9UPZja4hm6MxGNPO5DS0sS\n", - "4RQAAAAAAMD07pZ0i6f2nkQ08gU/mlmqCKcAAAAAAAA8wrH46yTd5Sl/XdLbfGhnSSOcAgAAAAAA\n", - "aBKOxQ9K+pCnnJT0skQ0UvWhpSWNcAoAAAAAAKAhHItfKOlf9fQD0CclvSARjaT96WppI5wCAAAA\n", - "AACQFI7FeyV9QdJGz9CdiWjkYR9aWhYIpwAAAAAAwLIXjsUNSX8v6VrP0DsS0cjnfGhp2SCcAgAA\n", - "AAAAkN4o6eWe2hclvd2HXpYVwikAAAAAALCshWPx50h6r6f8qKRXJaKRmg8tLSuEUwAAAAAAYNkK\n", - "x+L7JX1aT89IsqofgD7hT1fLC+EUAAAAAABYlsKx+EZJX5K0qqlck3RHIhp50p+ulh/CKQAAAAAA\n", - "sOyEY/FuSZ+XtMMz9MeJaORrPrS0bBFOAQAAAACAZaXxZL6PSnqGZ+jDkj7U+o6WN8IpAAAAAACw\n", - "3LxF0qs8tfsk/WEiGnF96GdZI5wCAAAAAADLRjgWf5Gkd3vKhyX9RiIaKfvQ0rJHOAUAAAAAAJaF\n", - "cCx+naRPesqOpOclohHHh5YgwikAAAAAALAMhGPx7ao/ma+3qVyR9OJENPKEP11BIpwCAAAAAABL\n", - "XDgWXyPpXkmbPUOvT0Qj3/ShJTQhnAIAAAAAAEtWOBbvlPRZSZd7hj6QiEb+3oeW4EE4BQAAAAAA\n", - "lqRwLG5I+oikQ56hz0p6U+s7wnQIpwAAAAAAwFL155J+y1P7vqRXJaKRWuvbwXQIpwAAAAAAwJIT\n", - "jsVfKekdnvIRSc9PRCN5H1rCDAinAAAAAADAkhKOxZ8l6WOeckbS7YloZLT1HWE2hFMAAAAAAGDJ\n", - "CMfiV0r6oqRQU7kk6QWJaOSwP11hNoRTAAAAAABgSQjH4jskfUXSas/Qbyaikf/0oSWcBcIpAAAA\n", - "AADQ9sKx+DpJX5W0xTP0lkQ08mkfWsJZIpwCAAAAAABtLRyL90r6kqS9nqG7Jb2v9R3hXBBOAQAA\n", - "AACAthWOxTsk3SPpRs+QJelPEtGI2/qucC4IpwAAAAAAQFsKx+KGpA9Lep5n6JuS7kxEI7XWd4Vz\n", - "RTgFAAAAAADa1Tsk/Y6n9lNJL0xEI0Uf+sF5IJwCAAAAAABtJxyLv0HSn3vKKUm3J6KRnA8t4TwR\n", - "TgEAAAAAgLYSjsV/S9IHPeW0pGcnopGh1neEuSCcAgAAAAAAbSMci/+6pH/0lCclPTcRjTzuQ0uY\n", - "I8IpAAAAAADQFsKx+CHVn8zXnGeUJP16Ihr5gT9dYa4IpwAAAAAAwKIXjsVvkPRFSZ1N5ZqklyWi\n", - "kW/40xXmA+EUAAAAAABY1MKx+OWS7pW0wjP0mkQ08jkfWsI8IpwCAAAAAACLVjgW3yXpa5LWeob+\n", - "NBGNfMyHljDPCKcAAAAAAMCiFI7Fd0iKS9rqGXpXIhrxPq0PbYpwCgAAAAAALDrhWHybpPskbfcM\n", - "/Z2kt7W+IywUwikAAAAAALCohGPxTaoHU7s8Q/8s6Q8S0Yjb+q6wUAinAAAAAADAohGOxddJ+rqk\n", - "vZ4hS9LvJKKRWuu7wkIinAIAAAAAAItCOBbvU/3w8ys8Q1+U9MpENFJpfVdYaIRTAAAAAADAd+FY\n", - "fJWk/5B0rWfoK5LuSEQj5dZ3hVYgnAIAAAAAAL4Kx+KrVQ+hbvQMxSW9KBGNFFvfFVqlw+8GAAAA\n", - "AADA8tUUTN3kGfqupOcnopF867tCK7FyCgAAAAAA+GKWYOqHkp6TiEYmW98VWo1wCgAAAAAAtNwZ\n", - "gqlfTUQj463vCn4gnAIAAAAAAC3VCKa+qtODqR+oHkzlWt8V/EI4BQAAAAAAWqYpmPIefv59Sc8m\n", - "mFp+CKcAAAAAAEBLhGPxtZK+oemDqV8jmFqeeFofAAAAAABYcOFYfKOkr0u60jN0asUUZ0wtU3MO\n", - "p0zT3Crpy5Iusiyrf4Y5d0n6fUkXS8pIulfS2yzLGplm7kskvVnSXkmTku6X9FbLso7MtVcAAAAA\n", - "ANB64Vh8q6T7JF3qGfqe6iumCKaWsTlt6zNNc7/qCeeVktwZ5vwvSXdL+ndJL5H0l5Iiku43TXO1\n", - "Z+7rJd0j6QFJL5cUlbRb0ndN09wxl14BAAAAAEDrhWPxHZK+rdODqfvFiiloDiunTNM8JOmzkh6T\n", - "9AVJr5pmznWS3ijptZZl/WNT/UuSHpL0PyX9aaO2TdL7Jb3bsqy3Nc39nOph1Qclvfh8+wUAAAAA\n", - "AK0VjsV3S4pLutAz9DVJL0xEI1Ot7wqLzVxWTt0p6UeSDqm+VW86r5V0pDmYkiTLsk5I+ltJv22a\n", - "5qmA7E5JZUnv8cydkvReSc83TXPzHPoFAAAAAAAtEo7F96m+YsobTH1R0vMJpnDKXMKpuyTdblnW\n", - "5CxzniXpP2YYu1dSn6Srm+be3wijppsblHTLeXUKAAAAAABaJhyLh1UPprZ4hixJv5GIRoqt7wqL\n", - "1XmHU5Zl5S3LKs00bpqmIWmn6tv+pvN443VX43X3THMtyxpTfXXWrunGAQAAAADA4hCOxQ+pvpVv\n", - "nWfoE5JenohGyq3vCovZnA5EP4PVqq92yk43aFnWhKSqfvk3a/9McxuyOv1vbAAAAAAAsEiEY/EX\n", - "qb77aaVn6MOSXp2IRqqt7wqL3UKGU6sar/lZ5uQlrWmaP9vcqaa5AAAAAABgEQnH4r8j6TOSOj1D\n", - "75H0+kQ0Umt9V2gH5/20vrMw0XjtmWVOj6Rc0/zZ5vY2zQUAAAAAAItEOBaPSnrfNENvTEQjH2h1\n", - "P2gvCxlOjau+ba9vukHTNFeqvu0v3ShlZprbsKZpLgAAAAAA8Fk4Fg+ovjLqTZ6hmqT/nohGPt76\n", - "rtBuFmxbn2VZrqQjki6dYcqp+pHG61MzzTVNc73q500dmW4cAAAAAAC0VjgW7+zqMP5FpwdTRUkv\n", - "JpjC2VrIM6ck6VuSbp9h7DmqH3L+YNPcZ5qm2TvD3Jqk78xzfwAAAAAA4Bw4jhP86kP21et6gj8u\n", - "VlyzecwwNCnp9kQ08gWf2kMbWuhw6u8l7TRN89XNRdM0N0n6PUn/ZFnWqUdI/rOkkKS3eOb2Nmr/\n", - "ZlnW8AL3CwAAAAAApuE4zpqhoaGbf/D4wDvfF3/qK+l89fLm8ZDhTj3v0vWvSUQj3/SrR7SnhTxz\n", - "SpZlPWCa5l9J+jvTNHdL+q6kzZLerPqqqb9smjtomuabJN1tmuY6SV+RtFrSH0laK+kNC9krAAAA\n", - "AAB4OsdxDEkXOY5zIJvN7v/mo8fWfnao56VlBdc2z+twKyN3bM1/5s6br33Up1bRxuYrnHIb12ks\n", - "y3qjaZpJSb+retCUlXSvpP9hWda4Z+6HTNMclRSVdKekKdW3+73MsqzUPPUKAAAAAABm4TjOinK5\n", - "vC+TyRw8ceLEWtu28/cPlrse6bjoN2tGYEXz3C63lLyh8LMPXdizs9+vftHeDNedNlNaMu677z5X\n", - "kg4dOmT43QsAAAAAAItVY5XU1lwud30ul7sulUoZtm2nHceZeiS08zq7Y+tvu4YRan5Pby3/8DOK\n", - "D3202y2Vrrjiigtvu+22f+3v7/+pT38JaKH5zFsWdFsfAAAAAABY3BzH6arVantHR0dvTafTW5LJ\n", - "ZGFgYGCoXC5XXUkPdO67/UTHul/3vm9NdeI7zyg+9KmgajUf2sYSQjgFAAAAAMAy5DjOpomJiWty\n", - "udwNR48eDdm27YyOjv7iSJ2ygsHvdV/5yvHAymd437uxmvm3cPGRL7NFCfOBcAoAAAAAgGXCcZyQ\n", - "pN1jY2O3ZDKZHclksmLb9kixWKw0z5swenp/2LX/rnyge+/TPsB1q9urw5+8svTk91rZN5Y2wikA\n", - "AAAAAJY4x3H6p6amrspmszcPDg722LY9Pjw8PDDdOdQnAv0bHuza+wdlI7SpuR5wa1N7y/b/2VUZ\n", - "PNyyxrEsEE4BAAAAALAEOY4TlHRxOp2+KZvN7rVtu2rb9ujk5OToTO850rHtksdCF91VMwIrm+sd\n", - "bmX06tLjf7O5mjmx4I1j2SGcAgAAAABgCXEcZ1WhUNjvOM6tw8PDq2zbnhwcHDxaq9VOXybV5MHO\n", - "PQePBTe+TIYRbK5314pPHij+7P+sdqdOLmznWK4IpwAAAAAAaHOO4xiStmez2QPZbPbKVCqlZDI5\n", - "Nj4+7pzpvRUFgt/vuuKObHD1M71jq2snf3Bj4eF/7lSlMt17gflAOAUAAAAAQJtyHKenVCrtcxzn\n", - "1pGRkXXJZLJw9OjRY9VqddZVUqeMG70rE12Xv/a0g8/FE/nQOoRTAAAAAAC0Gcdxto6Pj1+Xy+Wu\n", - "S6VSQdu2M5lMZuBcPmMwuGHbw527f69idKxrrhturbizMvixy8r2g/PbNTA9wikAAAAAANqA4zhd\n", - "tVptz9jY2MF0Or3Ntu1SKpU6USqVquf6WY+GLr4m2bH1t10j0NVc73Ar6StKT/7tturo4Px1DsyO\n", - "cAoAAAAAgEXMcZwNk5OTV2ez2RuPHj3aZdt2dmRkJHU+n1VVIPDDrstfkA72/Zp3rLtWOHyg+MhH\n", - "OPgcrUY4BQAAAADAIuM4ToekXWNjYzdnMpmdtm1XUqnUaD6fL5/vZ44bK1Ymuva9Jh/ovtQ71lcd\n", - "v//G4sP3dKh2zquwgLkinAIAAAAAYJFwHKcvn89f6TjOLcePH19h2/b40NDQgOue1fnmM0oFN+94\n", - "tPPiu6pGx9qnDbhudVt15NPXlA5/e043AOaAcAoAAAAAAB85jhOQdHEmk7khm83uSyaTtVQqNXry\n", - "5Mmx+fjGHecBAAAgAElEQVT8BzsvueVYcNPLZBhPywCCbjV7WTn5kYsqQ0fm4z7A+SKcAgAAAADA\n", - "B47jrCwWi/sdxzk4PDy8xrbtqWPHjh2t1WpzWybVUFCoM9F1+UtzwVU3e8e6a4Unri/9/KN9tZPj\n", - "83EvYC4IpwAAAAAAaBHHcQxJF2az2XAul7vKtm3Dtu2xXC43MJ/3GQqu2/xQ5yWvLRuhbd6xtdXc\n", - "Nw4Uf/Y5zpfCYkE4BQAAAADAAnMcp6dSqVyaTqdvHRsb25BMJosDAwPHK5VKbb7v9XBo14GBjs2v\n", - "dI1AV3PdcGulHZWhT+wvH3lgvu8JzAXhFAAAAAAAC8RxnC3j4+PX5HK5AwMDA8FUKuWMjY3N6yqp\n", - "U4oKhX7YdfkdueCqg96xkFs+sb/01Ee2VUcHF+LewFwQTgEAAAAAMI8cx+msVquXpNPpg47jXHjk\n", - "yJFSKpU6USqVFmwb3XBw7aaHOve8rjTNNr5VtckfHig+8n973GJxoe4PzAXhFAAAAAAA88BxnPWT\n", - "k5NXZ7PZm44dO9Zl23buxIkTqYW8pyvp4c7dzzga3PRS7zY+uW7lgurIp68qHf6OsZBNAHNEOAUA\n", - "AAAAwHlyHCcoadfY2NjN2Wx2VzKZrNq2PZLP58sLfe9Jo7sn0bXvlScDK673jnW4lZH9pac+ckF1\n", - "5NhC9wHMFeEUAAAAAADnyHGcNYVCYb/jOLceP358RSqVOjk4ODjgum5L7n+kY+vux0M7fqdqdKz1\n", - "jq2qTSYOFB/5JNv40C4IpwAAAAAAOAuO4wQk7XAc54ZsNnu5bduubdujExMT6Vb1UFUg8EDXZc8d\n", - "DfQ/V4bxtN16hlsrbauO3HNV6Yn/ZBsf2gnhFAAAAAAAs3AcZ0W5XL48nU7feuLEiT7btvPHjh07\n", - "Vq1WW7NMqmEk0L/hoc5LfrsQ6NrlHet0S0evKD35D1uq6eFW9gTMB8IpAAAAAAA8HMcxJG3L5XLX\n", - "53K5a1OpVCCZTI5ls9mBVvfiSvpp556Dg8ENv3HaoeeS1lazX7+++PMvdKpSaXVvwHwgnAIAAAAA\n", - "oMFxnO5arbZ3bGzs1tHR0U22bRcHBgaGyuVy1Zd+AqvW/KRz729OBXou944F3er4rvLRj++pHH3U\n", - "j96A+UI4BQAAAABY9hzH2TQxMXFtLpe74ejRox22bTujo6MtXyXV7JHQzutTHVteUTMCvd6x3lr+\n", - "4euKP//EGndywo/egPlEOAUAAAAAWJYcxwlJumR0dPSWTCazI5lMllKp1EixWPR1e9yE0bvix12X\n", - "vmwisCLsHTPcWnFbdcTi0HMsJYRTAAAAAIBlxXGctZOTk1dns9lnDA4O9qRSqdzw8HDKdVt6vvm0\n", - "Hg1dfK3dseXlNSO4yjvWXSs+cWXp8D9trGXH/OgNWCiEUwAAAACAJc9xnKCknel0+sZsNrs3mUxW\n", - "U6nU6OTk5IjfvUlSNrBy9YOde192MtB77WmDrlvZXE1/4ZrSY98IahEkaMA8I5wCAAAAACxZjuOs\n", - "LhQK+x3HOTg8PLzatu2Tx44dG1gMq6Sk+pP4fhbadcPRjs0vne5sqU63dPTy0lMf21YdO+5De0BL\n", - "EE4BAAAAAJYUx3EMSTscxzmQy+WusG1byWRydGJiwvG7t2bpwOr+n3buecVUoOeK0wZdt7qx5nz5\n", - "muJjXwmp6suTAoFWIZwCAAAAACwJjuP0lkqlfZlM5uDo6Oi6ZDJZOHr06LFqtbo4lkk1VBUIPNi5\n", - "57bh4LoXuEagyzve5ZbsfaWnPsFqKSwXhFMAAAAAgLbVWCW1NZfLXZ/L5a4dGBgI2LadyWQyA373\n", - "Np2B4KYdj3Ve9MqS0bndO2a4bnlTNf1v15Qe/0ZQtZof/QF+IJwCAAAAALQdx3G6arXanrGxsWem\n", - "0+ktyWSymEqlhsvl8qLcAjdldHX/pHPvC5zA6ttkGIZ3vLtWfHJ/+clPbK5mFsUB7UArEU4BAAAA\n", - "ANqG4zgbT548eU02m73x2LFjoWQy6YyOjqb87msmrqSfhy6+JtWx5aVVI9jnHTfcWn5rdfTzV5We\n", - "+HaAJ/FhmSKcAgAAAAAsao7jdEjaPTo6eovjOBfZtl2xbXukUChU/O5tNkPBdZsfDe28Ix/o3jfd\n", - "+Kra5ANXlp6w+msTuVb3BiwmhFMAAAAAgEXJcZz+qampq7LZ7M3Hjx/vSSaT48PDwwPuIl9glDe6\n", - "uh7s3PO8dGDNIRlG0Dve4VbGdpYHP7WnMvCIH/0Biw3hFAAAAABg0XAcJyjponQ6fVMul7ssmUxW\n", - "bdsemZycHPW7tzNxJf0stOvAsY5NL6kawTWnT3Cr62rZr19TfPzL3SqXWt8hsDgRTgEAAAAAfOc4\n", - "zqpisbjfcZyDw8PDq5PJ5OTg4OBArVZb3MukGgaCm3YcDu0wC4Gu3dON99QKj11WTn56a3VsqNW9\n", - "AYsd4RQAAAAAwBeO4xiStmez2XA2m70qlUopmUyOjY+PD/jd29nKBFb3/axz16+PB1beNN140K06\n", - "2ytDn9lXTv7otEf0AZBEOAUAAAAAaDHHcXoqlcpl6XT61tHR0fXJZLIwMDBwrFqttsUqKUkqGJ2d\n", - "P+285Nljgf5fdQ2j87QJrltZX8t+/erS4Xu73RJb+IBZEE4BAAAAAFrCcZwt4+Pj1+VyuesHBgY6\n", - "bNvOpNPptlklJUlVGcYjnbtuHAxufOG050pJ6q3lH768dMTaVMuMtLo/oB0RTgEAAAAAFozjOJ3V\n", - "anVPJpM5mE6nL0gmk6VUKnWiVCpV/e7tXLiSHg/tuCLVseWFZSO0bbo5Ibd8/OLy4Gf2VI4+2uL2\n", - "gLZGOAUAAAAAmHeO42yYnJy8KpvN3nT06NGuVCqVO3HiRMrvvs5HsmPrrqc6LnjRTIedB9zqxNbq\n", - "2BevKD353aBqtVb3B7Q7wikAAAAAwLxwHKdD0q6xsbGbHcfZmUwmq6lUaiSfz5f97u18DAbXbz0c\n", - "2vHCyUDvldNOcN3KulruG1eVDv9Hr1sstLg9YMkgnAIAAAAAzInjOH35fP4Kx3FuGRoaWmnb9sTx\n", - "48cHXLdtzjd/muHg2o2Ph3Y8b8JYcUCGcfpD9lzXXeVO/nBfKfnFDbVs2ocWgSWFcAoAAAAAcM4c\n", - "xwlIuiiTydyYzWYvs23bTaVSoxMTE20b1pwI9G94vPOi544bK26cNpSS1FvL/2xPeeDzF1RHjrW6\n", - "P2CpIpwCAAAAAJw1x3FWlsvlfel0+tYTJ0702badP3r06LFardaey6QkjQT61j/eedFzc8bKG2UY\n", - "genmdNWKR3ZWBj+3qzL4RKv7A5Y6wikAAAAAwKwcxzEkXZDNZsO5XO7qVCpl2LadzmazA373Nhcn\n", - "Ams3Hg5t/7VcYOWNMozgdHNCbnloe2X4C5eW7QenXUoFYM4IpwAAgCQpHIsbkkKSehpXb9Nrl6TA\n", - "DJcxQ70qqTzDVZqmVpQ0mYhGSgv+FwsAOCuO43RXKpVL0+n0rWNjY5uSyWRxYGDgeKVSaesn0h0L\n", - "brzgqdAFt08YvdfNtH0v5JaHL6iM/Ptl5eSPAmrTw7OANkE4BQDAEhCOxQOS1khaK6m/8Trbzyt0\n", - "egDVI2naPzVupXAsXpF0UtJk45rt55wkZ4Yrm4hGKq3uHwCWAsdxNo+Pj187Pj5+YGBgoMO27czY\n", - "2FjK777myu7YsjPZse32yUDP9E/fkxRyyye2VUa/dFn5SCJIKAW0BOEUAACLWDgWD0naLGmbpK2N\n", - "a5vndbOkPtVXMC0FHar/9fTN9YPCsfiEnh5YpSWNeK4TTT9nE9EI/yECYFlyHCdUrVb3ZDKZWzKZ\n", - "zPZkMllKpVIjxWKxrYP+mgzjcGj7/sHgxl/JB7r3zjSvw62MbKuMfGlfOZkIqtbWK8OAdkM4BQCA\n", - "Txrb6NZKurhx7ZR0kaQL9MvgaaOWTujkh1WNa/tZzi+HY/FRPT20GpJ0XNJg4zouaYjthwCWCsdx\n", - "1k1NTV3tOM5Ng4OD3bZt54aHh9t+lVRJHR2Pdl5844ngul8pG6HNM83rdMuDWysj915Wtn9MKAX4\n", - "g3AKAIAFFo7F+yXtkbS38bpH0iWqh1GrfWxtOlVJU5LyjevUz4XGmCupNsPlen4Oqn6G1dleXapv\n", - "N/Tz/5+E9MsVarNqhFinwqrm4OqYpAFJqUQ0cnLhWgWA8+c4TlDSzrGxsWdks9lLbNuu2rY9OjU1\n", - "1fbB+7jRu/KxzoufORZYc1vNCK6aaV5XrZi8sHri3r3l1EP8KRDgL8IpAADmSTgW3yDpcs+1T9L6\n", - "FrUwrvrWtUzTa2aamiNpQr8Mnn7xmohGyi3qdUbhWLxT0krVg6oVTT97aytV3/rXP8O1Rgu76mxD\n", - "47p6pgnhWNyRlFIjrJrmdSQRjfCn9ABaxnGcNYVCYb/jOLcODQ2ttG17YnBwcMBdAkcrHQ1u2m6H\n", - "ttw2bqwMu4YRmmleT63w2I7K0L27KsceJ5QCFgfCKQAAzlE4Fu9QfRXU1ZKuabxeofoWvPnmqr61\n", - "7Lh+uULH+zosKbMYgqX50NgudypYO2/hWDyo+sq0U2HVWknrVP+evNemxuvKudxzGqfuPVOAVQrH\n", - "4gOSkpKOSHqq+TURjYzPcz8AliHHcQxJFzmOcyCbze63bdu1bXt0YmIi7Xdvc1VWMPh4aMe1w8H1\n", - "txUCXbtmnOi61VXu5AM7y4Nfv7A6crSFLQI4C4RTAADMohFE7ZN0QFJY9TDqCknd83SLvOrBxKnr\n", - "iOqrak5tExteKqFTqyWikap+eRD6WQnH4r2qr4Y6FVpt1vQH0W/S/KzK6pS0u3FN109ansCq6edB\n", - "Vl0BmI3jOCvK5fK+TCZz8MSJE2tt284fPXr0WLVabftlUpnA6r4nQhcezATWHKwawTUzzTPcWn5t\n", - "bfw7e8qp+Lra+Fn/+wBAaxFOAQDQJByLXyjpGaqHUQckXSupd44fW5L0hKTDjevxxu9PSjrB0+EW\n", - "j0Q0MqX6drtZDwJuPEVxk+pBVXNotU3ShaofwH6h6mdYzcW6xnVgmrFSOBa3dXp4dVj1VVfFOd4b\n", - "QBtqrJLaNj4+fn02m712YGDASCaTacdxBvzuba6qCgSeCF24fyi44eCk0X2FDGPGPyTocCvpDVUn\n", - "flk5+Z+9brHQyj4BnDvCKQDAstXY9nWlpJubrgvn8JFFST+X9IjnshureLBENFazHZN0rHGocI/q\n", - "IWavpN5ardabnTjZ97OhkxcP5AoXp6cqF2YL1c2ZfKUvV6iuPll210xV3DUV15jLCrxO/fKAfa9a\n", - "I7g6rKcHo4clHeXvR2DpcRynq1ar7R0dHb01nU5vSSaThYGBgaFyudz2/3tPB9asfTJ0wc2ZwJpb\n", - "qkawb7a5PbXCo9uqI9+8pDzwcFBL4CAtYJkgnAIALBuNLXrXSnqWpNtUD6NmfIrPGQxLerBx/UTS\n", - "TyU9lYhGKnPvFIuB4zghNQVOknrL5fLKqampvnK53F+tVvtqtdqaWq3WWywW3UKhoHw+r0KhYOTz\n", - "eRWLxXKxWCwFCoWxlfn88WA+X+6v1Z72H0pTRle3E1i9bjywYsOU0b2+YHRtKBqhDWWjY31ZHetl\n", - "GMHzbD+g+tMgd0r6Nc9YMRyLP6WnB1anrhFW8gHtxXGcTRMTE9fkcrkbjh49GrJt2xkdHZ119Wc7\n", - "KCjU+URo+9UjwbU35Y2uy2ZbJWW4tWJf7eR/7awc+9aWanq4lX0CmB+EUwCAJSsciwckXSUponoY\n", - "dVD1A7LP1YikHzauByT9JBGN8H9+21Bju0u36mHTL1Y75fP51YVCob9SqfRXq9U1ruuuKZfLoVOh\n", - "UyN4MgqFglssFkuFQqFUKBRK+Xw+VywW0+f7lKtet1jorY4ObquODnrHqjKMbGB1fzawcv3JQO+G\n", - "vNG1oWh0bigZofVldayvGYHzPby9S/Vz1PZ5Bwxp8qYPfPOpgKHD1Zr7aNXVo5Iek3Q4EY3kz/N+\n", - "AOZZIzzfPTY2dksmk7komUyWU6nUSKFQaOs/IHElJTu27h4MbrxpPLDietcIzLq6tNMtHdtQzX57\n", - "b9n+AVv3gPZGOAUAWFLCsfgmSb8q6dmSfkXn/gS9ouoB1Pck/UD1QOooq0kWN8dxAvrlCqceNbbW\n", - "TU1N9ZVKpf5KpdJXq9X6arXaqlKpFCgUCm7jMvL5vFEsFmunQqd8Pl/K5/Ojfm+FCcp119VymXW1\n", - "XEb1VU1PM2l092QCq9dPBFasnzK6NxSMro1FI7ShZHRsrBoda8/nnq60olJzr1R9u+vThm7+4DdP\n", - "dHUEnuoMBg53Bo3HggHjYdfVTwbHi5ybBrSI4zhrp6amrspms88YHBzstW07Nzw8nDrfgHyxGA6u\n", - "3ZTq2HLACay+oWJ0bJhtruHWiqtrk4ntleFvb68Op+bjyRQA/Ec4BQBoa42tejdKep7q25euOseP\n", - "GJP03abrRxwkvXjMsLVuxdTUVH/T1rrVtVptxWxb6xornYpTU1MTNc/Wuna1wi3kV1QLR1XVaY9E\n", - "LyjUmQ72bcgFVm6aNHo25QNdG0sKbSoZHZtqRvB8VlwZpaq7uVStbpaqNzcPhAKa+tW/+dbQys7g\n", - "wIrO4OG1K7oe3d7X/eiv7V33+NbVXeOSTvb397f9mTeAXxrn2l2cTqdvymaze23brtq2PTo5OTnq\n", - "d29zkQ6sWZvs2Hp9Jrj6QMnoPON5j51uaWBj1fn2nnIqwSopYOkhnAIAtJ1wLL5G9SDqeZKeI+lc\n", - "VomMSvpW4/qmpMdY9dFaja11XfKETtNsrVtVqVS6isWi2wicpt1aVygUJgqFQqbdVw7Mp26VS9tm\n", - "2C44YfT0ZoJrNo0bKzZOBXo2FYzOTUUjtLGsjk2uEeg613uVa+p1CrVdTqG2SyrfprGC/iuV0z0/\n", - "PVFd1Wlk+ruD6XU9waG1PcHkttVdj193weqfXbp17ZCkk41rUtIkARbwdI7jrCoUCvsdx7l1eHh4\n", - "lW3bk4ODg0fbOWDPBFb12R1br8kE1lxfCHTtPtP8oFsd76tNfH97Zeh726pjx1vRIwB/EE4BANpC\n", - "OBa/QNILG9dBnf2/wyYkxSXdp3oY9Qhh1MJobK077al1022tK5fLRqFQcJtWOU23tS7t99a6pWiV\n", - "m59aVcknJSWb666kbGDVmkxg9caJwIrNU0b3poLRublkhLZUFFw322HE03Gl4HjJ3TBeqmxIjVcu\n", - "lXSbNKVPPOSoK2CPrw5pbG13YGzTio70RX1d6V1ruwYu6usc6AyFxrq7uzMrVqxwVA+uToVYUwRY\n", - "WOoa4f32bDZ7IJvNXplKpZRMJsfGx8cdv3s7XyOBvvUDHVuudQKrrikGunae8Q2uW1npTj24pTr2\n", - "vd3lY48GVau1oE0APiOcAgAsWuFYfJekF0l6saQbzvJtrupnRn1V0tckfT8RjZQXpsPlYaatdfl8\n", - "vr9UKvU1PbVu2q11pVKp0hQ6FfP5/ES1WiUgXGQMSf21iVx/bSIn6YnmsaJCobFg38ZsYNXmyUDP\n", - "5rzRtaVohDaXFdrkGkbnud6rWDNWjxa1erTo7nw8V9a3j5clnVRAtUJvoDa6KljLrO1SZsuKwOjF\n", - "fZ3pfRt7M30re2tDQ0OTwWDQCQaD6Z6enrHe3t6sGiuv1FiF1d/fz3/Iou04jtNbKpX2OY5zcGRk\n", - "ZJ1t24WBgYFj7fjPSlfSYHDjBcc7NlyVDay85my27Ml13R63+Pj6WvaHu8rHfrLSzU8tfKcAFhPC\n", - "KQDAohKOxXdKepmk39DZnx/lSLpX0pclfS0RjaQXqL0lY7atdcVisa9cLvdVq9U+13VXz7S1rlQq\n", - "lZueWsfWuiWsS+XydNsEazKMTGB1fyawZstEoHdz3ujafGq1Vc0IrjrX+9QU6D5ZC1x4sqYLh8rS\n", - "IyclnahJj03UQsqOdat8YlWwOraus5bZ2lPLXbwq4Gxb0z3Z29tr9Pb2Gt3d3RoaGpoIBoOZjo4O\n", - "p7u7+1SA9YvtgyLAwiLiOM7W8fHx63K53HWpVCpo23Ymk8kM+N3XuSoqFLJDWy8dDfRdMRFYcWXV\n", - "CPafzfu6asUj62q5xM7K4AN9tZPjC90ngMWLcAoA4LtwLL5F0h2qh1IHzvJtj0n698b1vUQ00taP\n", - "z54vs22tKxaLfdVq9Reh06mtdadWOLG1DucqINddX8tl1tefKPhI89iE0dObDvZtHg+s2Dxp9Gwu\n", - "GJ1bikbn5oqCG851i6AMI1BWx8ayOjZO1KTjBenhgiRHCrjVk53u5HCX6wz3qji8Nlga29ZVXnPR\n", - "Cnfjyt6eK7u7uwO9vb1ub2+v29PTY3R3dxvDw8PjgUAgEwqFMt3d3emenp5TK7BOhVhTBFhYKI7j\n", - "dNVqtT1jY2MH0+n0Ntu2S6lU6kSpVGqrf9aOBPo3DHZs3JcNrNw/ZfRcerarKLtqxWR/beLHOypD\n", - "P9pQy/KHSQAkEU4BAHzSONT8JZJeIelZqu8qOpMfSPqspM8nopEnF667xcezta5H9a11K2fbWnfq\n", - "aoROFU/odLwdt4ugfTTOtjoi6UhzvaSOjrFg34ZsYNXmk0bP5kKga8v/z96dhzd21fcf/1ytluxZ\n", - "M5mZTPYFkoZ9ERACKQgoECiFtBFbSDITdkjbH6Af0MIPKN2oWuhCurGUtqS0aktpgdAWUIFG8ow1\n", - "a2aLZ/G+W/axLdmSbEn394c84Cj2rNb19n49zzyOz7k63+88PJMMH59zbtHybZ+WZ/vFXMhesdxN\n", - "Bct9U0H+m8a1Tv2SjhYlFeySd6Q05LdnBhrs3EBjZXhgQyU3cLk9PrAl4LaDweDGQCCwraGhwR8I\n", - "BFyz4ZWCwaD8fr/V398/7na7jcfjGQkGg5mGhoYJ/Sy8OnMHFn+GcN6MMZdPTk4+e2xs7Lbu7m5f\n", - "R0fH2NDQUOdS93W+Jq2GQJdn+80jrg235lzBW0uW5/Lz+qBt2w128eTmysT+a0v9By+rrNz7swDU\n", - "D+EUAMAxoVjCLekVku5T9S6phnN8pCLpJ5K+qWog1VPfDp1njGlQTehUKBTWFQqFzWc5WmfPHq2z\n", - "pqenpzlah5XEp1JpRznTv6Oc6Z87bksyrvUbR6pHBLflrYYrCpZv27Tl3X6+R4SewLI8M/LumLG8\n", - "O3IKKjNnCXelPObLzgz4J6YHgnZhYF1ldGBzpX1gUyU75pJtW5alYDDoOxNgBQIB/5wdWAoEAvL7\n", - "/dbAwMC4y+Ua8Xq9o4FA4EyAVbsDiz+Qa5gxxiPppkwmc7sx5ob29vZSZ2fnUD6fX/Z3IRbk9XV7\n", - "tt844t5wc9YK3ly0fNfJslzn81nLtqeDdv745srEY9fN9B3aYE9m690vgJWNcAoAUHehWOIWSfdL\n", - "ukfSlefxkf+V9A1J/5qOhofq2FpdzHe0TlIwl8ttKBaLm+bsclo/MzPjnj1ap4WO1hUKhZGVdtwD\n", - "uFCWpM2VibHNlYkxScfnzuUtv3/YtXHbuKtp+6QrMHuvlW/7tDzbZFkX/PfZsuXemLfcG/NquGVM\n", - "63/Wg12Z9qo04LNnhhpK00PB8cLQOjM1tLncM7TenszO3d7pcrmsYDDoCwQCm4PB4I6GhgZfIBBw\n", - "B4PBSiAQsIPBoMvv99uzO7BGvV7vSGNj44jP56vdgZUnwFp9jDGb8vn8M4wxL+nr62vs6OiY6O/v\n", - "71zOPzzIWz5/j3vb9aPuDU/NWsGbC5bvelmW+3w/77ZLo+sqU4cvr5jHrpvpb/VrZtkHcACWD8Ip\n", - "AEBdhGKJgKrH9t4t6SXn8ZH9qgZS/5SOhrvr2dvFmv0J+BMCp1Kp1Dg1NbW59mjd9PT0mR1OZzta\n", - "18/ROuDcAnaxeE15sEvlwSdcFF2WZY24Nlxm3Ou356zg9imrYXvR8m6ftrzbL+ZCdtty+ablu2ba\n", - "8l2TU+MT5iy7kvepNOSzZ4Ya7OmhQKUwtL4wObR5cnxonT08PN+5ZJfLZTU2NvoCgcBlgUBgx+wR\n", - "QisYDOrMHVh+v78yuwNr1OfzjTY2Ng57vd6sfhZe5SQVCLCWv9kfTFw/Ojr6wrGxsVvb29srnZ2d\n", - "w7lcLrPUvc1n1LV+Y797y01jrqYbJ12Bm6blvfqC7oOz7VLALp7aUMkd3V4eOXZleajnwi6TA4Cf\n", - "IZwCACyqUCzxdEnvknSvpI3neLxT0t9J+no6Gj5R794WYox50lvr5jtaVy6X/bO7nOwzu5w4Wgcs\n", - "Hbdse2tlLLO1MpaRdGTu3DwXsm+ftrzbZuTZer5Hk+ayLVegKN+1Rct3bVaN0pz9JC67MuX9aXBV\n", - "HApWCkPr7cmhzeWJoXI2O5nNZosLrXsmwAoGg5cHAoEr/X6/f/btg3YgENCcAGvM7Xab2R1YcwOs\n", - "MyEWAdYSMcasKxaLTzPGvGRgYGBjR0fHVE9PT3elUlk2/3vkLb+/z73lWuNaf13OFbw+b/muK1ue\n", - "zRe6jteeGWiqTB3bUhk7em1p4ESDPT1dj34BrD2EUwCASxaKJfyq7pL6gKTbzvH4pKR/kfQ1ST9J\n", - "R8N1eSPW2Y7WTU9PbyqVSgserSsUClahUKicCZ3OvLWOo3XAyrHQhewzcrt/diF7cHve5d9eVHW3\n", - "lW25AhdTq2K5gkX5ritavutqgyvLrhS8KmW8dinjt2dGGuxiJmgXMusqUyObK+OZQGW6mM1mi2cL\n", - "sNxutxUMBv2zAdZVs0cIrTl3YFk+n688G2CN+ny+0WAwmJkNsM4cIZzctGlT/mJ+f3gyY4wl6eqx\n", - "sbHQ+Pj4szo7O6329vbM+Ph41zk/XGeTVkNgwH3ZVeOudVfnXIFr8pb/uhl5tl/wWzIleezScGMl\n", - "37qxkm29sjx0YnMlO1aPngGAcAoAcNFCscSVkt6r6tG9red4/MeSvirpm+loOHexNc92tG5mZmZD\n", - "qVTaUKlUNlYqlaZzHa0rFArTU1NTHK0D1hCvyuUryiMDV5RHBuaO25LGXU3rR10btmVdwcunLP+2\n", - "ouXfOm15ts7Is9W2XL6LqWdbroZp+a6atnxXTc4z77LLOa/KGa89k/HbM5mAXcw0VvIj6yuTmU2V\n", - "iTxcWp4AACAASURBVFGfSqVyuWxns9lCNpstLFTnTIDV2Ni4raGh4ZqGhgb/bHBlNzY2qqGhwerr\n", - "6yu5XK4zAdZIY2PjiMfjmXuEcHLTpk0L1oBkjAmUSqVbRkZG7shkMpe3t7cXu7q6+kqlUl1+0HI2\n", - "Zblcw+6Nl4+6NuzIuYI7pqyGqwuW7+qS5dlysWt67ZmBYKVwekMld+LK8vCJyyrjo4vZMwAshHAK\n", - "AHBBQrGEJemlkj6o6hv3znZZakbVHVJfTkfDrWdb9xxH6zbMHq3bMPdoXaFQsGaP1tnFYnFmztG6\n", - "XKFQMBytA3C+LEkbK7mJjZXchKSTc+eqbxJct9G41l+ecwW3TVkNW4uWb2vR8m4tybPVtizvxdat\n", - "WO6motxNRct33ZNSe9u23aqMe+1SxquZEZ9dMg32tGmwi6apkjcbKrnRdfZkzpJ0PgGWx+Nxze7A\n", - "2h4IBK6dbwfWbIBlPB7PTy9x93g8Z+6+mpSU27Rp04K7vFYrY8wV2Wz2uWNjYy/o6upydXZ2mkwm\n", - "48guqWl5PBn3xsvHXU3bclbwiilXw46i5d0xLe/2i3khwE/ZdqnBnu5stPOnNlUmTu0oDbett6cu\n", - "+odHAHApCKcAAOclFEt4JUUkfVjSc87xeELSX29t8n7r6295ukdS0BhzrWaP2U1OTm4sFosLHq2b\n", - "3e3kqn1rHUfrACyF6psEs2OzR5qeEFxVZFljrnUbRl3rt+Vcwa15y7+1YPm2TleDqy22ZV3Ujqtq\n", - "Ycsqy72xbLk3FuS/ad5nbLvkUdl47dKoV6Uxnz0z6renTcAumkClON5kT02sr0xOeFUul0qlysTE\n", - "RH5iYmLB431nAqzGxsYdDQ0N183dgVUbYLnd7hG/3z/a1NQ07HK55t5/NbkaAixjjK9cLj9ldHT0\n", - "jtHR0ava2tqmu7q6BovFYmmxaxUsn2/EtX5L1tW4Zcpq2JK3/JcXLd+2acu7vST35os5kvcEtm17\n", - "VRoI2MWOdZWp9s3l8Y4ryplen0qL/nsBgItBOAUAOKtQLLFB1WN7vyrpqoWec1mavGq97/tvfOq6\n", - "H4e2+/OVSuW6SqXyifb2do7WAVi1XLLtzZWJsc2ViTFJT9ghaksat5rWjbnXbclZgS15q2FLwfJt\n", - "mba8W2Ysz2WzocPZdp+em2V5SvJcXrI8l5/tQimXXcm5VR732OUJr0rjXrs04bNnxvz29ESDPT3R\n", - "aOfHmyr5bLCUnyqdI8Dyer3uYDDoCwaDVwYCgRv8fr9vzhsIFQwGrf7+/hnLsozH4xn1+/2ZxsbG\n", - "kdkAa+4OrGV5mbYxZsvk5OSzx8bGbuvt7W3o6OgYGxgY6LzY9SqyrAlX47pxq2nTpCuwuWD5NxUt\n", - "76Zpy7t5Wp7LZizPlot5u+SCbLviVak/YBd7gpV898ZKrmtHebgzaBc5sglg2SKcAgDMKxRLXCPp\n", - "1yW9U9KCf2lu8tjDtzTN7H1BU/aQp1SYKpws+L9/uGBxtA7AWmdJ2mjnshtLuayk9tr5sixrzLV+\n", - "05ir6bJJV2BL3vJvKVq+LdPybpmxPFvKcm245B0zsyqWq6kiV9OM5b3yrLei27btkj3pVjnntiuT\n", - "bpVzHruc86g86bVLWa9Kkz57JtcwOZ3z56anGuxcPmBPjzXYxeLcRr1er7uxsdEfCASuDAQCNzQ0\n", - "NPjmHB9UIBCw+vv7i2fuwPL7/SONjY2ZeXZgORJgzd5neEMmk7l9bGzsxvb29nJHR8dQPp+fme/5\n", - "guXzZa3guilXw7q85V9XtHzrpuVdP2N51s1Y7nUledaVLdf6stzrynI1XXIIuQC3XZ7w2TN9DXax\n", - "r9HO924uT3RvK4/2+TUzb98AsFwRTgEAniAUS9wi6aOS7tFC/52wbbvRzh+6ujSYuHGqp9WakJb8\n", - "9UQAsMK4ZduXVcZHZy+dPlk7Py2PZ9S9fnPWatwy5WrYVLB8m6bl3TRjeTbNWJ7NJbk32ZarYVGb\n", - "siyrIms2yLqAz9m2bckuuFTJu2Tn3Xal4CpUCu5CJe8areTdKhc8yudd9uSMS5UZtyozXpfKAY9L\n", - "QZ9bQa/bavR77MYGb2ldwF/aEGworw/6Z/xeb8FyWcayXKNye0Y9voaRsqxsfrqcy06Xc4f7cxP/\n", - "fXJ0RlJl9pckeSX5zuOr74p1vg03bvbf2uQqP2csO7lueGLSGs+XKmX5AmXrFn+5wRWoyNVQsVwN\n", - "FVkNFbkaKrKCF3tB/kWxbduj8qjXLg022NNDQbvQt76S67u8bPq5IwrAakE4BQCQJIViiedI+g1J\n", - "v6zqD/yfxLLtmQ2VbPIpM10/2FYxw442CABrjE+l0vby6NB2jQ4t9MyU5W8Yc63blLMCm/Kuhs1z\n", - "AqyNJcu9oSz3+rJc6xZrB9aCLMuyZQXKcgXKks472KpIKsz+ys6dODNYX/3ZafVnz2zOsiQ1nf01\n", - "H/Vi2xWPyiNeuzTis2cyDfb0cKOdH9xQyQ1tKY8NsRMKwGpHOAUAa1wolrhd0m9Keu1Cz/hdmtxc\n", - "NomnFtr+Z509Nd/b0AEASyBoFwvBcrFfUv9Cz5Tlck24GtflrMD6KVfDhoLlX1+Ud8OM5d0wY3k2\n", - "lOReXw2yXE225Qo42P6a4bIrUx6Vjccujfrs0phP06MNlWkTtAujGyq5zObKhHGrUjn3SgCwOjkW\n", - "TkUiEa+k96v66vFrJA1J+ntJvxePx7M1z7539rnrJY1KekTSJ+Px+II/NQIAXJhQLPFiSZ+R9MqF\n", - "nvG5rc7bt7mONvWk/8suTHKRKgCsQG5VKpsq2fFNyo6rrO6zPVuSy52zgsEpV0NT3vI3FS1f07Tl\n", - "bZqRp2nG8jSWLHdTSe6msuVuqsgKzh5zCzh6zG05sO2yW5WsW+UJj13OelTOeuxS1meXJnyayfrt\n", - "6WygUsw22oVsU2Uqy84nADg7J3dOfUnSmyX9kaSUpJ+T9DFJPx+JRH4+Ho+XJCkSiXxO1Qt4Py/p\n", - "J5J2zD53RyQSeWE8Hp9wsGcAWHVCscQLVQ2lXn2Wxw4954rGh99xffmy5uSj3fnC/BfCAgBWF48q\n", - "5Y12LruxnMue++mfKcnlzlt+f8HyB6Ytb0PR8gZmLG9gRu6GGcsTKMvdULLcgYosry2XtyLLU7Fc\n", - "PluWtyLLY8vy2rK8Fav69We/5J49ae6yf3bk3CXJkizZP/3nn45LUtmSXbakkiW7LNkl66dj1X+W\n", - "bZ95puxSpehSpeC2KwW3KgW3ygWPXS54ql/zXrtU9KqU99kzBb89U2ywi/mgXcjX95wkAKwtjoRT\n", - "kUjkeZLulfTueDz+5dnhRyKRyP9K2q3qpbtfm33uI7PPfWXO578j6TFJn5L0YSd6BoDVJhRLhFQN\n", - "pRY8vqfqDw9+51v3PK2ru7P9bY8+mupZ6E1FAACc4VGlvM7OT62z81NL3QsAYOVxnfuRRfGU2a/f\n", - "mzsYj8dbVD22d2b+3ZLa5gZTs88NSnpI0s5IJMI9WQBwAUKxxM+FYolvSmrRwsHU/0h6uaSXfG/n\n", - "M9t6uzvflkql+icnJx15hTcAAACAtcupoOfY7NdnSOo9MxiJRK6UtEnS8dmhl6kmwJrjEUmflvRs\n", - "SXvr0SQArCahWOJqVf+9eb8W/mHETyR9Kh0N/0iSMpnMU9rb29+RTCYHs9ls0Yk+AQAAAKxtjoRT\n", - "8Xj8sUgk8rCkv5y97LxF0lMl/amk/ZL+MRKJWJJukPT4Asu0zn69UYRTALCgUCxxmap39T0oyb/A\n", - "Y0lVj0on0tGwLUnGmBs6OzvvTaVSwxMTE3lnugUAAACw1jl1rE+SdqoaRD0iKaPqvSZeSa+evQx9\n", - "vSS3pLH5Pjz7Rr+ypMsc6RYAVphQLNEQiiU+Kum0qvf3zRdMpVW9CP2l6Wj4h3OCqWvb29vvS6VS\n", - "o2NjY9wXAgAAAMAxTl2I7pL0sKr3mfy6qiHVDapezPv9SCTycknrZh8/20/r85I21LFVAFhxQrGE\n", - "JeluSZ+TdN0Cj7VK+k1J3zwTSJ1hjLmqs7NzZ3Nz8/jo6OhkXZsFAAAAgBpO3Tl1r6RflvT8eDx+\n", - "cHbs0Ugk8l1Vj/F9RtXjJZIUOMs6AUnjdesSAFaYUCzxQklfkHTbAo/0qnrv1NfS0XCpdtIYs6O7\n", - "u3tXKpXKZjKZXP06BQAAAID5OXWs762SfjgnmJIkxePxEUlfk/TWeDw+oeqxvY3zLRCJRJpUPfY3\n", - "Ut9WAWD5C8US14RiiYcl7db8wdSYpI9Keko6Gv7yAsHUtp6engdSqVR+eHg4W+eWAQAAAGBeTu2c\n", - "ukbSjxeY65C0NRKJ+CS1SbplgefOjLctbmsAsHKEYokGSVFJH9f8O01Lkv5c0m+lo+EFw3xjzOV9\n", - "fX27mpubi4ODg+xIBQAAALBknAqnRiXdtMDcjZKy8Xh8OhKJ/EjSaxd47k5VdwIcXGAeAFat2Xul\n", - "Xi/pj1W9s28+35YUTUfDrQvMS5KMMZf19/fv3L17t93f3z/vSygAAAAAwClOHev7R0kvi0QiL5g7\n", - "GIlEtkm6X9K/zg59SdINkUhk1zzPfUDS1+Lx+Ez92wWA5SMUSzxF0nck/YfmD6Yek/TKdDT8hvMI\n", - "pjYNDAzs3LNnj7unp2e0Du0CAAAAwAVxaufUFyW9QdU3831O1f8jdZ2k/6vqBecfl6R4PL43Eol8\n", - "QdKfRyKRmyQlJW1X9d6UMVUv9QWANSEUSwRVfcPeRyT55nkkI+k3JH01HQ2Xz7WeMWbD4ODgzpaW\n", - "Fn9XV9fw4nYLAAAAABfHkZ1T8XjcVvU4yhck7VR1p9THVD2CEorH44Nznv2IpA+rGmbFJf2WqvdV\n", - "vXT20nQAWPVCscRrJB1RNXyqDaYqqob+T01Hw186z2Bq3dDQ0P179+4NdnR0EEwBAAAAWDac2jml\n", - "eDxeVHXn06fP49mHJD1U55YAYNkJxRJXqBrkv3mBR/5X0oPpaPjQ+a5pjGkcHh6+d9++fRtOnz49\n", - "sBh9AgAAAMBicSycAgAsLBRLuCS9R9LvSdowzyP9qh7v+0Y6GrbPd11jTGBkZOSe/fv3bzl58mT/\n", - "4nQLAAAAAIuHcAoAllgolni6qi+EeNE802eO8H0yHQ1f0NFmY0zDyMjI2w8cOHBFa2tr3yK0CgAA\n", - "AACLjnAKAJZIKJbwqXr/3ickeed5ZL+k96Sj4b0XurYxxj86OvrWQ4cOXX3s2LHeS2wVAAAAAOqG\n", - "cAoAlkAolniepK9KeuY805OqBlZfTEfDpQtd2xjjNcZEDh8+fMORI0e6L7FVAAAAAKgrwikAcFAo\n", - "lmiQ9ClJUUnueR75d1UvPL+oUMkY4xkbG7v76NGjTz106BDBFAAAAIBlj3AKABwSiiVuk/Q3km6e\n", - "Z3pI0gfS0fC/XOz6xhj3+Pj4XceOHXvagQMHOi92HQAAAABwEuEUANTZ7N1Sn5b0UUmueR75uqRf\n", - "T0fDIxdbwxjjnpiY+KXjx48/a9++fZ22fd4v9AMAAACAJUU4BQB1FIolninp7yQ9a57pPlUvPP/O\n", - "pdQwxriy2ezrHn/88efv3buXYAoAAADAikI4BQB1EIol3JI+LOmzknzzPPJlSdF0NDx2KXWMMVY2\n", - "m31Na2vrbS0tLR2VSoVkCgAAAMCKQjgFAIssFEvcKOlvJd0+z3SfpF3paPi/LrWOMcaanJx81cmT\n", - "J1+6Z88egikAAAAAKxLhFAAsklAsYUm6V9IXJTXN88g/SPpgOho2i1FvamrqZSdPnnz57t27O8vl\n", - "MsEUAAAAgBWJcAoAFkEoltgo6S8kvWWe6VFJ70tHw/HFqtfX1/fSU6dOvbq5ubmzVCpVFmtdAAAA\n", - "AHAa4RQAXKJQLHG7pIclXTvP9COS3pmOhvsXq15/f/9tp0+fvjOVSnXOzMyUF2tdAAAAAFgKhFMA\n", - "cJFCsYRH0m9K+n+SXDXTeUkfkvRX6Wh40Y7cDQwMhNra2t6QTCa7p6enCaYAAAAArHiEUwBwEUKx\n", - "xNWq3iH1knmmD0l6azoaPr6YNQcHB5/T3t5+VzKZ7CkWi6XFXBsAAAAAlkrtT/oBAOcQiiXulHRQ\n", - "8wdTfyzpRYsdTA0PDz+jvb09kkwme/P5/Mxirg0AAAAAS4mdUwBwnkKxhFfSZyV9dJ7pIUn3p6Ph\n", - "7y123Uwm83Pt7e1vTSaTfZOTk9OLvT4AAAAALCXCKQA4D7PH+L4h6fZ5pv9T1WBqcLHrZjKZp7S3\n", - "t7/90UcfHcjlcsXFXh8AAAAAlhrH+gDgHGaP8R3Qk4OpsqSPSXpdPYIpY8yNnZ2d9yWTyeFsNltY\n", - "7PUBAAAAYDlg5xQALCAUS7glfUbVN/LV6pX0lnQ0/Gg9ahtjrm1vb78vmUxmxsfH8/WoAQAAAADL\n", - "AeEUAMwjFEtcJulhSa+eZ/o/Jd2bjoaH61HbGHN1Z2fnzlQqNWaMmapHDQAAAABYLjjWBwA1QrHE\n", - "cyXt1ZODqbKkj6t6jK9ewdSOrq6unalUKjsyMpKrRw0AAAAAWE7YOQUAc4Riifsl/YWkhpqpQUmR\n", - "dDT8k3rVNsZs7+7u3tXc3JwfHh7O1qsOAAAAACwnhFMAICkUS/gl/bGk984znZJ0dzoa7qtXfWPM\n", - "5b29vbt27949PTg4OF6vOgAAAACw3HCsD8CaF4oltktKaP5g6ouSXl7nYOqyvr6+B/bs2VPp7+8f\n", - "q1cdAAAAAFiO2DkFYE0LxRLPk/QtSVfVTOUlvTsdDX+9nvWNMZsGBgZ2tbS0qKenZ7SetQAAAABg\n", - "OSKcArBmhWKJt0j6Gz35fqk2SXelo+FD9axvjNkwODi4s6WlxdvV1ZWpZy0AAAAAWK4IpwCsOaFY\n", - "wiXpt1V9816t/5b0lnQ0bOrZgzFm3dDQ0M50Oh3o6Oioy5v/AAAAAGAl4M4pAGtKKJZYL+nfNX8w\n", - "9XlJr3MgmGocHh6+b9++fevb2toIpgAAAACsaeycArBmhGKJ6yR9V9KtNVPTkt6Tjoa/Vu8ejDHB\n", - "TCZz7/79+zefPHlyoN71AAAAAGC5I5wCsCaEYokXqbpjamvN1KCkN6Wj4eZ692CMaRgZGXn7wYMH\n", - "t7W2ttbt7X8AAAAAsJJwrA/AqheKJSKS/kdPDqb2SXq+Q8GUf3R09G2HDh266tixYwRTAAAAADCL\n", - "nVMAVq1QLGGperfU78wz/c+S7k9Hw1P17sMY4zPGvPnw4cPXHzlypLve9QAAAABgJWHnFIBVKRRL\n", - "+CR9VfMHU7+r6hv5nAimvGNjY79y5MiRpxw6dIhgCgAAAABqsHMKwKoTiiU2SfqmpJfVTM1IercT\n", - "F59LkjHGPT4+ftfRo0dvPXjwYJcTNQEAAABgpSGcArCqhGKJqyX9p578Rr4xVS8+/5ETfRhj3BMT\n", - "E288fvz4s/bv399h27YTZQEAAABgxSGcArBqhGKJZ0j6nqQra6ZOS3pdOhpudaIPY4xrYmLi9ceP\n", - "H39eOp0mmAIAAACAs+DOKQCrQiiWeLmkR/XkYCol6UUOBlNWLpd77YkTJ16YTqc7CaYAAAAA4OwI\n", - "pwCseKFY4i2qHuVbXzP1b5JemY6GM070YYyxJicnX3XixImX7Nmzp7NSqZBMAQAAAMA5EE4BWNFC\n", - "scSHJH1Dkq9m6iFJd6ej4bxTvUxNTYVPnDjx8t27d3eWy2WCKQAAAAA4D9w5BWBFCsUSlqQ/kPSR\n", - "eaY/JukP0tGwYwFRX1/fHadOnXrl7t27u0qlUsWpugAAAACw0hFOAVhxQrGER9JfS9pZMzUjaWc6\n", - "Gn7YyX76+/tvO3369J2pVKpzZmam7GRtAAAAAFjpCKcArCihWKJB1WN8b6yZykq6Kx0N/8DJfgYG\n", - "Bl7Q1tb2hmQy2TU9PU0wBQAAAAAXiHAKwIoRiiXWS/qWpJfXTA1Jek06Gj7gZD+Dg4PPaWtre1My\n", - "mewpFoslJ2sDAAAAwGpBOAVgRQjFEpdL+p6k59VMdUp6VToaPulkP8PDw89ob2+PJJPJ3nw+P+Nk\n", - "bQAAAABYTQinACx7oVjiaknfl3RzzdQxSb+QjoZ7newnk8n8XFtb21uTyWTf1NTUtJO1AQAAAGC1\n", - "cS11AwBwNqFY4kZJj+rJwVSLpDuWIJh6ant7+9uTyeRALpcrOlkbAAAAAFYjwikAy1Yolvg5Sf8r\n", - "6ZqaqR9IekU6Gh5xsh9jzI2dnZ33JZPJ4Ww2W3CyNgAAAACsVoRTAJalUCzxLEk/lnRFzdS/Snp9\n", - "OhrOOdmPMea69vb2+5LJ5PD4+HjeydoAAAAAsJoRTgFYdkKxREjS/0i6vGbq7yS9JR0NO3qczhhz\n", - "dWdn585UKjVmjJlysjYAAAAArHaEUwCWlVAs8RJJP5S0qWbqLyXtTEfDJSf7McZc2dXVtSuVSk2M\n", - "jIw4ulsLAAAAANYCwikAy0YolghL+i9J62qmviDp/elouOJkP8aY7d3d3Tubm5unhoeHs07WBgAA\n", - "AIC1gnAKwLIQiiVeJem7koI1U78j6cPpaNh2sh9jzNbe3t5du3fvnh4cHBx3sjYAAAAArCWepW4A\n", - "AEKxxC9I+ndJDTVTn0hHw7/jdD/GmMv6+voe2L17d6W/v3/M6foAAAAAsJYQTgFYUmcJpj6Ujoa/\n", - "4HQ/xphNAwMDu1paWuze3t5Rp+sDAAAAwFpDOAVgycwGU/8hyV8z9avpaPjPnO7HGLNhcHBw5549\n", - "e7xdXV0Zp+sDAAAAwFrEnVMAlkQolni1llcwtW5oaGhnS0tLoLOzk2AKAAAAABxCOAXAcbPB1L/r\n", - "ycHUg0sUTDUNDw/fv3fv3nXt7e3DTtcHAAAAgLWMcAqAo0KxxCu1cDD1Raf7McYEM5nMvfv37990\n", - "6tSpQafrAwAAAMBaRzgFwDGhWOIOzX+U74NLFEwFRkZG7jlw4MDlra2tA07XBwAAAAAQTgFwSCiW\n", - "eJGk70oK1Ex9MB0NP+R0P8YY/+jo6FsPHTp05fHjx/udrg8AAAAAqCKcAlB3oVjiuZL+U1JTzdSv\n", - "L1Ew5TPGvOWxxx677siRI71O1wcAAAAA/AzhFIC6CsUSz5D0fUkbaqY+lo6G/8Tpfowx3rGxsbsP\n", - "Hz5802OPPdbjdH0AAAAAwBMRTgGom1AscYukH0jaXDP1mXQ0/Dmn+zHGeMbHx+86evTorYcOHep2\n", - "uj4AAAAA4MkIpwDURSiWuEHSDyVtrZn6A0mfcbofY4x7YmLijceOHXvm/v37O23bdroFAAAAAMA8\n", - "CKcALLpQLLFD1R1TO2qm/lTV43yOJkPGGNfExMTrjx8//ty9e/cSTAEAAADAMkI4BWBRhWKJzZL+\n", - "W9L1NVNfUvUCdKeDKSuXy93Z2tr6onQ6TTAFAAAAAMsM4RSARROKJZokPSLpaTVTD0t671IEU5OT\n", - "k7/Q2tp6e0tLS0elUiGZAgAAAIBlhnAKwKIIxRJ+Sf8m6YU1U9+WtDMdDVec7McYY01NTb3ixIkT\n", - "L9uzZ09nuVwmmAIAAACAZYhwCsAlC8USHkn/IOmVNVM/lvTmdDQ843RPU1NTd5w8efIVu3fv7iqV\n", - "So4GYwAAAACA80c4BeCShGIJS9JfS7qrZmqfpDeko+G80z319/e/+PTp069pbm7umpmZKTtdHwAA\n", - "AABw/ginAFyqP5C0s2bscUmvSUfDE043MzAw8MLTp0//YiqV6p6eniaYAgAAAIBljnAKwEULxRIf\n", - "kvSRmuEuSa9KR8MZp/sZHBx8bltb2xtTqVRPsVgsOV0fAAAAAHDhCKcAXJRQLPFWSX9UMzwk6ZXp\n", - "aLjH6X6Gh4ef2dbWdncymezN5/OO33EFAAAAALg4hFMALlgolnilpL+tGc5Jem06Gj7pdD+ZTObW\n", - "tra2t6RSqb6pqalpp+sDAAAAAC4e4RSACxKKJZ4j6d8keecMz0h6Uzoa3u90P5lM5ub29va3J5PJ\n", - "/lwuV3S6PgAAAADg0hBOAThvoVjiBknfk9RUM3VfOhr+gdP9GGNu7OzsvPfRRx8dymazBFMAAAAA\n", - "sAIRTgE4L6FYYquk/5K0rWbqQ+lo+BtO92OMub69vf3+Rx99dHhiYiLvdH0AAAAAwOIgnAJwTqFY\n", - "olHSdyTdVDP1h+lo+AtO92OMubqjo+P+ZDI5OjY2NuV0fQAAAADA4iGcAnBWoVjCLelhSaGaqYcl\n", - "fdTpfowxV3Z1de1qbm6eGB0dnXS6PgAAAABgcRFOATiXP5L0SzVj35e0Kx0NV5xsxBhzRXd39wOp\n", - "VGpyeHg462RtAAAAAEB9EE4BWFAolvg1Sb9WM3xI0i+no+FpJ3sxxmzt7e3duXv37sLQ0NCEk7UB\n", - "AAAAAPVDOAVgXqFY4o2Sau+T6pX0+nQ07OiuJWPMlr6+vgeam5vL/f39Y07WBgAAAADUl8fpgpFI\n", - "5BWqHgn61Xg8/sUFnnmvpA9Kul7SqKRHJH0yHo8POdYosIaFYokXSPoHSdac4Zyk16Wj4R4nezHG\n", - "bO7v79+1Z88e9fX1GSdrAwAAAADqz9GdU5FIxCPpTyUdkPTQAs98TtKfSPq2pF+R9GlJYUk/jkQi\n", - "653pFFi7QrHE9ar++QvMGS5LujsdDR9yshdjzMaBgYFdLS0tnu7u7hEnawMAAAAAnOH0zqkHJd0i\n", - "6bZ4PG7XTkYikedJ+oikd8fj8a/MGf+OpMckfUrShx3qFVhzQrHEJlV3Km6tmXpfOhr+Tyd7Mcas\n", - "HxwcvD+dTvs7OzuHnawNAAAAAHCOYzunIpHIVlXDpS/H4/GWBR57t6S2ucGUJMXj8UFVd1rtnN19\n", - "BWCRhWIJr6S4qgHyXL+Xjoa/5GQvxpim4eHh+/bt29fU3t5OMAUAAAAAq5iTx/p+X9K0pI+d5ZmX\n", - "SfreAnOPSNoo6dmL2xaAUCxhqXqc9pU1U/8o6RNO9mKMCWYymXv37du38dSpU9wzBwAAAACrnCPh\n", - "VCQSeYGk+yR9XNJMJBJpmOcZS9INkh5fYJnW2a831qVJYG37gKT31Yw1S9qZjoYrTjVhjAmMjIy8\n", - "48CBA5efOHFi0Km6AAAAAICl49TOqT9W9ULl/yNpQtJkJBL5n9k7ps5YL8ktad7XxMfj8ezsxdt7\n", - "ZQAAIABJREFUGpfVuVdgTQnFEq9WddfUXF2S3piOhgtO9WGM8Y+Ojr794MGDO44fP97vVF0AAAAA\n", - "wNKqezgViUR+QdKLJE1K+mdV38AXlXS9pJ9EIpHQ7KPrZr/mz7JcXtKGOrUKrDmhWOJWVe+Zmvvv\n", - "gpyk16ejYceO1BljfMaYtxw6dOjqo0eP9jpVFwAAAACw9Jy4XPxBVUOlF8Xj8TNH8xSJRL6s6hv4\n", - "/kTSiyVlZ6cCT1rhZwKSxuvUJ7CmhGKJLZK+requxTNsSW9NR8OHnerDGOMdGxuLHD58+KbDhw93\n", - "O1UXAAAAALA8OHGs7zZJ/zQ3mJKkeDw+oepxvxdFIpHLVD3uV1b10vMniUQiTaoe+xupb7vA6heK\n", - "JXyS/lXVe97m+kg6Gv6OU30YYzzj4+N3HTly5JaDBw8STAEAAADAGuREOLVO0skF5s6MXx6Px21J\n", - "bXrya+zPODPetoi9AWvO7Jv5HpJ0R83UlyV9wak+jDHuiYmJNx49evSZBw4c6HKqLgAAAABgeXEi\n", - "nOqVdNMCczdJqkg6c/nxjyS9doFn71T1svSDi9kcsAa9T9I7a8Z+JOkD6WjYdqIBY4wrm83+4vHj\n", - "x5+zb9++Ttt2pCwAAAAAYBlyIpz6Z0lvjkQi188djEQijZJ+VdIP4vH4mXukviTphkgksqvm2W2q\n", - "vur+a/F4fMaBnoFVKRRL/Lye/Ga+05J+JR0NTzvRgzHGyuVydz7++OMvSKfTXQRTAAAAALC2OXEh\n", - "+m9Leo2klkgk8jlJxyRdI+n/SGqS9MEzD8bj8b2RSOQLkv48EoncJCkpabukj6q6a+rTDvQLrEqh\n", - "WOJaSf+iJ/65z0n6pXQ07MhdbrPB1GtaW1tvb2lp6ahUKiRTAAAAALDG1X3nVDwez0q6XdX7bN4n\n", - "6d8k/T9JP5b0nHg8fqrm+Y9I+rCkN6j6ivvfmn32pbOXqAO4QKFYIijpW5K21Ezdk46GjzrRgzHG\n", - "mpqaesXJkyfv2L17d0e5XCaYAgAAAAA4snNK8Xg8J+njs7/O5/mHVL2wGcAlmr0A/auSnl0z9al0\n", - "NPzvTvUxNTX18ydPnnzF7t27uwimAAAAAABnOHHnFICl9VFJb64Z+6aqR24d0d/ff/upU6denUql\n", - "umZmZspO1QUAAAAALH+EU8AqFool7pT0uzXDRyTdl46GK0700N/f/8LTp0+/vrm5uZtgCgAAAABQ\n", - "i3AKWKVCscSNkh6WZM0ZHlX1AvScEz0MDg4+r62t7Y3JZLK7WCyWnKgJAAAAAFhZCKeAVWj2AvRv\n", - "Sto4Z7gsKZKOhtuc6GFwcPBZbW1tv5JKpXoLhQLBFAAAAABgXoRTwCozewH6X0t6Zs3U/01Hwz90\n", - "ooehoaGndXR0RJLJZO/U1NS0EzUBAAAAACsT4RSw+nxQ0ttrxv5J0hecKJ7JZG7u6Oh4ezKZHJic\n", - "nCSYAgAAAACcFeEUsIqEYomXSPp8zfBRSe9MR8N2vetnMpmbOjo63pFMJgez2Wyx3vUAAAAAACsf\n", - "4RSwSoRiiSsk/bMkz5zhrKS7nLgA3RhzfWdn533JZDIzMTGRr3c9AAAAAMDqQDgFrAKhWMKnajC1\n", - "vWbq3nQ0fKLe9Y0x13R0dNyfSqVGx8bGpupdDwAAAACwehBOAatDTNLtNWO/l46Gv1XvwsaYKzs7\n", - "O3elUqnx0dHRyXrXAwAAAACsLoRTwAoXiiXulvSrNcPfl/TJetc2xlzR3d39QHNzcy6TydT96CAA\n", - "AAAAYPUhnAJWsFAs8VRJX6kZ7pL0tnQ0XK5nbWPMtt7e3geam5vzQ0NDE/WsBQAAAABYvQingBUq\n", - "FEsEVL1nat2c4WlJv5KOhjP1rG2M2dLX17erubl5ZmBgYLyetQAAAAAAqxvhFLBy/ZmkZ9aMfSgd\n", - "DafrWdQYs7m/v3/X7t277b6+PlPPWgAAAACA1Y9wCliBQrHEfZIeqBn+J0l/Xs+6xpiNAwMDu/bs\n", - "2ePu6ekZrWctAAAAAMDaQDgFrDChWOLpkv6iZviEpHelo2G7XnWNMesHBwfvb2lp8Xd1dY3Uqw4A\n", - "AAAAYG0hnAJWkFAssU7Sv0gKzBkuqHrPVLZedY0xTUNDQ/fv27evqaOjY7hedQAAAAAAaw/hFLBC\n", - "hGIJS9JfSbq5Zur96Wj4cL3qGmMaM5nMffv3799w6tSpoXrVAQAAAACsTYRTwMrxTklvrRn7m3Q0\n", - "/Df1KmiMCYyMjNyzf//+LSdOnBisVx0AAAAAwNpFOAWsAKFY4mmS/rRm+LCkD9arpjGmYXR09O0H\n", - "Dx7c8fjjj/fXqw4AAAAAYG0jnAKWuVAsEZQUl9QwZ3hSUiQdDU/Vo6YxxmeMecuhQ4euPnr0aG89\n", - "agAAAAAAIBFOASvBH0u6tWbs/elo+PF6FDPGeMfGxiKPPfbYDYcPHyaYAgAAAADUFeEUsIyFYok3\n", - "S3pXzfDfp6Phv6tHPWOMZ3x8/JePHDly86FDh3rqUQMAAAAAgLkIp4BlKhRL3CDpr2uGT0p6fz3q\n", - "GWPcExMTbzx69OgzDhw40F2PGgAAAAAA1CKcApahUCzhk/SPktbPGZ5W9Z6p3GLXM8a4stnsG44d\n", - "O/bcffv2ddq2vdglAAAAAACYF+EUsDz9rqRQzdiH09HwwcUuZIyxstns6x5//PHQ3r17CaYAAAAA\n", - "AI4inAKWmVAs8RpJH64Z/pakhxa7ljHGyuVyr2ltbb2tpaWls1KpkEwBAAAAABxFOAUsI6FYYquk\n", - "r9UMd0t6IB0NL2pwZIyxpqamXnny5Mk79uzZ01kulwmmAAAAAACOI5wClolQLGFJ+htJ2+YMVyS9\n", - "LR0Njy52vampqZedPHky3NzcTDAFAAAAAFgyhFPA8vEBSXfWjP1WOhp+dLEL9fX1veTUqVO/kEql\n", - "ukqlUmWx1wcAAAAA4HwRTgHLQCiWeLqkP6wZTkn6ncWu1d/f/6LTp0+/rrm5uXtmZqa82OsDAAAA\n", - "AHAhCKeAJRaKJRok/YMk/5zhCUn3pKPh0mLWGhwcfF5bW9svpVKp7mKxuKhrAwAAAABwMQingKX3\n", - "+5KeUTP2/nQ03L6YRQYHB5/d1tb2K8lksqdQKBBMAQAAAACWBcIpYAmFYonXSPq1muGH09Hww4tZ\n", - "Z2ho6Ont7e2RZDLZm8/nZxZzbQAAAAAALgXhFLBEQrHEVklfqxnuUPVi9EWTyWRu6ejoeFsqleqf\n", - "nJycXsy1AQAAAAC4VIRTwBIIxRKWpC9L2jZnuKLqPVPji1Unk8k8paOj455kMjmYzWaLi7UuAAAA\n", - "AACLhXAKWBq7JP1izdhn09FwcrEKGGOu7+zsvDeZTGYmJibyi7UuAAAAAACLiXAKcFgolrhB0h/X\n", - "DO+W9NuLVcMYc21HR8fOVCo1OjY2NrVY6wIAAAAAsNgIpwAHhWIJt6S/k9Q0Z3hK0jvS0fCivEHP\n", - "GHNVZ2fnzlQqNTY6Ojq5GGsCAAAAAFAvhFOAsz4i6faasQ+lo+FTi7G4MeaK7u7uXalUKpvJZHKL\n", - "sSYAAAAAAPVEOAU4JBRLPEvSZ2uGH5H014uxvjFmW09PzwOpVCo/PDycXYw1AQAAAACoN8IpwAGh\n", - "WMIv6e8leecMj0h6Zzoati91fWPM5X19fbuam5unBwcHF+1tfwAAAAAA1BvhFOCMz0p6Rs3Ye9PR\n", - "cP+lLmyMuay/v3/X7t277f7+/rFLXQ8AAAAAACcRTgF1Fool7lD1rqm5vp6Ohv/lUtc2xmwaGBjY\n", - "uWfPHldPT8/opa4HAAAAAIDTCKeAOgrFEk2SvibJmjPcI+nBS13bGLN+cHBwZ0tLi7+rq2vkUtcD\n", - "AAAAAGApEE4B9fUHkq6vGbsvHQ1f0vE7Y8y6oaGhnXv37g12dHQMX8paAAAAAAAsJcIpoE5CscQr\n", - "JL2vZvhP0tFw4lLWNcY0Dg8P37tv374Np0+fHrqUtQAAAAAAWGqEU0AdhGKJ9ZK+WjN8UtJvXMq6\n", - "xpjAyMjIPfv3799y8uTJgUtZCwAAAACA5YBwCqiPmKRr5nxvS9qZjoanLnZBY0zDyMjI2w8cOHBF\n", - "a2vrJb/lDwAAAACA5YBwClhkoVjiFyS9u2b48+loOHmxaxpj/MaYtxw6dOjqY8eO9V1ahwAAAAAA\n", - "LB+EU8AiCsUSGyR9pWa4VdInL3ZNY4zXGBN57LHHbjxy5EjvJTUIAAAAAMAyQzgFLK7PS7pqzvcV\n", - "Sfeno+H8xSxmjPGMjY3dffTo0aceOnSoe1E6BAAAAABgGSGcAhZJKJa4U9KumuFYOhrefTHrGWPc\n", - "4+Pjdx07duxpBw4cIJgCAAAAAKxKhFPAIgjFEhslfalm+JikT1/MesYY18TExC8dP378Wfv27eu0\n", - "bftSWwQAAAAAYFkinAIWxx9K2jHn+7Kqx/kKF7qQMcaVzWZf9/jjjz9/7969XQRTAAAAAIDVjHAK\n", - "uEShWOKVkh6oGf6DdDScvtC1jDFWLpd7dWtr64tbWlo6K5UKyRQAAAAAYFUjnAIuQSiWaNKTj/M9\n", - "LukzF7qWMcaanJx81YkTJ+7Ys2dPB8EUAAAAAGAtIJwCLs3vSLpuzve2pF3paLh4oQtNTU297OTJ\n", - "ky/fvXt3Z7lcJpgCAAAAAKwJhFPARQrFEi+W9GDN8J+mo+HmC12rr6/vpadOnXp1c3NzV6lUqixO\n", - "hwAAAAAALH+EU8BFCMUSDZK+IsmaM9wu6TcvdK3+/v7bTp8+fWcqleqcmZkpL1aPAAAAAACsBIRT\n", - "wMX5pKRbasbelY6GJy9kkYGBgVBbW9sbUqlU9/T0NMEUAAAAAGDNIZwCLlAolniOpI/WDH85HQ3/\n", - "8ELWGRwcfE57e/tdyWSyp1AolBavQwAAAAAAVg7CKeAChGIJr6SvSnLPGe6T9JELWWdoaOjp7e3t\n", - "dyeTyd58Pj+zmD0CAAAAALCSEE4BF+ZDkp5dM/bedDQ8fr4LZDKZWzo6Ot6WTCb7Jycnpxe3PQAA\n", - "AAAAVhbCKeA8hWKJGyV9umb4G+lo+Nvnu0Ymk3lKe3v7Ox599NGBXC5XXNQGAQAAAABYgQingPMQ\n", - "iiUsSX8lqWHO8IikXzvfNYwxN3R2dt6XTCaHstlsYbF7BAAAAABgJSKcAs7POyS9ombsQ+loePh8\n", - "PmyMuba9vf2+ZDKZGR8fzy9+ewAAAAAArEyEU8A5hGKJyyV9vmb4h5L+/nw+b4y5urOzc2cqlRo3\n", - "xkwteoMAAAAAAKxghFPAuf2RpMvmfF9Q9RJ0+1wfNMbs6O7u3pVKpbIjIyO5unUIAAAAAMAKRTgF\n", - "nEUolniVqkf65vpMOho+da7PGmO29fT07EqlUlPDw8PZ+nQIAAAAAMDKRjgFLCAUSwQl/WXN8GFV\n", - "d1KdlTHm8t7e3geam5unBwcHx+vSIAAAAAAAqwDhFLCw/yfphjnf25LelY6GZ872IWPMZX19fQ/s\n", - "2bOn0t/fP1bXDgEAAAAAWOEIp4B5hGKJZ0n6SM3wF9PR8J6zfc4Ys2lgYGBXS0uLenp6RuvXIQAA\n", - "AAAAqwPhFFAjFEu4JP2VJPec4R5Jv3m2zxljNgwODu5saWnxdnV1EUwBAAAAAHAePEvdALAMvUvS\n", - "C2vGPpCOhhe81NwYs25oaOj+dDod6OjoGK5vewCAhXz961//xd7e3ufl8/ntknTFFVek3vOe9/zd\n", - "UvcFAACAhbFzCpgjFEtsk/T7NcPfSkfD/7HQZ4wxjcPDw/ft27dvQ1tbG8EUACyhe+6559sf/ehH\n", - "P71hw4aTkrRjx46TS90TAAAAzo5wCniimKSNc76flPRrCz1sjAlmMpl79+/ff9nJkycH6t4dAOC8\n", - "TE5O7pCkW2+99cRS9wIAAICzI5wCZoViiZdLekfN8KfT0XDXfM8bYxpGRkbefvDgwW2tra399e8Q\n", - "AHA+jh07tr1UKjX6fD5z4403jix1PwAAADg7wilAUiiW8Ev6i5rhw5L+ZL7njTH+0dHRtx46dOiq\n", - "Y8eO9dW9QQDAeTtx4sRNkrRp06ZTS90LAAAAzo1wCqj6iKSba8bel46GZ2ofNMZ4jTGRw4cP33Dk\n", - "yJFeZ9oDAJyvgYGBmyRp+/btHOkDAABYAQinsOaFYokbJH2iZvjL6Wg4WfusMcY7NjZ295EjR556\n", - "6NChbmc6BABcCGPMTZJ08803cxk6AADACuBZ6gaApRSKJSxJX5TUMGc4I+ljtc8aY9zj4+N3HT16\n", - "9NaDBw/Oew8VAGBp9fT0bCgWi1s8Hk/O7XZXHnrooXcVCoXNpVIpuHXr1iNvfvOb/y0YDJaWuk8A\n", - "AAD8zJKEU5FIxC1pn6RnSnpTPB7/95r590r6oKTrJY1KekTSJ+Px+JDTvWLVu0vSa2vGoulo+AkX\n", - "6Bpj3BMTE288fvz4s/bv399h27ZzHQIAztuRI0dukiSXyzXzyCOP3HPnnXd+/eabbx7q6+tb99Wv\n", - "fvXTX/nKV7Y8+OCDtXcMAgAAYAkt1c6p90vaLsme/fVTkUjkc5J+XdLnJf1E0g5Vd7HcEYlEXhiP\n", - "xycc7hWrVCiWaNKTLzz/iaS/nTtgjHFls9nXHT9+/HnpdJpgCgCWyLe//e3bjh49+trp6elNDQ0N\n", - "QzfeeOP/vulNb/qRy/WzWwp6e3tvkiSPxzO1c+fOhzZu3FiUpB07dmS3bt16sK+v7/Z0On19KBRq\n", - "X6LfBgAAAGo4fudUJBLZKukzkj4uyaqZe56qF1O/Px6Pfzwej38vHo9/RdJLJG2W9Cmn+8Wq9glJ\n", - "V875viTp/elo+KfpkzHGyuVyr21tbX1ROp3uJJgCgKXxjW984zX79u27b/369Z0PPvhg9KUvfek/\n", - "tre3v/ihhx56f7lc/unfJ0ZHR2+SpHA4/Pdngqkz/H5/TpJaW1uf7mz3AAAAOJuluBD9c5J+KCkx\n", - "z9y7JbXNBlI/FY/HByU9JGlnJBLhnixcslAscbOkD9UMfz4dDR89840xxpqcnHzViRMnXrJnz57O\n", - "SqVCMgUASyCdTl/f2tr6RpfLNX333Xd/Y9OmTYW2tran5vP5rSMjI8/87ne/e5skjY2N+ScnJ69y\n", - "u9355z//+R216xSLxSZJyufz6xz+LQAAAOAsHA2nIpHIbZIiqu6OsuZ55GWSvrfAxx+RtFHSs+vS\n", - "HNaM2UvQ/0ySd85wr6TPzn0u///bu/PwqMq7/+Of7BsQsrCHfQ0KuI1Sd0dQxKW43Wq1+lh9qtVq\n", - "7a+mT237tLWbtuNjtVVbq1aLS/Wo1bpLdXBDlHELiOwJeyAJgZCEkHV+f8wMHYaEdWbuZPJ+XVeu\n", - "mft7zpzzGSOQfOc+92lsPG3FihWnffTRR2va2tpoTAGABU1NTSler/cqSRo0aNCCfv367Vi+fHm/\n", - "FStWnNvW1pYpSevWrTtckkpLS0dLSsrNzV3Z0bG2b98+RJLS09Mb4xQfAAAA+yFuzSljTLICs5/u\n", - "chxnTQfbkySNkrS0k0MsCz6Ojk1C9CAXSJoeUfuBr8RdHxps3Ljx5BUrVkyfP3/+2tbW1vb4xgMA\n", - "hMyZM+fYxsbGgZI0efLk+ZLU3t6+288vSUlJbZK0fv36kZLUv3//FZHH2bFjR2pDQ8PQ4PZ1sc4N\n", - "AACA/RfPmVPXSyqQdEcn2/tISpG0raONjuPUSWoLHgM4KC6PN0fSHyLKXklOaFBRUfG1VatWzfzw\n", - "ww/XtrS0tMU1IABgl/b2dn311VdnSlJGRkbNcccdt0qSJkyYsHn06NGvpaSk7MzOzt7gdrtfkaS6\n", - "urr+kjRs2LA9Fjv3+Xzj/H5/SlJSUusxxxzzVTzfBwAAAPYuLus3GWMKFbhk6gbHcXZ2slto/Ye9\n", - "TbVvlJQbzWzocX4saWjYuFXSTaFF0Ddt2nRsWVnZefPmzVvb3NxMYwoALHr//fcnhmZN9evXb1H4\n", - "tm9+85svSXopvNbU1NRbkkaPHl0Reazly5cfKUkDBgz4pF+/fjtiFhoAAAAHLF4zp+6Q9KXjOM/s\n", - "ZZ+64GPWXvbJklQbtVToUVwe71gF1jsLd6+vxP2VJG3evPnIsrKy8+fNm7e+qampNf4JAQDhFi9e\n", - "fELo+ejRoxftbV9JysrK2ipJ+fn5uzWfampqsjZt2uRKTk5umjFjxksdvxoAAAC2xHzmlDFmgqSr\n", - "JZ1rjBkYtqlf8DHPGDNA0nYFLtvr28lxeilw2d+WGMZFggpbBD09rFwh6XZJqqqqmlReXm7mzZu3\n", - "obGxscVGRgDAf2zdujWzqqpqihRYU+rYY49dtq/XFBUVLdu4ceMJZWVlhePHj68M1Z977rmL2tra\n", - "Mo855phHR4wYURPL3AAAADhw8Zg5NTB4nlclbQz7+ji4/VEFmgRGUpmkCZ0cJ1Qvi1lSJLJZks6M\n", - "qP3AV+Kuq66uLi4vL79s3rx5G3fs2NFsIxwAYHfz58+f5Pf7UyWpV69eq3Nycvb5wcEZZ5zhy8rK\n", - "2vz+++9Pk6S2trakJ5544tyKioqvTZ48+R/nnHPOx/s6BgAAAOIvHmtOlUo6S5I/oj5Q0mMKzFyZ\n", - "L+lLSccH9+3ITAUWS/8iJimRsFweb7b2XAT9XUlPV1dXjy0vL7/8gw8+2FRfX99kIR4AoAOrV6+e\n", - "Enrer1+/5fvzmtTUVL8x5t6XX375G7///e9/lpSU1J6Tk7N51qxZv50yZcr62KUFAADAoYh5c8px\n", - "nK2S3oysG2NGBJ9+7jjOnGDtIUnXGmO+5TjO38L2HSDpRkmPOY7DJVc4ULdKGh42bpP03TnXHjmq\n", - "rKzsv+bNm1dZV1fX2UL9AIA4a29vV01NTXFoPGzYsJX7+9qRI0fW3HzzzffFJhkAAABiIS5369tf\n", - "juN8Yoz5g6QHjDFjJM1TYIbV/ygwa+oXFuOhG3J5vMMk/Sii/Kc51x5ZX15e/q158+ZV1dbW7u0O\n", - "kQCAOFu4cOHQ1tbWnODQP3nyZC7pBwAASGDxultfZyIv9ZPjOLdK+oGk8yQ5kn6pwCVYJzmOsz2+\n", - "8ZAAfq/d7wBZVXLysIfXrFlz9Ycffrht69at3E4cALqYZcuW7Zo1lZWVVZmfn8+HCAAAAAnM2swp\n", - "x3FWK3D3vY623S/p/rgGQsJxebwnS7okvDaod/rvxmc2XDhv3ofbt2zZUm8pGgBgLzZt2rTr5ih9\n", - "+vRZYzMLAAAAYs/2zCkgJlweb4qkP4bXUpOTFv5iau/s+fPnN1ZVVdVZigYA2IudO3em1NbWjg2N\n", - "CwsLaU4BAAAkOJpTSFTXSpoSXrhiYq+PPlnwcdPmzZtrLWUCAOzD559/Pqq9vT0tNC4qKqI5BQAA\n", - "kOBoTiHhuDzePEm/Ca+N6JNamrGhtLyiomKbpVgAgP2watWq8WFD/8SJE9dZCwMAAIC4oDmFRPRz\n", - "SQWhQUqSWo5OWvfahg0baixmAgDsh6qqqnGh55mZmVW5ublNNvMAAAAg9mhOIaG4PN6Jkr4bXhuZ\n", - "vuOdpoqVq+0kAgDsr507d6Zs3759VGjcp0+ftTbzAAAAID5oTiFhuDzeJEn3KOwukBlJ7VtHbl34\n", - "L3upAAD764svvhjp9/t33Um4oKCA5hQAAEAPQHMKieRcSdPDC0OaNz6ToZYWS3kAAAegrKxsbPh4\n", - "8ODBNKcAAAB6AJpTSAgujzdd0l3htaz2nUuLW8o/txQJAHCAqqqqdmtOjR8/nsXQAQAAegCaU0gU\n", - "N0j6zy81fr9/QstqJ8leHgDAAWhtbU2qra0dHRqnp6dv69+/f4PNTAAAAIgPmlPo9lweb76kn4XX\n", - "+rbXfzCkrWqDpUgAgAO0cOHCYe3t7Rmhca9evdbbzAMAAID4oTmFRPBzSXmhQYr8zYc3r2QRdADo\n", - "RlatWjU6fJybm8sHDAAAAD0EzSl0ay6Pd7wCl/TtMj575/t9/fV1liIBAA5CZWXlmPBxYWEhzSkA\n", - "AIAeguYUuru7JO267XhaSlKFO6/+Y4t5AAAHYdu2bbvNnBo6dCjNKQAAgB6C5hS6LZfHO03SOeG1\n", - "owb3eiAj2d9mKRIA4CCUl5fnt7S05IbGSUlJ7ePGjdtkM1NX8eWXXw664447frN06dIB8Trngw8+\n", - "eNWjjz56UbzOBwAAQHMK3ZLL402RdHdEed5tpwz12sgDADh4S5Ys2e2SvszMzMrMzMwe/0HDxx9/\n", - "PPqFF14omTBhwhsTJkzYHK/zXnzxxU5VVdXEhx566Ir29vZ4nRYAAPRgqfveBeiSviVpUkTt+6nJ\n", - "SWk2wgAADl5FRcWo8HGvXr0S6pK+xsbG1Jdeesm9evXq45uamgrS0tLqBg0a9On555//Sm5ublNH\n", - "r1m8ePGgOXPm3DRixAjv+eef/3488+bn5zdedtll986ePfunf/3rX1Ovv/76x2J5vocffvgb69ev\n", - "PzmyPnDgwI9ifW4AANA1MHMK3Y7L4+0j6dcR5Sd8JW6fjTwAgENTU1Oz23pTeXl5CdOc2rp1a+YD\n", - "Dzzw/SVLllwwfPjw+dddd91txcXFr69du/bURx555KaOXlNZWZnz0ksv3Zidnb3h8ssvfynemSVp\n", - "6NChtccff/zfN23aNPWFF144KZbnuuqqq56+4YYbfnD22Wf/LiMjozpUHzx48PJYnhcAAHQdNKfQ\n", - "Hf1IUv+wcaOk2yxlAQAcgrq6uvSGhoai8Fr//v0Tpjn1j3/84/K6urrReXl5iy+99NI3S0tLx37x\n", - "xReXt7e3p23fvn1MdXV1duRrHMf5ZktLS59Zs2b9LTnZ3o9qp5122peDBw+et2jRIrNkyZKBsTpP\n", - "Wlpae//+/RtcLld5cnJya6g+ceJEmlMAAPQQNKfQrbg83qGSvh9R9vhK3Ott5AEAHJrS0tKRkpLC\n", - "ayNGjEiI5lRpaWlRZWWlS5KKiooWSdKyZcuOD23PyMioKSws3BH+mrfeemtydXX1EcOHD587evTo\n", - "LfFNvKezzz77X5L8r7zyyjVtbW1J+3zBIaipqclqbGwcKEnp6elbx4wZU72v1wAAgMRAcwrdza8k\n", - "ZYaNN0nyWMoCADhEa9eu3W29qeTk5KZEaUosWLBg1zpKo0aNKpOk4uLiDzIzM6v69OlYIKQMAAAg\n", - "AElEQVSzcubMmQ+E779z586UBQsWXJaSktJ49tlnvxnvvB0ZMmTI9hEjRngbGhqGvvLKKyfE8lyl\n", - "paW7Lu/My8tbEctzAQCAroUF0dFtuDzeKZKujCj/zFfirreRBwBw6Kqrq3drTuXk5Gy0lSXaqqqq\n", - "JklScnJyy6RJk9ZJ0rRp00qnTZtW2tH+b7zxxteam5vzhg0b5o2cUWXTKaec8k55efkZixcvPmfm\n", - "zJkfpqWlxeQWfuvWrdt118bBgwcvi8U5AABA18TMKXQnHu1+6cdXkh61lAUAEAXbt28fGT7u06dP\n", - "QlymvWrVqoLm5uY8SerVq9fa1NRU/972b2trS1q6dOmZknTMMcfMi0fG/TV8+PBt+fn5i5qbm/u+\n", - "+eabx8bqPNXV1WNDz1lvCgCAnoXmFLoFl8d7pqTpEeUf+krcrR3tDwDo+latWlXQ2traK7xWUFCQ\n", - "EM2p5cuX72q65eXlle9r/3nz5k3YuXNnv+zs7A2TJ0/ucmtujRo16lNJWrZsWUzu3NfY2JhaV1c3\n", - "QpLS09O3jR07tioW5wEAAF0TzSl0eS6PN0V7ris1V9JrFuIAAKJkxYoVIyJrRUVF6yxEibpNmzaN\n", - "CD0fNGjQPptTS5YscUlS//79v4phrIPmcrkWS1JdXd3oVatWFUT7+KWlpSP8fn+KJOXl5TFrCgCA\n", - "HobmFLqDKyVNiqiV+Erce71EAgDQtVVUVIyMKPknTpyYEDOntm3bNiz0fOzYsav3tm9ra2tSZWXl\n", - "kZI0cuTIJTGOdlD69+/f0KtXrzWS9Pnnn0+J9vHLy8vD15uiOQUAQA/Dgujo0lweb7akX0eUn/SV\n", - "uD+1kQcAED1bt24dET7Oysqq7NWrV7OlOIfE4/H8pKGhYWhH2x5//PHfhI8PO+ywZy+++OK3Q+OF\n", - "CxcObWtry5Kkww8/fJ+zrDrS2tqa9MYbbxy7bNmyU3bs2DEoKSmpLTc3d9UJJ5zw2lFHHbVGkpqa\n", - "mlJeeOGF01evXn1SU1NTXmZmZvWQIUM+vfDCC1/Pysra52Xyubm5a+vr64dv3LixWJL3QPLV19en\n", - "v/nmm8evWbPmmIaGhsF+vz+1d+/e5SeeeOKLLpervKqqaldzqri4eK+LocfjvQIAgPiiOYWu7vuS\n", - "BoeNmyT9xFIWAECUtLa2JtXX1w8Lr/Xp02etrTyH6uabb76zpaUlRZKWLFky5NVXX/0fSSooKCi9\n", - "+uqrHwnfN7IBt2rVqjGSlJ6evrWgoKDxQM9dXV2d/cQTT/x3a2tr9pFHHvnqhAkTVldUVOS/9dZb\n", - "17z88ss/3LJly0Mnn3zyogcffPB6v9+ffM455/y5X79+2z/88MOjFi5ceMlDDz007Oabb75/X+fp\n", - "16/f2g0bNqiurm7YvvYNN2/evHHvvvvu1S0tLbkjR46cc9555z3Wq1evnR9++OHRb7zxxveam5v/\n", - "XFtbO1qS0tLSaseNG9fpelPxeq8AACC+aE6hy3J5vP0l/U9E+Y++EvcaG3kAANHz1VdfDW5vb08P\n", - "rxUUFHTbv98zMjLaMjIy2iSpsrKyf6ien5+/dl+zwaqrq0dKUk5OTsWBnrepqSll9uzZN2RnZ2+5\n", - "9tpr/xi6K+CQIUO219XVPfPuu+9+9+OPP75i7dq1vubm5t633HLL71JTU/3z5s0bv3DhQuP3+1Nq\n", - "amom1dTUZOXn5++1MTZgwIAKSWppacndvHlzrwEDBtTvK5/X6530/vvvX+/3+5OnTp368IwZM3bN\n", - "fL7gggvebWlpSfd6vdeFZo7l5+d3eklfPN8rAACIL9acQlf2M0m9w8Y1kn5rKQsAIIrKy8tHRNaK\n", - "ioq6bXMqXFVVVVHo+YABA/a5wHtDQ0M/ScrKytp6oOd69tlnZ/r9/uRrr732sVCzJmT06NHrJam1\n", - "tbXXunXrTps+ffoToX0+++wzt9/vT5Wk5OTkptzc3J37OldhYWFt6Pny5cuL9ravJM2dO/ewYGMq\n", - "ZezYsa+EN6ZCZs2a5VXYz6ODBg3q9JK+eL5XAAAQXzSn0CW5PN4xkq6LKP/KV+LeZiMPACC6Kisr\n", - "h0eU/MXFxQlxp77a2tohoeehpsne7Ny5s58kZWZmbj+Q82zcuLF3WVnZ9GnTpj0V2ayRpK1bt/YK\n", - "Pe/du3fZlClTdmXJy8tbL0lJSUntRxxxxDMpKSn7vMlIUVHRruZZdXV1v73tW1FR0fuDDz641u/3\n", - "p2RnZ2+85JJLOrzDbkZGRltOTs6uXMXFxR3OnIr3ewUAAPHFZX3oqn6t3f//LJP0gKUsAIAoq62t\n", - "3a05lZmZWZmXl5cQM1rq6+uLJCklJaVx5MiRNXvbt6WlJbm1tTVHkjIzM/d5mVy4Dz744Lg+ffqs\n", - "Cm/EhFu7du2uBdoHDx68MHzbFVdc8fLChQs/Kyws3D548OC6/TlfVlZWa3Jyckt7e3taU1NT9t72\n", - "ffHFFy8OXap32GGHvdlRQ0kKrD3W0NBQJAXWmxo/fnxlR/vF+70CAID4ojmFLsfl8R4t6ZKI8k99\n", - "Je5ueQcnAMDumpqaUkINiZDc3NyEuKRv8+bNvVpaWvpIUk5OzoZ97V9XV5cRep6amnpAd5HLz8+v\n", - "HD58eFln2zdt2jQ69Hz06NF7zEiaPHnyPvNFSkpKapGU1tzcnNXZPgsWLBi1efPmYyUpJSVlp9vd\n", - "+R12Fy5cOKytrS1TkvLy8jpdb8rGewUAAPFDcwpd0R0R488lPWMjCAAg+pYuXTrI7/enhNcKCwtX\n", - "W4oTVeFrMeXm5u7PelO7FoVPTU1tOZBzTZs2beHetldXV0+QpOTk5Oajjjqq/ECO3Znk5OSWtrY2\n", - "NTc3dzpz6pNPPjk99LygoGBRVlZWp023FStWjAs9Hzx4cKfNKRvvFQAAxA9rTqFLcXm80yRNjyjf\n", - "5itxt9vIAwCIvjVr1gyLrA0fPny1hShRV1FRsWu9qcLCwn2uNxUrq1evzm9qaiqUpD59+qzq7LK6\n", - "g+X3+5M6qtfX16dXV1dPDo2HDx++aG/H2bx58/jQ8+Li4k4XQ9+bWL9XAAAQezSn0GW4PN5kSXdG\n", - "lOdKmmMhDgAgRqqqqoaGj5OSktomTZq01laeaNq6deuumVNDhw7dZ3MqJydn1yXrra2tadHKsXDh\n", - "wgmh5wMGDDiopk9H2tvb0yUpNTW1qaPtpaWlI9vb23e9jylTpnR67tbW1qTa2toxkpSWlra9s/Wm\n", - "9iVW7xUAAMQPzSl0JRdJOjqi9j++EjefgAJAAqmtrd2tOZWdnb1xb5d+dSfbt28vkgJ3hpswYcI+\n", - "1znq3bv3riZPa2tr+t72PRAbNmzY1bDpaA2mgxVqPKWmpna4DuSmTZsGhZ5nZGRsKSoqqu3sWPu7\n", - "3tS+xOq9AgCA+KE5hS7B5fGmSfpNRPk5X4nbZyMPACB2GhoahoSP8/LyEmKNoJaWluQdO3YMlgJ3\n", - "H8zOzt5nwy0tLa09NTW1XpJ27ty51zvgHYiamprx0t7XYKqurs5+6qmnztrfY+7YsSPV7/enSlKv\n", - "Xr22drRPU1PTroXSe/fuvdc1t8LXmxo0aNCuGU/V1dXZTz/99Bn7mysW7xUAAMQXzSl0FddKGhM2\n", - "bpP0E0tZAAAxsnr16ry2trbd7vQ2YMCAhGhOhS/03rt37/1ebyozM7Naknbs2JF3IOerr69P/+ST\n", - "T0bU1tZmhNe/+uqrgS0tLbnBHOWdrcH0wQcfHLVx48Yp+3u+9evX78qXn5+/paN90tLSds2oysnJ\n", - "qd7b8SLWm9o142nBggWHr127dmr4vvF+rwAAIL64Wx+sc3m8OZJ+FlF+xFfiZmo+ACSY8vLywZG1\n", - "MWPGJERzas2aNbsuV8zLy9vv5lROTk5lfX39iJ07d+53c2r16tX5Tz311K3Nzc35GRkZ1bfeeuvP\n", - "0tLS2iVp0aJFk8JydLiWV2tra9Ly5cvdY8eOnbu/56yqqtqVb8iQIR2uDzVw4MANixcvliSlpKR0\n", - "evfB1atX523btm2cFFhvasKECZtD29avXz9+wIABi8L2jft7BQAA8cXMKXQFt0gaGDZulHS7pSwA\n", - "gBiqrKzc7ZK+lJSUxuLi4k228kRTZWXlrrsQDhw4cK+XtIXr169fuSQ1NDQM3Ne+If/+979nNjc3\n", - "50tSU1NTYUNDQ5oUuLRw9erVJ4b2y8jIaOjo9c8999x0v9+fPHPmzA/395yVlZUDJSk1NbVhzJgx\n", - "Hc6KcrlcK0KXKe7YsSO/o33q6urSn3322e+EFlfPycnZtTZXU1NTSmVl5RGTJk36zOZ7BQAA8UVz\n", - "Cla5PN4CST+MKN/jK3FvtJEHABBbW7du3a051bt379WWokRd+ELvY8eO3e+ZU2PGjFkpSS0tLbkV\n", - "FRW99+c1O3fu7BN6XlRU9F7fvn2bJOnZZ5890+/3Jw0YMGCBJNXU1AyLfO2cOXOOXLFixVkzZsx4\n", - "OCMjo21/c1ZVVQ2XpNzc3FWd7ZOZmdk2fvz41ySpurr68MbGxt1m6VdVVWX/9a9//X5WVlZN7969\n", - "y6TA4vGh7e+8886U9PT02qOOOmqNzfcKAADii8v6YNsPJfUJG2+V9HtLWQAAMVZXV7fbZX2FhYVl\n", - "trJEW319/VBJysjIqNnbXeoiTZo0af3LL7+8o62tLXvp0qXDBw0a9OW+XjN27NiPt2zZMrmgoGDh\n", - "6aef/sb69etz33vvvePLy8tP+/rXv35PYWHh9r///e/DqqqqjvznP/95ytSpUz+rqqrK/eSTT06s\n", - "qKg4Zvr06fdPmTJlvxtoklRbWztMkgYOHLhsb/tdeOGF3qqqqtGVlZVHP/bYY1eeddZZL6SkpLR/\n", - "9tlnhy9evPic/v37L7z66quf/vDDD8d7vd6bt2/fPuqrr74aWF9fn/3pp59efNRRRz1n+70CAID4\n", - "ojkFa1we72BJN0WU7/SVuLfZyAMAiK3W1takHTt2DAqvFRUVJURzasWKFf3a2toyJalv374rD+S1\n", - "KSkp/gEDBny+cePGE8rKyg477bTT9tmcmjFjxqfp6enNpaWl0x5//PGfJycntxYUFHx1+eWX3zli\n", - "xIgaSbrmmmt+/+qrr565fPnyaYsWLbo4PT19+4ABA7645pprbh80aFDdgWSsqKjo3dDQMFSS/9hj\n", - "j/10b/smJyfr+uuvf+ill15aunLlypNmz559e3Jycktubu7KU0899W/HH3/8Ckk66aSTliYlJd27\n", - "YMGCc5977rkfp6SkNI4bN27OjBkzdjt+vN8rAACIP5pTsOknksLv2FQh6T5LWQAAMbZq1ap+fr8/\n", - "/GcP/5QpUzq9RKw7KSsr23VJ37BhwxYf6OuLi4t9GzduPKGysnKSpGf25zVut3uR2+1e1Nn2wsLC\n", - "HVddddULkl440DyRPvnkk8OlwB3xhg8fvs8PkZKTkzVr1qz3Jb2/t/1OPPHEZSeeeOJeZ2JJ8X2v\n", - "AAAg/lhzCla4PN6Rkr4dUf6Vr8S9w0YeAEDsrVmzZrf1prKzszfm5eXttJUnmjZt2jRcCqyfdNxx\n", - "x3XaROnMCSecsDQzM7Oyqamp8LPPPttj7STbysvLj5ak8ePHv2c7CwAASDw0p2DLz7X7zL3Vkh6x\n", - "EwUAEA9VVVW7rTdVUFCwwlaWg1VTU5P1pz/96cZf/epX9zz++OPnhepbt24dIUl9+/ZdWlhYeMAf\n", - "tCQnJ6u4uHiOJH3yySenRC1wFJSVlRXU1NQcnp6evnXGjBkf284DAAASD80pxJ3L450o6ZsR5Z/7\n", - "StzNNvIAAOKjtrZ2t+bUkCFDul1z6sUXXzx3y5Ytk9ra2jLLy8tPlwJradXV1Q2XpEmTJs092GPP\n", - "mDFjfnp6es2mTZtclZWVOdHKfKjee++9UyVp/Pjxb6ampvrtpgEAAImI5hRs+KV2/39viaQnLWUB\n", - "AMRJXV3dbpf1TZo0qds1p6qrqyeEnvfu3XuNJM2fP398W1tbZlZW1qa9rYu0LxkZGW3HHXfc0+3t\n", - "7ekvv/zyOdHIe6jWrFnTd+3atafm5OSsmzVr1ru28wAAgMREcwpx5fJ4j5Z0YUT5p74Sd5uNPACA\n", - "+GhsbEzduXNn/9A4MzOzasiQIdttZjoYKSkpTZKUnZ29YebMmU9IUmlp6SmS/KeccsoTh3r8008/\n", - "fWFhYeEX69evP3nZsmX99/2K2Hr99ddn+f3+lNNPP/2JlJQUZk0BAICYoDmFePt1xPhTcWcdAEh4\n", - "y5cvH+j3+3f93JGXl7fSZp6DVVxcPFeSioqKPs3IyGh97rnnTquurj5y1KhRb06dOjUq7+nSSy+d\n", - "nZGRUfPyyy9/q6WlxdrPam+//fbkTZs2TZ0wYcILRx111BpbOQAAQOKjOYW4cXm8J0uaEVH+ia/E\n", - "zSexAJDg1qxZs9sd6AYPHrzcVpZDMXPmzAUnnnjiAxs3bpw8e/bsX6xcufK0KVOmPHXllVe+GK1z\n", - "FBYW7jjvvPPub2xsHPjkk0/OitZxD8TatWv7zp8//8qBAwd+dMkll/zbRgYAANBzpO57F+DQuTze\n", - "JEm/iSi/J2mOhTgAgDirqqoaGj4uLi7udutNhUybNm3htGnTFsbyHBMnTtxUX1//xzfffPO7zz//\n", - "fM2FF174TizPF666ujr76aefvjk/P3/pNddcMzte5wUAAD0XM6cQL2dIOjGixqwpAOghtm/fXhR6\n", - "npaWVjtmzJhqm3m6g2OPPbbsggsu8CxfvvyMpUuXDojXeZ999tlLCwoKlt1www0Pp6WltcfrvAAA\n", - "oOdi5hRiLjhr6lcR5dd9Je4PbOQBAMRffX39ruZUd11vyobDDjus4rDDDvtxPM/5ne9852/xPB8A\n", - "AAAzpxAPZ0tyRdT+10YQAED8lZWVFbS1tWWFxgMGDOi2l/QBAAAg+mhOIaaCs6Z+GVF+0Vfi/tRG\n", - "HgBA/K1atWq39abGjx+/zFYWAAAAdD00pxBrX5d0ZETtFxZyAAAsqaioGB56npaWVnv44YdX2MwD\n", - "AACAroXmFGLG5fEma89ZU8/5StylNvIAAOzYunXrruZUYWHhVzazAAAAoOuhOYVYulDSpLCxX8ya\n", - "AoAep66ubldzqqioaKnNLAAAAOh6aE4hJlweb4r2bEQ97StxL7YQBwBgyapVqwpaW1tzQuMpU6bQ\n", - "nAIAAMBuaE4hVoykiWHjdu15iR8AIMEtW7ZsdOh5VlbWpqKiolqbeQAAAND10JxC1Lk83lTtOWvq\n", - "SV+Jm0/LAaCH2bBhw7jQ8/79+39pMwsAAAC6JppTiIVvSBoXNm4Ts6YAoEfasmXLrn8PJkyYwA0x\n", - "AAAAsAeaU4gql8ebJulnEeW/+0rcK23kAQDYs2LFin47d+7sL0mpqakNxx57LP8WAAAAYA80pxBt\n", - "35Q0OmzcKunXlrIAACwqLS09PPS8f//+X6SkpPht5gEAAEDXRHMKUROcNfWTiPLffCXucht5AAB2\n", - "rVu37ojQc5fL9a7NLAAAAOi6aE4hmq6QNCps3CLpN5ayAAAsWrNmTd/a2trxktS7d+/yI488cq3t\n", - "TAAAAOiaUm0HQGII3qEvctbUo74SN7+MAEACWr58eb9//etf325sbOw/bty4Vy+99NI54dvnz59/\n", - "bOj55MmT34x/QgAAAHQXzJxCtFyuPdeausNSFgBAjL399tvnNjQ0DG1vb89YunTpBcuXL+8X2tbY\n", - "2JhaVlbmlqT8/Pwvp0+f/oW9pAAAAOjqaE7hkAVnTf00ovyYr8S92kIcAEActLa2ZoaP/X5/Uuj5\n", - "q6++elJzc3Pf5OTk5nPPPfep+KcDAABAd0JzCtFwmaQxYeNWSb+1lAUAEAdFRUWLJCklJWXn6NGj\n", - "Xxs/fnylJK1bty536dKl50jSlClTnhk5cmSNzZwAAADo+lhzCofE5fGmaM9ZU7O5Qx8AJLZzzz33\n", - "g3Xr1k1pbm7uNWbMmK+2bduWsWLFisFer/eqtra2rIkTJz7/9a9/fd6hnOOtt96asmjRotNbW1uz\n", - "JCWNGDHiwwsuuGDu22+/fcSUKVNWDBgwoD467wYAAAA20ZzCobpU0riwcZu4Qx8AJLzU1FT/jTfe\n", - "eP8///nP0957773L58yZ0z81NbUhLy9vxbRp0x49+uij1xzssdvb2/XII498Y+PGjccff/zxD0+f\n", - "Pv2L1tbWpL/85S/X3XfffYdv3bp14pYtW1687LLL3ojmewIAAIAdNKdw0IKzpv43ovy4r8RdZiMP\n", - "ACC+UlJS/BdffLFXkjeax3300Ucv2bBhw8lHHXXU7NBi6qmpqf5zzjnHeeyxx34rSQMHDlwfzXMC\n", - "AADAHppTOBRG0viwMbOmAACHZO7cuYetW7futF69eq0+77zzPgzfNmjQoNqkpKQ2SUlHHHHESksR\n", - "AQAAEGUsiI6D0smsqSd9JW5+WQAAHJTW1takjz766DJJGj9+/LuR20tLS4f7/f6U7OzsDXl5eTvj\n", - "nxAAAACxQHMKB+siScVh43ZJv7aUBQCQAObNm1fc1NRUmJSU1D516tTSyO1lZWVjJKmwsHB5/NMB\n", - "AAAgVmhO4YC5PN5k7XmHvqd8Je4VNvIAABLDsmXLjpaknJyctf369dsRub2ysnKcJBUVFfHvDQAA\n", - "QAKhOYWDcZ6kw8PGzJoCAByyurq6gZKUn5+/x4012trakmpra0dL8h9xxBHMnAIAAEggNKdwQFwe\n", - "b5L2nDXl+Ercy2zkAQAkjpaWlj6SVFhYuMed+L788sshbW1tWdnZ2RWhWVWzZ8+e1d7eHu+YAAAA\n", - "iDKaUzhQZ0g6OqL2WxtBAACJJT09fbsk9erVqy5y25IlSyZKUn5+/gpJamxsTK2urh6TnMyPMgAA\n", - "AN0dP9FhvwVnTUXeoe9FX4l7kY08AIDEMmjQoEWSVF9f3zu8XlpaWrR8+fJzJCk/P3+jJM2fP794\n", - "4MCBi+OfEgAAANFGcwoH4mRJJ0TUfmMjCAAg8Zx11llzMzIytqxcufKE1tbWJEmaO3fuYW+99dY3\n", - "XC7XbElqbW1Na29v15dffnnKSSed9KHdxAAAAIiG1HicxBiTIelmSVdJGiVpm6Q5kn7hOM7qDva/\n", - "XtJ3JY2UVCPpNUn/6zhOZTzyolORa0294Stxf2IlCQAg4fTt27fpkksuufvVV1+95K677vpFWlra\n", - "jry8vPJrr7323tzc3KbGxsac5cuXu++++27X6NGjPxg6dGit7cwAAAA4dDFvThljkiU5ks6UdK+k\n", - "dyUNlfT/JC0wxhwb3qAyxvxO0i2S7pb0nqTBkn4k6WRjzHGO42yPdWbsyeXxHidpWkSZO/QBAKJq\n", - "1KhRW2666aYHOtp2wQUXvKvAzxEAAABIIPGYOXVu8Osqx3EeDxWNMc9LWizpZ5K+FawdLelWSd92\n", - "HOeRsH1fkbRQ0s8l/SAOmbGnn0SM3/GVuOdZSQIAAAAAABJGPNacapDkkfREeNFxnGoFLu07Lqz8\n", - "bUll4Y2p4L6bJd0v6WpjTFwuRcR/uDzeIxRoMIZjrSkAAAAAAHDIYt7ocRznLUlvdbI5U1Jz2PhU\n", - "Sa93su9rkn4h6QhJrHMUXz+OGH8s6W0bQQAAAAAAQGKxdrc+Y0w/SWcpsK6UjDFJCiyWvrSTlywL\n", - "Po6OfTqEuDzeYkkXRZR/7Stx+23kAQAAAAAAicVKcyrYiHpIgZlbdwfLfSSlKHAnvz04jlMnqU1S\n", - "QTwyYpcfSUoKG5dKetVSFgAAAAAAkGBsrd90t6TzJN3sOM6aYK138LFxL69rlJQby2D4D5fHO1LS\n", - "5RFlZk0BAAAAAICoifvMKWPMTyV9T9J9juPcF7apLviYtZeXZ0mqjVU27OFWBWazhSyV9E9LWQAA\n", - "AAAAQAKKa3PKGHO9pF9Kmu04zs0Rm7crcNle305e20uBRsmWmIaEJMnl8Q6Q9K2I8u98Je52G3kA\n", - "AAAAAEBiiltzyhhziaT7JDmSro7c7jiOX1KZpAmdHCJUL4tJQES6RYG7KYask/SUpSwAAAAAACBB\n", - "xaU5ZYw5U9JsBRbSvjzYiOrIOwrcwa8jMxVYLP2LqAfEblweb66kGyLKd/lK3M028gAAAAAAgMQV\n", - "8+aUMWaqpOcVaDxd5DhO2152f0jSKGPMbpeTGWMGSLpR0mOO47TEKit2+Y4Cd08MqZb0sKUsAAAA\n", - "AAAggcXjbn2vKbCI+T2STjDG7LGD4zjvBB8/Mcb8QdIDxpgxkuZJGijpfxSYNfWLOOTt0Vweb5ak\n", - "70eU7/WVuHfYyAMAAAAAABJbPJpTfSXlKnBJX0f8CrsjnOM4txpjyhWYvfM9BZpSr0n6ieM422Oc\n", - "FYH1wPqHjesl3W8pCwAAAAAASHAxb045jnPAlw46jnO/aIjEncvjTZVUElH+i6/EvdVGHgAAAAAA\n", - "kPjidrc+dAuXShoRNm6W9Ac7UQAAAAAAQE9AcwqSJJfHmyzpRxHlx3wl7o028gAAAAAAgJ6B5hRC\n", - "zpF0WNi4XZLHUhYAAAAAANBD0JyCXB5vkqTbIsrP+krcK23kAQAAAAAAPQfNKUjSSZKmRtTutBEE\n", - "AAAAAAD0LDSnIEk/jBi/7itxf2ElCQAAAAAA6FFoTvVwLo/3cElnR5R/ZyMLAAAAAADoeWhO4daI\n", - "8QJJ79kIAgAAAAAAeh6aUz2Yy+MtkvSNiPLvfSVuv408AAAAAACg56E51bN9T1Ja2HilpBctZQEA\n", - "AAAAAD0QzakeyuXx9pV0XUT5Ll+Ju81GHgAAAAAA0DPRnOq5rpPUO2xcKWm2pSwAAAAAAKCHojnV\n", - "A7k83gxJt0SU/+grcTfayAMAAAAAAHoumlM90xWSBoaNGyT92VIWAAAAAADQg9Gc6mFcHm+ypJKI\n", - "8kO+EneNjTwAAAAAAKBnoznV85wjaXzYuE3SHyxlAQAAAAAAPRzNqZ7nhxHjf/hK3GutJAEAAAAA\n", - "AD0ezakexOXxHi/phIiyx0YWAAAAAAAAieZUT3NrxPgNX4l7oZUkAAAAAAAAojnVY7g83jGSZkWU\n", - "77KRBQAAAAAAIITmVM9xi6SksPEXkryWsgAAAAAAAEiiOdUjuDzefElXR5T/z/Pv4qMAABL5SURB\n", - "VFfi9tvIAwAAAAAAEEJzqme4XlJ22HiDpGcsZQEAAAAAANiF5lSCc3m8GZJuiij/0VfibrGRBwAA\n", - "AAAAIBzNqcR3maSBYeN6SX+1lAUAAAAAAGA3NKcSmMvjTZL0/yLKj/hK3Nts5AEAAAAAAIhEcyqx\n", - "TZc0KWzcLuleS1kAAAAAAAD2QHMqsf0gYvy8r8RdbiUJAAAAAABAB2hOJSiXxztJ0hkR5f+zkQUA\n", - "AAAAAKAzNKcSV+RaU/N8Je6PrSQBAAAAAADoBM2pBOTyeAdLujyizKwpAAAAAADQ5dCcSkw3SkoL\n", - "G6+S9JKlLAAAAAAAAJ2iOZVgXB5vtqTrI8p/8JW422zkAQAAAAAA2BuaU4nnCkn5YeOtkh6zEwUA\n", - "AAAAAGDvaE4lEJfHmyTplojyX30l7gYbeQAAAAAAAPaF5lRiOUNScdi4TdL9lrIAAAAAAADsE82p\n", - "xBI5a+o5X4l7nZUkAAAAAAAA+4HmVIJwebzFkmZElO+xkQUAAAAAAGB/0ZxKHN+LGH/kK3F/ZCUJ\n", - "AAAAAADAfqI5lQBcHm+BpCsjysyaAgAAAAAAXR7NqcTw35KywsbrJf3TUhYAAAAAAID9RnOqm3N5\n", - "vGmSvhtR/pOvxN1iIw8AAAAAAMCBoDnV/V0kaUjYeIekhy1lAQAAAAAAOCA0p7oxl8ebJOn7EeW/\n", - "+0rcNTbyAAAAAAAAHCiaU93b1yS5Imr32ggCAAAAAABwMGhOdW+3RIxf85W4l1lJAgAAAAAAcBBo\n", - "TnVTLo93qKQLIsr32MgCAAAAAABwsGhOdV/fkZQSNv5K0luWsgAAAAAAABwUmlPdkMvjzZL07Yjy\n", - "H30lbr+NPAAAAAAAAAeL5lT3dJmkgrDxNklPWMoCAAAAAABw0GhOdTMujzdJ0k0R5Yd9Je4GG3kA\n", - "AAAAAAAOBc2p7udESUeEjf2SHrCUBQAAAAAA4JDQnOp+bo4Yv+QrcZdbSQIAAAAAAHCIaE51Iy6P\n", - "d6ik8yPKf7SRBQAAAAAAIBpoTnUv35GUEjZeLGmupSwAAAAAAACHjOZUN+HyeLMkfTui/Cdfidtv\n", - "Iw8AAAAAAEA00JzqPi6TVBA23ibpCUtZAAAAAAAAooLmVDfg8niTJN0UUX7YV+JusJEHAAAAAAAg\n", - "WmhOdQ8nSjoibOyX9IClLAAAAAAAAFFDc6p7uDli/JKvxF1uJQkAAAAAAEAU0Zzq4lwe71BJ50eU\n", - "/2gjCwAAAAAAQLTRnOr6rpOUEjZeLGmupSwAAAAAAABRRXOqC3N5vBmS/juifL+vxO23kQcAAAAA\n", - "ACDaaE51bRdK6h823i7pcUtZAAAAAAAAoo7mVNd2Y8T4774Sd72VJAAAAAAAADFAc6qLcnm8R0g6\n", - "PqL8gI0sAAAAAAAAsUJzquuKnDX1tq/EvdRKEgAAAAAAgBihOdUFuTzePEmXR5Tvt5EFAAAAAAAg\n", - "lmhOdU3/JSkrbLxO0st2ogAAAAAAAMQOzakuxuXxJmvPS/oe9JW4W23kAQAAAAAAiCWaU13PGZJG\n", - "h42bJT1kKQsAAAAAAEBM0ZzqeiJnTT3rK3FXWkkCAAAAAAAQYzSnuhCXxztS0tkRZRZCBwAAAAAA\n", - "CYvmVNdyvaSksPHnkj6ylAUAAAAAACDmaE51ES6PN1PSNRHl+30lbr+NPAAAAAAAAPFAc6rruERS\n", - "Qdh4q6R/WMoCAAAAAAAQFzSnuo7rI8aP+krcO6wkAQAAAAAAiBOaU12Ay+M9QtLUiPJfbGQBAAAA\n", - "AACIJ5pTXcN3Isb/9pW4V1hJAgAAAAAAEEc0pyxzebx9JF0eUf6zjSwAAAAAAADxRnPKvisk5YSN\n", - "N0p62VKWhLBhw4ZTbGdA/GzZsuVc2xkQP3y/exa+3z0L3++ehe93z8L3u2d54IEHItdTBvaJ5pRF\n", - "Lo83SXte0veQr8TdaiNPoqirqzvZdgbET1NT0zm2MyB++H73LHy/exa+3z0L3++ehe93z7Jlyxaa\n", - "UzhgqbYDdMQYkyrph5KuljRE0mZJz0q63XGcBpvZouwESYeHjdskPWQpCwAAAAAAQNx11ZlTT0r6\n", - "kaS/SbpA0t2SvinpdWNMis1gURY5a+olX4l7g5UkAAAAAAAAFnS5mVPGmAskXSzpDMdx3gqW3zDG\n", - "vCXpM0k3SPqTrXzR4vJ4+0m6KKL8FxtZAAAAAAAAbOmKM6eukzQ3rDElSXIcZ4mkf0hKlOtXr5aU\n", - "HjZeJemtTvYFAAAAAABISF2qORVca+oESa92sstrkoqNMYXxSxV9Lo83WYEmXLi/+Erc7TbyAAAA\n", - "AAAA2NKlmlOSBknKlrS0k+3Lgo+j4xMnZs6QNCps3CTpMTtRAAAAAAAA7Olqzan84OO2TraH6gVx\n", - "yBJLkZcmPusrcVdbSQIAAAAAAGBRV2tO9Q4+NnayfUfwMTcOWWLC5fEOlXRuRPnPNrIAAAAAAADY\n", - "1tWaU3XBx6xOtmcHH2vjkCVWrtXu/90XSppvKQsAAAAAAIBVSX6/33aGXYwxQyWtkXSO4zivdbD9\n", - "cAWaOV9zHOfj/Tnm22+/3XXeIAAAAAAAQAI5/fTTkw71GF1t5lSFApf0Tehke6heFp84AAAAAAAA\n", - "iKVU2wHCOY7Taoz5QNLZku7uYJeZkpY4jlO1v8eMRgcPAAAAAAAAsdHVZk5J0oOSTjPGnB5eNMYU\n", - "S7osuB0AAAAAAAAJoEutORVijHlW0nRJd0oqlTRG0m0KXM53iuM4bRbjAQAAAAAAIEq61GV9YS5T\n", - "oBl1jaQhkjZLekrSz2lMAQAAAAAAJI4uOXMKAAAAAAAAPUNXXHMKAAAAAAAAPQTNKQAAAAAAAFhD\n", - "cwoAAAAAAADW0JwCAAAAAACANTSnAAAAAAAAYA3NKQAAAAAAAFhDcwoAAAAAAADWpNoOECvGmFRJ\n", - "P5R0taQhkjZLelbS7Y7jNNjMhtgyxgyW9KqkEY7j5NnOg+gyxmRIulnSVZJGSdomaY6kXziOs9pi\n", - "NMSIMeZwSb+QdLKkTEnLJT0o6RHHcdotRkOMGWNSJH0qabKk8x3H+ZflSIgBY8ze/hzPchznpbiF\n", - "QVwYY06X9G9JNzuOc5/tPIg+Y8xqScP2ssvtjuPcHqc4iDFjTJqkGyR9V4Hve6WkxyXd4ThOnc1s\n", - "iD5jTC9Jt0m6RFKRpGpJL0v6leM4Gw/2uIk8c+pJST+S9DdJF0i6W9I3Jb0e/GEXCSj4S+xHCvwi\n", - "47ccB1FmjEmW5Ej6lQINyIsk3S7pa5IWGGNG2EuHWDDGHCtpgaQBkm6RZBT4x+//JN1jMRri4wZJ\n", - "AxX4+5y/0xPbfZJO7eBrnqU8iJHgB8h/lPS5pPstx0HsXKKO/0xfFdy+Jv6REEMPSbpT0jOSzlfg\n", - "Z7T/lvRG8M88EkSwMfWBpBsV+L6fI+mXkmZK+swYM/pgj52Q/6MYYy6QdLGkMxzHeStYfsMY85ak\n", - "zxT4YfdPtvIhNoKfwj0vaamkFxVoRiKxnBv8uspxnMdDRWPM85IWS/qZpG9ZyobY2KnAhwv/6zhO\n", - "qDnxhjFmg6S/GmP+5DjOCnvxECvGmP4KNJ9/IOkRy3EQeysdx3nPdgjExU2SJkj6Wtjf60gwjuN8\n", - "3FHdGHOHArPen45vIsSKMeZoSVdK+rbjOA8Hy68ZY95XYNLAFZIesxQP0fdjBf4OP8pxnK9CRWOM\n", - "I2mRAh82nXUwB07UmVPXSZob1piSJDmOs0TSPyRdbyUVYu1KBS7/OF1SjeUsiI0GSR5JT4QXHcep\n", - "VuDSvuNshELsOI6z0HGcn3bwC0xoNsXweGdC3PxO0tuSvLaDAIiOYNP555Iedhxnge08iK/g0gzX\n", - "Svq74zg7bedB1IwNPr4eXgz+Ga8J247EcIkkJ7wxpUBhm6R7JU03xvQ5mAMn3Myp4LTBExSYQdGR\n", - "1yT9lzGmMPgLLRLH9ZLaHMdpNsbYzoIYCDac3+pkc6ak5jjGgV1HSmqR9KXtIIg+Y8zXFLiEc6Kk\n", - "JMtxEB98n3uGOxX4t/pHtoPAikslFUj6s+0giKpQk2KSpA2hojFmiKQ8SUtshELMFKnz7+kSBSZA\n", - "DZa0/UAPnHDNKUmDJGUrcGlXR5YFH0crsHAXEoTjOI22M8AOY0w/BaaPculPAjPGZErKlzRDgTWn\n", - "fuI4zia7qRBtwbXl7pd0l+M4a1hLrse40RjzY0m5klZI+ovjOKxHlECCawheJenbklqMMZnMnulx\n", - "bpT0tuM4y20HQfQ4jrPQGPOkpL8YY65XYK3QcQqsLfeZuIQz0dQo0KDqyJDg4wE3pqTEvKwvP/i4\n", - "rZPtoXpBHLIAiDFjTJICi/GlKrA2ERLXJknrJT0s6eeO49xlOQ9i43oF/o2+w3YQxM0GBe7qdKUC\n", - "lwsslPQnY8xfrKZCtN0jqU3S9xX4xaXBGDM3uF4NEpwx5jhJx4hZU4nqagUaUa8pMAHkQ0lpks50\n", - "HKfVZjBE3ZuSLjLG9A0vBj9cvFbSuoO9Y18izpzqHXzsbBbNjuBjbhyyAIi9uyWdp8DtqLnzS2Kb\n", - "JmmopK9LussY08txnN9azoQoMsYUKnA3zhuYUdGjjHAcpy1s/K/gbehvM8Y87TjOO3ZiIVqMMWdI\n", - "miqpVtKzCiyaO0LSzZLeM8ac6jiOz15CxMF3FWhEv2g7CKIr2JR4UtJpCtxZ+TNJoxS4qcm/jTGn\n", - "OY5zUDNp0CX9UtIsSXONMTdL+kKBv8/vVKAB/cODPXAiNqfqgo9ZnWzPDj7WxiELgBgyxvxU0vck\n", - "3ec4zn228yC2HMf5RNInkl4wxnglPWaMecVxnIWWoyF67pD0peM4z9gOgviJaEyF/FqBT2C/Kemd\n", - "uAZCLNykwAfHUx3HCS2xIWPMwwrMlLtX0vGWsiHGgssvXCzpt47jtNvOg6i7UtKFko5xHOeLYO0D\n", - "Y8yrCiy1c7sCMyaRABzHKTPGnKrAlQzvBsvtCtxhu1LSAwd77ES8rC90l7a+nWwPzZjaEocsAGIk\n", - "eE37LyXNdhznZtt5EF+O48xW4BPYy2xnQXQYYyYocFnAncaYgaEvSf2Cu+QFa5n2UiJegutIzlPg\n", - "dtXo/r4m6ZnwxpQkBWdT3CNpqjGGJTcS17cV+L3zr7aDICYuU2AtsS/Ci47jbJH0mPhZLeE4jvOF\n", - "4zjHKHDX7CMUuCFdqqTbHMfZsdcX70UiNqcqFPhkprMfZkL1svjEARBtxphLJN0nyVHgl1n0TBsU\n", - "+EcRiWGgAj+XvCppY9jXx8HtjwbH3I6152iRxFoliaG3AgvddyRU79fJdnRjxpgUSddJepGbmCSs\n", - "YZLKO9m2WlJ/Y0xa/OIgXhzHWRe8guEOSaWO4zx6KMdLuMv6HMdpNcZ8IOlsdbw48kxJSxzHqYpv\n", - "MgDRYIw5U9JsBX6BvdxxHL/lSIiR4BoG0yVVOo7zecS2JElj9J/GBbq/UgXuuhn5Z3qgAp+83i5p\n", - "vqQv4xsLsRT8hWVw5JqBxphUBdYoesVKMETbBgX+zu7IGAUuCamIXxzE0SwF7ux10Jf6oMurUed/\n", - "vkdLqnMcpyWOeRBHxpirJJ2iwAzZQ5KIM6ck6UFJpxljTg8vGmOKFZhW+KCVVAAOiTFmqqTnFVh/\n", - "5KJO1ilB4uilwAKb9wYbVeGuVeDurP+KeyrEhOM4Wx3HedNxnDnhX5LeC+7yebB2UHeAQZf1rqTX\n", - "jDG9IuolCvxC+0j8IyEGnpV0iTFmZHjRGJOjwKLobzmOw3qwiem7CkwMeMd2EMTM05JONcYcG140\n", - "xgyQ9F8K/OyOBBS8HPsuSX93HGfBoR4v4WZOSZLjOP80xjwv6XljzJ0KfBo7RtJtkj6VdL/NfAAO\n", - "2msK3MzgHkknGLPn1T388JM4HMfZboy5UdITCtzt5WFJ9QrMpvqOAv8Qem1mBHDIfiPpn5LmGWPu\n", - "UuAT+IsVWGD3Z47jfGYzHKLm15JmSFpgjPmdpK8UuBTo+wp8EPFdi9kQI8aYwxSYUcHaoIntPgXu\n", - "nP3v4J/vhQrcve2HCvzcfpu9aIix3yvQU/pRNA6WqDOnpMAMqf+TdI0C3dr/J+kpSWcy26JH8GvP\n", - "S0PQ/fVV4BKfVyV5O/h62140xELwrm1uBdYSvFeBdcZOlHST4zisN9Zz8Pd5gnIc51VJp0par8AH\n", - "D88ocBnIBY7j/NpiNESR4zh1CiyY+7ACHy68IOlnCsycO9JxnJUW4yF2bpTUIOnvtoMgdoJLbJwj\n", - "6Q8KrAX7vALNipcluRzH2WwxHmLEGHOSAjPjfuk4TmU0jpnk9/PzHgAAAAAAAOxI5JlTAAAAAAAA\n", - "6OJoTgEAAAAAAMAamlMAAAAAAACwhuYUAAAAAAAArKE5BQAAAAAAAGtoTgEAAAAAAMAamlMAAAAA\n", - "AACwhuYUAAAAAAAArKE5BQAAAAAAAGtoTgEAAAAAAMAamlMAAAAAAACwhuYUAAAAAAAArKE5BQAA\n", - "AAAAAGtoTgEAAAAAAMAamlMAAAAAAACwhuYUAAAAAAAArKE5BQAAAAAAAGtoTgEAAAAAAMAamlMA\n", - "AAAAAACw5v8DPWODrRZIv60AAAAASUVORK5CYII=\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": { - "image/png": { - "height": 381, - "width": 595 - } - }, - "output_type": "display_data" - } - ], - "source": [ - "plt.plot(x, y, lw=2)\n", - "plt.axis([0, 9, 0, 140])\n", - "plt.fill_between(xint, 0, yint, facecolor='gray', alpha=0.4)\n", - "plt.text(0.5 * (a + b), 30,r\"$\\int_a^b f(x)dx$\", horizontalalignment='center', fontsize=20);" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Compute the integral both at high accuracy and with the trapezoid approximation" - ] - }, - { - "cell_type": "code", - "execution_count": 5, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "name": "stdout", - "output_type": "stream", - "text": [ - "The integral is: 565.2499999999999 +/- 6.275535646693696e-12\n", - "The trapezoid approximation with 5 points is: 559.890625\n" - ] - } - ], - "source": [ - "from __future__ import print_function\n", - "from scipy.integrate import quad\n", - "integral, error = quad(f, a, b)\n", - "integral_trapezoid = sum( (xint[1:] - xint[:-1]) * (yint[1:] + yint[:-1]) ) / 2\n", - "print(\"The integral is:\", integral, \"+/-\", error)\n", - "print(\"The trapezoid approximation with\", len(xint), \"points is:\", integral_trapezoid)" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.2" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/IPython Kernel/Updating Displays.ipynb b/examples/IPython Kernel/Updating Displays.ipynb deleted file mode 100644 index 33b86670171..00000000000 --- a/examples/IPython Kernel/Updating Displays.ipynb +++ /dev/null @@ -1,337 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Updatable Displays\n", - "\n", - "Note: This feature requires notebook >= 5.0 or JupyterLab, and \n", - "\n", - "\n", - "IPython 6 implements a new API as part of the Jupyter Protocol version 5.1 for easily updating displays.\n", - "\n", - "When you display something, you can now pass a `display_id` argument to attach an id to that output.\n", - "\n", - "Any future display with the same ID will also update other displays that had the same ID.\n", - "\n", - "`display` with a `display_id` will return a `DisplayHandle`\n", - "object, which gives you easy access to update the output:" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": {}, - "outputs": [], - "source": [ - "from IPython.display import display, update_display" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "'z'" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "text/plain": [ - "" - ] - }, - "execution_count": 2, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "handle = display('x', display_id='update-me')\n", - "handle" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "When we call `handle.display('y')`, we get a new display of 'y',\n", - "but in addition to that, we updated the previous display." - ] - }, - { - "cell_type": "code", - "execution_count": 3, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "'z'" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "handle.display('y')" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "We can also *just* update the existing displays,\n", - "without creating a new display:" - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "metadata": {}, - "outputs": [], - "source": [ - "handle.update('z')" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "You don't have to generate display_ids yourself,\n", - "if you specify `display_id=True`, then a unique ID will be assigned:" - ] - }, - { - "cell_type": "code", - "execution_count": 5, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "'hello'" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "text/plain": [ - "" - ] - }, - "execution_count": 5, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "handle = display(\"hello\", display_id=True)\n", - "handle" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Calling `handle.display(obj)` is the same as calling `display(obj, handle.display_id)`,\n", - "so you don't need to use the handle objects if you don't want to:" - ] - }, - { - "cell_type": "code", - "execution_count": 6, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "'z'" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "display('x', display_id='here');" - ] - }, - { - "cell_type": "code", - "execution_count": 7, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "'z'" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "display('y', display_id='here');" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "And just like `display`, there is now `update_display`,\n", - "which is what `DisplayHandle.update` calls:" - ] - }, - { - "cell_type": "code", - "execution_count": 8, - "metadata": {}, - "outputs": [], - "source": [ - "update_display('z', display_id='here')" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## More detailed example\n", - "\n", - "One of the motivating use cases for this is simple progress bars.\n", - "\n", - "Here is an example ProgressBar using these APIs:" - ] - }, - { - "cell_type": "code", - "execution_count": 9, - "metadata": {}, - "outputs": [ - { - "data": { - "text/html": [ - "" - ], - "text/plain": [ - "[============================================================] 10/10" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "from IPython.display import ProgressBar\n", - "\n", - "bar = ProgressBar(10)\n", - "bar.display()" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "And the ProgressBar has `.display` and `.update` methods:" - ] - }, - { - "cell_type": "code", - "execution_count": 10, - "metadata": {}, - "outputs": [ - { - "data": { - "text/html": [ - "" - ], - "text/plain": [ - "[============================================================] 10/10" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "import time\n", - "\n", - "bar.display()\n", - "\n", - "for i in range(11):\n", - " bar.progress = i\n", - " bar.update()\n", - " time.sleep(0.25)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "The ProgressBar also has an update built into iteration:" - ] - }, - { - "cell_type": "code", - "execution_count": 11, - "metadata": {}, - "outputs": [ - { - "data": { - "text/html": [ - "" - ], - "text/plain": [ - "[============================================================] 10/10" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "for i in ProgressBar(10):\n", - " time.sleep(0.25)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "We would encourage any updatable-display objects that track their own display_ids to follow-suit with `.display()` and `.update()` or `.update_display()` methods." - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.6.2" - } - }, - "nbformat": 4, - "nbformat_minor": 1 -} diff --git a/examples/IPython Kernel/Working With External Code.ipynb b/examples/IPython Kernel/Working With External Code.ipynb deleted file mode 100644 index c5e5c840a78..00000000000 --- a/examples/IPython Kernel/Working With External Code.ipynb +++ /dev/null @@ -1,691 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Working With External Code" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "The IPython Kernel makes it easy to incorporate external code from sources such as the internet or copy/paste. " - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Pasting code into cells" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "You can copy and paste code from other sources directly into cells. Pasting code with `>>>` prompts works as expected:" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "name": "stdout", - "output_type": "stream", - "text": [ - "Be careful not to fall off!\n" - ] - } - ], - "source": [ - ">>> the_world_is_flat = 1\n", - ">>> if the_world_is_flat:\n", - "... print(\"Be careful not to fall off!\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## The %load magic" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "The `%load` magic lets you load code from URLs or local files:" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "%load?" - ] - }, - { - "cell_type": "code", - "execution_count": 3, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "%matplotlib inline" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": { - "collapsed": true - }, - "outputs": [], - "source": [ - "%load http://matplotlib.org/mpl_examples/showcase/integral_demo.py" - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "image/png": [ - "iVBORw0KGgoAAAANSUhEUgAABKkAAAMnCAYAAAD1XgGYAAAABHNCSVQICAgIfAhkiAAAAAlwSFlz\n", - "AAAWJQAAFiUBSVIk8AAAIABJREFUeJzs3Xm0pWV9J/rvc05VUQU1MhdTMY8lgwioQMRGcUIhRBHF\n", - "GTCKUcAERVTiCChEMQYHxClIHGNak2jS3VlJJ52k+2a+t3t1eqVv3xhAQKAKqqj5nPPeP3aVtWtz\n", - "ihrOOfvZw+ez1rv2fn/vPmd/F4tVp863nvfZpWmaAAAAAEBNI7UDAAAAAICSCgAAAIDqlFQAAAAA\n", - "VKekAgAAAKA6JRUAAAAA1SmpAAAAAKhOSQUAAABAdUoqAAAAAKpTUgEAAABQnZIKAAAAgOqUVAAA\n", - "AABUp6QCAAAAoDolFQAAAADVKakAAAAAqE5JBQAAAEB1SioAAAAAqlNSAQAAAFCdkgoAAACA6pRU\n", - "AAAAAFSnpAIAAACguimXVKWUw0spv1lK+YNSyms6rr2jlPIfp/oeAAAAAAy26VhJdX2Sdyf5j0lu\n", - "6Lj2hiSPTMN7AAAAADDAplRSlVLOTvIXTdOMJXlxkv/Vdm2vJKcl+c9TSggAAADAwJs1xa//30n+\n", - "ppRycJIXJvmltmvP3fz9/3yK7wEAAADAgJtSSdU0zcNJUkq5NMnqJD9qu3xukkeapvmfU3kPAAAA\n", - "AAbfdH2634uS/GnTNJvaZr+Q5C+m6fsDAAAAMMCmq6Q6LNvuR7VHkjPjVj8AAAAAdsJ0lVQ/SbJP\n", - "2/mtSebGpukAAAAA7ITSNM3Uv0kpxyW5O8k/Jlmb1qbpJzVNs/eUv/lO+JM/+ZMmSc4///zSjfcD\n", - "AAAAYHpN9dP9kiRN0/yvtDZKTymlJHkwyQ+n43sDAAAAMPimfLtfKeWbpZR/ahtdnGRJklum+r0B\n", - "AAAAGA7TsSfV+Un+LElKKQcluT3JmzavrgIAAACAHZqO2/3eluSMUsptSQ5MclnTNH8zDd8XAAAA\n", - "gCEx5ZKqaZrvJ/n+NGQBAAAAYEhNx+1+AAAAADAlSioAAAAAqlNSAQAAAFCdkgoAAACA6pRUAAAA\n", - "AFSnpAIAAACgOiUVAAAAANUpqQAAAACoTkkFAAAAQHVKKgAAAACqU1IBAAAAUJ2SCgAAAIDqlFQA\n", - "AAAAVKekAgAAAKA6JRUAAAAA1SmpAAAAAKhOSQUAAABAdUoqAAAAAKpTUgEAAABQnZIKAAAAgOqU\n", - "VAAAAABUp6QCAAAAoDolFQAAAADVKakAAAAAqE5JBQAAAEB1SioAAAAAqlNSAQAAAPBUpZRuvp2S\n", - "CgAAAIBttQqqv+jmWyqpAAAAAOj0kiRnd/MNlVQAAAAAbNVaRfX+br+tkgoAAACAducmeW6331RJ\n", - "BQAAAEC7G2u8qZIKAAAAgJZSnpnkRTXeWkkFAAAAwBbvq/XGSioAAAAAklKOT/JLtd5eSQUAAABA\n", - "krw3SWk7/8duvrmSCgAAAGDYlbIsyes6prd0M4KSCgAAAIBfSzKr7fxfkvxuNwMoqQAAAACGWSn7\n", - "J7myY3prmma8mzGUVAAAAADD7dokc9vO70/yjW6HUFIBAAAADKtSFid5R8f0tjTNxm5HUVIBAAAA\n", - "DK+rkyxsO380yd01giipAAAAAIZRKXsmua5j+uk0zdoacZRUAAAAAMPpyiT7tp2vTvK5SlmUVAAA\n", - "AABDp5Q5Sa7vmN6Zpnm8RpxESQUAAAAwjC5Pckjb+fokd1TKkkRJBQAAADBcShlNckPH9O40zcM1\n", - "4myhpAIAAAAYLpckObbtfCzJ7ZWy/JySCgAAAGBYlFKS3Ngx/Uaa5ic14rRTUgEAAAAMjxcnObXt\n", - "vEnyiUpZtqGkAgAAABgenauovp+m+ecqSTooqQAAAACGQSnnJjmnY3pLjSiTUVIBAAAADIf3dZz/\n", - "cZrm76okmYSSCgAAAGDQlXJakpd0TG+uEWV7lFQAAAAAg69zFdVfJvmLGkG2R0kFAAAAMMhKOS7J\n", - "KzumN6dpmhpxtkdJBQAAADDY3puktJ3/U5IfV8qyXUoqAAAAgEFVymFJXt8xvaXXVlElSioAAACA\n", - "QfarSWa1nf/vJN+rlOVpKakAAAAABlEp+ye5qmN6a5pmvEacHVFSAQAAAAyma5LMazu/P8k9lbLs\n", - "kJIKAAAAYNCUsijJr3RMb0/TbKwRZ2coqQAAAAAGz9VJFradP5rk7kpZdoqSCgAAAGCQlLJnkus6\n", - "pnekadbUiLOzlFQAAAAAg+UtSfZrO1+d5M5KWXaakgoAAABgUJQyJ8l7OqafS9M8XiPOrlBSAQAA\n", - "AAyO1yY5tO18fZJPV8qyS5RUAAAAAIOglNEkN3RMv5ymebhGnF2lpAIAAAAYDL+Y5Li287Ekt1XK\n", - "ssuUVAAAAAD9rpSS5MaO6b1pmp/UiLM7lFQAAAAA/e+CJKe1nTdJPlEpy25RUgEAAAD0v85VVL+X\n", - "pvmfVZLsJiUVAAAAQD8r5Zwkv9AxvaVGlKlQUgEAAAD0t/d1nP+HNM3fVkkyBUoqAAAAgH5VyqlJ\n", - "XtoxvblGlKlSUgEAAAD0r85VVH+V5M9rBJkqJRUAAABAPyrluCSv6pjenKZpasSZKiUVAAAAQH/6\n", - "UJLSdv5/J/lRnShTp6QCAAAA6DelnJLkso7px/t1FVWipAIAAADoRx/tOP+nJN+rEWS6KKkAAAAA\n", - "+kkpz07y8o7p+9M0EzXiTBclFQAAAEB/+XjH+V+nj/ei2kJJBQAAANAvSjk/yb/rmN7Yz3tRbaGk\n", - "AgAAAOgHpZQ8dRXVf0rT/FmFNNNOSQUAAADQHy5MclbH7P01gswEJRUAAABArytlJMnHOqY/SNP8\n", - "XzXizAQlFQAAAEDvuzTJyW3nTZIPVsoyI5RUAAAAAL2slFlJPtIx/Vaa5v+pEWemKKkAAAAAetsb\n", - "kxzTdj6e5NcrZZkxSioAAACAXlXKHklu6ph+NU3zLzXizCQlFQAAAEDvemuSw9rON+apt/4NBCUV\n", - "AAAAQC8qZa8kH+iYfj5Nc1+NODNNSQUAAADQm96ZZP+287VJbqmUZcYpqQAAAAB6TSmLk7y3Y3pH\n", - "mubhGnG6QUkFAAAA0Ht+NcnitvMnktxeKUtXKKkAAAAAekkp+ye5rmN6W5pmZY043aKkAgAAAOgt\n", - "NyTZq+38kSSfqZSla5RUAAAAAL2ilEOSXN0xvTlN82SNON2kpAIAAADoHR9Mskfb+f1JvlApS1cp\n", - "qQAAAAB6QSlHJXlLx/QjaZr1NeJ0m5IKAAAAoDd8KMmstvP/N8nXqiSpQEkFAAAAUFspy5Nc3jG9\n", - "KU2zqUacGpRUAAAAAPV9JElpO//vSb5VKUsVSioAAACAmko5I8kvdkw/mKaZqBGnFiUVAAAAQF0f\n", - "6zj/myQ/qBGkJiUVAAAAQC2lPC/JBR3T96dpmhpxalJSAQAAANRQSkny8Y7pnyX5T90PU5+SCgAA\n", - "AKCOFyc5u2M2lKuoEiUVAAAAQPeVMpKnrqL6UZrmr2rE6QVKKgAAAIDuuyTJaR2zD9QI0iuUVAAA\n", - "AADdVMpoko92TL+bpvmHGnF6hZIKAAAAoLtel+T4tvOJJDdVytIzlFQAAAAA3VLKnCQf6pj+dprm\n", - "nyuk6SlKKgAAAIDuuTLJ4W3nm5J8uE6U3qKkAgAAAOiGUvbMUzdHvytN868V0vQcJRUAAABAd1yd\n", - "ZGnb+bokH6+UpecoqQAAAABmWikLk7yvY/pbaZoHa8TpRUoqAAAAgJl3XZK9285XJ/lEpSw9SUkF\n", - "AAAAMJNK2SfJr3ZMfyNN81iNOL1KSQUAAAAws96bZEHb+WNJPl0pS89SUgEAAADMlFIOTfLOjumt\n", - "aZpVNeL0MiUVAAAAwMz5RJK5becPJrmzUpaepqQCAAAAmAmlPDfJazqmv56mWVcjTq9TUgEAAABM\n", - "t1JGktzRMf2nJF+pkKYvKKkAAAAApt/rkpzRMbsmTTNeI0w/UFIBAAAATKdS5ie5tWP6u2ma/1wj\n", - "Tr9QUgEAAABMr/cmWdp2vjHJeypl6RtKKgAAAIDpUsqyJL/WMf1Umub/1IjTT5RUAAAAANPnk0nm\n", - "tp0/nOTmSln6ipIKAAAAYDqUck6SSzumN6ZpVteI02+UVAAAAABTVcpIkjs6pn+f5GvdD9OflFQA\n", - "AAAAU/fGJKd3zK5N00zUCNOPlFQAAAAAU1HKgjx136nvpmn+okacfqWkAgAAAJia9yU5sO18Q5L3\n", - "VMrSt5RUAAAAALurlCOSvLtjenua5l8rpOlrSioAAACA3ffJJHu0nT+Y5NZKWfqakgoAAABgd5Ty\n", - "vCSv7Ji+L03zZI04/U5JBQAAALCrShlNckfH9G+T3FMhzUBQUgEAAADsujclObVjdm2aZqJCloGg\n", - "pAIAAADYFaUsTHJzx/RbaZq/rBFnUCipAAAAAHbN+5Ps33a+Lsl7K2UZGEoqAAAAgJ1VylFJru2Y\n", - "3pam+bcacQaJkgoAAABg592WZE7b+QNJPlkpy0BRUgEAAADsjFKen+QXO6Y3pGnW1IgzaJRUAAAA\n", - "ADtSymiSOzqm/y3J71RIM5CUVAAAAAA7dkWSkztm16ZpJmqEGURKKgAAAICnU8qiJB/rmN6bpvmv\n", - "NeIMKiUVAAAAwNP7QJL92s7XJbmhUpaBpaQCAAAA2J5SjklyTcf0E2ma+2vEGWRKKgAAAIDtuz3J\n", - "7Lbz+5LcVinLQFNSAQAAAEymlBckeUXH9L1pmrU14gw6JRUAAABAp1JmJfl0x/Svk3yrQpqhoKQC\n", - "AAAAeKqrkizvmF2TpmlqhBkGSioAAACAdqUsTvLRjulvp2n+pkacYaGkAgAAANjWTUn2aTtfm+TG\n", - "SlmGhpIKAAAAYItSjkvyzo7pLWmaB2rEGSZKKgAAAICtfiPJrLbzf9s8Y4YpqQAAAACSpJQXJXlZ\n", - "x/Q9aZp1NeIMGyUVAAAAQCmzknyqY/pfknynQpqhpKQCAAAASN6W5MS28ybJtWmaplKeoaOkAgAA\n", - "AIZbKUuTfKxj+vU0zd/ViDOslFQAAADAsLsjyaK28zVJbqyUZWgpqQAAAIDhVcqFSS7tmH4wTfNg\n", - "jTjDTEkFAAAADKdSFiT5XMf0b5P8ZoU0Q09JBQAAAAyrjyY5tO18PMlb0zTjlfIMNSUVAAAAMHxK\n", - "OTPJuzqmn0rT/EONOCipAAAAgGFTyuwkdyUpbdP/L8mH6wQiUVIBAAAAw+e6JKd0zN6epllTIwwt\n", - "SioAAABgeJRyVJIPdUzvTdP8cYU0tFFSAQAAAMOhlJLk80nmtU1XJHl3nUC0U1IBAAAAw+LyJC/s\n", - "mP1qmuZnNcKwLSUVAAAAMPhK2TfJpzumf5rk6xXSMAklFQAAADAMbk+yb9v5hiS/nKZpKuWhg5IK\n", - "AAAAGGylnJ/kjR3Tj6Rp/qVGHCanpAIAAAAGVynzknyxY/rf01pZRQ9RUgEAAACD7KYkR7WdN0mu\n", - "StNsrJSH7VBSAQAAAIOplJOTXN8xvTNN819rxOHpKakAAACAwVPKaJIvJRltmz6Q5P11ArEjSioA\n", - "AABgEF2d5MyO2TvSNKtqhGHHlFQAAADAYCnl0CQ3d0y/n6b5QY047BwlFQAAADA4SilJ7kwyv226\n", - "Ksm76gRiZympAAAAgEFySZKXd8xuSNM8UCMMO09JBQAAAAyGUhYn+WzH9K+SfLFCGnaRkgoAAAAY\n", - "FLckWdp2vinJW9M0E5XysAuUVAAAAED/K+WcJG/rmH4iTfM/asRh1ympAAAAgP5Wyh5J7uqY/kuS\n", - "j1dIw25SUgEAAAD97r1JTuiYvTVNs75GGHaPkgoAAADoX6Ucn+T9HdOvpGn+rEIapkBJBQAAAPSn\n", - "UkbSus1vTtv0Z0murxOIqVBSAQAAAP3qLUnO7Zhdk6ZZUSMMU6OkAgAAAPpPKQcmua1j+uMk366Q\n", - "hmmgpAIAAAD60R1JFredr01ydZqmqZSHKVJSAQAAAP2llJcleXXH9INpmn+tkIZpoqQCAAAA+kcp\n", - "85N8rmP690l+s0IappGSCgAAAOgnH0lyWNv5RJKr0jRjlfIwTZRUAAAAQH8o5VlJrumYfjpN8/c1\n", - "4jC9lFQAAABA7ytlzyT3ZNsu4ydJfr1OIKabkgoAAADoB59IcnzH7O1pmjU1wjD9lFQAAABAbyvl\n", - "JUl+pWP61TTNj2vEYWYoqQAAAIDeVcp+Sb7aMf0/eereVPQ5JRUAAADQm0opSb6U5IC26USS16Vp\n", - "VtcJxUxRUgEAAAC96ookF3XMPpam+esaYZhZSioAAACg95RyTJLPdEz/W5KPVUhDFyipAAAAgN5S\n", - "yuwk30iyZ9t0TZLXp2k21QnFTFNSAQAAAL3m/UnO7Jhdm6b5lxph6A4lFQAAANA7SnlOkg90TH+Q\n", - "5MsV0tBFSioAAACgN5SyIMk9SUbbpg8nuSpN09QJRbcoqQAAAIBecUeSozpmb07TPFIjDN2lpAIA\n", - "AADqK+WSJG/pmN6ZpvlxjTh0n5IKAAAAqKuUg5J8qWP6z0neUyENlSipAAAAgHpKGUny1SR7t003\n", - "Jbk8TbO2TihqUFIBAAAANb0jyQUdsw+maf6+RhjqUVIBAAAAdZRyUpJPdkz/PMntFdJQmZIKAAAA\n", - "6L5S9kjyjSRz26arkrwhTTNeJxQ1KakAAACAGj6S5NSO2dVpmp/UCEN9SioAAACgu0o5L8n1HdNv\n", - "Jfmd7oehVyipAAAAgO4pZUmS305S2qb3pbWKqqkTil6gpAIAAAC66c4kh7adN0nemKZZWSkPPUJJ\n", - "BQAAAHRHKa9N8pqO6e1pmj+tEYfeoqQCAAAAZl4py5J8rmP6T0k+WCENPUhJBQAAAMysUkaTfD3J\n", - "orbphiSXp2k21AlFr1FSAQAAADPtV5M8r2P2njTN/6gRht6kpAIAAABmTimnJflYx/Q/JPmtCmno\n", - "YUoqAAAAYGaUMi/JvUlmt01XJHlzmmaiTih6lZIKAAAAmCmfSHJCx+yqNM1Pa4ShtympAAAAgOlX\n", - "youTvLNj+pU0zfdrxKH3KakAAACA6VXKfkm+2jH9P0murZCGPqGkAgAAAKZPKSXJXUkO3DJqkokk\n", - "r0vTrK6Wi56npAIAAACm0zuSXNw+uO/QQ7+TpvnrSnnoE0oqAAAAYHqUck6ST7ePHlm2bPx3Lr/8\n", - "25US0Udm1Q4AAAAADIBSlib5btq6hon58/OnV1yxdsPExHi9YPQLK6kAAACAqSllTloF1YHt48c/\n", - "85k8ceCBE3VC0W+UVAAAAMBU3Z7k7PbBk+96Vza85CWV4tCPlFQAAADA7ivldUne2T7a8LznZfX1\n", - "11cKRL9SUgEAAAC7p5RTk9zVPho75JCsvPPOZHS0Uij6lZIKAAAA2HWl7J3k+0nmbRk1c+dm5d13\n", - "p9l773q56FtKKgAAAGDXlDKa5N4kR7SPn7j11oydfHKdTPQ9JRUAAACwq349yYvbB2ve+Masu/TS\n", - "SnEYBEoqAAAAYOeV8vIkH2wfbTz99Kz68IcrBWJQKKkAAACAnVPKMUm+0T4a33ffrLzrrmTOnEqh\n", - "GBRKKgAAAGDHSpmf1kbpC7eMmtHRPH7XXZlYurReLgaGkgoAAAB4eqWUJHcnWd4+XnXTTdn47GfX\n", - "ycTAUVIBAAAAO3Jtkle3D9ZdfHHWXnllpTgMIiUVAAAAsH2lnJfktvbRphNOyBO3356UUicTA0lJ\n", - "BQAAAEyulEOSfDvJ6JbRxMKFWXn33Wn23LNeLgaSkgoAAAB4qlL2SPK9JPu3jx//7GczfsQRdTIx\n", - "0JRUAAAAwGTuSHJW+2D1u9+dDS98YaU4DDolFQAAALCtUt6c5G3to/Xnn58n3/3uSoEYBkoqAAAA\n", - "YKtSTk/y+fbR2LJlefyzn01G1AjMHP93AQAAAC2l7Jvk+0n22DJq5s7Nyi9/Oc3ixfVyMRSUVAAA\n", - "AEBSymiSbyY5rH38+O23Z+zEE+tkYqgoqQAAAIAk+ViSF7QP1lxxRdZfckmlOAwbJRUAAAAMu1Iu\n", - "SXJD+2jDWWdl1U03VQrEMFJSAQAAwDAr5fgkX28fjR9wQB7/4heT2bMrhWIYKakAAABgWJWyIMnv\n", - "JZm/ZdTMnp2Vd92Vif33r5eLoaSkAgAAgGFUSknytSTHt49XfehD2XTGGVUiMdyUVAAAADCc3pNk\n", - "m13R177qVVn7pjfVScPQU1IBAADAsGltlH5L+2jTSSfliVtvTUqpFIphp6QCAACAYVLK2UnuTfLz\n", - "Nmpi8eKs/PKXk3nz6uVi6CmpAAAAYFi0Psnv95PM3TJqRkez8nOfy/hhh9XLBVFSAQAAwHAoZWmS\n", - "P0qypH38xG23ZeN551WJBO2UVAAAADDoSlmQ5A+TLGsfr/61X8u6yy6rkwk6KKkAAABgkJUyO8n3\n", - "kpzWPl772tfmyeuuq5MJJqGkAgAAgEFVSklyd5IL2sfrzz/fJ/nRc5RUAAAAMLg+muQN7YONp5yS\n", - "x7/whWTWrEqRYHJKKgAAABhEpfxykve3j8aWLcvKe+5Js9delULB9impAAAAYNCU8ookn2sfje+9\n", - "d1bce28m9t23Uih4ekoqAAAAGCSlPDvJt9L2O38zd25W/vZvZ/zII+vlgh1QUgEAAMCgKOWYJL+f\n", - "ZN6WUTMykpVf+EI2PfOZ9XLBTlBSAQAAwCAo5YAkf5Rkm/v5Vt1ySzZccMHkXwM9REkFAAAA/a6U\n", - "+Un+IMk29/OtvuaarH396+tkgl2kpAIAAIB+VsqsJN9O8qz28dpLL82T73lPnUywG5RUAAAA0K9K\n", - "KUm+kOSl7eMNz3tenrjttqSUOrlgNyipAAAAoH/dlOSK9sGm5cuz8ktfSmbPrhQJdo+SCgAAAPpR\n", - "KVck+VD7aOyQQ7LinnvSzJ9fJxNMgZIKAAAA+k0pL03yxfbRxJIlWXHvvZk44IBKoWBqlFQAAADQ\n", - "T0p5VpLvJhndMmrmzs2Kr34148ccUy8XTJGSCgAAAPpFKUcm+cMke24ZNaVk5Z13ZtOZZ9bLBdNA\n", - "SQUAAAD9oJT9kvxRkv3bx6s++tFseMlL6mSCaaSkAgAAgF5Xyp5Jfj/JNvfzPXn11Vn7lrfUyQTT\n", - "TEkFAAAAvayUWUm+meSs9vG6Sy7J6htvrJMJZoCSCgAAAHpVKSXJZ5O8on284Zxz8vinPpWM+LWe\n", - "weH/ZgAAAOhdH0zytvbBphNPzMq7707mzKkUCWaGkgoAAAB6USkfSPLh9tH4QQdlxT33pFm4sFIo\n", - "mDlKKgAAAOg1pdyU5KPto4lFi7Li3nszsXRppVAws5RUAAAA0EtK+VA6VlBN7LVXVnztaxk77rg6\n", - "maALZtUOAAAAAGTLJukfSnJT+3hir72y4t57s+nMM6vEgm5RUgEAAEBtrYLqI0k+0D6emD+/VVCd\n", - "cUadXNBFSioAAACoqVVQfSzJje3jiQULsuJ3fiebTj+9Ti7oMiUVAAAA1NIqqG5OckP7eGLBgqz4\n", - "5jez6ZnPrJMLKlBSAQAAQA2tgurWJO9pH08sXNgqqE47rU4uqERJBQAAAN3WKqg+meTX2scTixZl\n", - "xbe+lU2nnFInF1SkpAIAAIBuahVUtyd5d/t4YtGiPPbtb2fs5JPr5ILKRmoHAAAAgKHRKqg+lc6C\n", - "avFiBRVDz0oqAAAA6IZWQfXpJNe0jyeWLMlj3/pWxp7xjDq5oEcoqQAAAGCmtQqqzyR5Z/t4YsmS\n", - "1gqq5cvr5IIeoqQCAACAmdQqqD6b5B3t44klS/LYd76TsZNOqpMLeoySCgAAAGZKKSNJfivJ29vH\n", - "43vvnRXf+U7GTjyxTi7oQUoqAAAAmAmtgurOJG9rH4/vs09WfPe7GTv++Dq5oEcpqQAAAGC6tQqq\n", - "zyd5a/t4fN99WwXVccfVyQU9TEkFAAAA06lVUH0xyZXt4/H99msVVMceWycX9DglFQAAAEyXVkH1\n", - "pSRvaR+P77dfVnzvexk75pg6uaAPjNQOAAAAAAOhlNEkX05nQbX//nlMQQU7ZCUVAAAATNXWguqN\n", - "7ePxAw7IY9/9bsaPPrpOLugjSioAAACYilZB9dUkr28fjx94YKugOuqoOrmgzyipAAAAYHeVsmeS\n", - "byT5xfbx+NKlrYLqyCPr5II+pKQCAACA3VHKAUl+mOTM9vH40qV57Hvfy/gRR9TJBX1KSQUAAAC7\n", - "qpQTkvwoyeHt4/GDDmoVVIcfPtlXAU/Dp/sBAADArijl+Un+Kh0F1aYTTsijP/iBggp2k5IKAAAA\n", - "dlYpb0jyx0kWt4/Xn3deHvv3/z4TBx9cJxcMACUVAAAA7EgpJaV8KMnXk8xuv7T28suz8utfT7Ng\n", - "QZVoMCjsSQUAAABPp5Q5Se5O8vrOS6tuvDFr3vGOpJTu54IBo6QCAACA7SllSZLvJzmvfdzssUce\n", - "v+OOrL/ooiqxYBApqQAAAGAypRyR1if4Hd8+nliyJCu++tVsOvPMOrlgQCmpAAAAoFMpZyb5/ST7\n", - "t4/HjjgiK+65J+NHHlknFwwwG6cDAABAu1J+McmfpaOg2njGGXn0hz9UUMEMUVIBAABAsuUT/K5L\n", - "8rtJ5rVfWnfRRXns299Os88+dbLBEFBSAQAAQCmzknw2yaeSbPNRfU++8515/M47k7lzq0SDYWFP\n", - "KgAAAIZbKfOTfDPJhe3jZnQ0T9x6a9ZdfnmdXDBklFQAAAAMr1IOSvIHSU5rH0/Mn5+Vd92Vjeed\n", - "VyUWDCMlFQAAAMOplGck+cMkh7aPx5cuzYp77snYiSfWyQVDyp5UAAAADJ9SXpjkL9NRUG1avjyP\n", - "/uEfKqigAiUVAAAAw6WUK5L8KMmC9vH6F7wgj/3e72XiwAPr5IIhp6QCAABgOJQyklI+nuTudGx/\n", - "s+aNb8zKr3wlzV571ckG2JMKAACAIVDKnkm+nOSy9nFTSlbfdFPWvPWtSSl1sgFJlFQAAAAMulJO\n", - "SvKdJNtsNNXMnZvHf+u3sv6lL62TC9iGkgoAAIDBVEpJ8qYkdyaZ135pfJ99svJrX8um00+vkQyY\n", - "hJIKAACAwVPK/CSfS/L6zktjRx+dFffck/Fly7qfC9guG6cDAAAwWEo5OcnfZJKCau0rX5lHf/xj\n", - "BRX0ICupAAAAGAyt2/uuSvKZJHPbLzVz5+aJm2/Oule/2gbp0KOUVAAAAPS/UhYm+WI6Pr0vSTYd\n", - "e2wev+vpHga3AAAgAElEQVSujB17bPdzATvN7X4AAAD0t1JOS/J3maSgWnvZZXn0Rz9SUEEfsJIK\n", - "AACA/tS6ve/tST6dZE77pYk998yqW2/Nule+sko0YNcpqQAAAOg/pSxKcneSp7RQm044ISu/8IWM\n", - "H3NM93MBu83tfgAAAPSXUp6V5B8ySUG15vWvz6N/8AcKKuhDVlIBAADQH1q3970ryW1JZrdfmpg/\n", - "P0988pNZf/HFVaIBU6ekAgAAoPeVsiTJV5I8pYXatHx56/a+I4/sfi5g2rjdDwAAgN5Wyllp3d73\n", - "lIJqzZvelEd/+EMFFQwAK6kAAADoTaWMJLkuya3p+P11YsGCPPEbv5H1F15YJRow/ZRUAAAA9J5S\n", - "9kny9SQv67y08ZRT8vgXvpDxZcu6nwuYMW73AwAAoLeUcnaSf8wkBdWTV12Vx37wAwUVDCArqQAA\n", - "AOgNpcxO8p4kH04y2n5pYtGiPP7pT2fDi19cJRow85RUAAAA1NfaHP1LSZ7ReWnj6afn8c9/PuOH\n", - "HNL9XEDXuN0PAACAekpZkFJ+M8lfZ5KC6sm3vS2Pff/7CioYAlZSAQAAUEcpL0/yuSRPaaAmlizJ\n", - "45/5TDa84AXdzwVUYSUVAAAA3VXK0pTy3SQ/zCQF1dpXvjKP/PmfK6hgyFhJBQAAQHeUMpLkqiSf\n", - "SLKo8/LYsmV54tZbs/F5z+t6NKA+JRUAAAAzr5QTk9yV5OzOS83oaNa87W1Zfd11yZ57dj8b0BOU\n", - "VAAAAMycUvZIcmOS9yWZ3Xl54ymn5InbbsvY8uVdjwb0FiUVAAAAM6OUX0hr9dRxnZcm9twzq2+4\n", - "IWvf/OZkdLT72YCeo6QCAABgepWyJK19p66a7PL6F7wgT9x8cyYOecqe6cAQU1IBAAAwPUopSV6V\n", - "5DeTHNB5eXy//bLqox/N+pe/PCml6/GA3qakAgAAYOpKOSzJ55K8bLLLay+/PKve//40ixd3NxfQ\n", - "N5RUAAAA7L5SRpP8SpKPJ9mr8/LYUUflidtuy8ZnP7vr0YD+oqQCAABg95RyapIvJXlW56Vm9uw8\n", - "+Su/kiff+c5k7tzuZwP6jpIKAACAXVPKXkluSvKrSZ7y0XwbzzgjT9x2W8aOPbbr0YD+paQCAABg\n", - "55QyJ8mVST6Y5MDOyxMLFmT1Bz6QtZdfnoyMdD0e0N+UVAAAADy9UkaSXJbko0mOnOwl6y68MKs+\n", - "8pFMHPiU7gpgpyipAAAAmFwpJclLk9yc5OTJXjK+dGmeuPnmbHjRi7oaDRg8SioAAACeqpRzk9yS\n", - "5OzJLjdz52bNW96SJ6+5Js2CBd3NBgwkJRUAAABblXJKWiunXjrZ5WbWrKx97Wvz5LXXurUPmFZK\n", - "KgAAAJJSjk7ykSSv2d5L1l18cVZff33Gjziie7mAoaGkAgAAGGalHJTWp/Vdme38jrj+/POz+r3v\n", - "zdjy5V2NBgwXJRUAAMAwKmVJkvcmeVeSeZO9ZOMZZ2TVjTdm01lndTUaMJyUVAAAAMOklL3SKqbe\n", - "k2TxZC/ZdOKJWX3DDdlw/vlJKV2NBwwvJRUAAMAwKGVOWrf0fTDJpDuejy1bltXXX5/1F1+cjIx0\n", - "NR6AkgoAAGCQlTKS1mboH0ly5GQvGd9//zx53XVZ+5rXJHPmdDUewBZKKgAAgEFUSklyYZKPJ3nG\n", - "ZC+ZWLQoT159ddZecUWaPffsajyATkoqAACAQdLac+r1ae07dcJkL2nmzs2aK6/Mk1dfnWbxpNtS\n", - "AXSdkgoAAGAQlLIsyTuSXJXtbIjezJqVtZdfnievvTYTBxzQ1XgAO6KkAgAA6FetW/rOTXJNkouT\n", - "TLrbeVNK1l98cVZff33GDz+8iwEBdp6SCgAAoN+UMjfJZWmVU6du72XN6GjWv/SlefJd78rYSSd1\n", - "LR7A7lBSAQAA9ItSDkry9iS/nGS/7b1sYsmSrH3d67LmDW/IxMEHdy0ewFQoqQAAAHpdKWeltWrq\n", - "VXma3+M2HX981lxxRdZdckkyb17X4gFMByUVAABALypldpJXplVOnbW9lzWlZMMFF2TNFVdk49ln\n", - "J6V0LSLAdFJSAQAA9JJS9kvrdr63Jzloey+bWLAga1/zmqx985szvmxZ1+IBzBQlFQAAQC8o5ZS0\n", - "Vk29Nske23vZ2JFHtm7pu/TSNHvt1bV4ADNNSQUAAFBLKfOSXJjkHUme93QvXX/eeVl75ZXZcN55\n", - "ychIN9IBdJWSCgAAoJtKmZPkhUkuS3Jxkvnbe+nEvHlZd+mlWfOWt2T8mGO6lRCgCiUVACRbNqdd\n", - "kmTx5sfOY0FaPze3HLM7zqdyJMnGJBs6jslmuzpfk+TxtmNVmmZiWv6bAbDzShlNcl5axdQvpfWz\n", - "ZbvGDj00a9/85qx9zWvSLFrUhYAA9SmpABgcpeyRZO9sv2jackx2fXg29ShlVbaWVk9k2xKr87xz\n", - "9kSaZlOF1AD9p5SRJM9Jq5h6VZIDdvQlG5773Ky54opsuOCCZHR0phMC9BQlFQD9o5T5SZYlOXzz\n", - "0fl8/zrB+s7Czcdhu/XVpaxNq7B6NMnDm4+fbef5I2majVOPDNAnSilJnplWMfXqJIfu6EvGDzgg\n", - "61/+8qx99aszdtJJM50QoGcpqQDoHaUsytbiabIyap86weiw5+Zjux+Lvo1SVmb7Jda2z5vmyRnI\n", - "CzDzSjkprWLqsiRH7+jlE0uWZN2FF2b9RRdl41lnWTUFECUVAN3U2ij2+CRHZvLVUIvrBEuakZE0\n", - "ixZlYvPRLFyYicWLW88XLcrEwoXJ7NlpZs1q/SIxa1aaLY9TmGXWrKRpko0bUzYf2bCh9XzTpq3P\n", - "n26+cWPKhg2t+ZbnW+Zr1mRk1aqMPPFEyqpVGXmySge05ZbK43b4ytYqrYeTPLD5uH/z8UDb44Nu\n", - "OQR6QilHpbVa6rIkz9jRyyfmz8/6l7wk6y++OBvOOSeZPXvGIwL0EyUVADOjtSrqlCSnJTl18+OJ\n", - "aW04PiOakZFMLF6cZnO59POCafHibQuo9udbiqj584fj47zHx1NWr87IqlUpTzyRkdWrW4+rVrVK\n", - "rC2Pk802P5aJGd13fc8kR2w+tqdJKQ9l+yVW67Fp1s5kUGBIlXJIkkvTKqbO2NHLm7lzs/6FL8y6\n", - "iy/Ohuc/P5k7d8YjAvQrJRUAU9Pae+OgbC2itpRSR073WzWzZmX84IMzfuihWx8PPTTjhxzSejzw\n", - "wNbKJLZvdDTN4sUZX7ybi9aaJmXNmpTHH8/oY49l5NFHM/LII63jsccy2vZ85JFHMrJixUyUWiXJ\n", - "0s3Hs7b/qrIyTy2x7k/yb0l+kuS+NM266Q4HDJjW5uenJDk/ySuSnLujL2lmz86G5z8/6y66KBsu\n", - "uCDNXsPz2RwAU+Fv8gDsvNbHZx+TbVdHnZpkv+n49s2cOa3yaUvptPlxbPPjxAEH2LOjtlLSzJ+f\n", - "Zv78TBxyyI5fPz6ekZUrtxZZjz6a0S3F1qOP/rzkGt38vGyc1j3Wt9xmuP1bcEr5WbaWVpM9Ppam\n", - "aaYzFNDjWv/4clRapdT5Sf5ddmJPxGZ0NBvPOSfrLroo61/84jS7+48BAENMSQXA5EqZl9Yv9+1l\n", - "1Mlp3Y6128aXLs3YscdmrH0V1JYSav/9h+OWu2EyOpqJfffNxL77Jiec8PSvbZrWrYgPP5zRhx7K\n", - "6EMPZeTBBzPadow89FBGH3lkOhPuv/nY3oqstSllS2k1WZH1QJpmbDoDARWUckC2llLnp7Vf4k7Z\n", - "8OxnZ/1FF2X9y17W+rMOgN2mpAKgpZSFSX4hyQuSPD/JSUl2e9lSMzKSsaOPztjy5dl00kk/P5p9\n", - "fEAf21FKmoULM75wYcaPOWb7r9u4MaMPP7xNgTXy0ENbnz/4YEYffjhlbFq6oz3T2uz/+O1cn0gp\n", - "D2RrafWvHY//5pZC6EGtn3nPy9ZSavmufPnG007L+osuyroLL8zEQTv3QacA7JiSCmBYlbJHkmen\n", - "VUqdn+TM7GYp1cydu7WIWr48YyedlE3HH5/MmzeNgWGzOXN+vh/Zdj/ib2KidWvhltJqy/HTn2bk\n", - "gQcyev/9GX3ooZTx8ammGUly6Obj7Elf0drkfbICq/XYNGumGgLYgSn+zJtYuDAbn/OcbDjnnGw4\n", - "//yMH374zOQEGHJKKoBh0dpP6tRs/Vfjc5Pscos0vvferdVRW1ZILV+e8SOPtFcUvWVkJBP779+6\n", - "hfSUUyZ/zdhYawXWAw+0jvvv3/q4+RhZNy2LoA7cfJw16dVSHs3kBVbredOsmo4QMFRam51v+Zn3\n", - "guziz7xmjz2y8YwzsuGcc7LxnHOy6eSTfTAHQBf4kxZgULU2fj06W//V+PlJ9t6VbzG2bNnWlVGb\n", - "S6mJAw9MSpmBwNBls2Zl4pBDMnHIIZOvyGqalJUrty2wOsusRx+djiT7bj4m3xer9SmFk+2HteX5\n", - "z9I00/4RitBXWntKbdlD8VnZxZ95TSnZdMop2XjOOa1i6owzrAYGqEBJBTBISlmabTd+PXRXvnzs\n", - "6KOz4dxzW39Bf85zfDIRw62UNHvvnbG9987YM7bzAYHr1mX0pz/duvrqgQcyet99mXXffa2VWA89\n", - "lDIx5f5oy6cUnrqd6xtSyn2ZvMD6SZL70zQbphoCekJrhdSReeqnzC7d1W81dvTRrdv3zj3XzzyA\n", - "HqGkAuhnpSxKcl62llIn7sqXjy9d2vrL+TnnZMPZZ2di6S7/HR+G27x5GT/qqIwfddTk1zdtau2F\n", - "tbm0+vnjluc//el07Iu1R1qrJo/ezvWmbV+sztVY/5bkviQr0zTNVIPAtGrtI3VSti2jTkmyYHe+\n", - "3fiBB279mXfOOX7mAfQgJRVAvynlwCSvTPLqJM9Na+PmnTKxaFE2Pve5P18tNX7UUW7dg5k0e3bG\n", - "Dzss44cdNvn1tn2xZt1337Zl1uZbCsum7W4Pv7NKWqtMlqa1cfRk1m3+lML7k2x5bH/+QJKH0zRT\n", - "btRgUqUsTquAal8hdWKm8PvKz3/mbS6lxo8+2s88gB6npALoB6XsneSSJJeltc/GThVTzdy5rY1f\n", - "zz03G889N5uWL7fBOfSS9n2xzppkX/WJiYw8/PC2+2G174/1wAMZWTUt+6rPy9OvxkqS8ZTy02y/\n", - "xLo/yU/dWsjTapVRhyc5IsnybC2ljpjKt23mzMmm44/fuofiaadl0zOe4WceQJ9RUgH0qlIWJLko\n", - "rWLqRdmJP7ObkZFsOvXU1q0M556bjaefnsydO9NJgZkyMpKJpUszsXRpNj1rO/uqr1r11A3d2x5H\n", - "Hn44ZXru5BtNa5+7p9/rrpRH0r76qnX8bJLnK2z4PmBaH9ixd1ol1LLNj53PF071bSYWLfr5h3mM\n", - "bXk8+uhk9uypfmsAKlNSAfSSUuYleVlaxdTLkuywYdp07LFbS6nnPCfNwin//R/oI83ChRlbuDBj\n", - "J5ww+Qs2bmzti7WdImvkoYcysnbtdEbab/Nx2g5eN7650Hq6ImvL85+laaZ83yNT1Cqh9s3Wwunw\n", - "PLWMmj+dbzl28MHbfMLs2DOekfGDD3bbHsCAUlIB1FbKnCQXpFVMXZSd+Av+ppNOyrqLLsr6V7xi\n", - "+3vdACTJnDkZX7Ys48uWTX69aVqrsR56KCMPPtgqtDYfIw89tPX5ypXTnWw0yYGbjx0rZUW2lleP\n", - "JHl88/FE2/PJzp+0KfzTaP3jyJZPkFzc9nzLcWC2LaLmzUSMZnQ0Y0cfnU3Ll28tpU48Mc3ee8/E\n", - "2wHQo5RUADWUMprWp/JdluSX0vpF4GmNHXVU1l18cda94hUZP+aYGQ4IDI1S0ixalLFFi5Ljjtv+\n", - "69aty+hDD20ts37609Z5W5k18rOfpUzM2B18e28+jt/Fr5tIKTsqstrP1yTZmGTDJMfGbZ7Xvl2x\n", - "tbJpVlqf8DhZwdR+bO/6Ht2M3OyxR8YPPjjjhx6ascMP33rL3nHHJfNmpP8CoI8oqQC6pZSRJM9J\n", - "q5h6VZIDdvQlY4cemvUXXZR1F12UsRNPdHsDUM+8eRk/4oiMH/E0+1uPjWXkZz9rrb56+OGMPPJI\n", - "Rh59tHU88kj+f/buPM7Ksv7/+OuaYZMdFFyA3JDFBUVNXEhQUFxS02JcyhA1zUwzKNwycUkzRcOS\n", - "zARcMnX0p5lb7ruJ4hpopn1RLMUF2ZcBZq7fH8cZZu4ZYAZmzn3Omdfz8eDBuT/XWd5HeQi+ue/r\n", - "Lq72uGjRomwlL2J1IdO4QlhJ7fJqzaVW5k6LLRrxR73v7potsU0bVvXqRXmvXpT37Jn5Ufm4Vy8q\n", - "NtkEinIutiQpR1hSSVJTyvwt965kiqmjWdeGw0D5ppuy7PDDWX744azcdVeLKUn5o0ULKrbYgoot\n", - "tmCdG0gtX07RF19QPHduprSqVmgVJ8qtoi+/bKzN3xtby69+NBsV7dqtsYAq79WLiq5d/X1LkrTe\n", - "LKkkqSmE0BY4HjgD2GFdT6/o0oVl3/wmy484ghWDBnnLbEmFr00bKnr2pKJnz3U/t7ycoi+/XF1m\n", - "zZ9P0cKFhAULKFq0iLBwIUULFmR+Xrhw9c8LFlC0bFnTf5c8Flu2pKJTJ2LHjlR07px53KkTFZ06\n", - "UdG5M7FLF8p79mTVV6VU7NLFEkqS1GQsqSSpMYXwNeB04Aes49KSig4dWH7wwSw/4gjKBg/21tmS\n", - "tCbFxVR060ZFt24Nf+3KlVWlVY1ia8GCmoVWZdG1bBlhxYrM68rKMo9XrKjxc+WPXBBbtMicwdap\n", - "ExUdO2YKprrKpsr1r9YqOnUidu5M3GgjSydJUs6wpJKkDZW5pG8w8BPgSNayR0hs04blBx7IsiOO\n", - "oGy//aBNm2yllKTmqWVL4sYbU77xxpQ35vvGuObyqrLcqlZ0hRUriEVF0KJFplgqLs48rvy5jlmN\n", - "9TpmFBVZMEmSCoollSStrxBak9lr6ifAwDU9LRYXUzZsGMu+9S3KDjiA2K5d1iJKkppICNC6NbF1\n", - "5uZ4ObljliRJecaSSpIaKoTNgdOAU4Hua3paRZcuLP3ud1kyahQVPXpkLZ4kSZIk5SNLKkmqrxC+\n", - "TuasqRLWcjenlX37suTkk1l25JHQtm3W4kmSJElSPrOkkqS1CaEl8G3gTGCvNT0thkDZAQew5OST\n", - "WbHPPu4RIkmSJEkNZEklSXUJYRPgFOBHwBqv1avo0IGlxxzD0tGjKd9qq2ylkyRJkqSCY0klSdWF\n", - "MIDMJX3fBVqv6WmrttmGJSeeyLKSEmL79lmLJ0mSJEmFypJKkkIoBg4jU04NXdtTy4YMYcnJJ1O2\n", - "336ZW39LkiRJkhqFJZWk5iuEABwJXAr0X9PTKjbaiGUlJSw98URWbbdd1uJJkiRJUnNiSSWpeQph\n", - "f+ByYI81PWVVz54sHT2apcceS+zcOXvZJEmSJKkZsqSS1LyE8HXgMmD4mp5SttdeLD3pJJYfeCC0\n", - "8D+TkiRJkpQN/t+XpOYhhH5kLuv7dl3LsaiIZUcdxZJTTmHVjjtmN5skSZIkyZJKUoEL4WvAhcAJ\n", - "QJ07nS8/+GAWnX02q/r0yWYySZIkSVI1llSSClMI3YDzgB8Brep6Stk++7Do3HNZueuuWY0mSZIk\n", - "SarNkkpSYQmhAzAG+BnQvq6nrBgwgEXnnsuKffeFELIaT5IkSZJUN0sqSYUhhDbAD4HzgU3qesqq\n", - "bbdl0dlns/zQQy2nJEmSJCnHWFJJym8htAC+D4wHetX1lPLNN2fR2LEsKynxbn2SJEmSlKP8vzVJ\n", - "+SmEABxF5o59/ep6SkWXLiw+80yWjBoFbdpkNZ4kSZIkqWEsqSTlnxCGA5cBX69ruaJdO5aceipL\n", - "Tj2V2KFDdrNJkiRJktaLJZWk/BHC14HLgWF1LcdWrVj6/e+z+Mwzqdikzm2pJEmSJEk5ypJKUu4L\n", - "oRswATi+ruVYVMSykSNZPHYs5T17ZjebJEmSJKlRWFJJyl2ZfaeOB64GNq7rKcsOOYTF48axqk+f\n", - "rEaTJEmSJDUuSypJuSmEbYHrgeF1LZcNHsyic89l5cCB2c0lSZIkSWoSllSScksILYExwHig1i35\n", - "Vvbrx8Lx41mx777ZTiZJkiRJakKWVJJyRwh7AH8CBiSXYuvWLBozhiU//CG0bJn9bJIkSZKkJmVJ\n", - "JSl9IXQALgHOBEJyuWzwYBb8+teUb7NN1qNJkiRJkrLDkkpSukL4JjAJ6JVcqujShYUXXsiykSMh\n", - "1OquJEmSJEkFxJJKUjpC2ByYCIysa3nZUUexcPx4KjbZJLu5JEmSJEmpsKSSlF0hFAEnAVcCnZLL\n", - "q3r1YsEVV7Bi6NBsJ5MkSZIkpciSSlL2hNAPuAH4RnIpFhez5JRTWDx2LLFt2+xnkyRJkiSlypJK\n", - "UtMLoTVwDnAe0Cq5vGLAABZceSWrdtop69EkSZIkSbnBkkpS0wrhG2TOnuqXXKpo25ZFZ5/N0tGj\n", - "oYX/OZIkSZKk5sz/K5TUNELoDFwBnFLX8vL992fhr39Nec+e2c0lSZIkScpJllSSGlcIAfg28Dtg\n", - "s+Ry+SabsPCSS1h++OEQQtbjSZIkSZJykyWVpMYTwmZkLu07rK7lpccdx8Lzzyd26ZLdXJIkSZKk\n", - "nGdJJalxhDAcuA3onlxatc02LLjySlbstVf2c0mSJEmS8oIllaQNE0ILYDyZO/fVuH4vtmzJ4tNP\n", - "Z/GZZ0KbNmmkkyRJkiTlCUsqSesvhB7AX4B9k0srdtuNBVddxaq+fbOfS5IkSZKUdyypJK2fEA4C\n", - "bgU2qT6OIbB4zBgWn3UWFBenk02SJEmSlHcsqSQ1TAgtgUuAs5NL5d27M/+661ixzz7ZzyVJkiRJ\n", - "ymuWVJLqL4RewB3A3smlsn33Zf7vfkdFt27ZzyVJkiRJyntFaQeQlCdCOAx4g0RBVRECc8eM4cu/\n", - "/MWCSpIkSZK03iypJK1dCK0IYQLwN6BrYvXjv4wevXjeaadBkf85kSRJkiStP/+vUtKahbAV8Bww\n", - "po7Vh4FdPtxmm/JsRpIkSZIkFSZLKkl1C+FI4HVgj8RKOZlN079JjJ9nPZckSZIkqSC5cbqkmkJo\n", - "DVwJnFHH6kfAMcT4YnZDSZIkSZIKnSWVpNVC2Ba4E9itjtX7gdHEODe7oSRJkiRJzYGX+0nKCGEk\n", - "8Bq1C6pVZPakOsKCSpIkSZLUVDyTSmruQmgDXA2cVsfqB8DRxPhyVjNJkiRJkpodSyqpOQuhD1AK\n", - "7FzH6r3AicQ4P7uhJEmSJEnNkZf7Sc1VCMcBr1K7oFoBnAl824JKkiRJkpQtnkklNTeZu/f9DvhB\n", - "Hav/B5QQ46vZDSVJkiRJau4sqaTmJISNyVzG9406VkuBU4hxQXZDSZIkSZLk5X5S8xHCtsCL1C6o\n", - "yshsmn6MBZUkSZIkKS2eSSU1ByHsBfwN2CSx8j4wkhjfyH4oSZIkSZJW80wqqdCFMBJ4itoF1XPA\n", - "IAsqSZIkSVIusKSSClUIgRDGkdlrqnVi9S/AAcT4ZfaDSZIkSZJUmyWVVIhCaAH8AbiijtVLgO8R\n", - "Y1l2Q0mSJEmStGbuSSUVmhA6kDl76qDEyioyd++bmv1QkiRJkiStnSWVVEhC6Ak8AOycWFkIHEWM\n", - "T2Q/lCRJkiRJ62ZJJRWKEHYBHgS2SKzMBg4hxpnZDyVJkiRJUv24J5VUCEI4mMzd+pIF1XQyd/Cz\n", - "oJIkSZIk5TRLKinfhXAqcD/QPrHyN2AoMc7JfihJkiRJkhrGkkrKVyEUEcIVwPVAcWL1WjJ7UC3J\n", - "fjBJkiRJkhrOPamkfBTCRsDNwMjESgR+SowTsx9KkiRJkqT1Z0kl5ZsQugH3AXslVpYBxxLjfdkP\n", - "JUmSJEnShrGkkvJJCH2Bh4BtEiufAocR4yvZDyVJkiRJ0oZzTyopX4SwL/APahdUbwN7WlBJkiRJ\n", - "kvKZJZWUD0I4DngM6JJYeRLYhxg/yHomSZIkSZIakSWVlMtCCITwC+A2oFVi9SbgYGKcn/VckiRJ\n", - "kiQ1MvekknJVCC2B64ET61j9JXApMcbshpIkSZIkqWlYUkm5KIR2wL3AAYmVlcCJxPjn7IeSJEmS\n", - "JKnpWFJJuSZTUD0IDEmszAOOJMZnsh9KkiRJkqSmZUkl5ZIQ2pMpqPZNrMwCDiHGf2U/lCRJkiRJ\n", - "Tc+SSsoVIXQAHgIGJ1beAEYQ42fZDyVJkiRJUnZYUkm5IFNQPQzsk1h5DTiAGL/MfihJkiRJkrKn\n", - "KO0AUrMXQkfg79QuqF4FhltQSZIkSZKaA0sqKU0hdAIeAfZOrLxCpqCal/1QkiRJkiRlnyWVlJbV\n", - "BdWeiZWXgQOJcX72Q0mSJEmSlA5LKikNIXQGHgUGJVamYUElSZIkSWqGLKmkbAuhC/AYsEdi5SUy\n", - "d/FbkP1QkiRJkiSly7v7Sdm0uqDaLbHyD+AgYlyY/VCSJEmSJKXPM6mkbAmhK/A4tQuqF8icQWVB\n", - "JUmSJElqtiyppGxYXVDtmlh5HjiYGBdlP5QkSZIkSbnDkkpqaiFsDDwBDEysPIcFlSRJkiRJgCWV\n", - "1LRC2IRMQbVLYuUZ4BBiXJz9UJIkSZIk5R43TpeaSgjdyBRUOyVWnga+SYxLsp5JkiRJkqQc5ZlU\n", - "UlMIoTvwJLULqieBQy2oJEmSJEmqyZJKamyrC6odEytPAIcR49Lsh5IkSZIkKbdZUkmNKYRNgaeA\n", - "HRIrj2FBJUmSJEnSGllSSY0lhM3IFFTbJ1YeBY4gxmXZDyVJkiRJUn6wpJIaQwibkymo+idW/o4F\n", - "lSRJkiRJ62RJJW2o1QVVv8TKw8CRxLg8+6EkSZIkScovllTShghhC+BpoG9i5UEsqCRJkiRJqjdL\n", - "Kml9hbAxmbv49UmsPAB8mxjLsh9KkiRJkqT8ZEklrY8QNgLup/YZVH8DvmNBJUmSJElSw1hSSQ0V\n", - "QjHwF2CvxMp9wEgLKkmSJEmSGs6SSmqIEAIwEfhWYuVp4GhiXJH1TJIkSZIkFQBLKqlhxgGnJ2Yz\n", - "yGyS7hlUkiRJkiStJ0sqqb5C+C7w68T0f8AhxDg/hUSSJEmSJBUMSyqpPkIYBkxNTBcCBxPjRykk\n", - "kqhB0Q8AACAASURBVCRJkiSpoFhSSesSwgDgHqBltekK4FvE+M90QkmSJEmSVFgsqaS1CeFrwMNA\n", - "x8TKKGJ8KoVEkiRJkiQVJEsqaU1C6EKmoNoisfJzYrwjhUSSJEmSJBUsSyqpLiG0Af4KbJ9YuRaY\n", - "kP1AkiRJkiQVNksqKSmEIuBmYN/Eyv8DxhBjzH4oSZIkSZIKmyWVVNtVQEli9jzwPWIsTyGPJEmS\n", - "JEkFz5JKqi6EnwI/TUzfAY4gxuUpJJIkSZIkqVmwpJIqhVACXJ2YfgIcTIxfppBIkiRJkqRmw5JK\n", - "AghhCHBrYroIOIQYP0whkSRJkiRJzYollRTCDmTu5Neq2nQV8G1ifCOdUJKk5uqqq65i6NCh9OjR\n", - "gx49ejBmzJi0I0mSJGWFJZWatxB6AH8HOidWTiTGx1JIJElq5n72s5/x9NNPs+eeewJU/SxJklTo\n", - "LKnUfIXQCXgY6JlYOY8Yk5f+SZKUVe+++y4hBEsqSZLUbFhSqXkKoRVwD7BTYuUPwK+zH0iSpNXe\n", - "e+895s2bx2abbcbXvva1tONIkiRlhSWVmp8QioCpwP6JlfuAM4gxZj+UJEmrvfzyywAMGjQo5SSS\n", - "JEnZY0ml5uhy4LjE7CXgOGIsTyGPJEk1VJZUXuonSZKaE0sqNS8h/BgYl5i+BxxGjEtTSCRJUi0v\n", - "v/yy+1FJkqRmp0XaAaSsCeEo4NrE9DPgIGL8IoVEkiTV8umnnzJ79mw23nhjiouLOfXUU/n4449Z\n", - "sGAB+++/P+eccw5t2rRJO6YkSVKjs6RS8xDCPsBtQKg2XQIcQoz/l04oSZJqmzZtGgCtW7fm7LPP\n", - "5oorrmCbbbbh888/Z7/99mP27NlMmTIl5ZSSJEmNz8v9VPhC6Af8Daj+187lwEhifDWdUJKk5ujO\n", - "O+9k8ODBbLvttgwfPpypU6fWul9H5X5UnTp1YurUqWyzzTYAdOvWjYMOOohHHnmEV1/1ty9JklR4\n", - "LKlU2ELoDNwPdE2s/IAYH04hkSSpmfrd737HmDFjGDBgAG+88QaXXnoppaWljB49moqKiqrnVZZU\n", - "V155Je3bt6/xHl27Zn47e+qpp7IXXJIkKUssqVS4QigCbgF6J1YuJMapKSSSJDVTr776KldccQVt\n", - "27blV7/6FR06dODFF19k1qxZPPbYY9x5550ALF68mHfeeYdOnToxcODAWu8zd+5cAL74wq0UJUlS\n", - "4bGkUiE7HzgsMZsKXJJCFklSM7Vy5UrGjh1LjJEjjzySLl26MGvWLCZMmMCiRYuA1WdGTZ8+nYqK\n", - "Cnbfffc63+tf//oXAB07dsxOeEmSpCyypFJhCuFg4KLE9BXgR7U2/5AkqQndc889vPfee4QQ+M53\n", - "vgNAeXl5jee0aJG5l83rr78OwKBBg2q9z/Lly3n77bcB2H777ZsysiRJUiosqVR4QtgG+As17+T3\n", - "BfBtYlyeTihJUnMUY2TSpEkA9OjRgz322AOA3r1785Of/IQOHTrQv39/xowZA8CsWbMA2HXXXWu9\n", - "10svvcSKFSto3bo1Q4YMydI3kCRJyp4WaQeQGlUIbYF7gM7VphXA0cT4UTqhJEnN1TPPPMP7778P\n", - "wLBhw2qsjRs3jnHjxtWYVe411adPn1rv9fDDmft9HHbYYXTp0qUp4kqSJKXKM6lUOEIIwB+BnRMr\n", - "5xDjkykkkiQ1c3fccUfV42RJVZfNN98cgE6dOtWYL1y4kL/+9a+0a9eOn//8540bUpIkKUdYUqmQ\n", - "nA58LzG7G7gqhSySpGZu0aJFPProowC0atWKvffee52v2WeffQCYPXt2jfnFF1/M4sWLueyyy+jZ\n", - "s2fjh5UkScoBllQqDCEMBq5JTN8BTnSjdElSGh5//HHKysoAGDBgABtttNE6X3PEEUew7bbb8qc/\n", - "/QmAiooKrrzySu666y4uu+yyqo3XJUmSCpF7Uin/hbA5cBc1fz0vAo4kxkXphJIkNXeVZ1EB9TqL\n", - "CqC4uJi//OUvnHvuuQwbNoyioiK23XZbHnroIXbYYYemiipJkpQTLKmU30JoRaag2iyx8n1ifDeF\n", - "RJIkEWPk2WefrTquvKtfffTs2ZNbb721KWJJkiTlNC/3U767CtgnMbuMGP+aRhhJkgBmzJjB/Pnz\n", - "ASgqKmK33XZLOZEkSVLus6RS/grhe8AZiemjwC9TSCNJUpXnnnuu6vHWW29Nx44dU0wjSZKUHyyp\n", - "lJ9C2AW4ITH9EDiOGMtTSCRJUpXnn3++6vHOO++cYhJJkqT8YUml/BNCV+AeoPptkpYDRxHj3HRC\n", - "SZKUsWLFCqZNm1Z1PGDAgBTTSJIk5Q9LKuWXEIqB24CtEys/JMbXUkgkSVINr732GsuXL686tqSS\n", - "JEmqH0sq5ZsLgYMSsz8Q481phJEkKemFF16oelxUVMSOO+6YYhpJkqT8YUml/BHCYcAFielLwFkp\n", - "pJEkqU7/+Mc/qh5vueWWtGvXLsU0kiRJ+cOSSvkhhO2APyemnwHfIcYVKSSSJKmWFStW8Nprq68+\n", - "32mnnVJMI0mSlF8sqZT7QmhPZqP06vfvLgdGEuP/0gklSVJtr7/+OmVlZVXHllSSJEn1Z0ml3BZC\n", - "AG4Ekht6/IwYn00hkSRJa1T9rn5gSSVJktQQllTKdWcBRydmtwMTU8giSdJavfTSS1WPQwjssMMO\n", - "KaaRJEnKL5ZUyl0hDAWuTEz/CfyAGGP2A0mStGbl5eVMnz696njTTTela9euKSaSJEnKL5ZUyk0h\n", - "9ATuBIqrTRcARxHjknRCSZK0ZjNmzGDJktW/RW2//fYpppEkSco/llTKPSG0Bu4GuidWvkeM76eQ\n", - "SJKkdXrllVdqHPfr1y+lJJIkSfnJkkq56LfAoMTsImJ8II0wkiTVx8svv1zjuH///iklkSRJyk+W\n", - "VMotIYwGfpiYPgRcnEIaSZLq7dVXX61x7JlUkiRJDWNJpdwRwm7AHxLT/yNzmV9FCokkSaqX//73\n", - "v8yZM6fquEWLFvTu3TvFRLnj3XffZc899+T997N3xf5ZZ53FRRddlLXPkyRJjcOSSrkhhE2Ae4DW\n", - "1abLgCOJcV46oSRJqp/kpX5bbbUVrVq1SilN7nj55Zc56qijOP3007Na2l188cU8++yzjBs3rslv\n", - "CFxRUcG8efOYNWsWr7/+Ok899RTLli1r0s+UJKlQtUg7gEQIAZgCfC2x8gNifCuFRJIkNUihX+pX\n", - "VlbG5MmTufPOO/noo4/o1q0bhx56KGPHjqVdu3Z1vubf//43xx9/PCeddBLHH398VvN27NiR2267\n", - "jREjRlBWVsbEiROb5HMOOeQQ/vnPf1JRUfOE72nTptGzZ88m+UxJkgqZZ1IpF/wAOCwxm0iMt6UR\n", - "RpKkhkre2a+QNk1ftGgRJSUl/OpXv2LkyJG88sornHHGGdx0001rLJ++/PJLTjjhBPr168fPf/7z\n", - "LCfO2Gyzzbj66qu5++67ufXWW5vkM7797W9z8skn1yglM3/3JkmS1odnUildIfQBrklMXwLS+ROt\n", - "JEkNtHTpUt55550as0I6k+rss89m+vTp7Lfffvz4xz/mwQcf5JxzziHGyLRp05g/fz6dO3eu8Zpx\n", - "48bx2Wefcccdd6Ra2gwbNoxjjz2W8ePHs+eee7Lddts16vufdNJJQObXwG677cbChQsb9f0lSWpu\n", - "PJNK6QmhJfBnoG216WIyG6WvTCeUJEkN89prr9W43CuEUDBnUs2YMYP77rsPgP333x+A0tLSqn2e\n", - "evbsWaugeuSRR3j44Yc58cQT+drXklfyZ9+4ceMIIXD66afXuiyvsbRt29aN8iVJagSWVErTL4Gv\n", - "J2ZnEuN/0ggjSdL6SO5H1bZtW7bccsuU0jSuP//5z0CmeNt9990BOPbYY9lqq63YY489mDx5co3n\n", - "r1ixgvPPP5+OHTvyox/9KOt569K9e3dOOukkZs6cye23395kn+NG+ZIkbThLKqUjhH2A8xLTe4Cb\n", - "sh9GkqT1lyyp+vbtm1KSxvf4448D0Lp1a3bYYQcADjroIF544QXuvfdedtxxxxrPv+uuu/jkk08Y\n", - "OXJkrTOs0jRq1CiKi4u5+uqrWbVqVdpxJEnSGlhSKftC6AjcSs1ff58Apzb5faIlSWpkr7/+eo3j\n", - "7bffPqUkjWv27Nl88sknAOy0004UFxev9fkVFRVMmjSJEALHHHNMNiLW2xZbbMGwYcOYM2cO9957\n", - "b9pxJEnSGlhSKQ0Tga0Ts9HE+EUaYSRJWl+zZ8/myy+/rDErlJLqtddeq3o8cODAdT7/ueee44MP\n", - "PqBfv345+c/gsMMyNxKuvIRRkiTlHksqZVcI3wFOSEyvJcZHUkgjSdIGeeONN2rNKi+Ly3dvvvlm\n", - "1eP6lFSVG6zvu+++TZZpQwwdOpQQAq+++iqzZ89OO44kSaqDJZWyJ4QewB8T05nAOSmkkSRpgyUv\n", - "9SsqKsrJs4jWxz//+U8gs2n6LrvsstbnlpeX8/e//x3I3ZKqa9euDBgwgBgjjz76aNpxJElSHSyp\n", - "lB0hFAFTga7VpiuA7xLjsnRCSZK0YZJnUm299da0bds2pTQb5sADD6RHjx5VP/7xj38AEGNkr732\n", - "qrH2pz/9qcZrZ86cyYIFCwgh1Ousq7qUl5dz9913c/jhh9O/f38GDBjAiSeeWOOMrpUrV3Ldddcx\n", - "ePBgttlmG4YMGcJVV11FWVlZvT5jp512AuDZZ59tULZ3332X8ePHM3z4cPr06cO2227LvvvuyyWX\n", - "XMKcOXMa9F6VsvF9JUnKNy3SDqBm40zggMTsfGJ8s64nS5KU68rLy6vONqpUWYLkowcffJCVK1cC\n", - "8K9//atqD6cRI0bw+9//vsZzk0Xcyy+/DMBmm21Gp06dGvzZ8+fP54c//CELFy7krLPOYpddduF/\n", - "//sfZ5xxBt/61reYNGkSw4cP56STTqKiooIbb7yRbt268eCDD/LLX/6St956i1tuuWWdn1P572fm\n", - "zJn1yrVy5UrGjx/PzTffzGabbcaPf/xjvvGNb9ClSxc+/vhj7r//fkaMGMGFF16Yk99XkqR8Y0ml\n", - "phfCTsCvE9OngKtTSCNJUqN49913Wbas5snAAwYMSCnNhmvZsiUtW7YEYNasWVXznXbaaZ1nh1Ve\n", - "9ti3b98Gf+7KlSsZPXo0vXr14rbbbqu6i2D37t256KKL+P73v8+4ceP41re+xdy5c/nb3/5GcXEx\n", - "L7zwAuPHj2flypU88cQTLFy4kI4dO671s7bbbjsAPv30U+bOncvGG2+8xufOnz+fUaNGMX36dLbe\n", - "emvuv/9+unTpUrXetWtXdtxxR4488khGjhxZVfDl0veVJCnfeLmfmlYIbYDbgNbVpguAUcRYkU4o\n", - "SZI2XF2bpudzSVXd22+/XfW4PntsffDBB0DmTKqGmjhxIuXl5VxzzTVVhU3ys7/88kumTJnCFVdc\n", - "UfWcyZMnV1321q5dO9q3b7/Oz9p0002rHlf/jnU566yzmD59Oi1atGDKlCk1Cqrq+vXrxzXXXMPi\n", - "xYvX+fmQ3e8rSVK+saRSU7sUSF778ENi/CiNMJIkNZa33nqrxnFRURE77rhjSmka1zvvvANkNk2v\n", - "z90KP/zwQyBzNlBDfP755/zxj3/k8ssvr1XYAMydO7fq8W677Vbjn2///v0BaNGiBRdddBFFRev+\n", - "Y+3mm28OZPbZqizW6nLzzTfz2GOPAZnLHfv06bPW9x0+fDhbbLHFOj8/299XkqR84+V+ajohDAPG\n", - "Jqa3EeMdacSRJKkxJUuqrbbaig4dOqSUpnFVllQdOnSgZ8+ea33uqlWrmDdvHsAazzZak3vuuYfd\n", - "dtttjUVY9bOdDjig5taWP//5zzn00EPp1q0b3bp1q9fntW7dmtatW1NWVsaCBQvqfM6qVav47W9/\n", - "W3V85JFH1uu96yPb31eSpHxjSaWmEUIX4ObEdDbw4xTSSJLUqFauXFlV5FTaeeedU0rTuObOnctn\n", - "n30GrD57Z22WLl1a9bh169ZreWZtW221FWPHJv8+a7Xp06dXPd5rr71qrdfnUsSkjTbaiLKyMhYt\n", - "WlTn+gsvvFD1/UMIjfrvNY3vK0lSPrGkUuMLIQDXAz2qTSNwPDHOTyeUJEmN59///jcrVqyoMdtl\n", - "l11SStO4Grof1YaUVCNGjFjr+vPPPw9k7iY4cODABr33mrRp0waAhQsX1rn+6quvVj1u1apVvS7j\n", - "q680vq8kSfnEi9nVFL4LlCRmVxDjs2mEkSSpsf3zn/+sNSuUkqr6GWINPXMnxthoOf773/9W7XW1\n", - "++6717mH0/qozFhRUff9Wz799NOqx506dWqUz6yPpvq+kiTlE0sqNa4QtgKuS0xfBy7MehZJkprI\n", - "zJkzaxy3bNmSnXZK3ickP1U/k6o+m6a3bdu26nHl3ecaQ+VZRQB77713o73v8uXLgZq516Rly5aN\n", - "9rnr0lTfV5KkfGJJpcYTQjFwK9Cx2nQ58F1iXFH3iyRJyj/Jkqpv374NvtQtV1WWVMXFxfTt23ed\n", - "z69e9lQWQI3hhRdeqHpc1/5M66sy40YbbVTneuUdAKs/Nxua6vtKkpRPLKnUmMYBgxOznxHjO3U9\n", - "WZKkfJXcNH3XXXdNKUnjWrVqFe+99x4AW2+9ddX+TWvTokULunbtCrDGO+atj8rSZm37M82fP5+J\n", - "EyfW+z2XL19edbZX9TKquuqfNX/+/DVeFtjYmuL7SpKUbyyp1DhC2A24ODH9OzAphTSSJDWZ//3v\n", - "f7U23S6UTa7fe++9qg3hG7If1ZZbbgnAJ5980qDPW7p0Ka+//jpLliyplaNyb6iBAweucX+mBx98\n", - "kEcffbTen1eZL4RAr1696nzO3nvvzSabbAJk9q1KFpIbItvfV5KkfGNJpQ0XQlvgNmreLfILYHSj\n", - "7qAqSVIOePfdd2schxAKpqSaMWNG1eOGlFRbb701AB9//HG9X/Pf//6XoUOH8s1vfpMDDjiAVatW\n", - "Va09/vjjVY933HHHOl9fXl7O5MmTOeaYY+r9mdVLtMrMSS1btuS0004DMpusP/zww+t835UrV9a4\n", - "y2Fd0vi+kiTlG0sqNYYrgeSmFScT45w0wkiS1JT+9a9/1Tju0KED2223XUppGlf1kqo+m6ZXqryz\n", - "4X/+8596v+baa6/lf//7HwCzZ8+u2v9p1apV3H777VXP69KlS52vv/766ykvL29QafP+++8D0Llz\n", - "56qzv+pyyimnsPvuuwNw00038cUXX6z1fa+//nrmzZtXdbx48eJaz0nj+0qSlG8sqbRhQjgE+FFi\n", - "+idivC+NOJIkNbVkSVVZ0BSCypIqhNCgkmqPPfYA4NNPP11noVPps88+q3p8/PHH0759ewAmTZpE\n", - "RUUFRx11VI1M1T300ENcd911TJo0qUF34HvrrbcAqgqoNSkqKmLSpElst912zJs3j1NOOYVFixbV\n", - "+dzbbruNyZMn06FDByBz9tWdd95Z62TyNL6vJEn5xpJK6y+E7sDUxPR9YEwKaSRJyopkSVUom6bD\n", - "6rsW9ujRg0033bTer9thhx3o3LkzMUbefPPNer2mspQ54IADOP300/n000+ZOHEiU6ZM4cYbb2T8\n", - "+PH07t2bhx56iJtvvpnPP/+cmTNncv7553P22WczderUBhVpsLqk2meffdb53B49enD//fczbNgw\n", - "pk2bxkEHHcQdd9zBrFmzmD17No8++ijHHnssU6ZM4e6776Zjx9U3N77hhhvo378/gwcPrtprKo3v\n", - "K0lSvmmx7qdIdQghADcC3atNy4HvEWPtc9wlSSoA5eXlVZeMVVrXWTn54oMPPqg6W6jyzKj6Kioq\n", - "4uCDD+b222/n6aefZtiwYet8zeGHH07btm254YYb2H///WnZsiVDhw7lgQceoGfPngDcd999TJo0\n", - "iRtuuIGLLrqIbt26MWLECJ566qmqzc3r64svvmDmzJkUFRVx6KGH1us1HTp04JZbbuGZZ57hzjvv\n", - "ZMKECXz++ee0b9+eHXbYgSOPPJKSkhKKiopo3bo1m222GV26dKFr165VP1feITHb31eSpHxkSaX1\n", - "9QPgsMTsYmKclkYYSZKy4YMPPqCsrKzquKioqGBKquqXmQ0dOrTBrz/iiCO4/fbbeeKJJ7jkkkvq\n", - "9Zrhw4czfPjwNa537tyZ8847j/POO6/BeZKeeOIJIHP3vC222KJBrx0yZAhDhgxZ63Oee+65db5P\n", - "Nr+vJEn5yMv91HAh9AGuSUxfAi5LIY0kSVmTvLNf3759q/YiyneVl8K1aNGiXmdCJQ0ePJitt96a\n", - "Dz/8sOq9csmDDz4IZPaDkiRJucmSSg0TQkvgz0DbatPFZC7zW1X3iyRJKgzJkmrQoEEpJVl/Cxcu\n", - "ZNSoUfTt25ff/OY3VfM33ngDyOzX1Llz5wa/bwiB0047DYBbbrmlccI2ko8++ognn3ySLbbYompv\n", - "KEmSlHssqdRQFwBfT8zOJMb633NakqQ8VQgl1YQJE3j88cdZvHgxN954I5DZa6vy7KfRo0ev93uX\n", - "lJTQo0cP/vrXv/Lll182St7GMHXqVGKMnHbaaRQXF6cdR5IkrYElleovhEHA+YnpPcBN2Q8jSVL2\n", - "vfPOO1WPQwjsueeeKaZZP88//3zV4wEDBgDw4osvsmjRInr37s0BBxyw3u/dsmVLLr30UpYtW8Y1\n", - "1yR3BkjHxx9/zE033cQOO+zACSeckHYcSZK0FpZUqp/MZX43UvPXzCfAqcQY0wklSVL2lJWVMWvW\n", - "rKrjLbfcku7du6/lFbmpbdvMFfv9+/evutzvlltuoaioqMblf+vrwAMP5OCDD+bWW2/lP/9J/0Tr\n", - "K664glWrVnHllVdSVOQffSVJymX+Tq36+hmwY2I2mhi/SCOMJEnZ9t5771FeXl51vMcee6SYZv2N\n", - "Hj2aEALf/OY3adWqFZMnT+ahhx7i9NNPb7TLF6+66ip69OjBmWeeyapV6W1Z+eijj3L33Xdz7rnn\n", - "svPOO6eWQ5Ik1Y8lldYthO2ACxPTm4nxkTTiSJKUhhkzZtQ4zsdL/QCOOuooJk+ezGOPPcbQoUOZ\n", - "OnUql19+Oeecc06jfUbnzp256aabeP/99/n1r3/daO/bEJ988gljx47lO9/5TtWG7pIkKbe1SDuA\n", - "clwIAbgeaF1t+gWZM6skSWo2Zs6cWfU4X/ejqjRixAhGjBjRpJ+x3XbbcdtttzFq1Ch69OixQRuy\n", - "N9T8+fP57ne/y+DBg5kwYULWPleSJG0Yz6TSunwf2D8x+6mX+UmSmpu333676nH37t3ZcsstU0yT\n", - "H3bffXfuvfderr/+et5///2sfe4FF1zAPvvswx/+8AdatPDvZCVJyhf+rq01C6E7cHVi+hhwWwpp\n", - "JElKVfWSKl/3o0pDnz59mDZtWlY/83e/+11WP0+SJDUOz6TS2lwNdK12vAz4oXfzkyQ1Nx999BEL\n", - "Fy6sOm6sDcYlSZK0miWV6hbCCOC7iel4Yvy/NOJIkpSm6pumhxDYe++9U0wjSZJUmCypVFsI7chs\n", - "ll7dm8A1KaSRJCl1b731VtXjTTfdlL59+6aYRpIkqTBZUqkuFwJbVTuOwA+IcWU6cSRJStebb75Z\n", - "9fgb3/hGikkkSZIKlyWVagphIDAmMb2WGF9JI44kSbmg+plUllSSJElNw5JKq4VQDPwJKK42/Qi4\n", - "IJ1AkiSlb/bs2cybNw/I7Ec1ePDglBNJkiQVJksqVXcGsFtidjoxLkojjCRJuWD69OlVj3v37s2m\n", - "m26aYhpJkqTCZUmljBC2BC5NTO8ixvvTiCNJUq546aWXqh7vt99+KSaRJEkqbJZUyly7AJOAdtWm\n", - "C4Az0wkkSVLuePHFF6sejxgxIsUkkiRJhc2SSgAlwCGJ2c+JcU4aYSRJyhUffPABs2bNAqBz587s\n", - "scceKSeSJEkqXJZUzV0IXYBrE9PngMkppJEkKac88cQTVY8POuggior8o5MkSVJT8U9a+g3Qvdrx\n", - "CuBUYqxIKY8kSTnjkUceATJXxo8aNSrlNJIkSYXNkqo5C2EIcHJiehkxvpNGHEmScsnHH39ctR/V\n", - "wIEDGTBgQMqJJEmSCpslVXMVQhvgj4npv4Bfp5BGkqSsmzVrFiNGjKBPnz5cd911tdbvvfdeYoyE\n", - "EPjRj36UQkJJkqTmxZKq+ToX6JuYnUKMZWmEkSQp2yZMmMCMGTNYsmQJl112WdUG6QBlZWVMmTIF\n", - "gP3224+DDz44rZiSJEnNhiVVcxTC9mRKqupuIMbn0ogjSVIaFi9eXPU4hEBFxertGP/85z8zZ84c\n", - "2rZty+WXX55GPEmSpGbHkqq5CaEIuAFoWW06Bzg7nUCSJKVj2LBhALRv354zzzyTbbfdFoA5c+Zw\n", - "9dVXE0LgoosuomfPnmnGlCRJajYsqZqfHwD7JGZnEuP8NMJIkpSW4447jmHDhtG7d2+GDBnC4sWL\n", - "ee211zj66KNZvHgxv/jFLzjuuOM26DP+/ve/M3LkSA488EAOOOAAbrzxRioqKnjwwQeZO3duI30T\n", - "SZKkwtAi7QDKohC2AH6TmD4A3J1CGkmSUlVcXMxNN93ElClTOOecc/jggw/o3LkzgwYNYuLEieyy\n", - "yy7r/d4xRs4991xKS0u57rrrOPjggykvL+fUU0/lqaee4umnn+acc87hjDPOaMRvJEmSlN8sqZqX\n", - "a4GO1Y6XAKcTY0wpjyRJqSoqKuLkk0/m5JNPbtT3veCCC7j11luZMGFC1abrxcXFjB8/nkGDBhFC\n", - "YPvtt2/Uz5QkScp3Xu7XXIRwBPDtxPR8YpydRhxJkgrVk08+ydSpUxk4cCDHHHNMjbVNN92UVq1a\n", - "UVRUxB577JFSQkmSpNxkSdUchNARuC4xnQ78PoU0kiQVrPLycn7xi18AcPzxx9daf/PNN1mxYgX9\n", - "+/enQ4cO2Y4nSZKU0yypmodLgR7VjsuBHxBjeUp5JEkqSM899xwffvghxcXFHHjggbXWp02bBsBe\n", - "e+2V7WiSJEk5z5Kq0IUwCPhxYjqBGN9II44kSYXsgQceAGDAgAF06dKl1nplSTVo0KCs5pIkfeao\n", - "7gAADLpJREFUScoHllSFLISWwJ+AUG36f8BF6QSSJKmwvffeewDsuuuutdYqKip45ZVXKCoqYs89\n", - "98x2NEmSpJxnSVXYxgI7JWY/JMalaYSRJKnQzZ07F4D+/fvXWnv77bdZuHAh2223XdVZVpdffrk3\n", - "2ZUkSfqKJVWhCqE3cGFieisxPpZGHEmSmoNNNtmkxs/VPfPMM8DqS/3Kysp45ZVXCCHUeq4kSVJz\n", - "ZElViDJ/2r0eaFNtOpfMmVWSJKmJDBs2DIAvvviixnzGjBn89re/BaBfv34APPvsswwZMiS7ASVJ\n", - "knKYJVVh+j4wLDEbQ4yfpxFGkqTmYvTo0fTq1Ys777yT8vLMTXSffPJJzjvvPK666ioAli9fToyR\n", - "W2+9laOPPjrNuJIkSTmlRdoB1MhC2Bi4OjF9Arg1hTSSJDUr7du356677uKCCy5g6NChdO7cmV13\n", - "3ZXbb7+ddu3aMW/ePCZPnsx9993Hsccey2abbZZ2ZEmSpJxhSVV4xgNdqx0vJ7NZuruySpKUBb16\n", - "9eKmm26qc+2EE07ghBNOyGoeSZKkfOHlfoUkhB2A0xLTS4jx/TTiSJIkSZIk1ZclVaHIbJZ+NVBc\n", - "bTqL2pf+SZIkSZIk5RxLqsJxCHBgYvYzYlyeRhhJkiRJkqSGsKQqBCG0ovYZU88A96aQRpIkSZIk\n", - "qcEsqQrD6UCfascROMvN0iVJkiRJUr6wpMp3IWwCXJiY3kiMb6QRR5IkSZIkaX1YUuW/i4FO1Y4X\n", - "AReklEWSJEmSJGm9WFLlsxB2Ak5NTC8hxk/TiCNJkiRJkrS+LKnyVQgBuIaa/w7/A1ybTiBJkiRJ\n", - "kqT1Z0mVvw4DhiVmPyPGsjTCSJIkSZIkbQhLqnwUQmtgQmL6JHBfCmkkSZIkSZI2mCVVfvox0Lva\n", - "cQXwU2KMKeWRJEmSJEnaIJZU+SaE7sAvE9M/EeNbacSRJEmSJElqDJZU+ecSoGO14wXABSllkSRJ\n", - "kiRJahSWVPkkhJ2BkxPTi4nx8zTiSJIkSZIkNRZLqnwRQgCuoea/s/eA36cTSJIkSZIkqfFYUuWP\n", - "I4D9ErOxxLgijTCSJEmSJEmNyZIqH4TQGrgqMX0MeCCFNJIkSZIkSY3Okio//ATYttpxBTCGGGNK\n", - "eSRJkiRJkhqVJVWuC2FT4BeJ6fXEOCONOJIkSZIkSU3Bkir3XQp0qHY8H7gwpSySJEmSJElNwpIq\n", - "l4UwEDgpMb2IGL9II44kSZIkSVJTsaTKVSEE4BogVJu+C1yXTiBJkiRJkqSmY0mVu44ChiRmY4hx\n", - "ZRphJEmSJEmSmpIlVS4KoQ1wVWL6CPBwCmkkSZIkSZKanCVVbjoL2KracTmZs6hiOnEkSZIkSZKa\n", - "liVVrglhc+D8xHQSMb6dRhxJkiRJkqRssKTKPb8C2lc7ngdclFIWSZIkSZKkrLCkyiUh7AackJhe\n", - "SIxzU0gjSZIkSZKUNZZUuSKEAPwWCNWm7wDXpxNIkiRJkiQpeyypcsdIYHBi9lNiXJlGGEmSJEmS\n", - "pGyypMoFIWwE/CYxfYgYH0kjjiRJkiRJUrZZUuWGMcCW1Y5XfTWTJEmSJElqFiyp0hbCFsC5ienv\n", - "ifHdNOJIkiRJkiSlwZIqfZcB7aodzwUuTimLJEmSJElSKiyp0hTC14FRiekviXFeGnEkSZIkSZLS\n", - "YkmVlhAC8NvEdCZwQwppJEmSJEmSUmVJlZ6jgb0Ts58S46o0wkiSJEmSJKXJkioNIbQGrkhM7yfG\n", - "x9KII0mSJEmSlDZLqnScCnyt2vFKYGxKWSRJkiRJklJnSZVtIbQDzk9M/0CM76URR5IkSZIkKRdY\n", - "UmXfGUD3asdLgctSyiJJkiRJkpQTLKmyKYTOwNmJ6URi/DSNOJIkSZIkSbnCkiq7xgKdqx0vAK5M\n", - "KYskSZIkSVLOsKTKlhC6Az9NTK8kxnlpxJEkSZIkScolllTZcw7Qrtrx58DElLJIkiRJkiTlFEuq\n", - "bAihJ/CjxPQyYlycRhxJkiRJkqRcY0mVHRcArasd/xe4PqUskiRJkiRJOceSqqmF0Bs4MTG9mBiX\n", - "pxFHkiRJkiQpF1lSNb3xQItqx/8BbkoliSRJkiRJUo6ypGpKIewIHJeYXkiMK9OII0mSJElSGubM\n", - "mXNs2hmU+yypmtbFQKh2PAO4I6UskiRJkiSloqyszJJK62RJ1VRC+DpwZGJ6ATGWpxFHkiRJkiQp\n", - "l1lSNZ1LE8evAPelEUSSJEmSJCnXWVI1hRCGAAcmpucTY0wjjiRJkiRJUq6zpGpsIQTgV4npM8Dj\n", - "KaSRJEmSJEnKC5ZUje8gYJ/EzLOoJEmSJEmS1sKSqjGFUETts6geIsYX0ogjSZIkSZKULyypGtdR\n", - "wMDE7BdpBJEkSZIkSconllSNJYRi4JLE9C5ifD2NOJIkSZIkSfnEkqrxfA/oV+24AvhlSlkkSZIk\n", - "SZLySiiE/byfeOKJ/P8SkiRJkiRJOWjYsGEhG5/jmVSSJEmSJElKXUGcSSVJkiRJkqT85plUkiRJ\n", - "kiRJSp0llSRJkiRJklJnSSVJkiRJkqTUWVJJkiRJkiQpdZZUkiRJkiRJSp0llSRJkiRJklJnSSVJ\n", - "kiRJkqTUWVJJkiRJkiQpdZZUkiRJkiRJSp0llSRJkiRJklJnSSVJkiRJkqTUWVJJkiRJkiQpdS3S\n", - "DiBJkiRJkgpPSUnJvsAVwCDg1tLS0lEpR1KO80wqSZIkSZLU6EpLS58FhgHlwHMpx1EesKSSJEmS\n", - "JElNZW+gGEsq1YMllSRJkiRJairfAD4vLS19N+0gyn2WVJIkSZIkqansCzyfdgjlhxBjTDuDpDxV\n", - "UlKyP3AK8CHQDXgS+ElpaenXUw0mSZIkKXUlJSUtgfnAFKDsq/EA4KzS0tK3UwumnOWZVJLWS0lJ\n", - "yUnAX4AxpaWlZwMXATcCX6QaTJIkSVKu+DqwEfA14OzS0tKfAQ8Dd6eaSjnLkkpSg5WUlOwM/IHM\n", - "WVMfA5SWln4ILMINESVJkiRlfAP4Eji6tLS0/KvZh0C/kpKS/unFUq6ypJK0Pn4FLKTa34B89ZvM\n", - "xlhSSZIkScrYF3iutLR0ebVZr69+bpdCHuU4SypJDVJSUtIZOAh4rNrfhgAMBVYA09LIJUmSJCnn\n", - "DAKeTcz2BFYB72U/jnKdJZWkhupN5r8d/0jMhwIvl5aWrigpKdk666kkSZIk5YySkpJNgK7AK9Vm\n", - "xcBwMn/hvSCtbMpdllSSGmrhVz/PrhyUlJRsRKakevGr0U+ynEmSJElSblkKRGBOtdl3gC7Ahakk\n", - "Us6zpJLUIKWlpf8G3gK2hqrbyv4eaA18+NXfmHiHP0mSJKkZKy0tXQo8DmwPUFJS0gO4FhhbWlo6\n", - "Pc1syl0t0g4gKS+NBK4pKSnpBRQDl5G51vwEYBfg3PSiSZIkScoRJwNXlZSUDCWzbchJpaWlD6Qb\n", - "SbksxBjTziBJkiRJkqRm7v+3dwerOkVxGIffJROZKDMmJykTM3egTNyDpJSJGTKQThmSzEydW3AB\n", - "MlA6E8oNSDKUDE/CMjifOimfnH3qlZ5ntvZuf/89/rXX+mz3AwAAAKBOpAIAAACgTqQCAAAAoE6k\n", - "AgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQC\n", - "AAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIA\n", - "AACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAA\n", - "AKBOpAIAAACg7nD7BQAAAAD4940xziW5lORbko0kV5NcS3Isyckkm3POt/v9fZEKAAAAgLXGGKeS\n", - "XJlzXl+tt5JsJ7mc3Z16L5K8TvJovzNs9wMAAADgT24kub1nfTTJpznndpL3SR4m2VoyYMw5lzwP\n", - "AAAAwH9ujLEx53y3Z/0hyZM5592DmuFLKgAAAADW+iVQnUlyIsnzg5whUgEAAADwN84n+ZLk5c8L\n", - "qzOrFhGpAAAAAPitMcaRMcb9McbZ1aULSd7MOXdW9w8lubV0jn/3AwAAAGCdi0luJnk1xvia5HSS\n", - "z3vu38nCQ9MTB6cDAAAAsMYY43iSB0k+Jvme5F6Sx0l2srvt7+mc89niOSIVAAAAAG3OpAIAAACg\n", - "TqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBO\n", - "pAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6kAgAAAKBOpAIAAACgTqQCAAAAoE6k\n", - "AgAAAKBOpAIAAACg7gefISOV+L+GHQAAAABJRU5ErkJggg==\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": { - "image/png": { - "height": 403, - "width": 596 - } - }, - "output_type": "display_data" - } - ], - "source": [ - "# %load http://matplotlib.org/mpl_examples/showcase/integral_demo.py\n", - "\"\"\"\n", - "Plot demonstrating the integral as the area under a curve.\n", - "\n", - "Although this is a simple example, it demonstrates some important tweaks:\n", - "\n", - " * A simple line plot with custom color and line width.\n", - " * A shaded region created using a Polygon patch.\n", - " * A text label with mathtext rendering.\n", - " * figtext calls to label the x- and y-axes.\n", - " * Use of axis spines to hide the top and right spines.\n", - " * Custom tick placement and labels.\n", - "\"\"\"\n", - "import numpy as np\n", - "import matplotlib.pyplot as plt\n", - "from matplotlib.patches import Polygon\n", - "\n", - "\n", - "def func(x):\n", - " return (x - 3) * (x - 5) * (x - 7) + 85\n", - "\n", - "\n", - "a, b = 2, 9 # integral limits\n", - "x = np.linspace(0, 10)\n", - "y = func(x)\n", - "\n", - "fig, ax = plt.subplots()\n", - "plt.plot(x, y, 'r', linewidth=2)\n", - "plt.ylim(ymin=0)\n", - "\n", - "# Make the shaded region\n", - "ix = np.linspace(a, b)\n", - "iy = func(ix)\n", - "verts = [(a, 0)] + list(zip(ix, iy)) + [(b, 0)]\n", - "poly = Polygon(verts, facecolor='0.9', edgecolor='0.5')\n", - "ax.add_patch(poly)\n", - "\n", - "plt.text(0.5 * (a + b), 30, r\"$\\int_a^b f(x)\\mathrm{d}x$\",\n", - " horizontalalignment='center', fontsize=20)\n", - "\n", - "plt.figtext(0.9, 0.05, '$x$')\n", - "plt.figtext(0.1, 0.9, '$y$')\n", - "\n", - "ax.spines['right'].set_visible(False)\n", - "ax.spines['top'].set_visible(False)\n", - "ax.xaxis.set_ticks_position('bottom')\n", - "\n", - "ax.set_xticks((a, b))\n", - "ax.set_xticklabels(('$a$', '$b$'))\n", - "ax.set_yticks([])\n", - "\n", - "plt.show()\n" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.2" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/IPython Kernel/data/flare.json b/examples/IPython Kernel/data/flare.json deleted file mode 100644 index b976cd1304b..00000000000 --- a/examples/IPython Kernel/data/flare.json +++ /dev/null @@ -1,380 +0,0 @@ -{ - "name": "flare", - "children": [ - { - "name": "analytics", - "children": [ - { - "name": "cluster", - "children": [ - {"name": "AgglomerativeCluster", "size": 3938}, - {"name": "CommunityStructure", "size": 3812}, - {"name": "HierarchicalCluster", "size": 6714}, - {"name": "MergeEdge", "size": 743} - ] - }, - { - "name": "graph", - "children": [ - {"name": "BetweennessCentrality", "size": 3534}, - {"name": "LinkDistance", "size": 5731}, - {"name": "MaxFlowMinCut", "size": 7840}, - {"name": "ShortestPaths", "size": 5914}, - {"name": "SpanningTree", "size": 3416} - ] - }, - { - "name": "optimization", - "children": [ - {"name": "AspectRatioBanker", "size": 7074} - ] - } - ] - }, - { - "name": "animate", - "children": [ - {"name": "Easing", "size": 17010}, - {"name": "FunctionSequence", "size": 5842}, - { - "name": "interpolate", - "children": [ - {"name": "ArrayInterpolator", "size": 1983}, - {"name": "ColorInterpolator", "size": 2047}, - {"name": "DateInterpolator", "size": 1375}, - {"name": "Interpolator", "size": 8746}, - {"name": "MatrixInterpolator", "size": 2202}, - {"name": "NumberInterpolator", "size": 1382}, - {"name": "ObjectInterpolator", "size": 1629}, - {"name": "PointInterpolator", "size": 1675}, - {"name": "RectangleInterpolator", "size": 2042} - ] - }, - {"name": "ISchedulable", "size": 1041}, - {"name": "Parallel", "size": 5176}, - {"name": "Pause", "size": 449}, - {"name": "Scheduler", "size": 5593}, - {"name": "Sequence", "size": 5534}, - {"name": "Transition", "size": 9201}, - {"name": "Transitioner", "size": 19975}, - {"name": "TransitionEvent", "size": 1116}, - {"name": "Tween", "size": 6006} - ] - }, - { - "name": "data", - "children": [ - { - "name": "converters", - "children": [ - {"name": "Converters", "size": 721}, - {"name": "DelimitedTextConverter", "size": 4294}, - {"name": "GraphMLConverter", "size": 9800}, - {"name": "IDataConverter", "size": 1314}, - {"name": "JSONConverter", "size": 2220} - ] - }, - {"name": "DataField", "size": 1759}, - {"name": "DataSchema", "size": 2165}, - {"name": "DataSet", "size": 586}, - {"name": "DataSource", "size": 3331}, - {"name": "DataTable", "size": 772}, - {"name": "DataUtil", "size": 3322} - ] - }, - { - "name": "display", - "children": [ - {"name": "DirtySprite", "size": 8833}, - {"name": "LineSprite", "size": 1732}, - {"name": "RectSprite", "size": 3623}, - {"name": "TextSprite", "size": 10066} - ] - }, - { - "name": "flex", - "children": [ - {"name": "FlareVis", "size": 4116} - ] - }, - { - "name": "physics", - "children": [ - {"name": "DragForce", "size": 1082}, - {"name": "GravityForce", "size": 1336}, - {"name": "IForce", "size": 319}, - {"name": "NBodyForce", "size": 10498}, - {"name": "Particle", "size": 2822}, - {"name": "Simulation", "size": 9983}, - {"name": "Spring", "size": 2213}, - {"name": "SpringForce", "size": 1681} - ] - }, - { - "name": "query", - "children": [ - {"name": "AggregateExpression", "size": 1616}, - {"name": "And", "size": 1027}, - {"name": "Arithmetic", "size": 3891}, - {"name": "Average", "size": 891}, - {"name": "BinaryExpression", "size": 2893}, - {"name": "Comparison", "size": 5103}, - {"name": "CompositeExpression", "size": 3677}, - {"name": "Count", "size": 781}, - {"name": "DateUtil", "size": 4141}, - {"name": "Distinct", "size": 933}, - {"name": "Expression", "size": 5130}, - {"name": "ExpressionIterator", "size": 3617}, - {"name": "Fn", "size": 3240}, - {"name": "If", "size": 2732}, - {"name": "IsA", "size": 2039}, - {"name": "Literal", "size": 1214}, - {"name": "Match", "size": 3748}, - {"name": "Maximum", "size": 843}, - { - "name": "methods", - "children": [ - {"name": "add", "size": 593}, - {"name": "and", "size": 330}, - {"name": "average", "size": 287}, - {"name": "count", "size": 277}, - {"name": "distinct", "size": 292}, - {"name": "div", "size": 595}, - {"name": "eq", "size": 594}, - {"name": "fn", "size": 460}, - {"name": "gt", "size": 603}, - {"name": "gte", "size": 625}, - {"name": "iff", "size": 748}, - {"name": "isa", "size": 461}, - {"name": "lt", "size": 597}, - {"name": "lte", "size": 619}, - {"name": "max", "size": 283}, - {"name": "min", "size": 283}, - {"name": "mod", "size": 591}, - {"name": "mul", "size": 603}, - {"name": "neq", "size": 599}, - {"name": "not", "size": 386}, - {"name": "or", "size": 323}, - {"name": "orderby", "size": 307}, - {"name": "range", "size": 772}, - {"name": "select", "size": 296}, - {"name": "stddev", "size": 363}, - {"name": "sub", "size": 600}, - {"name": "sum", "size": 280}, - {"name": "update", "size": 307}, - {"name": "variance", "size": 335}, - {"name": "where", "size": 299}, - {"name": "xor", "size": 354}, - {"name": "_", "size": 264} - ] - }, - {"name": "Minimum", "size": 843}, - {"name": "Not", "size": 1554}, - {"name": "Or", "size": 970}, - {"name": "Query", "size": 13896}, - {"name": "Range", "size": 1594}, - {"name": "StringUtil", "size": 4130}, - {"name": "Sum", "size": 791}, - {"name": "Variable", "size": 1124}, - {"name": "Variance", "size": 1876}, - {"name": "Xor", "size": 1101} - ] - }, - { - "name": "scale", - "children": [ - {"name": "IScaleMap", "size": 2105}, - {"name": "LinearScale", "size": 1316}, - {"name": "LogScale", "size": 3151}, - {"name": "OrdinalScale", "size": 3770}, - {"name": "QuantileScale", "size": 2435}, - {"name": "QuantitativeScale", "size": 4839}, - {"name": "RootScale", "size": 1756}, - {"name": "Scale", "size": 4268}, - {"name": "ScaleType", "size": 1821}, - {"name": "TimeScale", "size": 5833} - ] - }, - { - "name": "util", - "children": [ - {"name": "Arrays", "size": 8258}, - {"name": "Colors", "size": 10001}, - {"name": "Dates", "size": 8217}, - {"name": "Displays", "size": 12555}, - {"name": "Filter", "size": 2324}, - {"name": "Geometry", "size": 10993}, - { - "name": "heap", - "children": [ - {"name": "FibonacciHeap", "size": 9354}, - {"name": "HeapNode", "size": 1233} - ] - }, - {"name": "IEvaluable", "size": 335}, - {"name": "IPredicate", "size": 383}, - {"name": "IValueProxy", "size": 874}, - { - "name": "math", - "children": [ - {"name": "DenseMatrix", "size": 3165}, - {"name": "IMatrix", "size": 2815}, - {"name": "SparseMatrix", "size": 3366} - ] - }, - {"name": "Maths", "size": 17705}, - {"name": "Orientation", "size": 1486}, - { - "name": "palette", - "children": [ - {"name": "ColorPalette", "size": 6367}, - {"name": "Palette", "size": 1229}, - {"name": "ShapePalette", "size": 2059}, - {"name": "SizePalette", "size": 2291} - ] - }, - {"name": "Property", "size": 5559}, - {"name": "Shapes", "size": 19118}, - {"name": "Sort", "size": 6887}, - {"name": "Stats", "size": 6557}, - {"name": "Strings", "size": 22026} - ] - }, - { - "name": "vis", - "children": [ - { - "name": "axis", - "children": [ - {"name": "Axes", "size": 1302}, - {"name": "Axis", "size": 24593}, - {"name": "AxisGridLine", "size": 652}, - {"name": "AxisLabel", "size": 636}, - {"name": "CartesianAxes", "size": 6703} - ] - }, - { - "name": "controls", - "children": [ - {"name": "AnchorControl", "size": 2138}, - {"name": "ClickControl", "size": 3824}, - {"name": "Control", "size": 1353}, - {"name": "ControlList", "size": 4665}, - {"name": "DragControl", "size": 2649}, - {"name": "ExpandControl", "size": 2832}, - {"name": "HoverControl", "size": 4896}, - {"name": "IControl", "size": 763}, - {"name": "PanZoomControl", "size": 5222}, - {"name": "SelectionControl", "size": 7862}, - {"name": "TooltipControl", "size": 8435} - ] - }, - { - "name": "data", - "children": [ - {"name": "Data", "size": 20544}, - {"name": "DataList", "size": 19788}, - {"name": "DataSprite", "size": 10349}, - {"name": "EdgeSprite", "size": 3301}, - {"name": "NodeSprite", "size": 19382}, - { - "name": "render", - "children": [ - {"name": "ArrowType", "size": 698}, - {"name": "EdgeRenderer", "size": 5569}, - {"name": "IRenderer", "size": 353}, - {"name": "ShapeRenderer", "size": 2247} - ] - }, - {"name": "ScaleBinding", "size": 11275}, - {"name": "Tree", "size": 7147}, - {"name": "TreeBuilder", "size": 9930} - ] - }, - { - "name": "events", - "children": [ - {"name": "DataEvent", "size": 2313}, - {"name": "SelectionEvent", "size": 1880}, - {"name": "TooltipEvent", "size": 1701}, - {"name": "VisualizationEvent", "size": 1117} - ] - }, - { - "name": "legend", - "children": [ - {"name": "Legend", "size": 20859}, - {"name": "LegendItem", "size": 4614}, - {"name": "LegendRange", "size": 10530} - ] - }, - { - "name": "operator", - "children": [ - { - "name": "distortion", - "children": [ - {"name": "BifocalDistortion", "size": 4461}, - {"name": "Distortion", "size": 6314}, - {"name": "FisheyeDistortion", "size": 3444} - ] - }, - { - "name": "encoder", - "children": [ - {"name": "ColorEncoder", "size": 3179}, - {"name": "Encoder", "size": 4060}, - {"name": "PropertyEncoder", "size": 4138}, - {"name": "ShapeEncoder", "size": 1690}, - {"name": "SizeEncoder", "size": 1830} - ] - }, - { - "name": "filter", - "children": [ - {"name": "FisheyeTreeFilter", "size": 5219}, - {"name": "GraphDistanceFilter", "size": 3165}, - {"name": "VisibilityFilter", "size": 3509} - ] - }, - {"name": "IOperator", "size": 1286}, - { - "name": "label", - "children": [ - {"name": "Labeler", "size": 9956}, - {"name": "RadialLabeler", "size": 3899}, - {"name": "StackedAreaLabeler", "size": 3202} - ] - }, - { - "name": "layout", - "children": [ - {"name": "AxisLayout", "size": 6725}, - {"name": "BundledEdgeRouter", "size": 3727}, - {"name": "CircleLayout", "size": 9317}, - {"name": "CirclePackingLayout", "size": 12003}, - {"name": "DendrogramLayout", "size": 4853}, - {"name": "ForceDirectedLayout", "size": 8411}, - {"name": "IcicleTreeLayout", "size": 4864}, - {"name": "IndentedTreeLayout", "size": 3174}, - {"name": "Layout", "size": 7881}, - {"name": "NodeLinkTreeLayout", "size": 12870}, - {"name": "PieLayout", "size": 2728}, - {"name": "RadialTreeLayout", "size": 12348}, - {"name": "RandomLayout", "size": 870}, - {"name": "StackedAreaLayout", "size": 9121}, - {"name": "TreeMapLayout", "size": 9191} - ] - }, - {"name": "Operator", "size": 2490}, - {"name": "OperatorList", "size": 5248}, - {"name": "OperatorSequence", "size": 4190}, - {"name": "OperatorSwitch", "size": 2581}, - {"name": "SortOperator", "size": 2023} - ] - }, - {"name": "Visualization", "size": 16540} - ] - } - ] -} diff --git a/examples/IPython Kernel/ipython-get-history.py b/examples/IPython Kernel/ipython-get-history.py index 116b4b7c155..ee0ed17074e 100755 --- a/examples/IPython Kernel/ipython-get-history.py +++ b/examples/IPython Kernel/ipython-get-history.py @@ -16,6 +16,7 @@ to build much more flexible and powerful tools to browse and pull from the history database. """ + import sys from pathlib import Path @@ -37,4 +38,4 @@ hist = HistoryAccessor() for session, lineno, cell in hist.get_range(session=session_number, raw=raw): - dest.write(cell + '\n') + dest.write(cell + "\n") diff --git a/examples/IPython Kernel/nbpackage/__init__.py b/examples/IPython Kernel/nbpackage/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/examples/IPython Kernel/nbpackage/mynotebook.ipynb b/examples/IPython Kernel/nbpackage/mynotebook.ipynb deleted file mode 100644 index fd3920ca420..00000000000 --- a/examples/IPython Kernel/nbpackage/mynotebook.ipynb +++ /dev/null @@ -1,69 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# My Notebook" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "def foo():\n", - " return \"foo\"" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "def has_ip_syntax():\n", - " listing = !ls\n", - " return listing" - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "def whatsmyname():\n", - " return __name__" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.2" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/IPython Kernel/nbpackage/nbs/__init__.py b/examples/IPython Kernel/nbpackage/nbs/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/examples/IPython Kernel/nbpackage/nbs/other.ipynb b/examples/IPython Kernel/nbpackage/nbs/other.ipynb deleted file mode 100644 index dad7e734a70..00000000000 --- a/examples/IPython Kernel/nbpackage/nbs/other.ipynb +++ /dev/null @@ -1,44 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "This notebook just defines `bar`" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "def bar(x):\n", - " return \"bar\" * x" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.2" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/Index.ipynb b/examples/Index.ipynb deleted file mode 100644 index 30e201a7e31..00000000000 --- a/examples/Index.ipynb +++ /dev/null @@ -1,61 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "

" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# IPython Documentation" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "This directory contains IPython's notebook-based documentation. This augments our [Sphinx-based documentation](https://ipython.org/ipython-doc/stable/index.html) with notebooks that contain interactive tutorials and examples. Over time, more of our documentation will be pulled into this format." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Topics" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "* [IPython Kernel](IPython Kernel/Index.ipynb): IPython's core syntax and command line features available in all frontends\n", - "* [Embedding](Embedding/Index.ipynb): Embedding and reusing IPython's components into other applications\n" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.4.3" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} diff --git a/examples/auto_suggest_llm.py b/examples/auto_suggest_llm.py new file mode 100644 index 00000000000..d137241eff4 --- /dev/null +++ b/examples/auto_suggest_llm.py @@ -0,0 +1,174 @@ +""" +This is an example of Fake LLM Completer for IPython, as +well as example on how to configure IPython for LLMs. + +8.32 – this is provisional and may change. + +To test this you can run the following command from the root of IPython +directory: + + $ ipython --TerminalInteractiveShell.llm_provider_class=examples.auto_suggest_llm.ExampleCompletionProvider + +Or you can set the value in your config file, which also allows you to set a +keyboard shortcut:: + + c.TerminalInteractiveShell.llm_provider_class = "examples.auto_suggest_llm.ExampleCompletionProvider" + c.TerminalInteractiveShell.shortcuts = [ + { + "new_keys": ["c-q"], + "command": "IPython:auto_suggest.llm_autosuggestion", + "new_filter": "navigable_suggestions & default_buffer_focused", + "create": True, + }, + ] + + +You can use the following configuration option to:: + + c.TerminalInteractiveShell.llm_constructor_kwargs = {"model_id": "mymodel"} + + +For convenience and testing you can bind a shortcut at runtime:: + + In [1]: from examples.auto_suggest_llm import setup_shortcut + ...: setup_shortcut('c-q') + + +Getting access to history content +--------------------------------- + +This uses the same providers as Jupyter AI, In JupyterAI, providers may get +access to the current notebook content to pass as to the LLM as context. + +Here Jupyter AI documents how to get such context. + +https://jupyter-ai.readthedocs.io/en/latest/developers/index.html + + +When reusing these models you may want to pass them more context as well in +IPython to do so you can set the +`c.TerminalInteractiveShell.llm_prefix_from_history` to `"no_prefix"`, +`"input_history"` or a fully qualified name of a function that will get +imported, get passed a `HistoryManager`, and return a prefix to be added the LLM +context. + + +For more flexibility, subclass the provider, and access the history of IPython +via: + + ``` + ip = get_ipython() + hm = ip.history_manager() + hm.get_range(...) # will let you select how many input/output... etc. + ``` + +""" + +import asyncio +import textwrap +from typing import Any +from collections.abc import AsyncIterable, AsyncIterator + +from jupyter_ai_magics.models.completion import ( + InlineCompletionList, + InlineCompletionReply, + InlineCompletionRequest, + InlineCompletionStreamChunk, +) +from jupyter_ai_magics.providers import BaseProvider +from langchain_community.llms import FakeListLLM + + +from IPython.terminal.shortcuts.filters import ( + navigable_suggestions, + default_buffer_focused, +) +from IPython.terminal.shortcuts.auto_suggest import llm_autosuggestion + + +def setup_shortcut(seq): + import IPython + + ip = IPython.get_ipython() + ip.pt_app.key_bindings.add_binding( + seq, filter=(navigable_suggestions & default_buffer_focused) + )(llm_autosuggestion), + + +class ExampleCompletionProvider(BaseProvider, FakeListLLM): # type: ignore[misc, valid-type] + """ + This is an example Fake LLM provider for IPython + + As of 8.32 this is provisional and may change without any warnings + """ + + id = "my_provider" + name = "My Provider" + model_id_key = "model" + models = ["model_a"] + + def __init__(self, **kwargs: Any): + kwargs["responses"] = ["This fake response will not be used for completion"] + kwargs["model_id"] = "model_a" + super().__init__(**kwargs) + + async def generate_inline_completions( + self, request: InlineCompletionRequest + ) -> InlineCompletionReply: + raise ValueError("IPython 8.32 only support streaming models for now.") + + async def stream_inline_completions( + self, request: InlineCompletionRequest + ) -> AsyncIterator[InlineCompletionStreamChunk]: + token_1 = f"t{request.number}s0" + + yield InlineCompletionReply( + list=InlineCompletionList( + items=[ + {"insertText": "It", "isIncomplete": True, "token": token_1}, + ] + ), + reply_to=request.number, + ) + + reply: InlineCompletionStreamChunk + async for reply in self._stream( + textwrap.dedent( + """ + was then that the fox appeared. + “Good morning,” said the fox. + “Good morning,” the little prince responded politely, although when he turned around he saw nothing. + “I am right here,” the voice said, “under the apple tree.” + “Who are you?” asked the little prince, and added, “You are very pretty to look at.” + “I am a fox,” said the fox. + “Come and play with me,” proposed the little prince. “I am so unhappy.” + """ + ).strip(), + request.number, + token_1, + start_with="It", + ): + yield reply + + async def _stream( + self, sentence: str, request_number: int, token: str, start_with: str = "" + ) -> AsyncIterable[InlineCompletionStreamChunk]: + suggestion = start_with + + for fragment in sentence.split(" "): + await asyncio.sleep(0.05) + suggestion += " " + fragment + yield InlineCompletionStreamChunk( + type="stream", + response={"insertText": suggestion, "token": token}, + reply_to=request_number, + done=False, + ) + + # finally, send a message confirming that we are done + yield InlineCompletionStreamChunk( + type="stream", + response={"insertText": suggestion, "token": token}, + reply_to=request_number, + done=True, + ) diff --git a/examples/images/FrontendKernel.graffle/data.plist b/examples/images/FrontendKernel.graffle/data.plist deleted file mode 100644 index 6179209c407..00000000000 --- a/examples/images/FrontendKernel.graffle/data.plist +++ /dev/null @@ -1,461 +0,0 @@ - - - - - ActiveLayerIndex - 0 - ApplicationVersion - - com.omnigroup.OmniGraffle - 139.18.0.187838 - - AutoAdjust - - BackgroundGraphic - - Bounds - {{0, 0}, {576, 733}} - Class - SolidGraphic - ID - 2 - Style - - shadow - - Draws - NO - - stroke - - Draws - NO - - - - BaseZoom - 0 - CanvasOrigin - {0, 0} - ColumnAlign - 1 - ColumnSpacing - 36 - CreationDate - 2014-05-27 21:39:30 +0000 - Creator - bgranger - DisplayScale - 1 0/72 in = 1.0000 in - GraphDocumentVersion - 8 - GraphicsList - - - Class - LineGraphic - ControlPoints - - {0, 0} - {-7, 8} - {6.9999849080788863, -8.0000033519149838} - {0, 0} - - ID - 29 - Points - - {164, 341.5} - {186.5, 338} - {196, 327.5} - - Style - - stroke - - Bezier - - HeadArrow - 0 - Legacy - - LineType - 1 - TailArrow - 0 - - - - - Bounds - {{107.64779663085938, 305.5}, {69.088050842285156, 84.499992370605469}} - Class - ShapedGraphic - ID - 9 - ImageID - 1 - Shape - Rectangle - Style - - fill - - Draws - NO - - shadow - - Draws - NO - - stroke - - Draws - NO - - - - - Class - LineGraphic - Head - - ID - 6 - Position - 0.53676468133926392 - - ID - 8 - Points - - {288.09285678056523, 276} - {288.49999833106995, 304.50001973116196} - - Style - - stroke - - HeadArrow - FilledArrow - Legacy - - LineType - 1 - TailArrow - 0 - - - Tail - - ID - 7 - - - - Bounds - {{207, 263}, {162, 13}} - Class - ShapedGraphic - FitText - YES - Flow - Resize - ID - 7 - Shape - Rectangle - Style - - fill - - Draws - NO - - shadow - - Draws - NO - - stroke - - Draws - NO - - - Text - - Pad - 0 - Text - {\rtf1\ansi\ansicpg1252\cocoartf1265\cocoasubrtf190 -\cocoascreenfonts1{\fonttbl\f0\fnil\fcharset0 xkcd-Regular;} -{\colortbl;\red255\green255\blue255;} -\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\qc - -\f0\fs20 \cf0 Interactive Computing Protocol} - VerticalPad - 0 - - Wrap - NO - - - Class - LineGraphic - Head - - ID - 1 - - ID - 6 - Points - - {252, 304.50001973116196} - {320, 304.50001973116196} - - Style - - stroke - - HeadArrow - FilledArrow - Legacy - - LineType - 1 - Pattern - 1 - TailArrow - FilledArrow - - - Tail - - ID - 5 - - - - Bounds - {{186.5, 286.5}, {65, 36}} - Class - ShapedGraphic - ID - 5 - Shape - Rectangle - Style - - shadow - - Draws - NO - - - Text - - Text - {\rtf1\ansi\ansicpg1252\cocoartf1265\cocoasubrtf190 -\cocoascreenfonts1{\fonttbl\f0\fnil\fcharset0 xkcd-Regular;} -{\colortbl;\red255\green255\blue255;} -\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\qc - -\f0\fs20 \cf0 Frontend} - - - - Bounds - {{320.5, 286.5}, {65, 36}} - Class - ShapedGraphic - ID - 1 - Shape - Rectangle - Style - - shadow - - Draws - NO - - - Text - - Text - {\rtf1\ansi\ansicpg1252\cocoartf1265\cocoasubrtf190 -\cocoascreenfonts1{\fonttbl\f0\fnil\fcharset0 xkcd-Regular;} -{\colortbl;\red255\green255\blue255;} -\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\qc - -\f0\fs20 \cf0 Kernel} - - - - GridInfo - - GuidesLocked - NO - GuidesVisible - YES - HPages - 1 - ImageCounter - 2 - ImageLinkBack - - - - ImageList - - image1.png - - KeepToScale - - Layers - - - Lock - NO - Name - Layer 1 - Print - YES - View - YES - - - LayoutInfo - - Animate - NO - circoMinDist - 18 - circoSeparation - 0.0 - layoutEngine - dot - neatoSeparation - 0.0 - twopiSeparation - 0.0 - - LinksVisible - NO - MagnetsVisible - NO - MasterSheets - - ModificationDate - 2014-05-27 22:28:18 +0000 - Modifier - bgranger - NotesVisible - NO - Orientation - 2 - OriginVisible - NO - PageBreaks - YES - PrintInfo - - NSBottomMargin - - float - 41 - - NSHorizonalPagination - - coded - BAtzdHJlYW10eXBlZIHoA4QBQISEhAhOU051bWJlcgCEhAdOU1ZhbHVlAISECE5TT2JqZWN0AIWEASqEhAFxlwCG - - NSLeftMargin - - float - 18 - - NSPaperSize - - size - {612, 792} - - NSPrintReverseOrientation - - int - 0 - - NSRightMargin - - float - 18 - - NSTopMargin - - float - 18 - - - PrintOnePage - - ReadOnly - NO - RowAlign - 1 - RowSpacing - 36 - SheetTitle - Canvas 1 - SmartAlignmentGuidesActive - YES - SmartDistanceGuidesActive - YES - UniqueID - 1 - UseEntirePage - - VPages - 1 - WindowInfo - - CurrentSheet - 0 - ExpandedCanvases - - - name - Canvas 1 - - - Frame - {{277, 7}, {832, 871}} - ListView - - OutlineWidth - 142 - RightSidebar - - ShowRuler - - Sidebar - - SidebarWidth - 120 - VisibleRegion - {{96.5, 197.5}, {348.5, 366}} - Zoom - 2 - ZoomValues - - - Canvas 1 - 2 - 1 - - - - - diff --git a/examples/images/FrontendKernel.graffle/image1.png b/examples/images/FrontendKernel.graffle/image1.png deleted file mode 100644 index c01e3497f5b..00000000000 Binary files a/examples/images/FrontendKernel.graffle/image1.png and /dev/null differ diff --git a/examples/images/FrontendKernel.png b/examples/images/FrontendKernel.png deleted file mode 100644 index 62aa890274a..00000000000 Binary files a/examples/images/FrontendKernel.png and /dev/null differ diff --git a/examples/images/animation.m4v b/examples/images/animation.m4v deleted file mode 100644 index 13ecf88c5de..00000000000 Binary files a/examples/images/animation.m4v and /dev/null differ diff --git a/examples/images/ipython_logo.png b/examples/images/ipython_logo.png deleted file mode 100644 index e9bdce39415..00000000000 Binary files a/examples/images/ipython_logo.png and /dev/null differ diff --git a/examples/images/python_logo.svg b/examples/images/python_logo.svg deleted file mode 100644 index 116eaac3111..00000000000 --- a/examples/images/python_logo.svg +++ /dev/null @@ -1,269 +0,0 @@ - - - diff --git a/examples/utils/cwd_prompt.py b/examples/utils/cwd_prompt.py index 1d1b03ac66b..6accf4db212 100644 --- a/examples/utils/cwd_prompt.py +++ b/examples/utils/cwd_prompt.py @@ -1,26 +1,22 @@ -"""This is an example that shows how to create new prompts for IPython -""" +"""This is an example that shows how to create new prompts for IPython""" from IPython.terminal.prompts import Prompts, Token import os + class MyPrompt(Prompts): + def in_prompt_tokens(self): + return [(Token, os.getcwd()), (Token.Prompt, ">>>")] - def in_prompt_tokens(self, cli=None): - return [(Token, os.getcwd()), - (Token.Prompt, '>>>')] def load_ipython_extension(shell): new_prompts = MyPrompt(shell) new_prompts.old_prompts = shell.prompts shell.prompts = new_prompts + def unload_ipython_extension(shell): - if not hasattr(shell.prompts, 'old_prompts'): + if not hasattr(shell.prompts, "old_prompts"): print("cannot unload") else: shell.prompts = shell.prompts.old_prompts - - - - diff --git a/examples/utils/list_pyfiles.ipy b/examples/utils/list_pyfiles.ipy index 71a9e5d75ce..4b15482e766 100644 --- a/examples/utils/list_pyfiles.ipy +++ b/examples/utils/list_pyfiles.ipy @@ -3,4 +3,4 @@ from IPython.display import FileLink, display files =!ls *.py for f in files: - display(FileLink(f)) \ No newline at end of file + display(FileLink(f)) diff --git a/examples/utils/list_subdirs.ipy b/examples/utils/list_subdirs.ipy index a1bbb74ca9d..b8a16124565 100644 --- a/examples/utils/list_subdirs.ipy +++ b/examples/utils/list_subdirs.ipy @@ -4,4 +4,4 @@ from IPython.display import FileLinks, display dirs =!ls -d */ for d in dirs: if d != '__pycache__/': - display(FileLinks(d)) \ No newline at end of file + display(FileLinks(d)) diff --git a/mypy.ini b/mypy.ini deleted file mode 100644 index 7c1be49cd62..00000000000 --- a/mypy.ini +++ /dev/null @@ -1,4 +0,0 @@ -[mypy] -python_version = 3.8 -ignore_missing_imports = True -follow_imports = silent diff --git a/pyproject.toml b/pyproject.toml index c68b8c200f3..4114c2a254a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,585 @@ [build-system] -requires = ["setuptools >= 51.0.0", "wheel"] -build-backend = "setuptools.build_meta:__legacy__" +requires = ["setuptools>=80.0"] +# We need access to the 'setupbase' module at build time. +# Hence we declare a custom build backend. +build-backend = "_build_meta" # just re-exports setuptools.build_meta definitions +backend-path = ["."] + +[project] +name = "ipython" +description = "IPython: Productive Interactive Computing" +keywords = ["Interactive", "Interpreter", "Shell", "Embedding"] +classifiers = [ + "Framework :: IPython", + "Framework :: Jupyter", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Topic :: System :: Shells", +] +license = "BSD-3-Clause" +license-files = ["LICENSE", "COPYING.rst"] +requires-python = ">=3.11" +dependencies = [ + 'colorama>=0.4.4; sys_platform == "win32"', + "ipython-pygments-lexers>=1.0.0", + "jedi>=0.18.2", + "matplotlib-inline>=0.1.6", + 'pexpect>4.6; sys_platform != "win32" and sys_platform != "emscripten"', + "prompt_toolkit>=3.0.41,<3.1.0", + 'psutil>=7; sys_platform != "emscripten" and sys_platform != "cygwin"', + "pygments>=2.14.0", # wheel + "stack_data>=0.6.0", + "traitlets>=5.13.0", + "typing_extensions>=4.6; python_version<'3.12'", +] +dynamic = ["authors", "version"] + +[project.scripts] +ipython = "IPython:start_ipython" +ipython3 = "IPython:start_ipython" + +[project.readme] +file = "long_description.rst" +content-type = "text/x-rst" + +[project.urls] +Homepage = "https://ipython.org" +Documentation = "https://ipython.readthedocs.io/" +Funding = "https://jupyter.org/about#donate" +Source = "https://github.com/ipython/ipython" +Tracker = "https://github.com/ipython/ipython/issues" + +[project.optional-dependencies] +black = [ + "black", +] +doc = [ + "docrepr", + "exceptiongroup", + "intersphinx_registry", + "ipykernel", + "ipython[test,matplotlib]", + "setuptools>=80.0", + "sphinx_toml==0.0.4", + "sphinx-rtd-theme>=0.1.8", # wheel + "sphinx>=8.0", + "typing_extensions", +] +test = [ + "pytest>=7.0.0", # keep in sync with tool.pytest.ini_options.minversion + "pytest-asyncio>=1.0.0", + "testpath>=0.2", + "packaging>=23.0.0", + "setuptools>=80.0", +] +test_extra = [ + "ipython[test]", + "curio", + "jupyter_ai", + "ipython[matplotlib]", + "nbformat", + "nbclient", + "ipykernel>6.30", + "numpy>=2.0", + "pandas>2.1", + "trio>=0.22.0", +] +matplotlib = [ + "matplotlib>3.9" +] +all = [ + "ipython[doc,matplotlib,test,test_extra]", + "argcomplete>=3.0", +] + + +[tool.mypy] +python_version = "3.11" +ignore_missing_imports = true +follow_imports = 'silent' +exclude = [ + 'test_\.+\.py', + 'IPython.utils.tests.test_wildcard', + 'testing', + 'tests', + 'IPython/core/application.py', + 'IPython/core/profileapp.py', + 'IPython/lib/deepreload.py', + 'IPython/sphinxext/ipython_directive.py', + 'IPython/terminal/ipapp.py', + 'IPython/utils/path.py', + 'IPython/core/debugger_backport.py', +] +check_untyped_defs = true +disallow_untyped_calls = true +disallow_untyped_decorators = true +# ignore_errors = false +# ignore_missing_imports = false +disallow_incomplete_defs = true +disallow_untyped_defs = true +warn_redundant_casts = true +warn_unused_ignores = true +strict_equality = true +warn_unreachable = true +enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"] + +[[tool.mypy.overrides]] +module = "sphinx.*" +follow_imports = "skip" +#warn_unreachable = true +#strict = true + +[[tool.mypy.overrides]] +# numpy's stubs use PEP 695 `type` statements (3.12+), which mypy rejects +# when parsing under python_version = "3.11". Skip following its stubs. +module = "numpy.*" +follow_imports = "skip" +follow_imports_for_stubs = true + +[[tool.mypy.overrides]] +module = [ + "IPython.core.events", + "IPython.core.magic", + "IPython.utils._process_common", + "IPython.utils._process_win32", +] +# Strictest configuration, everything turned up to the max +check_untyped_defs = true +disallow_incomplete_defs = true +disallow_untyped_calls = true +disallow_untyped_decorators = true +disallow_untyped_defs = true +disallow_any_generics = true +disallow_subclassing_any = true +warn_return_any = true +warn_unused_ignores = true +warn_unreachable = true +strict_equality = true +no_implicit_optional = true +ignore_errors = false +ignore_missing_imports = false + +[[tool.mypy.overrides]] +module = [ + "IPython.core.ultratb", +] +check_untyped_defs = true +disallow_incomplete_defs = true +disallow_untyped_calls = false +disallow_untyped_decorators = true +disallow_untyped_defs = false +ignore_errors = false +ignore_missing_imports = false + +[[tool.mypy.overrides]] +module = [ + "IPython.core.crashhandler", + "IPython.utils.text", + "IPython.utils.PyColorize", + "IPython.utils.sentinel", + "IPython.utils.data", + "IPython.utils.importstring", + "IPython.utils.syspathcontext", + "IPython.utils.generics", + "IPython.utils.encoding", + "IPython.utils.module_paths", +] +check_untyped_defs = true +disallow_incomplete_defs = true +disallow_untyped_calls = true +disallow_untyped_decorators = true +disallow_untyped_defs = true +ignore_errors = false +ignore_missing_imports = false + +[[tool.mypy.overrides]] +module = [ + "IPython.core.debugger", +] +disallow_untyped_defs = false +ignore_errors = false +ignore_missing_imports = true +disallow_untyped_calls = false +disallow_incomplete_defs = false +check_untyped_defs = true +disallow_untyped_decorators = true + +[[tool.mypy.overrides]] +module = [ + "IPython.core.interactiveshell", +] +disallow_untyped_defs = false +ignore_errors = false +ignore_missing_imports = true +disallow_untyped_calls = false +disallow_incomplete_defs = false +check_untyped_defs = true +disallow_untyped_decorators = false +disable_error_code = [ + "arg-type", + "assignment", + "attr-defined", + "index", + "var-annotated", + "union-attr" +] + +# Newly promoted to type-checking (previously fully ignored). +# These pass a lenient check (real type errors surfaced) but are not yet +# fully annotated, so untyped defs are still permitted for now. +[[tool.mypy.overrides]] +module = [ + "IPython.core.async_helpers", + "IPython.core.builtin_trap", + "IPython.core.extensions", + "IPython.core.hooks", + "IPython.core.macro", + "IPython.core.magic_arguments", + "IPython.core.magics.ast_mod", + "IPython.core.payload", + "IPython.core.profiledir", + "IPython.external.qt_for_kernel", + "IPython.lib.guisupport", + "IPython.paths", + "IPython.sphinxext.ipython_console_highlighting", + "IPython.terminal.pt_inputhooks.asyncio", + "IPython.terminal.pt_inputhooks.gtk", + "IPython.terminal.pt_inputhooks.gtk3", + "IPython.terminal.pt_inputhooks.gtk4", + "IPython.terminal.pt_inputhooks.pyglet", + "IPython.terminal.pt_inputhooks.qt", + "IPython.terminal.pt_inputhooks.wx", + "IPython.terminal.ptutils", + "IPython.terminal.shortcuts.auto_match", + "IPython.utils._process_emscripten", + "IPython.utils.ipstruct", + "IPython.utils.process", + "IPython.utils.strdispatch", + "IPython.utils.terminal", +] +check_untyped_defs = true +disallow_incomplete_defs = false +disallow_untyped_defs = false +disallow_untyped_calls = false +disallow_untyped_decorators = false +ignore_errors = false +ignore_missing_imports = true + +# gloabl ignore error +[[tool.mypy.overrides]] +module = [ + "IPython", + "IPython.terminal.pt_inputhooks", + "IPython.terminal.shortcuts", + "IPython.core.alias", + "IPython.core.autocall", + "IPython.core.compilerop", + "IPython.core.completer", + "IPython.core.completerlib", + "IPython.core.display", + "IPython.core.display_functions", + "IPython.core.display_trap", + "IPython.core.displayhook", + "IPython.core.displaypub", + "IPython.core.formatters", + "IPython.core.getipython", + "IPython.core.guarded_eval", + "IPython.core.historyapp", + "IPython.core.inputtransformer2", + "IPython.core.logger", + "IPython.core.magics.auto", + "IPython.core.magics.basic", + "IPython.core.magics.code", + "IPython.core.magics.config", + "IPython.core.magics.display", + "IPython.core.magics.execution", + "IPython.core.magics.extension", + "IPython.core.magics.history", + "IPython.core.magics.logging", + "IPython.core.magics.namespace", + "IPython.core.magics.osm", + "IPython.core.magics.packaging", + "IPython.core.magics.pylab", + "IPython.core.magics.script", + "IPython.core.oinspect", + "IPython.core.page", + "IPython.core.payloadpage", + "IPython.core.prefilter", + "IPython.core.pylabtools", + "IPython.core.shellapp", + "IPython.core.splitinput", + "IPython.extensions.autoreload", + "IPython.extensions.storemagic", + "IPython.external.pickleshare", + "IPython.external.qt_loaders", + "IPython.lib.backgroundjobs", + "IPython.lib.clipboard", + "IPython.lib.demo", + "IPython.lib.display", + "IPython.lib.editorhooks", + "IPython.lib.latextools", + "IPython.lib.pretty", + "IPython.terminal.debugger", + "IPython.terminal.embed", + "IPython.terminal.interactiveshell", + "IPython.terminal.magics", + "IPython.terminal.prompts", + "IPython.terminal.pt_inputhooks.glut", + "IPython.terminal.pt_inputhooks.osx", + "IPython.terminal.pt_inputhooks.tk", + "IPython.terminal.shortcuts.auto_suggest", + "IPython.terminal.shortcuts.filters", + "IPython.utils.capture", + "IPython.utils.dir2", + "IPython.utils.io", + "IPython.utils.openpy", + "IPython.utils.tempdir", + "IPython.utils.timing", + "IPython.utils.tokenutil", + "IPython.utils.wildcard", + +] +disallow_untyped_defs = false +ignore_errors = true +ignore_missing_imports = true +disallow_untyped_calls = false +disallow_incomplete_defs = false +check_untyped_defs = true +disallow_untyped_decorators = false + +[tool.pytest.ini_options] +minversion = "7" # keep in sync with project.optional-dependencies.test +addopts = [ + "--durations=10", + "-pIPython.testing.plugin.pytest_ipdoctest", + "--ipdoctest-modules", + "--ignore=docs", + "--ignore=examples", + "--ignore=htmlcov", + "--ignore=ipython_kernel", + "--ignore=ipython_parallel", + "--ignore=results", + "--ignore=tmp", + "--ignore=tools", + "--ignore=traitlets", + "--ignore=tests/fake_ext_dir/", + "--ignore=IPython/sphinxext", + "--ignore=IPython/terminal/pt_inputhooks", + "--ignore=IPython/__main__.py", + "--ignore=IPython/external/qt_for_kernel.py", + "--ignore=IPython/utils/_process_posix.py" +] +doctest_optionflags = [ + "NORMALIZE_WHITESPACE", + "ELLIPSIS" +] +ipdoctest_optionflags = [ + "NORMALIZE_WHITESPACE", + "ELLIPSIS" +] +asyncio_mode = "strict" +filterwarnings = [ + "error::ResourceWarning", +] + +[tool.pyright] +pythonPlatform="All" + +[tool.setuptools] +zip-safe = false +platforms = ["Linux", "Mac OSX", "Windows"] +include-package-data = false + +[tool.setuptools.packages.find] +include = ["IPython*"] +exclude = ["setupext", "tests*"] +namespaces = false + +[tool.setuptools.package-data] +"IPython" = ["py.typed"] +"IPython.core" = ["profile/README*"] +"IPython.testing.plugin" = ["*.txt"] + +[tool.setuptools.dynamic] +version = {attr = "IPython.core.release.__version__"} + +[tool.coverage.run] +omit = [ + # omit everything in /tmp as we run tempfile + "/tmp/*", +] + +[tool.ruff.lint] +extend-select = [ + # "B", # flake8-bugbear + # "I", # isort + # that will be a problem for pytest fixture unless you swap with the usefixture decorator https://docs.pytest.org/en/7.1.x/how-to/fixtures.html#use-fixtures-in-classes-and-modules-with-usefixtures + # "ARG", # flake8-unused-arguments + # "C4", # flake8-comprehensions + # "EM", # flake8-errmsg + # "ICN", # flake8-import-conventions + # "G", # flake8-logging-format + # "PGH", # pygrep-hooks + # "PIE", # flake8-pie + # "PL", # pylint + # "PTH", # flake8-use-pathlib + # "PT", # flake8-pytest-style + # "RET", # flake8-return + # "RUF", # Ruff-specific + # "SIM", # flake8-simplify + # "T20", # flake8-print + # "UP", # pyupgrade + "UP004", # 1 [*] Class `...` inherits from `object` + # "UP006", # 1 [*] Use `list` instead of `t.List` for type annotation + # "UP006", # 1 [*] Use `tuple` instead of `t.Tuple` for type annotation + # "UP010", # 1 [*] Unnecessary `__future__` import `print_function` for target Python version + "UP011", # 1 [*] Unnecessary parentheses to `functools.lru_cache` + "UP018", # 1 [*] Unnecessary `bool` call (rewrite as a literal) + # "UP006", #182 [*] Use `...` instead of `...` for type annotation + # "UP007", # 5 Use `X | Y` for type annotations + # "UP007", #149 [*] Use `X | Y` for type annotations + # "UP008", # 63 Use `super()` instead of `super(__class__, self)` + # "UP009", # 61 [*] UTF-8 encoding declaration is unnecessary + "UP015", # 0 [*] Unnecessary open modes (0 violations, locked in) + # "UP017", # 2 [*] Use `datetime.UTC` alias + # "UP020", # 15 [*] Use builtin `open` + # "UP024", # 16 [*] Replace aliased errors with `OSError` + # "UP025", # 91 [*] Remove unicode literals from strings + "UP028", # 3 Replace `yield` over `for` loop with `yield from` + "UP029", # 1 Unnecessary builtin import + # "UP030", # 28 Use implicit references for positional format fields + # "UP032", # 75 [*] Use f-string instead of `format` call + "UP034", # 1 [*] Avoid extraneous parentheses + "UP035", # 0 [*] Deprecated typing imports (0 violations, locked in) + # "UP036", # 3 Version block is outdated for minimum Python version + "UP037", # 1 [*] Remove quotes from type annotation + # "UP038", # 21 Use `X | Y` in `isinstance` call instead of `(X, Y)` + "YTT", # flake8-2020 (0 violations, locked in) + "FURB", # refurb (readability/modernization) + "B008", # function-call-in-default-argument (0 violations, locked in) + "B022", # useless-contextlib-suppress (0 violations, locked in) + "B025", # duplicate-try-block-exception (0 violations, locked in) + "C420", # unnecessary-dict-comprehension-for-iterable (0 violations, locked in) + "PLW0127", # self-assigning-variable (0 violations, locked in) + "PLW0128", # redeclared-assigned-name (0 violations, locked in) + "PLW0406", # import-self (0 violations, locked in) + "RUF007", # zip-instead-of-pairwise (0 violations, locked in) + "S324", # hashlib-insecure-hash-function (0 violations, locked in) + "SIM110", # reimplemented-builtin (0 violations, locked in) + "SIM211", # if-expr-with-false-true (0 violations, locked in) + "TRY203", # useless-try-except (0 violations, locked in) + # "EXE", # flake8-executable (file-mode/shebang churn across examples) + # "PYI", # flake8-pyi (stub-oriented; little value on source) + # "ICN", # flake8-import-conventions (codebase uses plain `matplotlib`, not `mpl`) + # "RUF100", # unused `noqa` (entangled with the F401 global-ignore; strips intentional markers) + # "PT", # flake8-pytest-style (PT015 false-positives on non-test `assert False`) + # "S", # flake8-bandit +] +ignore = [ + # "E501", # E501 Line too long (158 > 100 characters) + # "SIM105", # SIM105 Use `contextlib.suppress(...)` + # "PLR", # Design related pylint codes + # "S101", # Use of `assert` detected + "UP031", # 297 Use format specifiers instead of percent format + "I001", # 162 unsorted imports + "BLE001", # 111 blind-except + "UP032", # 90 f-strings + "C408", # 33 unnecessary collection call + "SIM201", # 27 collapsible IF + "PLC0414", # WRONG CONFLICT WITH EXPLICT REEXPORT + "E713", # 1 Test for membership should be `not in` + "F601", # 3 Dictionary key literal `True` repeated (`True` hashes to the same value as `1`) + "E702", # 3 Multiple statements on one line (semicolon) + "E721", # 3 Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks + "E401", # 5 Multiple imports on one line + "E711", # 14 Comparison to `None` should be `cond is None` + "E701", # 19 Multiple statements on one line (colon) + "E741", # 25 Ambiguous variable name: `` + "E731", # 27 Do not assign a `lambda` expression, use a `def` + "E402", # 28 Module level import not at top of file + "E722", # 75 Do not use bare `except` + "F523", # 1 ; at end of line + "F403", # 7 import *` used; unable to detect undefined names + "F841", # 38 Local variable `...` is assigned to but never used + "F401", # 69 imported but unused + "F821", # 624 Undefined name + "FURB110", # prefer explicit `x if x else y` ternary over `x or y` (readability) + "SIM102", # collapsible-if + "S110", # try-except-pass + "PIE790", # unnecessary-placeholder + "RUF012", # mutable-class-default + "SIM115", # open-file-with-context-handler + "S102", # exec-builtin + "N999", # invalid-module-name + "SIM118", # in-dict-keys + "LOG015", # root-logger-call + "RUF059", # unused-unpacked-variable + "RUF022", # unsorted-dunder-all + "FLY002", # static-join-to-f-string + "RET501", # unnecessary-return-none + "T100", # debugger + "TRY002", # raise-vanilla-class + "RUF100", # unused-noqa + "UP020", # open-alias + "TRY004", # type-check-without-type-error + "B018", # useless-expression + "SIM114", # if-with-same-arms + "B009", # get-attr-with-constant + "C419", # unnecessary-comprehension-in-call + "DTZ005", # call-datetime-now-without-tzinfo + "EXE002", # shebang-missing-executable-file + "PIE810", # multiple-starts-ends-with + "RUF010", # explicit-f-string-type-conversion + "SIM103", # needless-bool + "UP009", # utf8-encoding-declaration + "B006", # mutable-argument-default + "PTH124", # py-path + "B004", # unreliable-callable-check + "EXE001", # shebang-not-executable + "G201", # logging-exc-info + "ISC004", # implicit-string-concatenation-in-collection-literal + "PIE794", # duplicate-class-field-definition + "PIE808", # unnecessary-range-start + "PLC0206", # dict-index-missing-items + "PLC0208", # iteration-over-set + "PLR1711", # useless-return + "PLW0120", # useless-else-on-loop + "PLW0602", # global-variable-not-assigned + "PLW1508", # invalid-envvar-default + "PYI034", # non-self-return-type + "RUF015", # unnecessary-iterable-allocation-for-first-element + "SIM101", # duplicate-isinstance-call + "SIM210", # if-expr-with-true-false + "SIM905", # split-static-string + "B010", # set-attr-with-constant + "B019", # cached-instance-method + "DTZ006", # call-datetime-fromtimestamp + "EXE005", # shebang-not-first-line + "PERF102", # incorrect-dict-iterator + "PIE800", # unnecessary-spread + "PLR0402", # manual-from-import + "PLR1722", # sys-exit-alias + "PLR1730", # if-stmt-min-max + "PLR2044", # empty-comment + "PYI036", # bad-exit-annotation + "PYI063", # pep484-style-positional-only-parameter + "SIM117", # multiple-with-statements + "UP036", # outdated-version-block +] +unfixable = [ + # Don't touch print statements + "T201", + # Don't touch noqa lines + "RUF100", +] + +[tool.ruff] +target-version = "py311" +extend-exclude = ["tests"] + +[tool.black] +# moved here from setup.cfg, where it had been in (ignored) INI syntax +exclude = 'timing\.py' diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index e0cfec07bdf..00000000000 --- a/pytest.ini +++ /dev/null @@ -1,47 +0,0 @@ -[pytest] -addopts = --durations=10 - -p IPython.testing.plugin.pytest_ipdoctest --ipdoctest-modules - --ignore=docs - --ignore=examples - --ignore=htmlcov - --ignore=ipython_kernel - --ignore=ipython_parallel - --ignore=results - --ignore=tmp - --ignore=tools - --ignore=traitlets - --ignore=IPython/core/tests/daft_extension - --ignore=IPython/sphinxext - --ignore=IPython/terminal/pt_inputhooks - --ignore=IPython/__main__.py - --ignore=IPython/config.py - --ignore=IPython/frontend.py - --ignore=IPython/html.py - --ignore=IPython/nbconvert.py - --ignore=IPython/nbformat.py - --ignore=IPython/parallel.py - --ignore=IPython/qt.py - --ignore=IPython/external/qt_for_kernel.py - --ignore=IPython/html/widgets/widget_link.py - --ignore=IPython/html/widgets/widget_output.py - --ignore=IPython/terminal/console.py - --ignore=IPython/terminal/ptshell.py - --ignore=IPython/utils/_process_cli.py - --ignore=IPython/utils/_process_posix.py - --ignore=IPython/utils/_process_win32.py - --ignore=IPython/utils/_process_win32_controller.py - --ignore=IPython/utils/daemonize.py - --ignore=IPython/utils/eventful.py - - --ignore=IPython/kernel - --ignore=IPython/consoleapp.py - --ignore=IPython/core/inputsplitter.py - --ignore=IPython/lib/kernel.py - --ignore=IPython/utils/jsonutil.py - --ignore=IPython/utils/localinterfaces.py - --ignore=IPython/utils/log.py - --ignore=IPython/utils/signatures.py - --ignore=IPython/utils/traitlets.py - --ignore=IPython/utils/version.py -doctest_optionflags = NORMALIZE_WHITESPACE ELLIPSIS -ipdoctest_optionflags = NORMALIZE_WHITESPACE ELLIPSIS diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index b9eadb806d6..00000000000 --- a/readthedocs.yml +++ /dev/null @@ -1,4 +0,0 @@ -conda: - file: docs/environment.yml -python: - version: 3 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 2027b531d02..00000000000 --- a/setup.cfg +++ /dev/null @@ -1,115 +0,0 @@ -[metadata] -name = ipython -version = attr: IPython.core.release.__version__ -url = https://ipython.org -description = IPython: Productive Interactive Computing -long_description_content_type = text/x-rst -long_description = file: long_description.rst -license_file = LICENSE -project_urls = - Documentation = https://ipython.readthedocs.io/ - Funding = https://numfocus.org/ - Source = https://github.com/ipython/ipython - Tracker = https://github.com/ipython/ipython/issues -keywords = Interactive, Interpreter, Shell, Embedding -platforms = Linux, Mac OSX, Windows -classifiers = - Framework :: IPython - Framework :: Jupyter - Intended Audience :: Developers - Intended Audience :: Science/Research - License :: OSI Approved :: BSD License - Programming Language :: Python - Programming Language :: Python :: 3 - Programming Language :: Python :: 3 :: Only - Topic :: System :: Shells - -[options] -packages = find: -python_requires = >=3.8 -zip_safe = False -install_requires = - appnope; sys_platform == "darwin" - backcall - colorama; sys_platform == "win32" - decorator - jedi>=0.16 - matplotlib-inline - pexpect>4.3; sys_platform != "win32" - pickleshare - prompt_toolkit>=2.0.0,<3.1.0,!=3.0.0,!=3.0.1 - pygments>=2.4.0 - setuptools>=18.5 - stack_data - traitlets>=5 - -[options.extras_require] -black = - black -doc = - Sphinx>=1.3 -kernel = - ipykernel -nbconvert = - nbconvert -nbformat = - nbformat -notebook = - ipywidgets - notebook -parallel = - ipyparallel -qtconsole = - qtconsole -terminal = -test = - pytest<7.1 - pytest-asyncio - testpath -test_extra = - %(test)s - curio - matplotlib!=3.2.0 - nbformat - numpy>=1.19 - pandas - trio -all = - %(black)s - %(doc)s - %(kernel)s - %(nbconvert)s - %(nbformat)s - %(notebook)s - %(parallel)s - %(qtconsole)s - %(terminal)s - %(test_extra)s - %(test)s - -[options.packages.find] -exclude = - setupext - -[options.package_data] -IPython.core = profile/README* -IPython.core.tests = *.png, *.jpg, daft_extension/*.py -IPython.lib.tests = *.wav -IPython.testing.plugin = *.txt - -[options.entry_points] -console_scripts = - ipython = IPython:start_ipython - ipython3 = IPython:start_ipython -pygments.lexers = - ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer - ipython = IPython.lib.lexers:IPythonLexer - ipython3 = IPython.lib.lexers:IPython3Lexer - -[velin] -ignore_patterns = - IPython/core/tests - IPython/testing - -[tool.black] -exclude = 'timing\.py' diff --git a/setup.py b/setup.py index 5614d3ef8c8..541985ec9df 100644 --- a/setup.py +++ b/setup.py @@ -23,36 +23,17 @@ # # This check is also made in IPython/__init__, don't forget to update both when # changing Python version requirements. -if sys.version_info < (3, 8): - pip_message = 'This may be due to an out of date pip. Make sure you have pip >= 9.0.1.' - try: - import pip - pip_version = tuple([int(x) for x in pip.__version__.split('.')[:3]]) - if pip_version < (9, 0, 1) : - pip_message = 'Your pip version is out of date, please install pip >= 9.0.1. '\ - 'pip {} detected.'.format(pip.__version__) - else: - # pip is new enough - it must be something else - pip_message = '' - except Exception: - pass - - +if sys.version_info < (3, 11): error = """ -IPython 8+ supports Python 3.8 and above, following NEP 29. -When using Python 2.7, please install IPython 5.x LTS Long Term Support version. -Python 3.3 and 3.4 were supported up to IPython 6.x. -Python 3.5 was supported with IPython 7.0 to 7.9. -Python 3.6 was supported with IPython up to 7.16. -Python 3.7 was still supported with the 7.x branch. - -See IPython `README.rst` file for more information: - - https://github.com/ipython/ipython/blob/master/README.rst +IPython 9.x supports Python 3.11 and above, following SPEC0 +IPython 8.19+ supports Python 3.10 and above, following SPEC0 +IPython 8.13+ supports Python 3.9 and above, following NEP 29. +IPython 8.0-8.12 supports Python 3.8 and above, following NEP 29. Python {py} detected. -{pip} -""".format(py=sys.version_info, pip=pip_message ) +""".format( + py=sys.version_info + ) print(error, file=sys.stderr) sys.exit(1) @@ -62,6 +43,7 @@ from setuptools import setup # Our own imports + from setupbase import target_update from setupbase import ( @@ -69,35 +51,14 @@ check_package_data_first, find_data_files, git_prebuild, - install_symlinked, - install_lib_symlink, - install_scripts_for_symlink, - unsymlink, ) -#------------------------------------------------------------------------------- -# Handle OS specific things -#------------------------------------------------------------------------------- - -if os.name in ('nt','dos'): - os_name = 'windows' -else: - os_name = os.name - -# Under Windows, 'sdist' has not been supported. Now that the docs build with -# Sphinx it might work, but let's not turn it on until someone confirms that it -# actually works. -if os_name == 'windows' and 'sdist' in sys.argv: - print('The sdist command is not available under Windows. Exiting.') - sys.exit(1) - - #------------------------------------------------------------------------------- # Things related to the IPython documentation #------------------------------------------------------------------------------- # update the manuals when building a source dist -if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'): +if len(sys.argv) >= 2 and sys.argv[1] == 'sdist': # List of things to be updated. Each entry is a triplet of args for # target_update() @@ -130,10 +91,6 @@ 'build_py': \ check_package_data_first(git_prebuild('IPython')), 'sdist' : git_prebuild('IPython', sdist), - 'symlink': install_symlinked, - 'install_lib_symlink': install_lib_symlink, - 'install_scripts_sym': install_scripts_for_symlink, - 'unsymlink': unsymlink, } #--------------------------------------------------------------------------- diff --git a/setupbase.py b/setupbase.py index b57dcc1b2a5..17b4dd0fe0f 100644 --- a/setupbase.py +++ b/setupbase.py @@ -13,6 +13,7 @@ # Distributed under the terms of the Modified BSD License. import os +from pathlib import Path import re import sys from glob import glob @@ -30,33 +31,19 @@ #------------------------------------------------------------------------------- # A few handy globals -isfile = os.path.isfile -pjoin = os.path.join -repo_root = os.path.dirname(os.path.abspath(__file__)) +repo_root = Path(__file__).resolve().parent -def execfile(fname, globs, locs=None): +def execfile(path, globs, locs=None): locs = locs or globs - with open(fname, encoding="utf-8") as f: - exec(compile(f.read(), fname, "exec"), globs, locs) - -# A little utility we'll need below, since glob() does NOT allow you to do -# exclusion on multiple endings! -def file_doesnt_endwith(test,endings): - """Return true if test is a file and its name does NOT end with any - of the strings listed in endings.""" - if not isfile(test): - return False - for e in endings: - if test.endswith(e): - return False - return True + with path.open(encoding="utf-8") as f: + exec(compile(f.read(), str(path), "exec"), globs, locs) #--------------------------------------------------------------------------- # Basic project information #--------------------------------------------------------------------------- # release.py contains version, authors, license, url, keywords, etc. -execfile(pjoin(repo_root, 'IPython','core','release.py'), globals()) +execfile(Path(repo_root, "IPython", "core", "release.py"), globals()) # Create a dict with the basic information # This dict is eventually passed to setup after additional keys are added. @@ -66,60 +53,21 @@ def file_doesnt_endwith(test,endings): license = license, ) - -#--------------------------------------------------------------------------- -# Find packages -#--------------------------------------------------------------------------- - -def find_packages(): - """ - Find all of IPython's packages. - """ - excludes = ['deathrow', 'quarantine'] - packages = [] - for directory, subdirs, files in os.walk("IPython"): - package = directory.replace(os.path.sep, ".") - if any(package.startswith("IPython." + exc) for exc in excludes): - # package is to be excluded (e.g. deathrow) - continue - if '__init__.py' not in files: - # not a package - continue - packages.append(package) - return packages - #--------------------------------------------------------------------------- -# Find package data +# Check package data #--------------------------------------------------------------------------- -def find_package_data(): - """ - Find IPython's package_data. - """ - # This is not enough for these things to appear in an sdist. - # We need to muck with the MANIFEST to get this to work - - package_data = { - 'IPython.core' : ['profile/README*'], - 'IPython.core.tests' : ['*.png', '*.jpg', 'daft_extension/*.py'], - 'IPython.lib.tests' : ['*.wav'], - 'IPython.testing.plugin' : ['*.txt'], - } - - return package_data - - def check_package_data(package_data): """verify that package_data globs make sense""" print("checking package data") for pkg, data in package_data.items(): - pkg_root = pjoin(*pkg.split('.')) + pkg_root = Path(*pkg.split(".")) for d in data: - path = pjoin(pkg_root, d) - if '*' in path: - assert len(glob(path)) > 0, "No files match pattern %s" % path + path = pkg_root / d + if "*" in str(path): + assert len(glob(str(path))) > 0, "No files match pattern %s" % path else: - assert os.path.exists(path), "Missing package data: %s" % path + assert path.exists(), f"Missing package data: {path}" def check_package_data_first(command): @@ -146,26 +94,26 @@ def find_data_files(): """ if "freebsd" in sys.platform: - manpagebase = pjoin('man', 'man1') + manpagebase = Path("man") / "man1" else: - manpagebase = pjoin('share', 'man', 'man1') + manpagebase = Path("share") / "man" / "man1" # Simple file lists can be made by hand - manpages = [f for f in glob(pjoin('docs','man','*.1.gz')) if isfile(f)] + manpages = [f for f in Path("docs/man").glob("*.1.gz") if f.is_file()] if not manpages: # When running from a source tree, the manpages aren't gzipped - manpages = [f for f in glob(pjoin('docs','man','*.1')) if isfile(f)] + manpages = [f for f in Path("docs/man").glob("*.1") if f.is_file()] # And assemble the entire output list - data_files = [ (manpagebase, manpages) ] + data_files = [(str(manpagebase), [str(f) for f in manpages])] return data_files # The two functions below are copied from IPython.utils.path, so we don't need -# to import IPython during setup, which fails on Python 3. +# to import IPython (and hence its dependencies) during setup. -def target_outdated(target,deps): +def target_outdated(target, deps): """Determine whether a target is out of date. target_outdated(target,deps) -> 1/0 @@ -177,19 +125,19 @@ def target_outdated(target,deps): true, otherwise return false. """ try: - target_time = os.path.getmtime(target) - except os.error: + target_time = Path(target).stat().st_mtime + except FileNotFoundError: return 1 for dep in deps: - dep_time = os.path.getmtime(dep) + dep_time = Path(dep).stat().st_mtime if dep_time > target_time: - #print "For target",target,"Dep failed:",dep # dbg - #print "times (dep,tar):",dep_time,target_time # dbg + # print("For target",target,"Dep failed:",dep) # dbg + # print("times (dep,tar):",dep_time,target_time) # dbg return 1 return 0 -def target_update(target,deps,cmd): +def target_update(target, deps, cmd): """Update a target with a given command given a list of dependencies. target_update(target,deps,cmd) -> runs cmd if target is outdated. @@ -197,96 +145,13 @@ def target_update(target,deps,cmd): This is just a wrapper around target_outdated() which calls the given command if target is outdated.""" - if target_outdated(target,deps): + if target_outdated(target, deps): os.system(cmd) -#--------------------------------------------------------------------------- -# Find scripts -#--------------------------------------------------------------------------- - -def find_entry_points(): - """Defines the command line entry points for IPython - - This always uses setuptools-style entry points. When setuptools is not in - use, our own build_scripts_entrypt class below parses these and builds - command line scripts. - - Each of our entry points gets both a plain name, e.g. ipython, and one - suffixed with the Python major version number, e.g. ipython3. - """ - ep = [ - 'ipython%s = IPython:start_ipython', - ] - suffix = str(sys.version_info[0]) - return [e % '' for e in ep] + [e % suffix for e in ep] - -class install_lib_symlink(Command): - user_options = [ - ('install-dir=', 'd', "directory to install to"), - ] - - def initialize_options(self): - self.install_dir = None - - def finalize_options(self): - self.set_undefined_options('symlink', - ('install_lib', 'install_dir'), - ) - - def run(self): - if sys.platform == 'win32': - raise Exception("This doesn't work on Windows.") - pkg = os.path.join(os.getcwd(), 'IPython') - dest = os.path.join(self.install_dir, 'IPython') - if os.path.islink(dest): - print('removing existing symlink at %s' % dest) - os.unlink(dest) - print('symlinking %s -> %s' % (pkg, dest)) - os.symlink(pkg, dest) - -class unsymlink(install): - def run(self): - dest = os.path.join(self.install_lib, 'IPython') - if os.path.islink(dest): - print('removing symlink at %s' % dest) - os.unlink(dest) - else: - print('No symlink exists at %s' % dest) - -class install_symlinked(install): - def run(self): - if sys.platform == 'win32': - raise Exception("This doesn't work on Windows.") - - # Run all sub-commands (at least those that need to be run) - for cmd_name in self.get_sub_commands(): - self.run_command(cmd_name) - - # 'sub_commands': a list of commands this command might have to run to - # get its work done. See cmd.py for more info. - sub_commands = [('install_lib_symlink', lambda self:True), - ('install_scripts_sym', lambda self:True), - ] - -class install_scripts_for_symlink(install_scripts): - """Redefined to get options from 'symlink' instead of 'install'. - - I love distutils almost as much as I love setuptools. - """ - def finalize_options(self): - self.set_undefined_options('build', ('build_scripts', 'build_dir')) - self.set_undefined_options('symlink', - ('install_scripts', 'install_dir'), - ('force', 'force'), - ('skip_build', 'skip_build'), - ) - - #--------------------------------------------------------------------------- # VCS related #--------------------------------------------------------------------------- - def git_prebuild(pkg_dir, build_cmd=build_py): """Return extended build or sdist command class for recording commit @@ -324,25 +189,24 @@ def _record_commit(self, base_dir): repo_commit, _ = proc.communicate() repo_commit = repo_commit.strip().decode("ascii") - out_pth = pjoin(base_dir, pkg_dir, 'utils', '_sysinfo.py') - if os.path.isfile(out_pth) and not repo_commit: + out_pth = Path(base_dir) / pkg_dir / "utils" / "_sysinfo.py" + if out_pth.is_file() and not repo_commit: # nothing to write, don't clobber return - print("writing git commit '%s' to %s" % (repo_commit, out_pth)) + print(f"writing git commit '{repo_commit}' to {out_pth}") # remove to avoid overwriting original via hard link try: - os.remove(out_pth) - except (IOError, OSError): + out_pth.unlink() + except FileNotFoundError: pass - with open(out_pth, "w", encoding="utf-8") as out_file: + with out_pth.open("w", encoding="utf-8") as out_file: out_file.writelines( [ "# GENERATED BY setup.py\n", - 'commit = u"%s"\n' % repo_commit, + f'commit = "{repo_commit}"\n', ] ) return MyBuildPy - diff --git a/IPython/core/tests/2x2.jpg b/tests/2x2.jpg similarity index 100% rename from IPython/core/tests/2x2.jpg rename to tests/2x2.jpg diff --git a/IPython/core/tests/2x2.png b/tests/2x2.png similarity index 100% rename from IPython/core/tests/2x2.png rename to tests/2x2.png diff --git a/IPython/lib/tests/__init__.py b/tests/__init__.py similarity index 100% rename from IPython/lib/tests/__init__.py rename to tests/__init__.py diff --git a/IPython/core/tests/bad_all.py b/tests/bad_all.py similarity index 65% rename from IPython/core/tests/bad_all.py rename to tests/bad_all.py index a7716ab6f32..0d50bf01ffe 100644 --- a/IPython/core/tests/bad_all.py +++ b/tests/bad_all.py @@ -3,12 +3,16 @@ To test https://github.com/ipython/ipython/issues/9678 """ + def evil(): pass + def puppies(): pass -__all__ = [evil, # Bad - 'puppies', # Good - ] + +__all__ = [ + evil, # Bad + "puppies", # Good +] diff --git a/IPython/conftest.py b/tests/conftest.py similarity index 68% rename from IPython/conftest.py rename to tests/conftest.py index abf61314798..6368d342804 100644 --- a/IPython/conftest.py +++ b/tests/conftest.py @@ -11,24 +11,12 @@ # Must register before it gets imported pytest.register_assert_rewrite("IPython.testing.tools") -from .testing import tools - - -def pytest_collection_modifyitems(items): - """This function is automatically run by pytest passing all collected test - functions. - - We use it to add asyncio marker to all async tests and assert we don't use - test functions that are async generators which wouldn't make sense. - """ - for item in items: - if inspect.iscoroutinefunction(item.obj): - item.add_marker("asyncio") - assert not inspect.isasyncgenfunction(item.obj) +from IPython.testing import tools def get_ipython(): - from .terminal.interactiveshell import TerminalInteractiveShell + from IPython.terminal.interactiveshell import TerminalInteractiveShell + if TerminalInteractiveShell._instance: return TerminalInteractiveShell.instance() @@ -40,12 +28,14 @@ def get_ipython(): return shell -@pytest.fixture(scope='session', autouse=True) +@pytest.fixture(scope="session", autouse=True) def work_path(): path = pathlib.Path("./tmp-ipython-pytest-profiledir") os.environ["IPYTHONDIR"] = str(path.absolute()) if path.exists(): - raise ValueError('IPython dir temporary path already exists ! Did previous test run exit successfully ?') + raise ValueError( + "IPython dir temporary path already exists ! Did previous test run exit successfully ?" + ) path.mkdir() yield shutil.rmtree(str(path.resolve())) @@ -58,8 +48,7 @@ def nopage(strng, start=0, screen_lines=0, pager_cmd=None): def xsys(self, cmd): - """Replace the default system call with a capturing one for doctest. - """ + """Replace the default system call with a capturing one for doctest.""" # We use getoutput, but we need to strip it because pexpect captures # the trailing newline differently from commands.getoutput print(self.getoutput(cmd, split=False, depth=1).rstrip(), end="", file=sys.stdout) @@ -70,17 +59,22 @@ def xsys(self, cmd): # unfortunately this will fail on some test that get executed as _collection_ # time (before the fixture run), in particular parametrized test that contain # yields. so for now execute at import time. -#@pytest.fixture(autouse=True, scope='session') +# @pytest.fixture(autouse=True, scope='session') def inject(): - builtins.get_ipython = get_ipython builtins._ip = get_ipython() builtins.ip = get_ipython() builtins.ip.system = types.MethodType(xsys, ip) builtins.ip.builtin_trap.activate() - from .core import page + from IPython.core import page page.pager_page = nopage + + from IPython.core.history import HistoryManager + + # ensure we don't leak History managers + if os.name != "nt": + HistoryManager._max_inst = 1 # yield diff --git a/IPython/core/tests/daft_extension/daft_extension.py b/tests/fake_ext_dir/daft_extension.py similarity index 90% rename from IPython/core/tests/daft_extension/daft_extension.py rename to tests/fake_ext_dir/daft_extension.py index 37fefe31459..415e136d4e9 100644 --- a/IPython/core/tests/daft_extension/daft_extension.py +++ b/tests/fake_ext_dir/daft_extension.py @@ -2,11 +2,13 @@ """ Useless IPython extension to test installing and loading extensions. """ -some_vars = {'arq': 185} +some_vars = {"arq": 185} + def load_ipython_extension(ip): # set up simplified quantity input ip.push(some_vars) + def unload_ipython_extension(ip): ip.drop_by_id(some_vars) diff --git a/tests/fake_llm.py b/tests/fake_llm.py new file mode 100644 index 00000000000..ceacc5a8ea5 --- /dev/null +++ b/tests/fake_llm.py @@ -0,0 +1,102 @@ +import asyncio +from time import sleep + +try: + from jupyter_ai_magics.providers import BaseProvider + from langchain_community.llms import FakeListLLM +except ImportError: + + class BaseProvider: + pass + + class FakeListLLM: + pass + + +FIBONACCI = """\ +def fib(n): + if n < 2: return n + return fib(n - 1) + fib(n - 2) +""" + + +class FibonacciCompletionProvider(BaseProvider, FakeListLLM): # type: ignore[misc, valid-type] + id = "my_provider" + name = "My Provider" + model_id_key = "model" + models = ["model_a"] + + def __init__(self, **kwargs): + kwargs["responses"] = ["This fake response will not be used for completion"] + kwargs["model_id"] = "model_a" + super().__init__(**kwargs) + + async def generate_inline_completions(self, request): + raise ValueError("IPython only supports streaming models.") + + async def stream_inline_completions(self, request): + from jupyter_ai.completions.models import ( + InlineCompletionList, + InlineCompletionReply, + ) + + assert request.number > 0 + token = f"t{request.number}s0" + last_line = request.prefix.splitlines()[-1] + + if not FIBONACCI.startswith(last_line): + return + + yield InlineCompletionReply( + list=InlineCompletionList( + items=[ + {"insertText": "", "isIncomplete": True, "token": token}, + ] + ), + reply_to=request.number, + ) + + async for reply in self._stream( + FIBONACCI[len(last_line) :], + request.number, + token, + ): + yield reply + + async def _stream(self, sentence, request_number, token, start_with=""): + from jupyter_ai.completions.models import InlineCompletionStreamChunk + + suggestion = start_with + + for fragment in sentence.split(" "): + await asyncio.sleep(0.05) + if suggestion: + suggestion += " " + suggestion += fragment + yield InlineCompletionStreamChunk( + type="stream", + response={"insertText": suggestion, "token": token}, + reply_to=request_number, + done=False, + ) + + # finally, send a message confirming that we are done + yield InlineCompletionStreamChunk( + type="stream", + response={"insertText": suggestion, "token": token}, + reply_to=request_number, + done=True, + ) + + +class SlowStartingCompletionProvider(BaseProvider, FakeListLLM): # type: ignore[misc, valid-type] + id = "slow_provider" + name = "Slow Provider" + model_id_key = "model" + models = ["model_a"] + + def __init__(self, **kwargs): + kwargs["responses"] = ["This fake response will be used for completion"] + kwargs["model_id"] = "model_a" + sleep(10) + super().__init__(**kwargs) diff --git a/IPython/core/tests/nonascii.py b/tests/nonascii.py similarity index 91% rename from IPython/core/tests/nonascii.py rename to tests/nonascii.py index 78801dfd093..12738e3adc2 100644 --- a/IPython/core/tests/nonascii.py +++ b/tests/nonascii.py @@ -1,4 +1,4 @@ # coding: iso-8859-5 # (Unlikely to be the default encoding for most testers.) # �� <- Cyrillic characters -u = '��' +u = "��" diff --git a/IPython/core/tests/nonascii2.py b/tests/nonascii2.py similarity index 50% rename from IPython/core/tests/nonascii2.py rename to tests/nonascii2.py index a1afce4f3ef..b87ceb0a1b8 100644 --- a/IPython/core/tests/nonascii2.py +++ b/tests/nonascii2.py @@ -1,4 +1,4 @@ # coding: iso-8859-5 # (Unlikely to be the default encoding for most testers.) -# БЖџрстуфхцчшщъыьэюя <- Cyrillic characters -'Ўт№Ф' +# �� <- Cyrillic characters +"��" diff --git a/IPython/core/tests/print_argv.py b/tests/print_argv.py similarity index 96% rename from IPython/core/tests/print_argv.py rename to tests/print_argv.py index 0e92bddcb06..4ec9e2799ed 100644 --- a/IPython/core/tests/print_argv.py +++ b/tests/print_argv.py @@ -1,2 +1,3 @@ import sys + print(sys.argv[1:]) diff --git a/IPython/core/tests/refbug.py b/tests/refbug.py similarity index 63% rename from IPython/core/tests/refbug.py rename to tests/refbug.py index 92e2eead347..07aa6acdc99 100644 --- a/IPython/core/tests/refbug.py +++ b/tests/refbug.py @@ -13,34 +13,33 @@ test_run.py calls it. """ -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Module imports -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- from IPython import get_ipython -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Globals -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # This needs to be here because nose and other test runners will import # this module. Importing this module has potential side effects that we # want to prevent. -if __name__ == '__main__': - +if __name__ == "__main__": ip = get_ipython() - if not '_refbug_cache' in ip.user_ns: - ip.user_ns['_refbug_cache'] = [] + if not "_refbug_cache" in ip.user_ns: + ip.user_ns["_refbug_cache"] = [] + aglobal = "Hello" - aglobal = 'Hello' def f(): return aglobal - cache = ip.user_ns['_refbug_cache'] + cache = ip.user_ns["_refbug_cache"] cache.append(f) def call_f(): for func in cache: - print('lowercased:',func().lower()) + print("lowercased:", func().lower()) diff --git a/IPython/core/tests/simpleerr.py b/tests/simpleerr.py similarity index 74% rename from IPython/core/tests/simpleerr.py rename to tests/simpleerr.py index f85e2d6b925..28464c329d2 100644 --- a/IPython/core/tests/simpleerr.py +++ b/tests/simpleerr.py @@ -1,11 +1,14 @@ """Error script. DO NOT EDIT FURTHER! It will break exception doctests!!!""" + import sys + def div0(): "foo" x = 1 y = 0 - x/y + x / y + def sysexit(stat, mode): raise SystemExit(stat, f"Mode = {mode}") @@ -13,21 +16,22 @@ def sysexit(stat, mode): def bar(mode): "bar" - if mode=='div': + if mode == "div": div0() - elif mode=='exit': + elif mode == "exit": try: stat = int(sys.argv[2]) except: stat = 1 sysexit(stat, mode) else: - raise ValueError('Unknown mode') + raise ValueError("Unknown mode") + -if __name__ == '__main__': +if __name__ == "__main__": try: mode = sys.argv[1] except IndexError: - mode = 'div' + mode = "div" bar(mode) diff --git a/IPython/core/tests/tclass.py b/tests/tclass.py similarity index 78% rename from IPython/core/tests/tclass.py rename to tests/tclass.py index 6bd9ffcd9a0..5160e171b23 100644 --- a/IPython/core/tests/tclass.py +++ b/tests/tclass.py @@ -2,33 +2,34 @@ See test_run for details.""" - import sys + # We want to ensure that while objects remain available for immediate access, # objects from *previous* runs of the same script get collected, to avoid # accumulating massive amounts of old references. class C(object): - def __init__(self,name): + def __init__(self, name): self.name = name self.p = print self.flush_stdout = sys.stdout.flush - + def __del__(self): - self.p('tclass.py: deleting object:',self.name) + self.p("tclass.py: deleting object:", self.name) self.flush_stdout() + try: name = sys.argv[1] except IndexError: pass else: - if name.startswith('C'): + if name.startswith("C"): c = C(name) -#print >> sys.stderr, "ARGV:", sys.argv # dbg +# print("ARGV:", sys.argv, file=sys.stderr) # dbg # This next print statement is NOT debugging, we're making the check on a # completely separate process so we verify by capturing stdout: -print('ARGV 1-:', sys.argv[1:]) +print("ARGV 1-:", sys.argv[1:]) sys.stdout.flush() diff --git a/IPython/lib/tests/test.wav b/tests/test.wav similarity index 100% rename from IPython/lib/tests/test.wav rename to tests/test.wav diff --git a/IPython/core/tests/test_alias.py b/tests/test_alias.py similarity index 82% rename from IPython/core/tests/test_alias.py rename to tests/test_alias.py index 32d2e2f711e..c92aa839460 100644 --- a/IPython/core/tests/test_alias.py +++ b/tests/test_alias.py @@ -2,8 +2,9 @@ import pytest + def test_alias_lifecycle(): - name = 'test_alias1' + name = "test_alias1" cmd = 'echo "Hello"' am = _ip.alias_manager am.clear_aliases() @@ -11,32 +12,32 @@ def test_alias_lifecycle(): assert am.is_alias(name) assert am.retrieve_alias(name) == cmd assert (name, cmd) in am.aliases - + # Test running the alias orig_system = _ip.system result = [] _ip.system = result.append try: - _ip.run_cell('%{}'.format(name)) + _ip.run_cell("%{}".format(name)) result = [c.strip() for c in result] assert result == [cmd] finally: _ip.system = orig_system - + # Test removing the alias am.undefine_alias(name) assert not am.is_alias(name) with pytest.raises(ValueError): am.retrieve_alias(name) assert (name, cmd) not in am.aliases - + def test_alias_args_error(): """Error expanding with wrong number of arguments""" - _ip.alias_manager.define_alias('parts', 'echo first %s second %s') + _ip.alias_manager.define_alias("parts", "echo first %s second %s") # capture stderr: with capture_output() as cap: - _ip.run_cell('parts 1') + _ip.run_cell("parts 1") assert cap.stderr.split(":")[0] == "UsageError" @@ -51,16 +52,17 @@ def test_alias_args_commented(): # strip() is for pytest compat; testing via iptest patch IPython shell # in testing.globalipapp and replace the system call which messed up the # \r\n - assert cap.stdout.strip() == 'this is %s a commented out arg' + assert cap.stdout.strip() == "this is %s a commented out arg" + def test_alias_args_commented_nargs(): """Check that alias correctly counts args, excluding those commented out""" am = _ip.alias_manager - alias_name = 'comargcount' - cmd = 'echo this is %%s a commented out arg and this is not %s' - + alias_name = "comargcount" + cmd = "echo this is %%s a commented out arg and this is not %s" + am.define_alias(alias_name, cmd) assert am.is_alias(alias_name) - + thealias = am.get_alias(alias_name) assert thealias.nargs == 1 diff --git a/tests/test_application.py b/tests/test_application.py new file mode 100644 index 00000000000..04f483122e3 --- /dev/null +++ b/tests/test_application.py @@ -0,0 +1,392 @@ +# coding: utf-8 +"""Tests for IPython.core.application""" + +import os +import sys +import tempfile + +from tempfile import TemporaryDirectory + +import pytest +from traitlets import Unicode +from traitlets.config import Config + +from IPython.core.application import ( + LOGGING_CRITICAL, + LOGGING_DEBUG, + BaseIPythonApplication, + base_flags, +) +from IPython.core.profiledir import ProfileDir +from IPython.testing import decorators as dec + + +def test_logging_level_constants(): + """The inlined logging levels must not drift from the `logging` ones. + + `IPython.core.application` spells these out rather than importing + `logging` at startup; this is the check that keeps the copies honest. + """ + import logging + + assert LOGGING_DEBUG == logging.DEBUG + assert LOGGING_CRITICAL == logging.CRITICAL + assert base_flags["debug"][0]["Application"]["log_level"] == logging.DEBUG + assert base_flags["quiet"][0]["Application"]["log_level"] == logging.CRITICAL + + +@pytest.fixture +def preserve_excepthook(): + """initialize() installs a crash handler; restore sys.excepthook afterwards.""" + orig = sys.excepthook + yield + sys.excepthook = orig + + +def _clear_singletons(app): + """Unregister singleton instances created by the subcommand machinery.""" + from traitlets.config.configurable import SingletonConfigurable + + while app is not None: + for klass in type(app).__mro__: + if klass is SingletonConfigurable: + break + if getattr(klass, "_instance", None) is app: + klass._instance = None + app = getattr(app, "subapp", None) + + +@dec.onlyif_unicode_paths +def test_unicode_cwd(): + """Check that IPython starts with non-ascii characters in the path.""" + wd = tempfile.mkdtemp(suffix="€") + + old_wd = os.getcwd() + os.chdir(wd) + # raise Exception(repr(os.getcwd())) + try: + app = BaseIPythonApplication() + # The lines below are copied from Application.initialize() + app.init_profile_dir() + app.init_config_files() + app.load_config_file(suppress_errors=False) + finally: + os.chdir(old_wd) + + +@dec.onlyif_unicode_paths +def test_unicode_ipdir(): + """Check that IPython starts with non-ascii characters in the IP dir.""" + ipdir = tempfile.mkdtemp(suffix="€") + + # Create the config file, so it tries to load it. + with open(os.path.join(ipdir, "ipython_config.py"), "w", encoding="utf-8") as f: + pass + + old_ipdir1 = os.environ.pop("IPYTHONDIR", None) + old_ipdir2 = os.environ.pop("IPYTHON_DIR", None) + os.environ["IPYTHONDIR"] = ipdir + try: + app = BaseIPythonApplication() + # The lines below are copied from Application.initialize() + app.init_profile_dir() + app.init_config_files() + app.load_config_file(suppress_errors=False) + finally: + if old_ipdir1: + os.environ["IPYTHONDIR"] = old_ipdir1 + if old_ipdir2: + os.environ["IPYTHONDIR"] = old_ipdir2 + + +def test_cli_priority(): + with TemporaryDirectory() as td: + + class TestApp(BaseIPythonApplication): + test = Unicode().tag(config=True) + + # Create the config file, so it tries to load it. + with open(os.path.join(td, "ipython_config.py"), "w", encoding="utf-8") as f: + f.write("c.TestApp.test = 'config file'") + + app = TestApp() + app.initialize(["--profile-dir", td]) + assert app.test == "config file" + app = TestApp() + app.initialize(["--profile-dir", td, "--TestApp.test=cli"]) + assert app.test == "cli" + + +def test_extra_config_file(tmp_path, preserve_excepthook): + """--config loads an extra config file on top of the profile config.""" + + class ConfApp(BaseIPythonApplication): + test = Unicode().tag(config=True) + + profile_dir = tmp_path / "profile" + profile_dir.mkdir() + extra = tmp_path / "extra_config.py" + extra.write_text("c.ConfApp.test = 'extra'", encoding="utf-8") + + app = ConfApp() + app.initialize(["--profile-dir", str(profile_dir), "--config", str(extra)]) + assert app.extra_config_file == str(extra) + assert str(extra) in app.config_files + assert app.test == "extra" + + +def test_extra_config_file_missing(tmp_path, preserve_excepthook): + """A missing --config file is only warned about, not fatal.""" + profile_dir = tmp_path / "profile" + profile_dir.mkdir() + missing = tmp_path / "nonexistent_config.py" + app = BaseIPythonApplication() + app.initialize(["--profile-dir", str(profile_dir), "--config", str(missing)]) + assert app.extra_config_file == str(missing) + + +def test_bad_config_file(tmp_path, preserve_excepthook): + """Errors in config files are suppressed or raised per suppress_errors.""" + from traitlets.config import Application + + profile_dir = tmp_path / "profile" + profile_dir.mkdir() + bad = tmp_path / "bad_config.py" + bad.write_text("1/0", encoding="utf-8") + + app = BaseIPythonApplication() + # by default, errors in config files are logged, not raised + app.initialize(["--profile-dir", str(profile_dir), "--config", str(bad)]) + # make the underlying traitlets loader raise, to exercise IPython's + # suppress_errors handling + app.raise_config_file_errors = True + orig = Application.raise_config_file_errors + try: + # suppressed: only a warning is logged + app.load_config_file(suppress_errors=True) + # not suppressed: the error propagates + with pytest.raises(ZeroDivisionError): + app.load_config_file(suppress_errors=False) + finally: + # load_config_file toggles the class-level attribute and cannot + # restore it when the error propagates + Application.raise_config_file_errors = orig + + +def test_config_file_name_changed(): + app = BaseIPythonApplication() + app.config_file_name = "other_config.py" + assert "other_config.py" in app.config_file_specified + + +def test_profile_dir_autocreate_by_name(tmp_path, monkeypatch): + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + app = BaseIPythonApplication(profile="fresh", auto_create=True) + app.init_profile_dir() + assert (tmp_path / "profile_fresh").is_dir() + assert app.profile_dir.location == str(tmp_path / "profile_fresh") + + +def test_profile_not_found_by_name(tmp_path, monkeypatch): + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + app = BaseIPythonApplication(profile="nope") + with pytest.raises(SystemExit): + app.init_profile_dir() + + +def test_profile_dir_lazy_default(tmp_path, monkeypatch): + """Accessing profile_dir forces profile dir initialization.""" + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + app = BaseIPythonApplication() + assert app.profile_dir.location == str(tmp_path / "profile_default") + # a second call is a no-op + app.init_profile_dir() + assert app.profile_dir.location == str(tmp_path / "profile_default") + + +def test_profile_create_by_name_fails(tmp_path, monkeypatch): + """exit(1) if the profile dir cannot be created.""" + from IPython.core.profiledir import ProfileDirError + + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + + def raise_profile_dir_error(*args, **kwargs): + raise ProfileDirError("cannot create") + + monkeypatch.setattr( + ProfileDir, "create_profile_dir_by_name", raise_profile_dir_error + ) + app = BaseIPythonApplication(profile="fresh", auto_create=True) + with pytest.raises(SystemExit): + app.init_profile_dir() + + +def test_profile_create_by_location_fails(tmp_path, monkeypatch): + """exit(1) if the profile dir at an explicit location cannot be created.""" + from IPython.core.profiledir import ProfileDirError + + def raise_profile_dir_error(*args, **kwargs): + raise ProfileDirError("cannot create") + + monkeypatch.setattr(ProfileDir, "create_profile_dir", raise_profile_dir_error) + cfg = Config() + cfg.ProfileDir.location = str(tmp_path / "profile_xyz") + app = BaseIPythonApplication(config=cfg, auto_create=True) + with pytest.raises(SystemExit): + app.init_profile_dir() + + +def test_copy_config_files_from_builtin(tmp_path, monkeypatch): + """copy_config_files stages an existing builtin config file.""" + monkeypatch.setenv("IPYTHONDIR", str(tmp_path / "ip")) + builtin = tmp_path / "builtin" + builtin.mkdir() + (builtin / "ipython_config.py").write_text("# builtin config\n", encoding="utf-8") + + app = BaseIPythonApplication(copy_config_files=True) + app.builtin_profile_dir = str(builtin) + app.init_profile_dir() + app.init_config_files() + staged = tmp_path / "ip" / "profile_default" / "ipython_config.py" + assert staged.read_text(encoding="utf-8") == "# builtin config\n" + + +def test_stage_bundled_config_files(tmp_path, monkeypatch): + """bundled config files are staged even without copy_config_files.""" + monkeypatch.setenv("IPYTHONDIR", str(tmp_path / "ip")) + builtin = tmp_path / "builtin" + builtin.mkdir() + (builtin / "extra_bundled.py").write_text("# bundled\n", encoding="utf-8") + + app = BaseIPythonApplication() + app.builtin_profile_dir = str(builtin) + app.init_profile_dir() + app.init_config_files() + staged = tmp_path / "ip" / "profile_default" / "extra_bundled.py" + assert staged.read_text(encoding="utf-8") == "# bundled\n" + + +def test_profile_dir_autocreate_by_location(tmp_path): + location = tmp_path / "profile_xyz" + cfg = Config() + cfg.ProfileDir.location = str(location) + app = BaseIPythonApplication(config=cfg, auto_create=True) + app.init_profile_dir() + assert location.is_dir() + # profile name is derived from the directory name + assert app.profile == "xyz" + + +def test_profile_dir_location_not_found(tmp_path): + cfg = Config() + cfg.ProfileDir.location = str(tmp_path / "does_not_exist") + app = BaseIPythonApplication(config=cfg) + with pytest.raises(SystemExit): + app.init_profile_dir() + + +def test_add_ipython_dir_to_sys_path(tmp_path, monkeypatch): + monkeypatch.setenv("IPYTHONDIR", str(tmp_path / "default")) + app = BaseIPythonApplication(add_ipython_dir_to_sys_path=True) + ipdir = tmp_path / "ipdir" + try: + app.ipython_dir = str(ipdir) + assert os.path.abspath(str(ipdir)) in sys.path + assert (ipdir / "extensions").is_dir() + assert (ipdir / "nbextensions").is_dir() + + # changing the dir removes the old entry from sys.path + ipdir2 = tmp_path / "ipdir2" + app.ipython_dir = str(ipdir2) + assert os.path.abspath(str(ipdir)) not in sys.path + assert os.path.abspath(str(ipdir2)) in sys.path + finally: + for d in (tmp_path / "default", ipdir, tmp_path / "ipdir2"): + try: + sys.path.remove(os.path.abspath(str(d))) + except ValueError: + pass + + +def test_excepthook_lite(preserve_excepthook, capsys): + """without verbose_crash, the light crash handler prints a traceback.""" + app = BaseIPythonApplication() + app.init_crash_handler() + assert sys.excepthook == app.excepthook + try: + raise ValueError("some error message") + except ValueError: + app.excepthook(*sys.exc_info()) + err = capsys.readouterr().err + assert "some error message" in err + assert "https://github.com/ipython/ipython/issues" in err + + +def test_excepthook_verbose_crash(tmp_path, monkeypatch, preserve_excepthook, capsys): + """with verbose_crash, a crash report is written into the ipython dir.""" + monkeypatch.setattr("builtins.input", lambda *args: "") + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + app = BaseIPythonApplication(verbose_crash=True) + app.init_crash_handler() + try: + raise ValueError("crashing for the test") + except ValueError: + app.excepthook(*sys.exc_info()) + report = tmp_path / "Crash_report_ipython.txt" + assert report.exists() + content = report.read_text(encoding="utf-8") + assert "IPython post-mortem report" in content + assert "crashing for the test" in content + + +def test_load_subconfig_profile_aware(tmp_path, monkeypatch, preserve_excepthook): + """load_subconfig(..., profile='name') loads config from another profile.""" + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + + class SubCfgApp(BaseIPythonApplication): + test = Unicode().tag(config=True) + + sub = ProfileDir.create_profile_dir_by_name(tmp_path, "sub") + with open( + os.path.join(sub.location, "extra_sub.py"), "w", encoding="utf-8" + ) as f: + f.write("c.SubCfgApp.test = 'from sub profile'") + + main = ProfileDir.create_profile_dir_by_name(tmp_path, "default") + with open( + os.path.join(main.location, "ipython_config.py"), "w", encoding="utf-8" + ) as f: + f.write( + "load_subconfig('extra_sub.py', profile='sub')\n" + # missing profiles are silently ignored + "load_subconfig('extra_sub.py', profile='no_such_profile')\n" + ) + + app = SubCfgApp() + app.initialize([]) + assert app.test == "from sub profile" + + +def test_initialize_stops_at_subapp(tmp_path, monkeypatch, preserve_excepthook): + """initialize() stops early when a subcommand takes over.""" + from IPython.terminal.ipapp import TerminalIPythonApp + + monkeypatch.setenv("IPYTHONDIR", str(tmp_path)) + app = TerminalIPythonApp() + app.initialize(["profile", "list", "--ipython-dir", str(tmp_path)]) + try: + assert app.subapp is not None + # profile dir initialization is skipped when a subapp takes over + assert not (tmp_path / "profile_default").exists() + finally: + _clear_singletons(app) + + +def test_cwd_disappeared(monkeypatch): + """exit(1) if the current working directory no longer exists.""" + def missing_cwd(): + raise OSError("cwd does not exist") + + monkeypatch.setattr(os, "getcwd", missing_cwd) + with pytest.raises(SystemExit): + BaseIPythonApplication() diff --git a/tests/test_async_helpers.py b/tests/test_async_helpers.py new file mode 100644 index 00000000000..b79fd8ae7f8 --- /dev/null +++ b/tests/test_async_helpers.py @@ -0,0 +1,473 @@ +""" +Test for async helpers. + +Should only trigger on python 3.5+ or will have syntax errors. +""" + +import contextlib +import sys +from itertools import chain, repeat +from textwrap import dedent, indent +from typing import TYPE_CHECKING + +import pytest + +from IPython.core.async_helpers import _should_be_async +from IPython.testing.decorators import skip_without + +if TYPE_CHECKING: + from IPython import get_ipython + + ip = get_ipython() + + +def iprc(x): + return ip.run_cell(dedent(x)).raise_error() + + +def iprc_nr(x): + return ip.run_cell(dedent(x)) + + +def _finally_return_warning(): + """Context manager for the ``{val}="return"`` + ``"finally"`` test case. + + Compiling a ``return`` that exits a ``finally`` block emits + ``SyntaxWarning: 'return' in a 'finally' block`` starting with Python + 3.14 (PEP 765). That warning does not exist on older Pythons, so only + assert it there; on earlier versions this is a no-op. + """ + if sys.version_info >= (3, 14): + return pytest.warns(SyntaxWarning, match="'return' in a 'finally' block") + return contextlib.nullcontext() + + +@pytest.fixture(autouse=True) +def reset_loop_runner(): + yield + ip.loop_runner = "asyncio" + + +def test_should_be_async(): + assert not _should_be_async("False") + assert _should_be_async("await bar()") + assert _should_be_async("x = await bar()") + assert not _should_be_async( + dedent( + """ + async def awaitable(): + pass +""" + ) + ) + + assert not _should_be_async("return await foo()") + assert not _should_be_async("return bar()") + assert not _should_be_async("some invalid Python code") + + assert not _should_be_async("'\\ud800'") + + if sys.version_info >= (3, 13): + # Note: the next assert assumes the tests run without the `-OO` flag + assert not _should_be_async("'\\ud800'\nawait foo") + + +def _get_top_level_cases(): + # These are test cases that should be valid in a function + # but invalid outside of a function. + test_cases = [] + test_cases.append(("basic", "{val}")) + + # Note, in all conditional cases, I use True instead of + # False so that the peephole optimizer won't optimize away + # the return, so CPython will see this as a syntax error: + # + # while True: + # break + # return + # + # But not this: + # + # while False: + # return + # + # See https://bugs.python.org/issue1875 + + test_cases.append( + ( + "if", + dedent( + """ + if True: + {val} + """ + ), + ) + ) + + test_cases.append( + ( + "while", + dedent( + """ + while True: + {val} + break + """ + ), + ) + ) + + test_cases.append( + ( + "try", + dedent( + """ + try: + {val} + except: + pass + """ + ), + ) + ) + + test_cases.append( + ( + "except", + dedent( + """ + try: + pass + except: + {val} + """ + ), + ) + ) + + test_cases.append( + ( + "finally", + dedent( + """ + try: + pass + except: + pass + finally: + {val} + """ + ), + ) + ) + + test_cases.append( + ( + "for", + dedent( + """ + for _ in range(4): + {val} + """ + ), + ) + ) + + test_cases.append( + ( + "nested", + dedent( + """ + if True: + while True: + {val} + break + """ + ), + ) + ) + + test_cases.append( + ( + "deep-nested", + dedent( + """ + if True: + while True: + break + for x in range(3): + if True: + while True: + for x in range(3): + {val} + """ + ), + ) + ) + + return test_cases + +def _get_ry_syntax_errors(): + # This is a mix of tests that should be a syntax error if + # return or yield whether or not they are in a function + + test_cases = [] + + test_cases.append( + ( + "class", + dedent( + """ + class V: + {val} + """ + ), + ) + ) + + test_cases.append( + ( + "nested-class", + dedent( + """ + class V: + class C: + {val} + """ + ), + ) + ) + + return test_cases + + +def test_top_level_return_error(): + tl_err_test_cases = _get_top_level_cases() + tl_err_test_cases.extend(_get_ry_syntax_errors()) + + vals = ( + "return", + "yield", + "yield from (_ for _ in range(3))", + dedent( + """ + def f(): + pass + return + """ + ), + ) + + with _finally_return_warning(): + for test_name, test_case in tl_err_test_cases: + # This example should work if 'pass' is used as the value + iprc(test_case.format(val="pass")) + + # It should fail with all the values + for val in vals: + with pytest.raises(SyntaxError): + iprc(test_case.format(val=val)) + + +def test_in_func_no_error(): + # Test that the implementation of top-level return/yield + # detection isn't *too* aggressive, and works inside a function + func_contexts = [] + + func_contexts.append( + ( + "func", + False, + dedent( + """ + def f():""" + ), + ) + ) + + func_contexts.append( + ( + "method", + False, + dedent( + """ + class MyClass: + def __init__(self): + """ + ), + ) + ) + + func_contexts.append( + ( + "async-func", + True, + dedent( + """ + async def f():""" + ), + ) + ) + + func_contexts.append( + ( + "async-method", + True, + dedent( + """ + class MyClass: + async def f(self):""" + ), + ) + ) + + func_contexts.append( + ( + "closure", + False, + dedent( + """ + def f(): + def g(): + """ + ), + ) + ) + + def nest_case(context, case): + # Detect indentation + lines = context.strip().splitlines() + prefix_len = 0 + for c in lines[-1]: + if c != " ": + break + prefix_len += 1 + + indented_case = indent(case, " " * (prefix_len + 4)) + return context + "\n" + indented_case + + # yield is allowed in async functions, starting in Python 3.6, + # and yield from is not allowed in any version + vals = ("return", "yield", "yield from (_ for _ in range(3))") + + success_tests = zip(_get_top_level_cases(), repeat(False)) + failure_tests = zip(_get_ry_syntax_errors(), repeat(True)) + + tests = chain(success_tests, failure_tests) + + with _finally_return_warning(): + for context_name, async_func, context in func_contexts: + for (test_name, test_case), should_fail in tests: + nested_case = nest_case(context, test_case) + + for val in vals: + cell = nested_case.format(val=val) + + if should_fail: + with pytest.raises(SyntaxError): + iprc(cell) + else: + iprc(cell) + + +def test_nonlocal(): + # fails if outer scope is not a function scope or if var not defined + with pytest.raises(SyntaxError): + iprc("nonlocal x") + with pytest.raises(SyntaxError): + iprc( + """ + x = 1 + def f(): + nonlocal x + x = 10000 + yield x + """ + ) + with pytest.raises(SyntaxError): + iprc( + """ + def f(): + def g(): + nonlocal x + x = 10000 + yield x + """ + ) + + # works if outer scope is a function scope and var exists + iprc( + """ + def f(): + x = 20 + def g(): + nonlocal x + x = 10000 + yield x + """ + ) + + +def test_execute(): + iprc( + """ + import asyncio + await asyncio.sleep(0.001) + """ + ) + + +def test_autoawait(): + iprc("%autoawait False") + iprc("%autoawait True") + iprc( + """ + from asyncio import sleep + await sleep(0.1) + """ + ) + + +def test_memory_error(): + """The pgen parser in 3.8 or before use to raise MemoryError on too many nested parens.""" + iprc("(" * 200 + ")" * 200) + + +@pytest.mark.xfail(reason="fail on curio 1.6 and before on Python 3.12") +@pytest.mark.skip( + reason="skip_without(curio) fails on 3.12 for now even with other skip so must uncond skip" +) +def test_autoawait_curio(): + iprc("%autoawait curio") + + +@skip_without("trio") +def test_autoawait_trio(): + iprc("%autoawait trio") + + +@skip_without("trio") +def test_autoawait_trio_wrong_sleep(): + iprc("%autoawait trio") + res = iprc_nr( + """ + import asyncio + await asyncio.sleep(0) + """ + ) + with pytest.raises(TypeError): + res.raise_error() + + +@skip_without("trio") +def test_autoawait_asyncio_wrong_sleep(): + iprc("%autoawait asyncio") + res = iprc_nr( + """ + import trio + await trio.sleep(0) + """ + ) + with pytest.raises(RuntimeError): + res.raise_error() diff --git a/tests/test_autocall.py b/tests/test_autocall.py new file mode 100644 index 00000000000..75107822c67 --- /dev/null +++ b/tests/test_autocall.py @@ -0,0 +1,157 @@ +"""These kinds of tests are less than ideal, but at least they run. + +This was an old test that was being run interactively in the top-level tests/ +directory, which we are removing. For now putting this here ensures at least +we do run the test, though ultimately this functionality should all be tested +with better-isolated tests that don't rely on the global instance in iptest. +""" + +import pytest + +from IPython.core.magics.auto import AutoMagics +from IPython.core.splitinput import LineInfo +from IPython.core.prefilter import AutocallChecker + + +def doctest_autocall(): + """ + In [1]: def f1(a,b,c): + ...: return a+b+c + ...: + + In [2]: def f2(a): + ...: return a + a + ...: + + In [3]: def r(x): + ...: return True + ...: + + In [4]: ;f2 a b c + Out[4]: 'a b ca b c' + + In [5]: assert _ == "a b ca b c" + + In [6]: ,f1 a b c + Out[6]: 'abc' + + In [7]: assert _ == 'abc' + + In [8]: print(_) + abc + + In [9]: /f1 1,2,3 + Out[9]: 6 + + In [10]: assert _ == 6 + + In [11]: /f2 4 + Out[11]: 8 + + In [12]: assert _ == 8 + + In [12]: del f1, f2 + + In [13]: ,r a + Out[13]: True + + In [14]: assert _ == True + + In [15]: r'a' + Out[15]: 'a' + + In [16]: assert _ == 'a' + """ + + +def test_autocall_should_ignore_raw_strings(): + line_info = LineInfo("r'a'") + pm = ip.prefilter_manager + ac = AutocallChecker(shell=pm.shell, prefilter_manager=pm, config=pm.config) + assert ac.check(line_info) is None + + +@pytest.fixture +def restore_automagic(): + mman = ip.magics_manager + saved = mman.auto_magic + yield mman + mman.auto_magic = saved + + +@pytest.fixture +def restore_autocall(): + saved = ip.autocall + yield + ip.autocall = saved + + +def test_automagic_on_off_explicit(restore_automagic, capsys): + mman = restore_automagic + for arg in ("on", "1", "true"): + ip.run_line_magic("automagic", arg) + assert mman.auto_magic is True + out = capsys.readouterr().out + assert "Automagic is ON, % prefix IS NOT needed for line magics." in out + for arg in ("off", "0", "false"): + ip.run_line_magic("automagic", arg) + assert mman.auto_magic is False + out = capsys.readouterr().out + assert "Automagic is OFF, % prefix IS needed for line magics." in out + + +def test_automagic_case_insensitive(restore_automagic): + mman = restore_automagic + ip.run_line_magic("automagic", "OFF") + assert mman.auto_magic is False + ip.run_line_magic("automagic", "ON") + assert mman.auto_magic is True + + +def test_automagic_toggle(restore_automagic): + mman = restore_automagic + mman.auto_magic = True + ip.run_line_magic("automagic", "") + assert mman.auto_magic is False + ip.run_line_magic("automagic", "") + assert mman.auto_magic is True + + +def test_autocall_set_modes(restore_autocall, capsys): + for arg, expected, status in (("2", 2, "Full"), ("1", 1, "Smart"), ("0", 0, "Off")): + ip.run_line_magic("autocall", arg) + assert ip.autocall == expected + out = capsys.readouterr().out + assert "Automatic calling is: %s" % status in out + + +def test_autocall_invalid_mode(restore_autocall, caplog): + ip.autocall = 1 + ip.run_line_magic("autocall", "3") + # invalid mode leaves the setting unchanged and logs an error + assert ip.autocall == 1 + assert "Valid modes: 0->Off, 1->Smart, 2->Full" in caplog.text + + +def test_autocall_toggle_remembers_previous_mode(restore_autocall, capsys): + ip.run_line_magic("autocall", "2") + assert ip.autocall == 2 + # toggling turns it off... + ip.run_line_magic("autocall", "") + assert ip.autocall == 0 + out = capsys.readouterr().out + assert "Automatic calling is: Off" in out + # ... and toggling again restores the saved mode + ip.run_line_magic("autocall", "") + assert ip.autocall == 2 + out = capsys.readouterr().out + assert "Automatic calling is: Full" in out + + +def test_autocall_toggle_without_saved_state(restore_autocall): + # A fresh AutoMagics instance has no saved autocall state, so toggling + # from off defaults to smart mode (1). + ip.autocall = 0 + am = AutoMagics(ip) + am.autocall("") + assert ip.autocall == 1 diff --git a/tests/test_backgroundjobs.py b/tests/test_backgroundjobs.py new file mode 100644 index 00000000000..d820426fef3 --- /dev/null +++ b/tests/test_backgroundjobs.py @@ -0,0 +1,281 @@ +"""Tests for pylab tools module.""" + +# ----------------------------------------------------------------------------- +# Copyright (c) 2011, the IPython Development Team. +# +# Distributed under the terms of the Modified BSD License. +# +# The full license is in the file COPYING.txt, distributed with this software. +# ----------------------------------------------------------------------------- + +# ----------------------------------------------------------------------------- +# Imports +# ----------------------------------------------------------------------------- + +# Stdlib imports +import threading +import time + +# Third-party imports +import pytest + +# Our own imports +from IPython.lib import backgroundjobs as bg + +# ----------------------------------------------------------------------------- +# Globals and constants +# ----------------------------------------------------------------------------- +t_short = 0.0001 # very short interval to wait on jobs + + +# ----------------------------------------------------------------------------- +# Local utilities +# ----------------------------------------------------------------------------- +def sleeper(interval=t_short, *a, **kw): + args = dict(interval=interval, other_args=a, kw_args=kw) + time.sleep(interval) + return args + + +def crasher(interval=t_short, *a, **kw): + time.sleep(interval) + raise Exception("Dead job with interval %s" % interval) + + +# ----------------------------------------------------------------------------- +# Classes and functions +# ----------------------------------------------------------------------------- + + +def test_result(): + """Test job submission and result retrieval""" + jobs = bg.BackgroundJobManager() + j = jobs.new(sleeper) + j.join() + assert j.result["interval"] == t_short + + +def test_flush(): + """Test job control""" + jobs = bg.BackgroundJobManager() + j = jobs.new(sleeper) + j.join() + assert len(jobs.completed) == 1 + assert len(jobs.dead) == 0 + jobs.flush() + assert len(jobs.completed) == 0 + + +def test_dead(): + """Test control of dead jobs""" + jobs = bg.BackgroundJobManager() + j = jobs.new(crasher) + j.join() + assert len(jobs.completed) == 0 + assert len(jobs.dead) == 1 + jobs.flush() + assert len(jobs.dead) == 0 + + +def test_longer(): + """Test control of longer-running jobs""" + jobs = bg.BackgroundJobManager() + # Sleep for long enough for the following two checks to still report the + # job as running, but not so long that it makes the test suite noticeably + # slower. + j = jobs.new(sleeper, 0.1) + assert len(jobs.running) == 1 + assert len(jobs.completed) == 0 + j.join() + assert len(jobs.running) == 0 + assert len(jobs.completed) == 1 + + +def test_expression_job(): + """Jobs can be created from strings evaluated with given namespaces""" + jobs = bg.BackgroundJobManager() + j = jobs.new("x + y", dict(x=1, y=2)) + j.join() + assert j.result == 3 + # separate globals and locals + j = jobs.new("x + y", dict(x=10), dict(y=20)) + j.join() + assert j.result == 30 + + +def test_expression_job_caller_namespace(): + """With no namespace args, the caller's frame is used""" + jobs = bg.BackgroundJobManager() + only_visible_here = 21 + j = jobs.new("only_visible_here * 2") + j.join() + assert j.result == 42 + + +def test_expression_job_too_many_args(): + jobs = bg.BackgroundJobManager() + with pytest.raises(ValueError): + jobs.new("1 + 1", {}, {}, {}) + + +def test_new_invalid_type(): + jobs = bg.BackgroundJobManager() + with pytest.raises(TypeError): + jobs.new(42) + + +def test_base_job_not_instantiable(): + with pytest.raises(NotImplementedError): + bg.BackgroundJobBase() + + +def test_func_job_requires_callable(): + with pytest.raises(TypeError): + bg.BackgroundJobFunc("not a callable") + + +def test_daemon_flag(): + jobs = bg.BackgroundJobManager() + ev = threading.Event() + j = jobs.new(ev.wait, 5, daemon=True) + assert j.daemon + ev.set() + j.join(timeout=5) + assert not j.is_alive() + + +def test_getitem(): + """Jobs can be looked up by number or by the job object itself""" + jobs = bg.BackgroundJobManager() + j = jobs.new(sleeper) + j.join() + assert jobs[j.num] is j + assert jobs[j] is j + + +def test_str_and_repr(): + jobs = bg.BackgroundJobManager() + j = jobs.new("1 + 1") + j.join() + assert str(j) == "1 + 1" + assert repr(j) == "" % j.num + + +def test_status_call(capsys): + """Calling the manager prints a status report of all groups""" + jobs = bg.BackgroundJobManager() + ev = threading.Event() + running = jobs.new(ev.wait, 5) + completed = jobs.new(sleeper) + dead = jobs.new(crasher) + completed.join() + dead.join() + try: + jobs() # alias for jobs.status() + finally: + ev.set() + running.join(timeout=5) + out = capsys.readouterr().out + assert "Running jobs:" in out + assert "Completed jobs:" in out + assert "Dead jobs:" in out + assert "%s : %s" % (completed.num, completed) in out + + +def test_status_new(capsys): + """_status_new only reports jobs finished since the last call""" + jobs = bg.BackgroundJobManager() + j = jobs.new(sleeper) + j.join() + assert jobs._status_new() is True + out = capsys.readouterr().out + assert "Completed jobs:" in out + # state was reset: nothing new to report the second time + assert not jobs._status_new() + + +def test_remove(): + jobs = bg.BackgroundJobManager() + ok = jobs.new(sleeper) + bad = jobs.new(crasher) + ok.join() + bad.join() + jobs.remove(ok.num) + assert len(jobs.completed) == 0 + jobs.remove(bad.num) + assert len(jobs.dead) == 0 + + +def test_remove_running_and_missing(caplog): + jobs = bg.BackgroundJobManager() + ev = threading.Event() + j = jobs.new(ev.wait, 5) + try: + jobs.remove(j.num) + assert "still running" in caplog.text + assert len(jobs.running) == 1 + caplog.clear() + jobs.remove(1234) + assert "not found" in caplog.text + finally: + ev.set() + j.join(timeout=5) + + +def test_flush_empty(capsys): + jobs = bg.BackgroundJobManager() + jobs.flush() + assert "No jobs to flush." in capsys.readouterr().out + + +def test_result_method(caplog): + jobs = bg.BackgroundJobManager() + j = jobs.new("6 * 7") + j.join() + assert jobs.result(j.num) == 42 + jobs.result(1234) + assert "not found" in caplog.text + + +def test_traceback(capsys, caplog): + jobs = bg.BackgroundJobManager() + j = jobs.new(crasher) + j.join() + # traceback of a specific job, by number and by job object + jobs.traceback(j.num) + out = capsys.readouterr().out + assert "Dead job with interval" in out + jobs.traceback(j) + assert "Dead job with interval" in capsys.readouterr().out + # with no argument, print tracebacks for all dead jobs + jobs.traceback() + out = capsys.readouterr().out + assert "Traceback for: %r" % j in out + assert "Dead job with interval" in out + # missing job number logs an error + jobs.traceback(1234) + assert "not found" in caplog.text + + +def test_dead_job_attributes(): + jobs = bg.BackgroundJobManager() + j = jobs.new(crasher) + j.join() + assert j.stat_code == bg.BackgroundJobBase.stat_dead_c + assert j.finished is None + assert "died" in j.result + assert "Dead job with interval" in j._tb + + +def test_traceback_without_ipython(monkeypatch): + """Without an IPython instance, _init falls back to AutoFormattedTB. + + Note: the fallback currently passes the removed ``color_scheme`` + argument to AutoFormattedTB, so job creation raises TypeError. This + test documents the current behaviour; if the fallback is fixed, it + should be updated to assert that the job runs and formats a traceback. + """ + monkeypatch.setattr(bg, "get_ipython", lambda: None) + jobs = bg.BackgroundJobManager() + with pytest.raises(TypeError): + jobs.new(crasher) diff --git a/IPython/utils/tests/test_capture.py b/tests/test_capture.py similarity index 72% rename from IPython/utils/tests/test_capture.py rename to tests/test_capture.py index 8645ed18c9e..460514ed569 100644 --- a/IPython/utils/tests/test_capture.py +++ b/tests/test_capture.py @@ -1,16 +1,16 @@ # encoding: utf-8 """Tests for IPython.utils.capture""" -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Copyright (C) 2013 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Imports -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- import sys @@ -19,9 +19,9 @@ from IPython.utils import capture -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Globals -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- _mime_map = dict( _repr_png_="image/png", @@ -33,46 +33,48 @@ ) basic_data = { - 'image/png' : b'binarydata', - 'text/html' : "bold", + "image/png": b"binarydata", + "text/html": "bold", } basic_metadata = { - 'image/png' : { - 'width' : 10, - 'height' : 20, + "image/png": { + "width": 10, + "height": 20, }, } full_data = { - 'image/png' : b'binarydata', - 'image/jpeg' : b'binarydata', - 'image/svg+xml' : "bold", - 'application/javascript' : "alert();", - 'application/json' : "{}", + "image/png": b"binarydata", + "image/jpeg": b"binarydata", + "image/svg+xml": "bold", + "application/javascript": "alert();", + "application/json": "{}", } full_metadata = { - 'image/png' : {"png" : "exists"}, - 'image/jpeg' : {"jpeg" : "exists"}, - 'image/svg+xml' : {"svg" : "exists"}, - 'text/html' : {"html" : "exists"}, - 'application/javascript' : {"js" : "exists"}, - 'application/json' : {"json" : "exists"}, + "image/png": {"png": "exists"}, + "image/jpeg": {"jpeg": "exists"}, + "image/svg+xml": {"svg": "exists"}, + "text/html": {"html": "exists"}, + "application/javascript": {"js": "exists"}, + "application/json": {"json": "exists"}, } hello_stdout = "hello, stdout" hello_stderr = "hello, stderr" -#----------------------------------------------------------------------------- + +# ----------------------------------------------------------------------------- # Test Functions -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- @pytest.mark.parametrize("method_mime", _mime_map.items()) def test_rich_output_empty(method_mime): """RichOutput with no args""" rich = capture.RichOutput() method, mime = method_mime assert getattr(rich, method)() is None - + + def test_rich_output(): """test RichOutput basics""" data = basic_data @@ -103,6 +105,7 @@ def test_rich_output_metadata(method_mime): method, mime = method_mime assert getattr(rich, method)() == (data[mime], metadata[mime]) + def test_rich_output_display(): """test RichOutput.display @@ -118,6 +121,7 @@ def test_rich_output_display(): assert rich2.data == rich.data assert rich2.metadata == rich.metadata + def test_capture_output(): """capture_output works""" rich = capture.RichOutput(data=full_data) @@ -156,7 +160,9 @@ def test_capture_output_no_stderr(): def test_capture_output_no_display(): """test capture_output(display=False)""" - rich = capture.RichOutput(data=full_data) + data = full_data.copy() + del data["image/png"] + rich = capture.RichOutput(data=data) with capture.capture_output(display=False) as cap: print(hello_stdout, end="") print(hello_stderr, end="", file=sys.stderr) @@ -164,3 +170,11 @@ def test_capture_output_no_display(): assert hello_stdout == cap.stdout assert hello_stderr == cap.stderr assert cap.outputs == [] + + +def test_captured_io_none_streams(): + """CapturedIO accepts None for stdout/stderr and returns empty strings.""" + cap = capture.CapturedIO(None, None) + assert cap.stdout == "" + assert cap.stderr == "" + assert cap.outputs == [] diff --git a/tests/test_clipboard.py b/tests/test_clipboard.py new file mode 100644 index 00000000000..2283f9e7286 --- /dev/null +++ b/tests/test_clipboard.py @@ -0,0 +1,263 @@ +import subprocess +import sys +import types + +import pytest + +from IPython.core.error import TryNext +from IPython.lib import clipboard +from IPython.lib.clipboard import ( + ClipboardEmpty, + osx_clipboard_get, + tkinter_clipboard_get, + wayland_clipboard_get, + win32_clipboard_get, +) +from IPython.testing.decorators import skip_if_no_x11 + + +@skip_if_no_x11 +def test_clipboard_get(): + # Smoketest for clipboard access - we can't easily guarantee that the + # clipboard is accessible and has something on it, but this tries to + # exercise the relevant code anyway. + try: + a = get_ipython().hooks.clipboard_get() + except ClipboardEmpty: + # Nothing in clipboard to get + pass + except TryNext: + # No clipboard access API available + pass + else: + assert isinstance(a, str) + + +class FakePopen: + """Minimal stand-in for subprocess.Popen usable as a context manager.""" + + calls = [] + + def __init__(self, cmd, stdout=None): + type(self).calls.append(cmd) + self.returncode = 0 + + def communicate(self, input=None): + return (b"", b"") + + def wait(self): + return self.returncode + + def __enter__(self): + return self + + def __exit__(self, *exc_info): + return False + + +@pytest.fixture +def popen_recorder(monkeypatch): + """Install a FakePopen subclass in place of subprocess.Popen.""" + + def install(output=b"", returncode=0): + class Recorder(FakePopen): + calls = [] + + def __init__(self, cmd, stdout=None): + super().__init__(cmd, stdout=stdout) + self.returncode = returncode + + def communicate(self, input=None): + return (output, b"") + + monkeypatch.setattr(subprocess, "Popen", Recorder) + return Recorder + + return install + + +# ----------------------------------------------------------------------------- +# OS X (pbpaste) +# ----------------------------------------------------------------------------- + + +def test_osx_clipboard_get(popen_recorder): + recorder = popen_recorder(output=b"old\rmac\rline endings") + text = osx_clipboard_get() + # \r line endings are normalized to \n and bytes decoded to str + assert text == "old\nmac\nline endings" + assert recorder.calls == [["pbpaste", "-Prefer", "ascii"]] + + +# ----------------------------------------------------------------------------- +# Wayland (wl-paste) +# ----------------------------------------------------------------------------- + + +def test_wayland_clipboard_get(monkeypatch, popen_recorder): + monkeypatch.setenv("XDG_SESSION_TYPE", "wayland") + recorder = popen_recorder(output=b"wayland text") + assert wayland_clipboard_get() == "wayland text" + assert recorder.calls == [["wl-paste"]] + + +def test_wayland_clipboard_not_wayland(monkeypatch): + monkeypatch.setenv("XDG_SESSION_TYPE", "x11") + with pytest.raises(TryNext, match="wayland is not detected"): + wayland_clipboard_get() + + +def test_wayland_clipboard_no_wl_paste(monkeypatch): + monkeypatch.setenv("XDG_SESSION_TYPE", "wayland") + + def raise_fnf(*args, **kwargs): + raise FileNotFoundError("wl-paste") + + monkeypatch.setattr(subprocess, "Popen", raise_fnf) + with pytest.raises(TryNext, match="wl-clipboard"): + wayland_clipboard_get() + + +def test_wayland_clipboard_command_failure(monkeypatch, popen_recorder): + monkeypatch.setenv("XDG_SESSION_TYPE", "wayland") + popen_recorder(output=b"whatever", returncode=1) + with pytest.raises(TryNext): + wayland_clipboard_get() + + +def test_wayland_clipboard_empty(monkeypatch, popen_recorder): + monkeypatch.setenv("XDG_SESSION_TYPE", "wayland") + popen_recorder(output=b"") + with pytest.raises(ClipboardEmpty): + wayland_clipboard_get() + + +# ----------------------------------------------------------------------------- +# Windows (pywin32) +# ----------------------------------------------------------------------------- + + +def make_fake_win32clipboard(data): + """Build a fake win32clipboard module. + + *data* maps clipboard formats to either text or an exception to raise. + """ + mod = types.ModuleType("win32clipboard") + + class error(Exception): + pass + + mod.error = error + mod.CF_UNICODETEXT = 13 + mod.CF_TEXT = 1 + mod.opened = False + mod.closed = False + mod.data = dict(data) + + def OpenClipboard(): + mod.opened = True + + def CloseClipboard(): + mod.closed = True + + def GetClipboardData(fmt): + result = mod.data[fmt] + if isinstance(result, Exception): + raise result + return result + + mod.OpenClipboard = OpenClipboard + mod.CloseClipboard = CloseClipboard + mod.GetClipboardData = GetClipboardData + return mod + + +def test_win32_clipboard_get_unicode(monkeypatch): + fake = make_fake_win32clipboard({13: "unicode text"}) + monkeypatch.setitem(sys.modules, "win32clipboard", fake) + assert win32_clipboard_get() == "unicode text" + assert fake.opened + assert fake.closed + + +def test_win32_clipboard_get_fallback_to_cf_text(monkeypatch): + fake = make_fake_win32clipboard({13: TypeError("no unicode"), 1: b"plain text"}) + monkeypatch.setitem(sys.modules, "win32clipboard", fake) + assert win32_clipboard_get() == "plain text" + assert fake.closed + + +def test_win32_clipboard_get_empty(monkeypatch): + fake = make_fake_win32clipboard({}) + fake.data.update({13: fake.error("empty"), 1: fake.error("empty")}) + monkeypatch.setitem(sys.modules, "win32clipboard", fake) + with pytest.raises(ClipboardEmpty): + win32_clipboard_get() + # The clipboard must be closed even on failure. + assert fake.closed + + +def test_win32_clipboard_get_no_pywin32(monkeypatch): + monkeypatch.setitem(sys.modules, "win32clipboard", None) + with pytest.raises(TryNext, match="pywin32"): + win32_clipboard_get() + + +# ----------------------------------------------------------------------------- +# Tkinter +# ----------------------------------------------------------------------------- + + +def make_fake_tkinter(text=None): + mod = types.ModuleType("tkinter") + + class TclError(Exception): + pass + + class Tk: + instances = [] + + def __init__(self): + type(self).instances.append(self) + self.withdrawn = False + self.destroyed = False + + def withdraw(self): + self.withdrawn = True + + def clipboard_get(self): + if text is None: + raise TclError("CLIPBOARD selection doesn't exist") + return text + + def destroy(self): + self.destroyed = True + + mod.TclError = TclError + mod.Tk = Tk + return mod + + +def test_tkinter_clipboard_get(monkeypatch): + fake = make_fake_tkinter(text="tk text") + monkeypatch.setitem(sys.modules, "tkinter", fake) + assert tkinter_clipboard_get() == "tk text" + (root,) = fake.Tk.instances + assert root.withdrawn + assert root.destroyed + + +def test_tkinter_clipboard_get_empty(monkeypatch): + fake = make_fake_tkinter(text=None) + monkeypatch.setitem(sys.modules, "tkinter", fake) + with pytest.raises(ClipboardEmpty): + tkinter_clipboard_get() + # The Tk root window is destroyed even when the clipboard is empty. + (root,) = fake.Tk.instances + assert root.destroyed + + +def test_tkinter_clipboard_get_no_tkinter(monkeypatch): + monkeypatch.setitem(sys.modules, "tkinter", None) + with pytest.raises(TryNext, match="tkinter"): + tkinter_clipboard_get() diff --git a/tests/test_compilerop.py b/tests/test_compilerop.py new file mode 100644 index 00000000000..9542edc888f --- /dev/null +++ b/tests/test_compilerop.py @@ -0,0 +1,65 @@ +# coding: utf-8 +"""Tests for the compilerop module.""" +# ----------------------------------------------------------------------------- +# Copyright (C) 2010-2011 The IPython Development Team. +# +# Distributed under the terms of the BSD License. +# +# The full license is in the file COPYING.txt, distributed with this software. +# ----------------------------------------------------------------------------- + +import linecache +import sys + +import pytest + +from IPython.core import compilerop + + +@pytest.mark.parametrize("cell_number,prefix", [ + (0, " ncache + + +def test_proper_default_encoding(): + assert sys.getdefaultencoding() == "utf-8" + + +@pytest.mark.parametrize("src", [ + "a_unique_var_for_test_1 = 1", + "t = 'žćčšđ_unique'", + "y = '日本語_unique'", +]) +def test_cache_source(src): + cp = compilerop.CachingCompiler() + ncache = len(linecache.cache) + cp.cache(src) + assert len(linecache.cache) > ncache + + +def test_compiler_check_cache(): + """Test the compiler properly manages the cache.""" + cp = compilerop.CachingCompiler() + cp.cache("x=1", 99) + linecache.checkcache() + assert any( + k.startswith(" 131808: + size, start, stop, prct = recompute_unicode_ranges() + message = f"""_UNICODE_RANGES likely wrong and need updating. This is + likely due to a new release of Python. We've find that the biggest gap + in unicode characters has reduces in size to be {size} characters + ({prct}), from {start}, to {stop}. In completer.py likely update to + + _UNICODE_RANGES = [(32, {start}), ({stop}, 0xe01f0)] + + And update the assertion below to use + + len_exp <= {len_exp} + """ + assert len_exp == len_test, message + + # fail if new unicode symbols have been added. + assert len_exp <= 159801, message + + +@contextmanager +def greedy_completion(): + ip = get_ipython() + greedy_original = ip.Completer.greedy + try: + ip.Completer.greedy = True + yield + finally: + ip.Completer.greedy = greedy_original + + +@contextmanager +def evaluation_policy(evaluation: str, **overrides): + ip = get_ipython() + evaluation_original = ip.Completer.evaluation + overrides_original = ip.Completer.policy_overrides + try: + ip.Completer.evaluation = evaluation + ip.Completer.policy_overrides = overrides + yield + finally: + ip.Completer.evaluation = evaluation_original + ip.Completer.policy_overrides = overrides_original + + +@contextmanager +def custom_matchers(matchers): + ip = get_ipython() + try: + ip.Completer.custom_matchers.extend(matchers) + yield + finally: + ip.Completer.custom_matchers.clear() + + +if sys.platform == "win32": + pairs = [ + ("abc", "abc"), + (" abc", '" abc"'), + ("a bc", '"a bc"'), + ("a bc", '"a bc"'), + (" bc", '" bc"'), + ] +else: + pairs = [ + ("abc", "abc"), + (" abc", r"\ abc"), + ("a bc", r"a\ bc"), + ("a bc", r"a\ \ bc"), + (" bc", r"\ \ bc"), + # On posix, we also protect parens and other special characters. + ("a(bc", r"a$bc"), + ("a)bc", r"a$bc"), + ("a( )bc", r"a$\ $bc"), + ("a[1]bc", r"a\[1\]bc"), + ("a{1}bc", r"a\{1\}bc"), + ("a#bc", r"a\#bc"), + ("a?bc", r"a\?bc"), + ("a=bc", r"a\=bc"), + ("a\\bc", r"a\\bc"), + ("a|bc", r"a\|bc"), + ("a;bc", r"a\;bc"), + ("a:bc", r"a\:bc"), + ("a'bc", r"a\'bc"), + ("a*bc", r"a\*bc"), + ('a"bc', r"a\"bc"), + ("a^bc", r"a\^bc"), + ("a&bc", r"a\&bc"), + ] + + +@pytest.mark.parametrize("s1,expected", pairs) +def test_protect_filename(s1, expected): + assert completer.protect_filename(s1) == expected + + +def check_line_split(splitter, test_specs): + for part1, part2, split in test_specs: + cursor_pos = len(part1) + line = part1 + part2 + out = splitter.split_line(line, cursor_pos) + assert out == split + + +def test_line_split(): + """Basic line splitter test with default specs.""" + sp = completer.CompletionSplitter() + # The format of the test specs is: part1, part2, expected answer. Parts 1 + # and 2 are joined into the 'line' sent to the splitter, as if the cursor + # was at the end of part1. So an empty part2 represents someone hitting + # tab at the end of the line, the most common case. + t = [ + ("run some/script", "", "some/script"), + ("run scripts/er", "ror.py foo", "scripts/er"), + ("echo $HOM", "", "HOM"), + ("print sys.pa", "", "sys.pa"), + ("print(sys.pa", "", "sys.pa"), + ("execfile('scripts/er", "", "scripts/er"), + ("a[x.", "", "x."), + ("a[x.", "y", "x."), + ('cd "some_file/', "", "some_file/"), + ] + check_line_split(sp, t) + # Ensure splitting works OK with unicode by re-running the tests with + # all inputs turned into unicode + check_line_split(sp, [map(str, p) for p in t]) + + +class NamedInstanceClass: + instances = {} + + def __init__(self, name): + self.instances[name] = self + + @classmethod + def _ipython_key_completions_(cls): + return cls.instances.keys() + + +class KeyCompletable: + def __init__(self, things=()): + self.things = things + + def _ipython_key_completions_(self): + return list(self.things) + + +@pytest.fixture(autouse=True) +def silence_pending_deprecation_warning(): + """ + We want to silence all PendingDeprecationWarning when testing the completer + """ + import warnings + with warnings.catch_warnings(): + warnings.simplefilter("ignore", PendingDeprecationWarning) + yield + + +def test_custom_completion_error(): + """Test that errors from custom attribute completers are silenced.""" + ip = get_ipython() + + class A: + pass + + ip.user_ns["x"] = A() + + @complete_object.register(A) + def complete_A(a, existing_completions): + raise TypeError("this should be silenced") + + ip.complete("x.") + +def test_custom_completion_ordering(): + """Test that errors from custom attribute completers are silenced.""" + ip = get_ipython() + ip.Completer.use_jedi = False + + _, matches = ip.complete("in") + assert matches.index("input") < matches.index("int") + + def complete_example(a): + return ["example2", "example1"] + + ip.Completer.custom_completers.add_re("ex*", complete_example) + _, matches = ip.complete("ex") + assert matches.index("example2") < matches.index("example1") + +def test_unicode_completions(): + ip = get_ipython() + # Some strings that trigger different types of completion. Check them both + # in str and unicode forms + s = ["ru", "%ru", "cd /", "floa", "float(x)/"] + for t in s + list(map(str, s)): + # We don't need to check exact completion values (they may change + # depending on the state of the namespace, but at least no exceptions + # should be thrown and the return value should be a pair of text, list + # values. + text, matches = ip.complete(t) + assert isinstance(text, str) + assert isinstance(matches, list) + +def test_latex_completions(): + ip = get_ipython() + # Test some random unicode symbols + keys = random.sample(sorted(latex_symbols), 10) + for k in keys: + text, matches = ip.complete(k) + assert text == k + assert matches == [latex_symbols[k]] + # Test a more complex line + text, matches = ip.complete("print(\\alpha") + assert text == "\\alpha" + assert matches[0] == latex_symbols["\\alpha"] + # Test multiple matching latex symbols + text, matches = ip.complete("\\al") + assert "\\alpha" in matches + assert "\\aleph" in matches + +def test_latex_no_results(): + """ + forward latex should really return nothing in either field if nothing is found. + """ + ip = get_ipython() + text, matches = ip.Completer.latex_matches("\\really_i_should_match_nothing") + assert text == "" + assert matches == () + +def test_back_latex_completion(): + ip = get_ipython() + + # do not return more than 1 matches for \beta, only the latex one. + name, matches = ip.complete("\\β") + assert matches == ["\\beta"] + +def test_back_unicode_completion(): + ip = get_ipython() + + name, matches = ip.complete("\\Ⅴ") + assert matches == ["\\ROMAN NUMERAL FIVE"] + +def test_forward_unicode_completion(): + ip = get_ipython() + + name, matches = ip.complete("\\ROMAN NUMERAL FIVE") + assert matches == ["Ⅴ"] # This is not a V + assert matches == ["\u2164"] # same as above but explicit. + +def test_delim_setting(): + sp = completer.CompletionSplitter() + sp.delims = " " + assert sp.delims == " " + assert sp._delim_expr == r"[\ ]" + +def test_spaces(): + """Test with only spaces as split chars.""" + sp = completer.CompletionSplitter() + sp.delims = " " + t = [("foo", "", "foo"), ("run foo", "", "foo"), ("run foo", "bar", "foo")] + check_line_split(sp, t) + +@pytest.mark.parametrize("s,expected", [ + ("'", "'"), + ("'''", "'"), + ("'hi' '", "'"), + ('"', '"'), + ('"""', '"'), + ('"hi" "', '"'), + ("''", False), + ("''' '''", False), + ("'hi' 'ipython'", False), + ('""', False), + ('""" """', False), + ('"hi" "ipython"', False), +]) +def test_has_open_quotes(s, expected): + result = completer.has_open_quotes(s) + if expected is False: + assert not result + else: + assert result == expected + +@pytest.mark.xfail( + sys.platform == "win32", reason="abspath completions fail on Windows" +) +def test_abspath_file_completions(): + ip = get_ipython() + with TemporaryDirectory() as tmpdir: + prefix = os.path.join(tmpdir, "foo") + suffixes = ["1", "2"] + names = [prefix + s for s in suffixes] + for n in names: + open(n, "w", encoding="utf-8").close() + + # Check simple completion + c = ip.complete(prefix)[1] + assert c == names + + # Now check with a function call + cmd = 'a = f("%s' % prefix + c = ip.complete(prefix, cmd)[1] + comp = [prefix + s for s in suffixes] + assert c == comp + +def test_local_file_completions(): + ip = get_ipython() + with TemporaryWorkingDirectory(): + prefix = "./foo" + suffixes = ["1", "2"] + names = [prefix + s for s in suffixes] + for n in names: + open(n, "w", encoding="utf-8").close() + + # Check simple completion + c = ip.complete(prefix)[1] + assert c == names + + test_cases = { + "function call": 'a = f("', + "shell bang": "!ls ", + "ls magic": r"%ls ", + "alias ls": "ls ", + } + for name, code in test_cases.items(): + cmd = f"{code}{prefix}" + c = ip.complete(prefix, cmd)[1] + comp = {prefix + s for s in suffixes} + assert comp.issubset(set(c)), f"completes in {name}" + +def test_file_completions_only_in_path_contexts(): + ip = get_ipython() + + def path_matches(text): + with provisionalcompleter(): + return [ + completion.text + for completion in ip.Completer.completions(text, len(text)) + if completion.type == "path" + ] + + with TemporaryWorkingDirectory(): + open("alpha_path_marker", "w", encoding="utf-8").close() + open("foo_path_marker", "w", encoding="utf-8").close() + + assert path_matches("f(x=") == [] + assert path_matches("# alpha") == [] + assert path_matches("foo != alpha") == [] + assert "./foo_path_marker" in path_matches("./foo") + assert "alpha_path_marker" in path_matches('f("alpha') + assert "alpha_path_marker" in path_matches("!cat alpha") + assert "alpha_path_marker" in path_matches("%ls alpha") + assert "alpha_path_marker" in path_matches("files = ! cat alpha") + +def test_quoted_file_completions(): + ip = get_ipython() + + def _(text): + return ip.Completer._complete( + cursor_line=0, cursor_pos=len(text), full_text=text + )["IPCompleter.file_matcher"]["completions"] + + with TemporaryWorkingDirectory(): + name = "foo'bar" + open(name, "w", encoding="utf-8").close() + + # Don't escape Windows + escaped = name if sys.platform == "win32" else "foo\\'bar" + + # Single quote matches embedded single quote + c = _("open('foo")[0] + assert c.text == escaped + + # Double quote requires no escape + c = _('open("foo')[0] + assert c.text == name + + # No quote requires an escape + c = _("%ls foo")[0] + assert c.text == escaped + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +@pytest.mark.parametrize("jedi_status", [True, False]) +def test_all_completions_dups(jedi_status): + """ + Make sure the output of `IPCompleter.all_completions` does not have + duplicated prefixes. + """ + ip = get_ipython() + c = ip.Completer + ip.ex("class TestClass():\n\ta=1\n\ta1=2") + with provisionalcompleter(): + ip.Completer.use_jedi = jedi_status + matches = c.all_completions("TestCl") + assert matches == ["TestClass"], (jedi_status, matches) + matches = c.all_completions("TestClass.") + assert len(matches) > 2, (jedi_status, matches) + matches = c.all_completions("TestClass.a") + if jedi_status: + assert matches == ["TestClass.a", "TestClass.a1"], jedi_status + else: + assert matches == [".a", ".a1"], jedi_status + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +def test_jedi(): + """ + A couple of issue we had with Jedi + """ + ip = get_ipython() + + def _test_complete(reason, s, comp, start=None, end=None): + l = len(s) + start = start if start is not None else l + end = end if end is not None else l + with provisionalcompleter(): + ip.Completer.use_jedi = True + completions = set(ip.Completer.completions(s, l)) + ip.Completer.use_jedi = False + assert Completion(start, end, comp) in completions, reason + + def _test_not_complete(reason, s, comp): + l = len(s) + with provisionalcompleter(): + ip.Completer.use_jedi = True + completions = set(ip.Completer.completions(s, l)) + ip.Completer.use_jedi = False + assert Completion(l, l, comp) not in completions, reason + + import jedi + + jedi_version = tuple(int(i) for i in jedi.__version__.split(".")[:3]) + if jedi_version > (0, 10): + _test_complete("jedi >0.9 should complete and not crash", "a=1;a.", "real") + _test_complete("can infer first argument", 'a=(1,"foo");a[0].', "real") + _test_complete("can infer second argument", 'a=(1,"foo");a[1].', "capitalize") + _test_complete("cover duplicate completions", "im", "import", 0, 2) + + _test_not_complete("does not mix types", 'a=(1,"foo");a[0].', "capitalize") + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +def test_completion_have_signature(): + """ + Lets make sure jedi is capable of pulling out the signature of the function we are completing. + """ + ip = get_ipython() + with provisionalcompleter(): + ip.Completer.use_jedi = True + completions = ip.Completer.completions("ope", 3) + c = next(completions) # should be `open` + ip.Completer.use_jedi = False + assert "file" in c.signature, "Signature of function was not found by completer" + assert ( + "encoding" in c.signature + ), "Signature of function was not found by completer" + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +def test_completions_have_type(): + """ + Lets make sure matchers provide completion type. + """ + ip = get_ipython() + with provisionalcompleter(): + ip.Completer.use_jedi = False + completions = ip.Completer.completions("%tim", 3) + c = next(completions) # should be `%time` or similar + assert c.type == "magic", "Type of magic was not assigned by completer" + +@pytest.mark.xfail( + parse(version("jedi")) <= parse("0.18.0"), + reason="Known failure on jedi<=0.18.0", + strict=True, +) +def test_deduplicate_completions(): + """ + Test that completions are correctly deduplicated (even if ranges are not the same) + """ + ip = get_ipython() + ip.ex( + textwrap.dedent( + """ + class Z: + zoo = 1 + """ + ) + ) + with provisionalcompleter(): + ip.Completer.use_jedi = True + l = list( + _deduplicate_completions("Z.z", ip.Completer.completions("Z.z", 3)) + ) + ip.Completer.use_jedi = False + + assert len(l) == 1, "Completions (Z.z) correctly deduplicate: %s " % l + assert l[0].text == "zoo" # and not `it.accumulate` + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +def test_greedy_completions(): + """ + Test the capability of the Greedy completer. + + Most of the test here does not really show off the greedy completer, for proof + each of the text below now pass with Jedi. The greedy completer is capable of more. + + See the :any:`test_dict_key_completion_contexts` + + """ + ip = get_ipython() + ip.ex("a=list(range(5))") + ip.ex("b,c = 1, 1.2") + ip.ex("d = {'a b': str}") + ip.ex("x=y='a'") + _, c = ip.complete(".", line="a[0].") + assert not ".real" in c, "Shouldn't have completed on a[0]: %s" % c + + def _(line, cursor_pos, expect, message, completion): + with greedy_completion(), provisionalcompleter(): + ip.Completer.use_jedi = False + _, c = ip.complete(".", line=line, cursor_pos=cursor_pos) + assert expect in c, message % c + + ip.Completer.use_jedi = True + with provisionalcompleter(): + completions = ip.Completer.completions(line, cursor_pos) + assert completion in list(completions) + + with provisionalcompleter(): + _( + "a[0].", + 5, + ".real", + "Should have completed on a[0].: %s", + Completion(5, 5, "real"), + ) + _( + "a[0].r", + 6, + ".real", + "Should have completed on a[0].r: %s", + Completion(5, 6, "real"), + ) + _( + "a[0].from_", + 10, + ".from_bytes", + "Should have completed on a[0].from_: %s", + Completion(5, 10, "from_bytes"), + ) + _( + "assert str.star", + 14, + ".startswith", + "Should have completed on `assert str.star`: %s", + Completion(11, 14, "startswith"), + ) + _( + "d['a b'].str", + 12, + ".strip", + "Should have completed on `d['a b'].str`: %s", + Completion(9, 12, "strip"), + ) + _( + "a.app", + 4, + ".append", + "Should have completed on `a.app`: %s", + Completion(2, 4, "append"), + ) + _( + "x.upper() == y.", + 15, + ".upper", + "Should have completed on `x.upper() == y.`: %s", + Completion(15, 15, "upper"), + ) + _( + "(x.upper() == y.", + 16, + ".upper", + "Should have completed on `(x.upper() == y.`: %s", + Completion(16, 16, "upper"), + ) + _( + "(x.upper() == y).", + 17, + ".bit_length", + "Should have completed on `(x.upper() == y).`: %s", + Completion(17, 17, "bit_length"), + ) + _( + "{'==', 'abc'}.", + 14, + ".add", + "Should have completed on `{'==', 'abc'}.`: %s", + Completion(14, 14, "add"), + ) + _( + "b + c.", + 6, + ".hex", + "Should have completed on `b + c.`: %s", + Completion(6, 6, "hex"), + ) + +def test_omit__names(): + # also happens to test IPCompleter as a configurable + ip = get_ipython() + ip._hidden_attr = 1 + ip._x = {} + c = ip.Completer + ip.ex("ip=get_ipython()") + cfg = Config() + cfg.IPCompleter.omit__names = 0 + c.update_config(cfg) + with provisionalcompleter(): + c.use_jedi = False + s, matches = c.complete("ip.") + assert ".__str__" in matches + assert "._hidden_attr" in matches + + # c.use_jedi = True + # completions = set(c.completions('ip.', 3)) + # assert Completion(3 in 3, '__str__', completions) + # assert Completion(3 in 3, "_hidden_attr", completions) + + cfg = Config() + cfg.IPCompleter.omit__names = 1 + c.update_config(cfg) + with provisionalcompleter(): + c.use_jedi = False + s, matches = c.complete("ip.") + assert ".__str__" not in matches + # assert 'ip._hidden_attr' in matches + + # c.use_jedi = True + # completions = set(c.completions('ip.', 3)) + # assert Completion(3 not in 3,'__str__', completions) + # assert Completion(3 in 3, "_hidden_attr", completions) + + cfg = Config() + cfg.IPCompleter.omit__names = 2 + c.update_config(cfg) + with provisionalcompleter(): + c.use_jedi = False + s, matches = c.complete("ip.") + assert ".__str__" not in matches + assert "._hidden_attr" not in matches + + # c.use_jedi = True + # completions = set(c.completions('ip.', 3)) + # assert Completion(3 not in 3,'__str__', completions) + # assert Completion(3 not in 3, "_hidden_attr", completions) + + with provisionalcompleter(): + c.use_jedi = False + s, matches = c.complete("ip._x.") + assert ".keys" in matches + + # c.use_jedi = True + # completions = set(c.completions('ip._x.', 6)) + # assert Completion(6 in 6, "keys", completions) + + del ip._hidden_attr + del ip._x + +def test_limit_to__all__False_ok(): + """ + Limit to all is deprecated, once we remove it this test can go away. + + ``limit_to__all__`` has since been removed from ``IPCompleter``, so + setting it now triggers traitlets' "not recognized" warning; that is + expected here since the point of the test is to make sure the (now + unknown) option doesn't break completion. + """ + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + ip.ex("class D: x=24") + ip.ex("d=D()") + cfg = Config() + cfg.IPCompleter.limit_to__all__ = False + with pytest.warns(UserWarning, match="limit_to__all__.*not recognized"): + c.update_config(cfg) + s, matches = c.complete("d.") + assert ".x" in matches + +def test_get__all__entries_ok(): + class A: + __all__ = ["x", 1] + + words = completer.get__all__entries(A()) + assert words == ["x"] + +def test_get__all__entries_no__all__ok(): + class A: + pass + + words = completer.get__all__entries(A()) + assert words == [] + +def test_completes_globals_as_args_of_methods(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + ip.ex("long_variable_name = 1") + ip.ex("a = []") + s, matches = c.complete(None, "a.sort(lo") + assert "long_variable_name" in matches + +def test_completes_attributes_in_fstring_expressions(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + + class CustomClass: + def method_one(self): + pass + + ip.user_ns["custom_obj"] = CustomClass() + + # Test completion inside f-string expressions + s, matches = c.complete(None, "f'{custom_obj.meth") + assert ".method_one" in matches + +def test_completes_in_dict_expressions(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + ip.ex("class Test: pass") + ip.ex("test_obj = Test()") + ip.ex("test_obj.attribute = 'value'") + + # Test completion in dictionary expressions + s, matches = c.complete(None, "d = {'key': test_obj.attr") + assert ".attribute" in matches + + # Test global completion in dictionary expressions with dots + s, matches = c.complete(None, "d = {'k.e.y': Te") + assert "Test" in matches + +def test_func_kw_completions(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + ip.ex("def myfunc(a=1,b=2): return a+b") + s, matches = c.complete(None, "myfunc(1,b") + assert "b=" in matches + # Simulate completing with cursor right after b (pos==10): + s, matches = c.complete(None, "myfunc(1,b)", 10) + assert "b=" in matches + s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b') + assert "b=" in matches + # builtin function + s, matches = c.complete(None, "min(k, k") + assert "key=" in matches + +def test_default_arguments_from_docstring(): + ip = get_ipython() + c = ip.Completer + kwd = c._default_arguments_from_docstring("min(iterable[, key=func]) -> value") + assert kwd == ["key"] + # with cython type etc + kwd = c._default_arguments_from_docstring( + "Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n" + ) + assert kwd == ["ncall", "resume", "nsplit"] + # white spaces + kwd = c._default_arguments_from_docstring( + "\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n" + ) + assert kwd == ["ncall", "resume", "nsplit"] + +def test_line_magics(): + ip = get_ipython() + c = ip.Completer + s, matches = c.complete(None, "lsmag") + assert "%lsmagic" in matches + s, matches = c.complete(None, "%lsmag") + assert "%lsmagic" in matches + +def test_cell_magics(): + from IPython.core.magic import register_cell_magic + + @register_cell_magic + def _foo_cellm(line, cell): + pass + + ip = get_ipython() + c = ip.Completer + + s, matches = c.complete(None, "_foo_ce") + assert "%%_foo_cellm" in matches + s, matches = c.complete(None, "%%_foo_ce") + assert "%%_foo_cellm" in matches + +def test_line_cell_magics(): + from IPython.core.magic import register_line_cell_magic + + @register_line_cell_magic + def _bar_cellm(line, cell): + pass + + ip = get_ipython() + c = ip.Completer + + # The policy here is trickier, see comments in completion code. The + # returned values depend on whether the user passes %% or not explicitly, + # and this will show a difference if the same name is both a line and cell + # magic. + s, matches = c.complete(None, "_bar_ce") + assert "%_bar_cellm" in matches + assert "%%_bar_cellm" in matches + s, matches = c.complete(None, "%_bar_ce") + assert "%_bar_cellm" in matches + assert "%%_bar_cellm" in matches + s, matches = c.complete(None, "%%_bar_ce") + assert "%_bar_cellm" not in matches + assert "%%_bar_cellm" in matches + +def test_line_magics_with_code_argument(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + + # attribute completion + text, matches = c.complete("%timeit -n 2 -r 1 float.as_integer") + assert matches == [".as_integer_ratio"] + + text, matches = c.complete("%debug --breakpoint test float.as_integer") + assert matches == [".as_integer_ratio"] + + text, matches = c.complete("%time --no-raise-error float.as_integer") + assert matches == [".as_integer_ratio"] + + text, matches = c.complete("%prun -l 0.5 -r float.as_integer") + assert matches == [".as_integer_ratio"] + + # implicit magics + text, matches = c.complete("timeit -n 2 -r 1 float.as_integer") + assert matches == [".as_integer_ratio"] + + # built-ins completion + text, matches = c.complete("%timeit -n 2 -r 1 flo") + assert matches == ["float"] + + # dict completion + text, matches = c.complete("%timeit -n 2 -r 1 {'my_key': 1}['my") + assert matches == ["my_key"] + + # invalid arguments - should not throw + text, matches = c.complete("%timeit -n 2 -r 1 -invalid float.as_integer") + assert matches == [] + + text, matches = c.complete("%debug --invalid float.as_integer") + assert matches == [] + +def test_line_magics_with_code_argument_shadowing(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + + # shadow + ip.run_cell("timeit = 1") + + # should not suggest on implict magic when shadowed + text, matches = c.complete("timeit -n 2 -r 1 flo") + assert matches == [] + + # should suggest on explicit magic + text, matches = c.complete("%timeit -n 2 -r 1 flo") + assert matches == ["float"] + + # remove shadow + del ip.user_ns["timeit"] + + # should suggest on implicit magic after shadow removal + text, matches = c.complete("timeit -n 2 -r 1 flo") + assert matches == ["float"] + +def test_magic_completion_order(): + ip = get_ipython() + c = ip.Completer + + # Test ordering of line and cell magics. + text, matches = c.complete("timeit") + assert matches == ["%timeit", "%%timeit"] + +def test_magic_completion_shadowing(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = False + + # Before importing matplotlib, %matplotlib magic should be the only option. + text, matches = c.complete("mat") + assert matches == ["%matplotlib"] + + # The newly introduced name should shadow the magic. + ip.run_cell("matplotlib = 1") + text, matches = c.complete("mat") + assert matches == ["matplotlib"] + + # After removing matplotlib from namespace, the magic should again be + # the only option. + del ip.user_ns["matplotlib"] + text, matches = c.complete("mat") + assert matches == ["%matplotlib"] + +def test_magic_completion_shadowing_explicit(): + """ + If the user try to complete a shadowed magic, and explicit % start should + still return the completions. + """ + ip = get_ipython() + c = ip.Completer + + # Before importing matplotlib, %matplotlib magic should be the only option. + text, matches = c.complete("%mat") + assert matches == ["%matplotlib"] + + ip.run_cell("matplotlib = 1") + + # After removing matplotlib from namespace, the magic should still be + # the only option. + text, matches = c.complete("%mat") + assert matches == ["%matplotlib"] + +def test_magic_config(): + ip = get_ipython() + c = ip.Completer + + s, matches = c.complete(None, "conf") + assert "%config" in matches + s, matches = c.complete(None, "conf") + assert "AliasManager" not in matches + s, matches = c.complete(None, "config ") + assert "AliasManager" in matches + s, matches = c.complete(None, "%config ") + assert "AliasManager" in matches + s, matches = c.complete(None, "config Ali") + assert ["AliasManager"] == matches + s, matches = c.complete(None, "%config Ali") + assert ["AliasManager"] == matches + s, matches = c.complete(None, "config AliasManager") + assert ["AliasManager"] == matches + s, matches = c.complete(None, "%config AliasManager") + assert ["AliasManager"] == matches + s, matches = c.complete(None, "config AliasManager.") + assert "AliasManager.default_aliases" in matches + s, matches = c.complete(None, "%config AliasManager.") + assert "AliasManager.default_aliases" in matches + s, matches = c.complete(None, "config AliasManager.de") + assert ["AliasManager.default_aliases"] == matches + s, matches = c.complete(None, "config AliasManager.de") + assert ["AliasManager.default_aliases"] == matches + +def test_magic_color(): + ip = get_ipython() + c = ip.Completer + + s, matches = c.complete(None, "colo") + assert "%colors" in matches + s, matches = c.complete(None, "colo") + assert "nocolor" not in matches + s, matches = c.complete(None, "%colors") # No trailing space + assert "nocolor" not in matches + s, matches = c.complete(None, "colors ") + assert "nocolor" in matches + s, matches = c.complete(None, "%colors ") + assert "nocolor" in matches + s, matches = c.complete(None, "colors noco") + assert ["nocolor"] == matches + s, matches = c.complete(None, "%colors noco") + assert ["nocolor"] == matches + +def test_match_dict_keys(): + """ + Test that match_dict_keys works on a couple of use case does return what + expected, and does not crash + """ + delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?" + + def match(*args, **kwargs): + quote, offset, matches = match_dict_keys(*args, delims=delims, **kwargs) + return quote, offset, list(matches) + + keys = ["foo", b"far"] + assert match(keys, "b'") == ("'", 2, ["far"]) + assert match(keys, "b'f") == ("'", 2, ["far"]) + assert match(keys, 'b"') == ('"', 2, ["far"]) + assert match(keys, 'b"f') == ('"', 2, ["far"]) + + assert match(keys, "'") == ("'", 1, ["foo"]) + assert match(keys, "'f") == ("'", 1, ["foo"]) + assert match(keys, '"') == ('"', 1, ["foo"]) + assert match(keys, '"f') == ('"', 1, ["foo"]) + + # Completion on first item of tuple + keys = [("foo", 1111), ("foo", 2222), (3333, "bar"), (3333, "test")] + assert match(keys, "'f") == ("'", 1, ["foo"]) + assert match(keys, "33") == ("", 0, ["3333"]) + + # Completion on numbers + keys = [ + 0xDEADBEEF, + 1111, + 1234, + "1999", + 0b10101, + 22, + ] # 0xDEADBEEF = 3735928559; 0b10101 = 21 + assert match(keys, "0xdead") == ("", 0, ["0xdeadbeef"]) + assert match(keys, "1") == ("", 0, ["1111", "1234"]) + assert match(keys, "2") == ("", 0, ["21", "22"]) + assert match(keys, "0b101") == ("", 0, ["0b10101", "0b10110"]) + + # Should yield on variables + assert match(keys, "a_variable") == ("", 0, []) + + # Should pass over invalid literals + assert match(keys, "'' ''") == ("", 0, []) + +def test_match_dict_keys_tuple(): + """ + Test that match_dict_keys called with extra prefix works on a couple of use case, + does return what expected, and does not crash. + """ + delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?" + + keys = [("foo", "bar"), ("foo", "oof"), ("foo", b"bar"), ("other", "test")] + + def match(*args, extra=None, **kwargs): + quote, offset, matches = match_dict_keys( + *args, delims=delims, extra_prefix=extra, **kwargs + ) + return quote, offset, list(matches) + + # Completion on first key == "foo" + assert match(keys, "'", extra=("foo",)) == ("'", 1, ["bar", "oof"]) + assert match(keys, '"', extra=("foo",)) == ('"', 1, ["bar", "oof"]) + assert match(keys, "'o", extra=("foo",)) == ("'", 1, ["oof"]) + assert match(keys, '"o', extra=("foo",)) == ('"', 1, ["oof"]) + assert match(keys, "b'", extra=("foo",)) == ("'", 2, ["bar"]) + assert match(keys, 'b"', extra=("foo",)) == ('"', 2, ["bar"]) + assert match(keys, "b'b", extra=("foo",)) == ("'", 2, ["bar"]) + assert match(keys, 'b"b', extra=("foo",)) == ('"', 2, ["bar"]) + + # No Completion + assert match(keys, "'", extra=("no_foo",)) == ("'", 1, []) + assert match(keys, "'", extra=("fo",)) == ("'", 1, []) + + keys = [("foo1", "foo2", "foo3", "foo4"), ("foo1", "foo2", "bar", "foo4")] + assert match(keys, "'foo", extra=("foo1",)) == ("'", 1, ["foo2"]) + assert match(keys, "'foo", extra=("foo1", "foo2")) == ("'", 1, ["foo3"]) + assert match(keys, "'foo", extra=("foo1", "foo2", "foo3")) == ("'", 1, ["foo4"]) + assert match(keys, "'foo", extra=("foo1", "foo2", "foo3", "foo4")) == ( + "'", + 1, + [], + ) + + keys = [("foo", 1111), ("foo", "2222"), (3333, "bar"), (3333, 4444)] + assert match(keys, "'", extra=("foo",)) == ("'", 1, ["2222"]) + assert match(keys, "", extra=("foo",)) == ("", 0, ["1111", "'2222'"]) + assert match(keys, "'", extra=(3333,)) == ("'", 1, ["bar"]) + assert match(keys, "", extra=(3333,)) == ("", 0, ["'bar'", "4444"]) + assert match(keys, "'", extra=("3333",)) == ("'", 1, []) + assert match(keys, "33") == ("", 0, ["3333"]) + +def test_dict_key_completion_closures(): + ip = get_ipython() + complete = ip.Completer.complete + ip.Completer.auto_close_dict_keys = True + + ip.user_ns["d"] = { + # tuple only + ("aa", 11): None, + # tuple and non-tuple + ("bb", 22): None, + "bb": None, + # non-tuple only + "cc": None, + # numeric tuple only + (77, "x"): None, + # numeric tuple and non-tuple + (88, "y"): None, + 88: None, + # numeric non-tuple only + 99: None, + } + + _, matches = complete(line_buffer="d[") + # should append `, ` if matches a tuple only + assert "'aa' in ", matches + # should not append anything if matches a tuple and an item + assert "'bb'" in matches + # should append `]` if matches and item only + assert "'cc']" in matches + + # should append `, ` if matches a tuple only + assert "77 in ", matches + # should not append anything if matches a tuple and an item + assert "88" in matches + # should append `]` if matches and item only + assert "99]" in matches + + _, matches = complete(line_buffer="d['aa', ") + # should restrict matches to those matching tuple prefix + assert "11]" in matches + assert "'bb'" not in matches + assert "'bb' not in ", matches + assert "'bb']" not in matches + assert "'cc'" not in matches + assert "'cc' not in ", matches + assert "'cc']" not in matches + ip.Completer.auto_close_dict_keys = False + +def test_dict_key_completion_string(): + """Test dictionary key completion for string keys""" + ip = get_ipython() + complete = ip.Completer.complete + + ip.user_ns["d"] = {"abc": None} + + # check completion at different stages + _, matches = complete(line_buffer="d[") + assert "'abc'" in matches + assert "'abc']" not in matches + + _, matches = complete(line_buffer="d['") + assert "abc" in matches + assert "abc']" not in matches + + _, matches = complete(line_buffer="d['a") + assert "abc" in matches + assert "abc']" not in matches + + # check use of different quoting + _, matches = complete(line_buffer='d["') + assert "abc" in matches + assert 'abc"]' not in matches + + _, matches = complete(line_buffer='d["a') + assert "abc" in matches + assert 'abc"]' not in matches + + # check sensitivity to following context + _, matches = complete(line_buffer="d[]", cursor_pos=2) + assert "'abc'" in matches + + _, matches = complete(line_buffer="d['']", cursor_pos=3) + assert "abc" in matches + assert "abc'" not in matches + assert "abc']" not in matches + + # check multiple solutions are correctly returned and that noise is not + ip.user_ns["d"] = { + "abc": None, + "abd": None, + "bad": None, + object(): None, + 5: None, + ("abe", None): None, + (None, "abf"): None, + } + + _, matches = complete(line_buffer="d['a") + assert "abc" in matches + assert "abd" in matches + assert "bad" not in matches + assert "abe" not in matches + assert "abf" not in matches + assert not any(m.endswith(("]", '"', "'")) for m in matches), matches + + # check escaping and whitespace + ip.user_ns["d"] = {"a\nb": None, "a'b": None, 'a"b': None, "a word": None} + _, matches = complete(line_buffer="d['a") + assert "a\\nb" in matches + assert "a\\'b" in matches + assert 'a"b' in matches + assert "a word" in matches + assert not any(m.endswith(("]", '"', "'")) for m in matches), matches + + # - can complete on non-initial word of the string + _, matches = complete(line_buffer="d['a w") + assert "word" in matches + + # - understands quote escaping + _, matches = complete(line_buffer="d['a\\'") + assert "b" in matches + + # - default quoting should work like repr + _, matches = complete(line_buffer="d[") + assert '"a\'b"' in matches + + # - when opening quote with ", possible to match with unescaped apostrophe + _, matches = complete(line_buffer="d[\"a'") + assert "b" in matches + + # need to not split at delims that readline won't split at + if "-" not in ip.Completer.splitter.delims: + ip.user_ns["d"] = {"before-after": None} + _, matches = complete(line_buffer="d['before-af") + assert "before-after" in matches + + # check completion on tuple-of-string keys at different stage - on first key + ip.user_ns["d"] = {("foo", "bar"): None} + _, matches = complete(line_buffer="d[") + assert "'foo'" in matches + assert "'foo']" not in matches + assert "'bar'" not in matches + assert "foo" not in matches + assert "bar" not in matches + + # - match the prefix + _, matches = complete(line_buffer="d['f") + assert "foo" in matches + assert "foo']" not in matches + assert 'foo"]' not in matches + _, matches = complete(line_buffer="d['foo") + assert "foo" in matches + + # - can complete on second key + _, matches = complete(line_buffer="d['foo', ") + assert "'bar'" in matches + _, matches = complete(line_buffer="d['foo', 'b") + assert "bar" in matches + assert "foo" not in matches + + # - does not propose missing keys + _, matches = complete(line_buffer="d['foo', 'f") + assert "bar" not in matches + assert "foo" not in matches + + # check sensitivity to following context + _, matches = complete(line_buffer="d['foo',]", cursor_pos=8) + assert "'bar'" in matches + assert "bar" not in matches + assert "'foo'" not in matches + assert "foo" not in matches + + _, matches = complete(line_buffer="d['']", cursor_pos=3) + assert "foo" in matches + assert not any(m.endswith(("]", '"', "'")) for m in matches), matches + + _, matches = complete(line_buffer='d[""]', cursor_pos=3) + assert "foo" in matches + assert not any(m.endswith(("]", '"', "'")) for m in matches), matches + + _, matches = complete(line_buffer='d["foo","]', cursor_pos=9) + assert "bar" in matches + assert not any(m.endswith(("]", '"', "'")) for m in matches), matches + + _, matches = complete(line_buffer='d["foo",]', cursor_pos=8) + assert "'bar'" in matches + assert "bar" not in matches + + # Can complete with longer tuple keys + ip.user_ns["d"] = {("foo", "bar", "foobar"): None} + + # - can complete second key + _, matches = complete(line_buffer="d['foo', 'b") + assert "bar" in matches + assert "foo" not in matches + assert "foobar" not in matches + + # - can complete third key + _, matches = complete(line_buffer="d['foo', 'bar', 'fo") + assert "foobar" in matches + assert "foo" not in matches + assert "bar" not in matches + +def test_dict_key_completion_numbers(): + ip = get_ipython() + complete = ip.Completer.complete + + ip.user_ns["d"] = { + 0xDEADBEEF: None, # 3735928559 + 1111: None, + 1234: None, + "1999": None, + 0b10101: None, # 21 + 22: None, + } + _, matches = complete(line_buffer="d[1") + assert "1111" in matches + assert "1234" in matches + assert "1999" not in matches + assert "'1999'" not in matches + + _, matches = complete(line_buffer="d[0xdead") + assert "0xdeadbeef" in matches + + _, matches = complete(line_buffer="d[2") + assert "21" in matches + assert "22" in matches + + _, matches = complete(line_buffer="d[0b101") + assert "0b10101" in matches + assert "0b10110" in matches + +def test_dict_key_completion_contexts(): + """Test expression contexts in which dict key completion occurs""" + ip = get_ipython() + complete = ip.Completer.complete + d = {"abc": None} + ip.user_ns["d"] = d + + class C: + data = d + + ip.user_ns["C"] = C + ip.user_ns["get"] = lambda: d + ip.user_ns["nested"] = {"x": d} + + def assert_no_completion(**kwargs): + _, matches = complete(**kwargs) + assert "abc" not in matches + assert "abc'" not in matches + assert "abc']" not in matches + assert "'abc'" not in matches + assert "'abc']" not in matches + + def assert_completion(**kwargs): + _, matches = complete(**kwargs) + assert "'abc'" in matches + assert "'abc']" not in matches + + # no completion after string closed, even if reopened + assert_no_completion(line_buffer="d['a'") + assert_no_completion(line_buffer='d["a"') + assert_no_completion(line_buffer="d['a' + ") + assert_no_completion(line_buffer="d['a' + '") + + # completion in non-trivial expressions + assert_completion(line_buffer="+ d[") + assert_completion(line_buffer="(d[") + assert_completion(line_buffer="C.data[") + + # nested dict completion + assert_completion(line_buffer="nested['x'][") + + with evaluation_policy("minimal"): + with pytest.raises(AssertionError): + assert_completion(line_buffer="nested['x'][") + + # greedy flag + def assert_completion(**kwargs): + _, matches = complete(**kwargs) + assert "get()['abc']" in matches + + assert_no_completion(line_buffer="get()[") + with greedy_completion(): + assert_completion(line_buffer="get()[") + assert_completion(line_buffer="get()['") + assert_completion(line_buffer="get()['a") + assert_completion(line_buffer="get()['ab") + assert_completion(line_buffer="get()['abc") + +def test_completion_autoimport(): + ip = get_ipython() + complete = ip.Completer.complete + with ( + evaluation_policy("limited", allow_auto_import=True), + jedi_status(False), + ): + _, matches = complete(line_buffer="math.") + assert ".pi" in matches + +def test_completion_no_autoimport(): + ip = get_ipython() + complete = ip.Completer.complete + with ( + evaluation_policy("limited", allow_auto_import=False), + jedi_status(False), + ): + _, matches = complete(line_buffer="math.") + assert ".pi" not in matches + +def test_completion_allow_custom_getattr_per_module(): + factory_code = textwrap.dedent( + """ + class ListFactory: + def __getattr__(self, attr): + return [] + """ + ) + + safe_lib = types.ModuleType("my.safe.lib") + sys.modules["my.safe.lib"] = safe_lib + exec(factory_code, safe_lib.__dict__) + + unsafe_lib = types.ModuleType("my.unsafe.lib") + sys.modules["my.unsafe.lib"] = unsafe_lib + exec(factory_code, unsafe_lib.__dict__) + + fake_safe_lib = types.ModuleType("my_fake_lib") + sys.modules["my_fake_lib"] = fake_safe_lib + exec(factory_code, fake_safe_lib.__dict__) + + ip = get_ipython() + ip.user_ns["safe_list_factory"] = safe_lib.ListFactory() + ip.user_ns["unsafe_list_factory"] = unsafe_lib.ListFactory() + ip.user_ns["fake_safe_factory"] = fake_safe_lib.ListFactory() + complete = ip.Completer.complete + with ( + evaluation_policy("limited", allowed_getattr_external={"my.safe.lib"}), + jedi_status(False), + ): + _, matches = complete(line_buffer="safe_list_factory.example.") + assert ".append" in matches + # this also checks against https://github.com/ipython/ipython/issues/14916 + # because removing "un" would cause this test to incorrectly pass + _, matches = complete(line_buffer="unsafe_list_factory.example.") + assert ".append" not in matches + + sys.modules["my"] = types.ModuleType("my") + + with ( + evaluation_policy("limited", allowed_getattr_external={"my"}), + jedi_status(False), + ): + _, matches = complete(line_buffer="safe_list_factory.example.") + assert ".append" in matches + _, matches = complete(line_buffer="unsafe_list_factory.example.") + assert ".append" in matches + _, matches = complete(line_buffer="fake_safe_factory.example.") + assert ".append" not in matches + + with ( + evaluation_policy("limited"), + jedi_status(False), + ): + _, matches = complete(line_buffer="safe_list_factory.example.") + assert ".append" not in matches + _, matches = complete(line_buffer="unsafe_list_factory.example.") + assert ".append" not in matches + +def test_completion_allow_subclass_of_trusted_module(): + factory_code = textwrap.dedent( + """ + class ListFactory: + def __getattr__(self, attr): + return [] + """ + ) + trusted_lib = types.ModuleType("my.trusted.lib") + sys.modules["my.trusted.lib"] = trusted_lib + exec(factory_code, trusted_lib.__dict__) + + ip = get_ipython() + # Create a subclass in __main__ (untrusted namespace) + subclass_code = textwrap.dedent( + """ + class SubclassFactory(trusted_lib.ListFactory): + pass + """ + ) + ip.user_ns["trusted_lib"] = trusted_lib + exec(subclass_code, ip.user_ns) + ip.user_ns["subclass_factory"] = ip.user_ns["SubclassFactory"]() + complete = ip.Completer.complete + with ( + evaluation_policy("limited", allowed_getattr_external={"my.trusted.lib"}), + jedi_status(False), + ): + _, matches = complete(line_buffer="subclass_factory.example.") + assert ".append" in matches + + # Test that overriding __getattr__ in subclass in untrusted namespace prevents completion + overriding_subclass_code = textwrap.dedent( + """ + class OverridingSubclass(trusted_lib.ListFactory): + def __getattr__(self, attr): + return {} + """ + ) + exec(overriding_subclass_code, ip.user_ns) + ip.user_ns["overriding_factory"] = ip.user_ns["OverridingSubclass"]() + + with ( + evaluation_policy("limited", allowed_getattr_external={"my.trusted.lib"}), + jedi_status(False), + ): + _, matches = complete(line_buffer="overriding_factory.example.") + assert ".append" not in matches + assert ".keys" not in matches + +def test_completion_fallback_to_annotation_for_attribute(): + code = textwrap.dedent( + """ + class StringMethods: + def a(): + pass + + class Test: + str: StringMethods + def __init__(self): + self.str = StringMethods() + def __getattr__(self, name): + raise AttributeError(f"{name} not found") + """ + ) + + repro = types.ModuleType("repro") + sys.modules["repro"] = repro + exec(code, repro.__dict__) + + ip = get_ipython() + ip.user_ns["repro"] = repro + exec("r = repro.Test()", ip.user_ns) + + complete = ip.Completer.complete + try: + with evaluation_policy("limited"), jedi_status(False): + _, matches = complete(line_buffer="r.str.") + assert ".a" in matches + finally: + sys.modules.pop("repro", None) + ip.user_ns.pop("r", None) + +def test_policy_warnings(): + with pytest.warns(UserWarning): + with evaluation_policy("unsafe", allowed_getattr_external=[]): + pass + + with pytest.warns(UserWarning): + with evaluation_policy("limited", test=[]): + pass + +def test_dict_key_completion_bytes(): + """Test handling of bytes in dict key completion""" + ip = get_ipython() + complete = ip.Completer.complete + + ip.user_ns["d"] = {"abc": None, b"abd": None} + + _, matches = complete(line_buffer="d[") + assert "'abc'" in matches + assert "b'abd'" in matches + + if False: # not currently implemented + _, matches = complete(line_buffer="d[b") + assert "b'abd'" in matches + assert "b'abc'" not in matches + + _, matches = complete(line_buffer="d[b'") + assert "abd" in matches + assert "abc" not in matches + + _, matches = complete(line_buffer="d[B'") + assert "abd" in matches + assert "abc" not in matches + + _, matches = complete(line_buffer="d['") + assert "abc" in matches + assert "abd" not in matches + +def test_dict_key_completion_unicode_py3(): + """Test handling of unicode in dict key completion""" + ip = get_ipython() + complete = ip.Completer.complete + + ip.user_ns["d"] = {"a\u05d0": None} + + # query using escape + if sys.platform != "win32": + # Known failure on Windows + _, matches = complete(line_buffer="d['a\\u05d0") + assert "u05d0" in matches # tokenized after \\ + + # query using character + _, matches = complete(line_buffer="d['a\u05d0") + assert "a\u05d0" in matches + + with greedy_completion(): + # query using escape + _, matches = complete(line_buffer="d['a\\u05d0") + assert "d['a\\u05d0']" in matches # tokenized after \\ + + # query using character + _, matches = complete(line_buffer="d['a\u05d0") + assert "d['a\u05d0']" in matches + +@dec.skip_without("numpy") +def test_struct_array_key_completion(): + """Test dict key completion applies to numpy struct arrays""" + import numpy + + ip = get_ipython() + complete = ip.Completer.complete + ip.user_ns["d"] = numpy.array([], dtype=[("hello", "f"), ("world", "f")]) + _, matches = complete(line_buffer="d['") + assert "hello" in matches + assert "world" in matches + # complete on the numpy struct itself + dt = numpy.dtype( + [("my_head", [("my_dt", ">u4"), ("my_df", ">u4")]), ("my_data", ">f4", 5)] + ) + x = numpy.zeros(2, dtype=dt) + ip.user_ns["d"] = x[1] + _, matches = complete(line_buffer="d['") + assert "my_head" in matches + assert "my_data" in matches + + def completes_on_nested(): + ip.user_ns["d"] = numpy.zeros(2, dtype=dt) + _, matches = complete(line_buffer="d[1]['my_head']['") + assert any(["my_dt" in m for m in matches]) + assert any(["my_df" in m for m in matches]) + + # complete on a nested level + with greedy_completion(): + completes_on_nested() + + with evaluation_policy("limited"): + completes_on_nested() + + with evaluation_policy("minimal"): + with pytest.raises(AssertionError): + completes_on_nested() + +@dec.skip_without("pandas") +def test_dataframe_key_completion(): + """Test dict key completion applies to pandas DataFrames""" + import pandas + + ip = get_ipython() + complete = ip.Completer.complete + ip.user_ns["d"] = pandas.DataFrame({"hello": [1], "world": [2]}) + _, matches = complete(line_buffer="d['") + assert "hello" in matches + assert "world" in matches + _, matches = complete(line_buffer="d.loc[:, '") + assert "hello" in matches + assert "world" in matches + _, matches = complete(line_buffer="d.loc[1:, '") + assert "hello" in matches + _, matches = complete(line_buffer="d.loc[1:1, '") + assert "hello" in matches + _, matches = complete(line_buffer="d.loc[1:1:-1, '") + assert "hello" in matches + _, matches = complete(line_buffer="d.loc[::, '") + assert "hello" in matches + +def test_dict_key_completion_invalids(): + """Smoke test cases dict key completion can't handle""" + ip = get_ipython() + complete = ip.Completer.complete + + ip.user_ns["no_getitem"] = None + ip.user_ns["no_keys"] = [] + ip.user_ns["cant_call_keys"] = dict + ip.user_ns["empty"] = {} + ip.user_ns["d"] = {"abc": 5} + + _, matches = complete(line_buffer="no_getitem['") + _, matches = complete(line_buffer="no_keys['") + _, matches = complete(line_buffer="cant_call_keys['") + _, matches = complete(line_buffer="empty['") + _, matches = complete(line_buffer="name_error['") + _, matches = complete(line_buffer="d['\\") # incomplete escape + +def test_object_key_completion(): + ip = get_ipython() + ip.user_ns["key_completable"] = KeyCompletable(["qwerty", "qwick"]) + + _, matches = ip.Completer.complete(line_buffer="key_completable['qw") + assert "qwerty" in matches + assert "qwick" in matches + +def test_class_key_completion(): + ip = get_ipython() + NamedInstanceClass("qwerty") + NamedInstanceClass("qwick") + ip.user_ns["named_instance_class"] = NamedInstanceClass + + _, matches = ip.Completer.complete(line_buffer="named_instance_class['qw") + assert "qwerty" in matches + assert "qwick" in matches + +def test_tryimport(): + """ + Test that try-import don't crash on trailing dot, and import modules before + """ + from IPython.core.completerlib import try_import + + assert try_import("IPython.") + +def test_aimport_module_completer(): + ip = get_ipython() + _, matches = ip.complete("i", "%aimport i") + assert "io" in matches + assert "int" not in matches + +def test_nested_import_module_completer(): + ip = get_ipython() + _, matches = ip.complete(None, "import IPython.co", 17) + assert "IPython.core" in matches + assert "import IPython.core" not in matches + assert "IPython.display" not in matches + +def test_import_module_completer(): + ip = get_ipython() + _, matches = ip.complete("i", "import i") + assert "io" in matches + assert "int" not in matches + +def test_from_module_completer(): + ip = get_ipython() + _, matches = ip.complete("B", "from io import B", 16) + assert "BytesIO" in matches + assert "BaseException" not in matches + +def test_snake_case_completion(): + ip = get_ipython() + ip.Completer.use_jedi = False + ip.user_ns["some_three"] = 3 + ip.user_ns["some_four"] = 4 + _, matches = ip.complete("s_", "print(s_f") + assert "some_three" in matches + assert "some_four" in matches + +def test_mix_terms(): + ip = get_ipython() + from textwrap import dedent + + ip.Completer.use_jedi = False + ip.ex( + dedent( + """ + class Test: + def meth(self, meth_arg1): + print("meth") + + def meth_1(self, meth1_arg1, meth1_arg2): + print("meth1") + + def meth_2(self, meth2_arg1, meth2_arg2): + print("meth2") + test = Test() + """ + ) + ) + _, matches = ip.complete(None, "test.meth(") + assert "meth_arg1=" in matches + assert "meth2_arg1=" not in matches + +def test_percent_symbol_restrict_to_magic_completions(): + ip = get_ipython() + completer = ip.Completer + text = "%a" + + with provisionalcompleter(): + completer.use_jedi = True + completions = completer.completions(text, len(text)) + for c in completions: + assert c.text[0] == "%" + +def test_fwd_unicode_restricts(): + ip = get_ipython() + completer = ip.Completer + text = "\\ROMAN NUMERAL FIVE" + + with provisionalcompleter(): + completer.use_jedi = True + completions = [ + completion.text for completion in completer.completions(text, len(text)) + ] + assert completions == ["\u2164"] + +def test_dict_key_restrict_to_dicts(): + """Test that dict key suppresses non-dict completion items""" + ip = get_ipython() + c = ip.Completer + d = {"abc": None} + ip.user_ns["d"] = d + + text = 'd["a' + + def _(): + with provisionalcompleter(): + c.use_jedi = True + return [ + completion.text for completion in c.completions(text, len(text)) + ] + + completions = _() + assert completions == ["abc"] + + # check that it can be disabled in granular manner: + cfg = Config() + cfg.IPCompleter.suppress_competing_matchers = { + "IPCompleter.dict_key_matcher": False + } + c.update_config(cfg) + + completions = _() + assert "abc" in completions + assert len(completions) > 1 + +def test_matcher_suppression(): + @completion_matcher(identifier="a_matcher") + def a_matcher(text): + return ["completion_a"] + + @completion_matcher(identifier="b_matcher", api_version=2) + def b_matcher(context: CompletionContext): + text = context.token + result = {"completions": [SimpleCompletion("completion_b")]} + + if text == "suppress c": + result["suppress"] = {"c_matcher"} + + if text.startswith("suppress all"): + result["suppress"] = True + if text == "suppress all but c": + result["do_not_suppress"] = {"c_matcher"} + if text == "suppress all but a": + result["do_not_suppress"] = {"a_matcher"} + + return result + + @completion_matcher(identifier="c_matcher") + def c_matcher(text): + return ["completion_c"] + + with custom_matchers([a_matcher, b_matcher, c_matcher]): + ip = get_ipython() + c = ip.Completer + + def _(text, expected): + c.use_jedi = False + s, matches = c.complete(text) + assert expected == matches + + _("do not suppress", ["completion_a", "completion_b", "completion_c"]) + _("suppress all", ["completion_b"]) + _("suppress all but a", ["completion_a", "completion_b"]) + _("suppress all but c", ["completion_b", "completion_c"]) + + def configure(suppression_config): + cfg = Config() + cfg.IPCompleter.suppress_competing_matchers = suppression_config + c.update_config(cfg) + + # test that configuration takes priority over the run-time decisions + + configure(False) + _("suppress all", ["completion_a", "completion_b", "completion_c"]) + + configure({"b_matcher": False}) + _("suppress all", ["completion_a", "completion_b", "completion_c"]) + + configure({"a_matcher": False}) + _("suppress all", ["completion_b"]) + + configure({"b_matcher": True}) + _("do not suppress", ["completion_b"]) + + configure(True) + _("do not suppress", ["completion_a"]) + +def test_matcher_suppression_with_iterator(): + @completion_matcher(identifier="matcher_returning_iterator") + def matcher_returning_iterator(text): + return iter(["completion_iter"]) + + @completion_matcher(identifier="matcher_returning_list") + def matcher_returning_list(text): + return ["completion_list"] + + with custom_matchers([matcher_returning_iterator, matcher_returning_list]): + ip = get_ipython() + c = ip.Completer + + def _(text, expected): + c.use_jedi = False + s, matches = c.complete(text) + assert expected == matches + + def configure(suppression_config): + cfg = Config() + cfg.IPCompleter.suppress_competing_matchers = suppression_config + c.update_config(cfg) + + configure(False) + _("---", ["completion_iter", "completion_list"]) + + configure(True) + _("---", ["completion_iter"]) + + configure(None) + _("--", ["completion_iter", "completion_list"]) + +@pytest.mark.xfail( + sys.version_info.releaselevel in ("alpha",), + reason="Parso does not yet parse 3.13", +) +def test_matcher_suppression_with_jedi(): + ip = get_ipython() + c = ip.Completer + c.use_jedi = True + + def configure(suppression_config): + cfg = Config() + cfg.IPCompleter.suppress_competing_matchers = suppression_config + c.update_config(cfg) + + def _(): + with provisionalcompleter(): + matches = [completion.text for completion in c.completions("dict.", 5)] + assert "keys" in matches + + configure(False) + _() + + configure(True) + _() + + configure(None) + _() + +def test_matcher_disabling(): + @completion_matcher(identifier="a_matcher") + def a_matcher(text): + return ["completion_a"] + + @completion_matcher(identifier="b_matcher") + def b_matcher(text): + return ["completion_b"] + + def _(expected): + s, matches = c.complete("completion_") + assert expected == matches + + with custom_matchers([a_matcher, b_matcher]): + ip = get_ipython() + c = ip.Completer + + _(["completion_a", "completion_b"]) + + cfg = Config() + cfg.IPCompleter.disable_matchers = ["b_matcher"] + c.update_config(cfg) + + _(["completion_a"]) + + cfg.IPCompleter.disable_matchers = [] + c.update_config(cfg) + +def test_matcher_priority(): + @completion_matcher(identifier="a_matcher", priority=0, api_version=2) + def a_matcher(text): + return {"completions": [SimpleCompletion("completion_a")], "suppress": True} + + @completion_matcher(identifier="b_matcher", priority=2, api_version=2) + def b_matcher(text): + return {"completions": [SimpleCompletion("completion_b")], "suppress": True} + + def _(expected): + s, matches = c.complete("completion_") + assert expected == matches + + with custom_matchers([a_matcher, b_matcher]): + ip = get_ipython() + c = ip.Completer + + _(["completion_b"]) + a_matcher.matcher_priority = 3 + _(["completion_a"]) + +def test_private_attr_completions(): + ip = get_ipython() + ip.user_ns["Test"] = type("Test", (), {"_test1": 1, "__test2": 2}) + ip.user_ns["t"] = ip.user_ns["Test"]() + ip.Completer.use_jedi = False + + try: + with provisionalcompleter(): + completions = list(ip.Completer.completions(text="t._", offset=3)) + completion_texts = [c.text for c in completions] + + assert ( + "._test1" in completion_texts + ), f"_test1 not found in {completion_texts}" + assert ( + ".__test2" in completion_texts + ), f"__test2 not found in {completion_texts}" + finally: + del ip.user_ns["Test"] + del ip.user_ns["t"] + + +@pytest.mark.parametrize( + "use_jedi,evaluation", + [ + [True, "minimal"], + [False, "limited"], + ], +) +@pytest.mark.parametrize( + "code,insert_text", + [ + [ + "\n".join( + [ + "class NotYetDefined:", + " def my_method(self) -> str:", + " return 1", + "my_instance = NotYetDefined()", + "my_insta", + ] + ), + "my_instance", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def my_method(self) -> str:", + " return 1", + "instance = NotYetDefined()", + "instance.", + ] + ), + "my_method", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def my_method(self) -> str:", + " return 1", + "my_instance = NotYetDefined()", + "my_instance.my_method().", + ] + ), + "capitalize", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def my_method(self):", + " return []", + "my_instance = NotYetDefined()", + "my_instance.my_method().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " @property", + " def my_property(self):", + " return 1.1", + "my_instance = NotYetDefined()", + "my_instance.my_property.", + ] + ), + "as_integer_ratio", + ], + [ + "\n".join( + [ + "my_instance = 1.1", + "assert my_instance.", + ] + ), + "as_integer_ratio", + ], + [ + "\n".join( + [ + "def my_test() -> float:", + " pass", + "my_test().", + ] + ), + "as_integer_ratio", + ], + [ + "\n".join( + [ + "def my_test():", + " return {}", + "my_test().", + ] + ), + "keys", + ], + [ + "\n".join( + [ + "l = []", + "def my_test():", + " return l", + "my_test().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "num = {1: 'one'}", + "num[2] = 'two'", + "num.", + ] + ), + "keys", + ], + [ + "\n".join( + [ + "num = {1: 'one'}", + "num[2] = ['two']", + "num[2].", + ] + ), + "append", + ], + [ + "\n".join( + [ + "l = []", + "class NotYetDefined:", + " def my_method(self):", + " return l", + "my_instance = NotYetDefined()", + "my_instance.my_method().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "def string_or_int(flag):", + " if flag:", + " return 'test'", + " return 1", + "string_or_int().", + ] + ), + ["capitalize", "as_integer_ratio"], + ], + [ + "\n".join( + [ + "def foo():", + " l = []", + " return l", + "foo().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def __init__(self):", + " self.test = []", + "instance = NotYetDefined()", + "instance.", + ] + ), + "test", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def __init__(instance):", + " instance.test = []", + "instance = NotYetDefined()", + "instance.test.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def __init__(this):", + " this.test:str = []", + "instance = NotYetDefined()", + "instance.test.", + ] + ), + "capitalize", + ], + [ + "\n".join( + [ + "l = []", + "class NotYetDefined:", + " def __init__(me):", + " me.test = l", + "instance = NotYetDefined()", + "instance.test.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def test(self):", + " self.l = []", + " return self.l", + "instance = NotYetDefined()", + "instance.test().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "class NotYetDefined:", + " def test():", + " return []", + "instance = NotYetDefined()", + "instance.test().", + ] + ), + "append", + ], + [ + "\n".join( + [ + "def foo():", + " if some_condition:", + " return {'top':{'mid':{'leaf': 2}}}", + " return {'top': {'mid':[]}}", + "foo()['top']['mid'].", + ] + ), + ["keys", "append"], + ], + [ + "\n".join( + [ + "def foo():", + " if some_condition:", + " return {'top':{'mid':{'leaf': 2}}}", + " return {'top': {'mid':[]}}", + "foo()['top']['mid']['leaf'].", + ] + ), + "as_integer_ratio", + ], + [ + "\n".join( + [ + "async def async_func():", + " return []", + "async_func().", + ] + ), + "cr_await", + ], + [ + "\n".join( + [ + "async def async_func():", + " return []", + "(await async_func()).", + ] + ), + "append", + ], + [ + "\n".join(["t = []", "if some_condition:", " t."]), + "append", + ], + [ + "\n".join( + [ + "t = []", + "if some_condition:", + " t = 'string'", + "t.", + ] + ), + ["append", "capitalize"], + ], + [ + "\n".join( + [ + "t = []", + "if some_condition:", + " t = 'string'", + "else:", + " t.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "t = []", + "if some_condition:", + " t = 'string'", + "else:", + " t = 1", + "t.", + ] + ), + ["append", "capitalize", "as_integer_ratio"], + ], + [ + "\n".join( + [ + "t = []", + "if condition_1:", + " t = 'string'", + "elif condition_2:", + " t = 1", + "elif condition_3:", + " t.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "t = []", + "if condition_1:", + " t = 'string'", + "elif condition_2:", + " t = 1", + "elif condition_3:", + " t = {}", + "t.", + ] + ), + ["append", "capitalize", "as_integer_ratio", "keys"], + ], + [ + "\n".join( + [ + "t = []", + "if condition_1:", + " if condition_2:", + " t = 'nested'", + "t.", + ] + ), + ["append", "capitalize"], + ], + [ + "\n".join( + [ + "a = []", + "while condition:", + " a.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "t = []", + "while condition:", + " t = 'str'", + "t.", + ] + ), + ["append", "capitalize"], + ], + [ + "\n".join( + [ + "t = []", + "while condition_1:", + " while condition_2:", + " t = 'str'", + "t.", + ] + ), + ["append", "capitalize"], + ], + [ + "\n".join( + [ + "for i in range(10):", + " i.", + ] + ), + "bit_length", + ], + [ + "\n".join( + [ + "for i in range(10):", + " if i % 2 == 0:", + " i.", + ] + ), + "bit_length", + ], + [ + "\n".join( + [ + "for item in ['a', 'b', 'c']:", + " item.", + ] + ), + "capitalize", + ], + [ + "\n".join( + [ + "for key, value in {'a': 1, 'b': 2}.items():", + " key.", + ] + ), + "capitalize", + ], + [ + "\n".join( + [ + "for key, value in {'a': 1, 'b': 2}.items():", + " value.", + ] + ), + "bit_length", + ], + [ + "\n".join( + [ + "for sublist in [[1, 2], [3, 4]]:", + " sublist.", + ] + ), + "append", + ], + [ + "\n".join( + [ + "for sublist in [[1, 2], [3, 4]]:", + " for item in sublist:", + " item.", + ] + ), + "bit_length", + ], + [ + "\n".join( + [ + "t: list[str]", + "t[0].", + ] + ), + ["capitalize"], + ], + ], +) +def test_undefined_variables(use_jedi, evaluation, code, insert_text): + offset = len(code) + ip.Completer.use_jedi = use_jedi + ip.Completer.evaluation = evaluation + + with provisionalcompleter(): + completions = list(ip.Completer.completions(text=code, offset=offset)) + insert_texts = insert_text if isinstance(insert_text, list) else [insert_text] + for text in insert_texts: + match = [c for c in completions if c.text.lstrip(".") == text] + message_on_fail = f"{text} not found among {[c.text for c in completions]}" + assert len(match) == 1, message_on_fail + + +@pytest.mark.parametrize( + "code,insert_text", + [ + [ + "\n".join( + [ + "t: dict = {'a': []}", + "t['a'].", + ] + ), + ["append"], + ], + [ + "\n".join( + [ + "t: int | dict = {'a': []}", + "t.", + ] + ), + ["keys", "bit_length"], + ], + [ + "\n".join( + [ + "t: int | dict = {'a': []}", + "t['a'].", + ] + ), + "append", + ], + # Test union types + [ + "\n".join( + [ + "t: int | str", + "t.", + ] + ), + ["bit_length", "capitalize"], + ], + [ + "\n".join( + [ + "def func() -> int | str: pass", + "func().", + ] + ), + ["bit_length", "capitalize"], + ], + [ + "\n".join( + [ + "t: list = ['test']", + "t[0].", + ] + ), + ["capitalize"], + ], + [ + "\n".join( + [ + "class T:", + " @property", + " def p(self) -> int | str: pass", + "t = T()", + "t.p.", + ] + ), + ["bit_length", "capitalize"], + ], + ], +) +def test_undefined_variables_without_jedi(code, insert_text): + offset = len(code) + ip.Completer.use_jedi = False + ip.Completer.evaluation = "limited" + + with provisionalcompleter(): + completions = list(ip.Completer.completions(text=code, offset=offset)) + insert_texts = insert_text if isinstance(insert_text, list) else [insert_text] + for text in insert_texts: + match = [c for c in completions if c.text.lstrip(".") == text] + message_on_fail = f"{text} not found among {[c.text for c in completions]}" + assert len(match) == 1, message_on_fail + + +@pytest.mark.parametrize( + "code", + [ + "\n".join( + [ + "def my_test() -> float:", + " return 1.1", + "my_test().", + ] + ), + "\n".join( + [ + "class MyClass():", + " b: list[str]", + "x = MyClass()", + "x.b[0].", + ] + ), + "\n".join( + [ + "class MyClass():", + " b: list[str]", + "x = MyClass()", + "x.fake_attr().", + ] + ), + ], +) +def test_no_file_completions_in_attr_access(code): + """Test that files are not suggested during attribute/method completion.""" + with TemporaryWorkingDirectory(): + open(".hidden", "w", encoding="utf-8").close() + offset = len(code) + for use_jedi in (True, False): + with provisionalcompleter(), jedi_status(use_jedi): + completions = list(ip.Completer.completions(text=code, offset=offset)) + matches = [c for c in completions if c.text.lstrip(".") == "hidden"] + assert ( + len(matches) == 0 + ), f"File '.hidden' should not appear in attribute completion" + + +@pytest.mark.parametrize( + "line,expected", + [ + # Basic test cases + ("np.", "attribute"), + ("np.ran", "attribute"), + ("np.random.rand(np.random.ran", "attribute"), + ("np.random.rand(n", "global"), + ("d['k.e.y.'](ran", "global"), + ("d[0].k", "attribute"), + ("a = { 'a': np.ran", "attribute"), + ("n", "global"), + ("", "global"), + # Dots in string literals + ('some_var = "this is a string with a dot.', "global"), + ("text = 'another string with a dot.", "global"), + ('f"greeting {user.na', "attribute"), # Cursor in f-string expression + ('t"welcome {guest.na', "attribute"), # Cursor in t-string expression + ('f"hello {name} worl', "global"), # Cursor in f-string outside expression + ('f"hello {{a.', "global"), + ('f"hello {{{a.', "attribute"), + # Backslash escapes in strings + ('var = "string with \\"escaped quote and a dot.', "global"), + ("escaped = 'single \\'quote\\' with a dot.", "global"), + # Multi-line strings + ('multi = """This is line one\nwith a dot.', "global"), + ("multi_single = '''Another\nmulti-line\nwith a dot.", "global"), + # Inline comments + ("x = 5 # This is a comment", "global"), + ("y = obj.method() # Comment after dot.method", "global"), + # Hash symbol within string literals should not be treated as comments + ("d['#'] = np.", "attribute"), + # Nested parentheses with dots + ("complex_expr = (func((obj.method(param.attr", "attribute"), + ("multiple_nesting = {key: [value.attr", "attribute"), + # Numbers + ("3.", "global"), + ("3.14", "global"), + ("-42.14", "global"), + ("x = func(3.14", "global"), + ("x = func(a3.", "attribute"), + ("x = func(a3.12", "global"), + ("3.1.", "attribute"), + ("-3.1.", "attribute"), + ("(3).", "attribute"), + # Additional cases + ("", "global"), + ('str_with_code = "x.attr', "global"), + ('f"formatted {obj.attr', "attribute"), + ('f"formatted {obj.attr}', "global"), + ("dict_with_dots = {'key.with.dots': value.attr", "attribute"), + ("d[f'{a}']['{a.", "global"), + ("ls .", "global"), + ("t._", "attribute"), + ("t.__a", "attribute"), + ], +) +def test_completion_context(line, expected): + """Test completion context""" + ip = get_ipython() + get_context = ip.Completer._determine_completion_context + result = get_context(line) + assert result.value == expected, f"Failed on input: '{line}'" + + +@pytest.mark.parametrize( + "line,expected,expected_after_assignment", + [ + ("test_alias file", True, False), # overshadowed by variable + ("test_alias .", True, False), + ("test_alias file.", True, False), + ("%test_alias .file.ext", True, True), # magic, not affected by variable + ("!test_alias file.", True, True), # bang, not affected by variable + ], +) +def test_completion_in_cli_context(line, expected, expected_after_assignment): + """Test completion context with and without variable overshadowing""" + ip = get_ipython() + ip.run_cell("alias test_alias echo test_alias") + get_context = ip.Completer._is_completing_in_cli_context + + # Normal case + result = get_context(line) + assert result == expected, f"Failed on input: '{line}'" + + # Test with alias assigned as a variable + try: + ip.user_ns["test_alias"] = "some_value" + result_after_assignment = get_context(line) + assert ( + result_after_assignment == expected_after_assignment + ), f"Failed after assigning 'ls' as a variable for input: '{line}'" + finally: + ip.user_ns.pop("test_alias", None) + + +@pytest.mark.xfail(reason="Completion context not yet supported") +@pytest.mark.parametrize( + "line, expected", + [ + ("f'{f'a.", "global"), # Nested f-string + ("3a.", "global"), # names starting with numbers or other symbols + ("$).", "global"), # random things with dot at end + ], +) +def test_unsupported_completion_context(line, expected): + """Test unsupported completion context""" + ip = get_ipython() + get_context = ip.Completer._determine_completion_context + result = get_context(line) + assert result.value == expected, f"Failed on input: '{line}'" + + +@pytest.mark.parametrize( + "setup,code,expected,not_expected", + [ + ('a="str"; b=1', "(a, b.", [".bit_count", ".conjugate"], [".count"]), + ('a="str"; b=1', "(a, b).", [".count"], [".bit_count", ".capitalize"]), + ('x="str"; y=1', "x = {1, y.", [".bit_count"], [".count"]), + ('x="str"; y=1', "x = [1, y.", [".bit_count"], [".count"]), + ('x="str"; y=1; fun=lambda x:x', "x = fun(1, y.", [".bit_count"], [".count"]), + ], +) +def test_misc_no_jedi_completions(setup, code, expected, not_expected): + ip = get_ipython() + c = ip.Completer + ip.ex(setup) + with provisionalcompleter(), jedi_status(False): + matches = c.all_completions(code) + assert set(expected) - set(matches) == set(), set(matches) + assert set(matches).intersection(set(not_expected)) == set() + + +@pytest.mark.parametrize( + "code,expected", + [ + (" (a, b", "b"), + ("(a, b", "b"), + ("(a, b)", ""), # trim always start by trimming + (" (a, b)", "(a, b)"), + (" [a, b]", "[a, b]"), + (" a, b", "b"), + ("x = {1, y", "y"), + ("x = [1, y", "y"), + ("x = fun(1, y", "y"), + (" assert a", "a"), + ], +) +def test_trim_expr(code, expected): + c = get_ipython().Completer + assert c._trim_expr(code) == expected + + +@pytest.mark.parametrize( + "input, expected", + [ + ["1.234", "1.234"], + # should match signed numbers + ["+1", "+1"], + ["-1", "-1"], + ["-1.0", "-1.0"], + ["-1.", "-1."], + ["+1.", "+1."], + [".1", ".1"], + # should not match non-numbers + ["1..", None], + ["..", None], + [".1.", None], + # should match after comma + [",1", "1"], + [", 1", "1"], + [", .1", ".1"], + [", +.1", "+.1"], + # should not match after trailing spaces + [".1 ", None], + # some complex cases + ["0b_0011_1111_0100_1110", "0b_0011_1111_0100_1110"], + ["0xdeadbeef", "0xdeadbeef"], + ["0b_1110_0101", "0b_1110_0101"], + # should not match if in an operation + ["1 + 1", None], + [", 1 + 1", None], + ], +) +def test_match_numeric_literal_for_dict_key(input, expected): + assert _match_number_in_dict_key_prefix(input) == expected diff --git a/tests/test_completerlib.py b/tests/test_completerlib.py new file mode 100644 index 00000000000..de3f8abf970 --- /dev/null +++ b/tests/test_completerlib.py @@ -0,0 +1,137 @@ +# -*- coding: utf-8 -*- +"""Tests for completerlib.""" + +import os +import sys +from os.path import join +from tempfile import TemporaryDirectory + +import pytest + +from IPython.core.completerlib import magic_run_completer, module_completion, try_import +from IPython.testing.decorators import onlyif_unicode_paths + + +class MockEvent(object): + def __init__(self, line): + self.line = line + + +@pytest.fixture +def run_completer_dir(tmp_path, monkeypatch): + files = ["aao.py", "a.py", "b.py", "aao.txt"] + dirs = ["adir/", "bdir/"] + for fil in files: + (tmp_path / fil).write_text("pass\n", encoding="utf-8") + for d in dirs: + (tmp_path / d).mkdir() + monkeypatch.chdir(tmp_path) + return tmp_path, files, dirs + + +@pytest.mark.parametrize("line,expected_match", [ + ("%run a", {"a.py", "aao.py", "adir/"}), + ("%run aa", {"aao.py"}), + ('%run "a', {"a.py", "aao.py", "adir/"}), +]) +def test_magic_run_completer(run_completer_dir, line, expected_match): + match = set(magic_run_completer(None, MockEvent(line))) + assert match == expected_match + + +def test_magic_run_completer_more_args(run_completer_dir): + tmp_path, files, dirs = run_completer_dir + match = set(magic_run_completer(None, MockEvent("%run a.py "))) + assert match == set(files + dirs) + + +def test_magic_run_completer_in_dir(run_completer_dir): + # Github issue #3459 + tmp_path, files, dirs = run_completer_dir + event = MockEvent("%run a.py {}".format(join(str(tmp_path), "a"))) + match = set(magic_run_completer(None, event)) + assert match == { + join(str(tmp_path), f).replace("\\", "/") + for f in ("a.py", "aao.py", "aao.txt", "adir/") + } + + +@pytest.fixture +def run_completer_dir_nonascii(tmp_path, monkeypatch): + for fil in ["aaø.py", "a.py", "b.py"]: + (tmp_path / fil).write_text("pass\n", encoding="utf-8") + monkeypatch.chdir(tmp_path) + return tmp_path + + +@onlyif_unicode_paths +@pytest.mark.parametrize("line,expected_match", [ + ("%run a", {"a.py", "aaø.py"}), + ("%run aa", {"aaø.py"}), + ('%run "a', {"a.py", "aaø.py"}), +]) +def test_magic_run_completer_nonascii(run_completer_dir_nonascii, line, expected_match): + match = set(magic_run_completer(None, MockEvent(line))) + assert match == expected_match + + +def test_import_invalid_module(): + """Testing of issue https://github.com/ipython/ipython/issues/1107""" + invalid_module_names = {"foo-bar", "foo:bar", "10foo"} + valid_module_names = {"foobar"} + with TemporaryDirectory() as tmpdir: + sys.path.insert(0, tmpdir) + for name in invalid_module_names | valid_module_names: + filename = os.path.join(tmpdir, name + ".py") + open(filename, "w", encoding="utf-8").close() + + s = set(module_completion("import foo")) + intersection = s.intersection(invalid_module_names) + assert intersection == set() + + assert valid_module_names.issubset(s), valid_module_names.intersection(s) + + +def test_bad_module_all(): + """Test module with invalid __all__ + + https://github.com/ipython/ipython/issues/9678 + """ + testsdir = os.path.dirname(__file__) + sys.path.insert(0, testsdir) + try: + results = module_completion("from bad_all import ") + assert "puppies" in results + for r in results: + assert isinstance(r, str) + + results = module_completion("import bad_all.") + assert results == [] + finally: + sys.path.remove(testsdir) + + +def test_module_without_init(): + """ + Test module without __init__.py. + + https://github.com/ipython/ipython/issues/11226 + """ + fake_module_name = "foo_xder_134" + with TemporaryDirectory() as tmpdir: + sys.path.insert(0, tmpdir) + try: + os.makedirs(os.path.join(tmpdir, fake_module_name)) + s = try_import(mod=fake_module_name) + assert s == [], f"for module {fake_module_name}" + finally: + sys.path.remove(tmpdir) + + +def test_valid_exported_submodules(): + """ + Test checking exported (__all__) objects are submodules + """ + results = module_completion("import os.pa") + assert "os.path" in results + assert "os.pathconf" not in results diff --git a/tests/test_contexts.py b/tests/test_contexts.py new file mode 100644 index 00000000000..5afbd335ee9 --- /dev/null +++ b/tests/test_contexts.py @@ -0,0 +1,72 @@ +"""Tests for IPython.utils.contexts.""" + +import pytest + +from IPython.utils.contexts import preserve_keys + + +def test_preserve_keys_restores_existing_key(): + d = {"a": 1, "b": 2} + with preserve_keys(d, "a"): + d["a"] = 99 + assert d["a"] == 1 + + +def test_preserve_keys_deletes_new_key(): + d = {"a": 1} + with preserve_keys(d, "new_key"): + d["new_key"] = 42 + assert "new_key" not in d + + +def test_preserve_keys_preserves_unchanged_keys(): + d = {"a": 1, "b": 2, "c": 3} + with preserve_keys(d, "a"): + d["a"] = 99 + assert d["b"] == 2 + assert d["c"] == 3 + + +def test_preserve_keys_missing_key_deleted_on_exit(): + d = {"a": 1} + with preserve_keys(d, "missing"): + assert "missing" not in d + d["missing"] = "added" + assert "missing" not in d + + +def test_preserve_keys_multiple_keys(): + d = {"x": 10, "y": 20} + with preserve_keys(d, "x", "y", "z"): + d["x"] = 100 + del d["y"] + d["z"] = 30 + assert d["x"] == 10 + assert d["y"] == 20 + assert "z" not in d + + +def test_preserve_keys_restores_after_exception(): + d = {"a": 1} + try: + with preserve_keys(d, "a"): + d["a"] = 99 + raise RuntimeError("test") + except RuntimeError: + pass + assert d["a"] == 1 + + +@pytest.mark.parametrize("original_value", [None, 0, False, "", [], {}]) +def test_preserve_keys_restores_falsy_values(original_value): + d = {"k": original_value} + with preserve_keys(d, "k"): + d["k"] = "replaced" + assert d["k"] == original_value + + +def test_preserve_keys_no_keys_is_noop(): + d = {"a": 1} + with preserve_keys(d): + d["a"] = 99 + assert d["a"] == 99 diff --git a/tests/test_crashhandler.py b/tests/test_crashhandler.py new file mode 100644 index 00000000000..08265fae182 --- /dev/null +++ b/tests/test_crashhandler.py @@ -0,0 +1,213 @@ +"""Tests for IPython.core.crashhandler""" + +import sys +from unittest.mock import MagicMock + +import pytest + +from IPython.core import crashhandler +from IPython.core.crashhandler import CrashHandler, crash_handler_lite +from IPython.core.interactiveshell import InteractiveShell + + +class FakeApp: + """Minimal stand-in for an IPython Application.""" + + name = "testapp" + + def __init__(self, ipython_dir=None): + if ipython_dir is not None: + self.ipython_dir = ipython_dir + self.config = {"FakeApp": {"answer": 42}} + + +def _exc_info(): + try: + raise ValueError("crash-handler-test") + except ValueError: + return sys.exc_info() + + +@pytest.fixture +def input_prompts(monkeypatch): + """Replace builtins.input, recording the prompts it was called with.""" + prompts = [] + + def fake_input(prompt=""): + prompts.append(prompt) + return "" + + monkeypatch.setattr("builtins.input", fake_input) + return prompts + + +@pytest.fixture(autouse=True) +def restore_excepthook(monkeypatch): + # CrashHandler.__call__ resets sys.excepthook; make sure this does not + # leak out of the tests. + monkeypatch.setattr(sys, "excepthook", sys.excepthook) + + +def test_crash_handler_init(): + app = FakeApp() + ch = CrashHandler( + app, + contact_name="Jane Dev", + contact_email="jane@example.com", + bug_tracker="https://example.com/bugs", + ) + assert ch.crash_report_fname == "Crash_report_testapp.txt" + assert ch.app is app + assert ch.call_pdb is False + assert ch.show_crash_traceback is True + assert ch.info["app_name"] == "testapp" + assert ch.info["contact_name"] == "Jane Dev" + assert ch.info["contact_email"] == "jane@example.com" + assert ch.info["bug_tracker"] == "https://example.com/bugs" + assert ch.info["crash_report_fname"] == "Crash_report_testapp.txt" + + +def test_crash_handler_writes_report(tmp_path, capsys, input_prompts): + app = FakeApp(ipython_dir=str(tmp_path)) + ch = CrashHandler( + app, + contact_name="Jane Dev", + contact_email="jane@example.com", + bug_tracker="https://example.com/bugs", + ) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + + report_file = tmp_path / "Crash_report_testapp.txt" + assert report_file.is_file() + text = report_file.read_text(encoding="utf-8") + assert "IPython post-mortem report" in text + assert "Application name: testapp" in text + assert "Crash traceback:" in text + assert "ValueError" in text + assert "crash-handler-test" in text + + err = capsys.readouterr().err + # user-facing message + assert "Oops, testapp crashed." in err + assert "jane@example.com" in err + assert str(report_file) in err + # traceback shown on stderr by default + assert "ValueError" in err + + # the filename was expanded to the full path + assert ch.crash_report_fname == str(report_file) + assert ch.info["crash_report_fname"] == str(report_file) + # the crash handler uninstalls itself + assert sys.excepthook is sys.__excepthook__ + # and waits for the user to acknowledge + assert len(input_prompts) == 1 + + +def test_crash_handler_hidden_traceback(tmp_path, capsys, input_prompts): + app = FakeApp(ipython_dir=str(tmp_path)) + ch = CrashHandler(app, show_crash_traceback=False) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + + err = capsys.readouterr().err + # message is still printed, but not the traceback + assert "Oops, testapp crashed." in err + assert "ValueError" not in err + # the report on disk still has the traceback + text = (tmp_path / "Crash_report_testapp.txt").read_text(encoding="utf-8") + assert "ValueError" in text + + +def test_crash_handler_no_ipython_dir(tmp_path, monkeypatch, capsys, input_prompts): + # app without an ipython_dir attribute: report goes to cwd + monkeypatch.chdir(tmp_path) + ch = CrashHandler(FakeApp()) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + assert (tmp_path / "Crash_report_testapp.txt").is_file() + capsys.readouterr() + + +def test_crash_handler_missing_ipython_dir(tmp_path, monkeypatch, capsys, input_prompts): + # nonexistent ipython_dir: falls back to cwd + monkeypatch.chdir(tmp_path) + ch = CrashHandler(FakeApp(ipython_dir=str(tmp_path / "does-not-exist"))) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + assert (tmp_path / "Crash_report_testapp.txt").is_file() + capsys.readouterr() + + +def test_crash_handler_unwritable_report(tmp_path, capsys, input_prompts): + # make open() fail by occupying the report path with a directory + (tmp_path / "Crash_report_testapp.txt").mkdir() + ch = CrashHandler(FakeApp(ipython_dir=str(tmp_path))) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + + err = capsys.readouterr().err + assert "Could not create crash report on disk." in err + # bails out before the user message and the input() prompt + assert "Oops, testapp crashed." not in err + assert input_prompts == [] + + +def test_crash_handler_call_pdb(tmp_path, monkeypatch, input_prompts): + tb_instance = MagicMock() + verbose_tb = MagicMock(return_value=tb_instance) + monkeypatch.setattr(crashhandler.ultratb, "VerboseTB", verbose_tb) + + ch = CrashHandler(FakeApp(ipython_dir=str(tmp_path)), call_pdb=True) + etype, evalue, etb = _exc_info() + ch(etype, evalue, etb) + + verbose_tb.assert_called_once_with( + theme_name="nocolor", long_header=True, call_pdb=True + ) + tb_instance.assert_called_once_with(etype, evalue, etb) + # with call_pdb, no report is written and input() is not called + assert not (tmp_path / "Crash_report_testapp.txt").exists() + assert input_prompts == [] + + +def test_make_report_contains_config(): + ch = CrashHandler(FakeApp()) + report = ch.make_report("FAKE TRACEBACK") + assert "IPython post-mortem report" in report + assert "Application name: testapp" in report + assert "Current user configuration structure:" in report + assert "'answer': 42" in report + assert report.endswith("Crash traceback:\n\nFAKE TRACEBACK") + + +def test_make_report_without_config(): + app = FakeApp() + del app.config + ch = CrashHandler(app) + report = ch.make_report("FAKE TRACEBACK") + # the config section is skipped, the rest is still there + assert "IPython post-mortem report" in report + assert "Application name" not in report + assert "FAKE TRACEBACK" in report + + +def test_crash_handler_lite_no_shell(capsys, monkeypatch): + monkeypatch.setattr(InteractiveShell, "initialized", lambda: False) + etype, evalue, etb = _exc_info() + crash_handler_lite(etype, evalue, etb) + err = capsys.readouterr().err + assert "ValueError: crash-handler-test" in err + assert "If you suspect this is an IPython" in err + # outside of a shell, generic config syntax is suggested + assert "c.Application.verbose_crash=True" in err + + +def test_crash_handler_lite_in_shell(capsys, monkeypatch): + monkeypatch.setattr(InteractiveShell, "initialized", lambda: True) + etype, evalue, etb = _exc_info() + crash_handler_lite(etype, evalue, etb) + err = capsys.readouterr().err + assert "ValueError: crash-handler-test" in err + # inside a shell, the %config magic is suggested + assert "%config Application.verbose_crash=True" in err diff --git a/IPython/tests/cve.py b/tests/test_cve.py similarity index 98% rename from IPython/tests/cve.py rename to tests/test_cve.py index 0a9dec4e854..fab11b4bd89 100644 --- a/IPython/tests/cve.py +++ b/tests/test_cve.py @@ -1,5 +1,5 @@ """ -Test that CVEs stay fixed. +Test that CVEs stay fixed. """ from IPython.utils.tempdir import TemporaryDirectory, TemporaryWorkingDirectory @@ -9,7 +9,6 @@ import os import string import subprocess -import time def test_cve_2022_21699(): diff --git a/tests/test_data.py b/tests/test_data.py new file mode 100644 index 00000000000..bcf135d22c3 --- /dev/null +++ b/tests/test_data.py @@ -0,0 +1,76 @@ +"""Tests for IPython.utils.data.""" + +import warnings + +import pytest + +from IPython.utils.data import chop, uniq_stable + + +# --------------------------------------------------------------------------- +# chop +# --------------------------------------------------------------------------- + + +def test_chop_even_division(): + assert chop([1, 2, 3, 4], 2) == [[1, 2], [3, 4]] + + +def test_chop_uneven_division(): + result = chop([1, 2, 3, 4, 5], 2) + assert result == [[1, 2], [3, 4], [5]] + + +def test_chop_size_larger_than_seq(): + assert chop([1, 2], 10) == [[1, 2]] + + +def test_chop_size_1(): + assert chop([1, 2, 3], 1) == [[1], [2], [3]] + + +def test_chop_empty_sequence(): + assert chop([], 2) == [] + + +def test_chop_string(): + result = chop("abcdef", 2) + assert result == ["ab", "cd", "ef"] + + +@pytest.mark.parametrize("seq,size,expected", [ + ([1, 2, 3, 4, 5, 6], 3, [[1, 2, 3], [4, 5, 6]]), + ([1, 2, 3, 4, 5, 6], 2, [[1, 2], [3, 4], [5, 6]]), + ([1, 2, 3, 4, 5, 6], 6, [[1, 2, 3, 4, 5, 6]]), +]) +def test_chop_parametrized(seq, size, expected): + assert chop(seq, size) == expected + + +# --------------------------------------------------------------------------- +# uniq_stable (deprecated) +# --------------------------------------------------------------------------- + + +def test_uniq_stable_raises_deprecation_warning(): + with pytest.warns(DeprecationWarning, match="uniq_stable is deprecated"): + uniq_stable([1, 2, 1]) + + +def test_uniq_stable_preserves_order(): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", DeprecationWarning) + result = uniq_stable([3, 1, 2, 1, 3]) + assert result == [3, 1, 2] + + +def test_uniq_stable_empty(): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", DeprecationWarning) + assert uniq_stable([]) == [] + + +def test_uniq_stable_all_unique(): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", DeprecationWarning) + assert uniq_stable([1, 2, 3]) == [1, 2, 3] diff --git a/IPython/terminal/tests/test_debug_magic.py b/tests/test_debug_magic.py similarity index 51% rename from IPython/terminal/tests/test_debug_magic.py rename to tests/test_debug_magic.py index faa3b7c4993..425ecb5b5f2 100644 --- a/IPython/terminal/tests/test_debug_magic.py +++ b/tests/test_debug_magic.py @@ -1,24 +1,25 @@ """Test embedding of IPython""" -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Copyright (C) 2013 The IPython Development Team # # Distributed under the terms of the BSD License. The full license is in # the file COPYING, distributed as part of this software. -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Imports -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- import os import sys from IPython.testing.decorators import skip_win32 from IPython.testing import IPYTHON_TESTING_TIMEOUT_SCALE -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Tests -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- + @skip_win32 def test_debug_magic_passes_through_generators(): @@ -27,11 +28,15 @@ def test_debug_magic_passes_through_generators(): """ import pexpect import re - in_prompt = re.compile(br'In ?\[\d+\]:') - ipdb_prompt = 'ipdb>' + + in_prompt = re.compile(rb"In ?\[\d+\]:") + ipdb_prompt = "ipdb>" env = os.environ.copy() - child = pexpect.spawn(sys.executable, ['-m', 'IPython', '--colors=nocolor', '--simple-prompt'], - env=env) + child = pexpect.spawn( + sys.executable, + ["-m", "IPython", "--colors=nocolor", "--simple-prompt"], + env=env, + ) child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE child.expect(in_prompt) @@ -53,28 +58,30 @@ def test_debug_magic_passes_through_generators(): child.timeout = 10 * IPYTHON_TESTING_TIMEOUT_SCALE - child.expect('Exception:') + child.expect("Exception:") child.expect(in_prompt) - child.sendline(r'%debug') - child.expect('----> 2 raise Exception') + child.sendline(r"%debug") + child.expect("----> 2 raise Exception") child.expect(ipdb_prompt) - child.sendline('u') - child.expect_exact(r'----> 1 gen = (f(x) for x in [0])') + child.sendline("u") + child.expect_exact(r"----> 1 gen = (f(x) for x in [0])") child.expect(ipdb_prompt) - child.sendline('u') - child.expect_exact('----> 1 for x in gen:') + child.sendline("u") + child.expect_exact("----> 1 for x in gen:") child.expect(ipdb_prompt) - child.sendline('u') - child.expect_exact('*** Oldest frame') + child.sendline("u") + child.expect_exact( + "*** all frames above skipped (hidden frames and ignored modules). Use `skip_hidden False` for hidden frames or unignore_module for ignored modules." + ) child.expect(ipdb_prompt) - child.sendline('exit') + child.sendline("exit") child.expect(in_prompt) - child.sendline('exit') + child.sendline("exit") child.close() diff --git a/tests/test_debugger.py b/tests/test_debugger.py new file mode 100644 index 00000000000..3abd6c2393b --- /dev/null +++ b/tests/test_debugger.py @@ -0,0 +1,1993 @@ +"""Tests for debugging machinery.""" + +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. + +import builtins +import io +import os +import re as re_module +import sys +import platform +from pathlib import Path + +from tempfile import NamedTemporaryFile, TemporaryDirectory +from textwrap import dedent +from unittest.mock import patch + +from IPython.core import debugger +from IPython.testing import IPYTHON_TESTING_TIMEOUT_SCALE +from IPython.testing.decorators import skip_win32 +from IPython.utils import PyColorize +import pytest + +# Helper for executing files with proper debugger frame marking +def execfile(fname, glob, loc=None, compiler=None): + __tracebackhide__ = "__ipython_bottom__" + loc = loc if (loc is not None) else glob + with open(fname, "rb") as f: + compiler_fn = compiler or compile + exec(compiler_fn(f.read(), fname, "exec"), glob, loc) + + +# Helper classes, from CPython's Pdb test suite +# + + +class _FakeInput(object): + """ + A fake input stream for pdb's interactive debugger. Whenever a + line is read, print it (to simulate the user typing it), and then + return it. The set of lines to return is specified in the + constructor; they should not have trailing newlines. + """ + + def __init__(self, lines): + self.lines = iter(lines) + + def readline(self): + line = next(self.lines) + print(line) + return line + "\n" + + +class PdbTestInput(object): + """Context manager that makes testing Pdb in doctests easier.""" + + def __init__(self, input): + self.input = input + + def __enter__(self): + self.real_stdin = sys.stdin + sys.stdin = _FakeInput(self.input) + + def __exit__(self, *exc): + sys.stdin = self.real_stdin + + +# ----------------------------------------------------------------------------- +# Tests +# ----------------------------------------------------------------------------- + + +def test_ipdb_magics(): + '''Test calling some IPython magics from ipdb. + + First, set up some test functions and classes which we can inspect. + + In [1]: class ExampleClass(object): + ...: """Docstring for ExampleClass.""" + ...: def __init__(self): + ...: """Docstring for ExampleClass.__init__""" + ...: pass + ...: def __str__(self): + ...: return "ExampleClass()" + + In [2]: def example_function(x, y, z="hello"): + ...: """Docstring for example_function.""" + ...: pass + + In [3]: old_trace = sys.gettrace() + + Create a function which triggers ipdb. + + In [4]: def trigger_ipdb(): + ...: a = ExampleClass() + ...: debugger.Pdb().set_trace() + + Run ipdb with faked input & check output. Because of a difference between + Python 3.13 & older versions, the first bit of the output is inconsistent. + We need to use ... to accommodate that, so the examples have to use IPython + prompts so that ... is distinct from the Python PS2 prompt. + + In [5]: with PdbTestInput([ + ...: 'pdef example_function', + ...: 'pdoc ExampleClass', + ...: 'up', + ...: 'down', + ...: 'list', + ...: 'pinfo a', + ...: 'll', + ...: 'continue', + ...: ]): + ...: trigger_ipdb() + ...> (3)trigger_ipdb() + 1 def trigger_ipdb(): + 2 a = ExampleClass() + ----> 3 debugger.Pdb().set_trace() + + ipdb> pdef example_function + example_function(x, y, z='hello') + ipdb> pdoc ExampleClass + Class docstring: + Docstring for ExampleClass. + Init docstring: + Docstring for ExampleClass.__init__ + ipdb> up + > (11)() + 7 'pinfo a', + 8 'll', + 9 'continue', + 10 ]): + ---> 11 trigger_ipdb() + + ipdb> down... + > (3)trigger_ipdb() + 1 def trigger_ipdb(): + 2 a = ExampleClass() + ----> 3 debugger.Pdb().set_trace() + + ipdb> list + 1 def trigger_ipdb(): + 2 a = ExampleClass() + ----> 3 debugger.Pdb().set_trace() + + ipdb> pinfo a + Type: ExampleClass + String form: ExampleClass() + Namespace: Local... + Docstring: Docstring for ExampleClass. + Init docstring: Docstring for ExampleClass.__init__ + ipdb> ll + 1 def trigger_ipdb(): + 2 a = ExampleClass() + ----> 3 debugger.Pdb().set_trace() + + ipdb> continue + + Restore previous trace function, e.g. for coverage.py + + In [6]: sys.settrace(old_trace) + ''' + + +def test_ipdb_closure(): + """Test evaluation of expressions which depend on closure. + + In [1]: old_trace = sys.gettrace() + + Create a function which triggers ipdb. + + In [2]: def trigger_ipdb(): + ...: debugger.Pdb().set_trace() + + In [3]: with PdbTestInput([ + ...: 'x = 1; sum(x * i for i in range(5))', + ...: 'continue', + ...: ]): + ...: trigger_ipdb() + ...> (2)trigger_ipdb() + 1 def trigger_ipdb(): + ----> 2 debugger.Pdb().set_trace() + + ipdb> x = 1; sum(x * i for i in range(5)) + ipdb> continue + + Restore previous trace function, e.g. for coverage.py + + In [4]: sys.settrace(old_trace) + """ + + +def test_ipdb_magics2(): + """Test ipdb with a very short function. + + >>> old_trace = sys.gettrace() + + >>> def bar(): + ... pass + + Run ipdb. + + >>> with PdbTestInput([ + ... 'continue', + ... ]): + ... debugger.Pdb().runcall(bar) + > (2)bar() + 1 def bar(): + ----> 2 pass + + ipdb> continue + + Restore previous trace function, e.g. for coverage.py + + >>> sys.settrace(old_trace) + """ + + +def can_quit(): + """Test that quit work in ipydb + + >>> old_trace = sys.gettrace() + + >>> def bar(): + ... pass + + >>> with PdbTestInput([ + ... 'quit', + ... ]): + ... debugger.Pdb().runcall(bar) + > (2)bar() + 1 def bar(): + ----> 2 pass + + ipdb> quit + + Restore previous trace function, e.g. for coverage.py + + >>> sys.settrace(old_trace) + """ + + +def can_exit(): + """Test that quit work in ipydb + + >>> old_trace = sys.gettrace() + + >>> def bar(): + ... pass + + >>> with PdbTestInput([ + ... 'exit', + ... ]): + ... debugger.Pdb().runcall(bar) + > (2)bar() + 1 def bar(): + ----> 2 pass + + ipdb> exit + + Restore previous trace function, e.g. for coverage.py + + >>> sys.settrace(old_trace) + """ + + +def test_interruptible_core_debugger(): + """The debugger can be interrupted. + + The presumption is there is some mechanism that causes a KeyboardInterrupt + (this is implemented in ipykernel). We want to ensure the + KeyboardInterrupt cause debugging to cease. + """ + + def raising_input(msg="", called=[0]): + called[0] += 1 + assert called[0] == 1, "input() should only be called once!" + raise KeyboardInterrupt() + + tracer_orig = sys.gettrace() + try: + with patch.object(builtins, "input", raising_input): + debugger.InterruptiblePdb().set_trace() + # The way this test will fail is by set_trace() never exiting, + # resulting in a timeout by the test runner. The alternative + # implementation would involve a subprocess, but that adds issues + # with interrupting subprocesses that are rather complex, so it's + # simpler just to do it this way. + finally: + # restore the original trace function + sys.settrace(tracer_orig) + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_exception_command_aliases_exceptions(): + ipdb = debugger.Pdb() + + with patch.object(ipdb, "do_exceptions", return_value=True) as do_exceptions: + assert ipdb.onecmd("exception 0") is True + + do_exceptions.assert_called_once_with("0") + + +def test_execfile_marks_debugger_internal_frames_hidden(): + with TemporaryDirectory() as td: + script = Path(td) / "fails.py" + script.write_text( + "def user_frame():\n" + " raise RuntimeError('boom')\n" + "user_frame()\n", + encoding="utf-8", + ) + + with pytest.raises(RuntimeError) as exc_info: + execfile(script, {}) + + ipdb = debugger.Pdb() + stack, _ = ipdb.get_stack(None, exc_info.value.__traceback__) + hidden_frames = ipdb.hidden_frames(stack) + frame_names = [frame.f_code.co_name for frame, _ in stack] + execfile_index = frame_names.index("execfile") + + assert ( + stack[execfile_index][0].f_locals["__tracebackhide__"] + == "__ipython_bottom__" + ) + assert hidden_frames[execfile_index] is True + assert all(hidden_frames[:execfile_index]) + assert hidden_frames[execfile_index + 1 :] == [False, False] + + +@skip_win32 +def test_xmode_skip(): + """that xmode skip frames + + Not as a doctest as pytest does not run doctests. + """ + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + + child = pexpect.spawn( + sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env + ) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + + child.expect("IPython") + child.expect("\n") + child.expect_exact("In [1]") + + block = dedent( + """ + def f(): + __tracebackhide__ = True + g() + + def g(): + raise ValueError + + f() + """ + ) + + for line in block.splitlines(): + child.sendline(line) + child.expect_exact(line) + child.expect_exact("skipping") + + block = dedent( + """ + def f(): + __tracebackhide__ = True + g() + + def g(): + from IPython.core.debugger import set_trace + set_trace() + + f() + """ + ) + + for line in block.splitlines(): + child.sendline(line) + child.expect_exact(line) + + child.expect("ipdb>") + child.sendline("w") + child.expect("hidden") + child.expect("ipdb>") + child.sendline("skip_hidden false") + child.sendline("w") + child.expect("__traceba") + child.expect("ipdb>") + + child.close() + + +skip_decorators_blocks = ( + """ + def helpers_helper(): + pass # should not stop here except breakpoint + """, + """ + def helper_1(): + helpers_helper() # should not stop here + """, + """ + def helper_2(): + pass # should not stop here + """, + """ + def pdb_skipped_decorator2(function): + def wrapped_fn(*args, **kwargs): + __debuggerskip__ = True + helper_2() + __debuggerskip__ = False + result = function(*args, **kwargs) + __debuggerskip__ = True + helper_2() + return result + return wrapped_fn + """, + """ + def pdb_skipped_decorator(function): + def wrapped_fn(*args, **kwargs): + __debuggerskip__ = True + helper_1() + __debuggerskip__ = False + result = function(*args, **kwargs) + __debuggerskip__ = True + helper_2() + return result + return wrapped_fn + """, + """ + @pdb_skipped_decorator + @pdb_skipped_decorator2 + def bar(x, y): + return x * y + """, + """import IPython.terminal.debugger as ipdb""", + """ + def f(): + ipdb.set_trace() + bar(3, 4) + """, + """ + f() + """, +) + + +def _decorator_skip_setup(): + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + env["PROMPT_TOOLKIT_NO_CPR"] = "1" + + child = pexpect.spawn( + sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env + ) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + + child.expect("IPython") + child.expect("\n") + + child.timeout = 5 * IPYTHON_TESTING_TIMEOUT_SCALE + child.str_last_chars = 500 + + dedented_blocks = [dedent(b).strip() for b in skip_decorators_blocks] + in_prompt_number = 1 + for cblock in dedented_blocks: + child.expect_exact(f"In [{in_prompt_number}]:") + in_prompt_number += 1 + for line in cblock.splitlines(): + child.sendline(line) + child.expect_exact(line) + child.sendline("") + return child + + +@pytest.mark.skip(reason="recently fail for unknown reason on CI") +@skip_win32 +def test_decorator_skip(): + """test that decorator frames can be skipped.""" + + child = _decorator_skip_setup() + + child.expect_exact("ipython-input-8") + child.expect_exact("3 bar(3, 4)") + child.expect("ipdb>") + + child.expect("ipdb>") + child.sendline("step") + child.expect_exact("step") + child.expect_exact("--Call--") + child.expect_exact("ipython-input-6") + + child.expect_exact("1 @pdb_skipped_decorator") + + child.sendline("s") + child.expect_exact("return x * y") + + child.close() + + +@pytest.mark.skip(reason="recently fail for unknown reason on CI") +@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="issues on PyPy") +@skip_win32 +def test_decorator_skip_disabled(): + """test that decorator frame skipping can be disabled""" + + child = _decorator_skip_setup() + + child.expect_exact("3 bar(3, 4)") + + for input_, expected in [ + ("skip_predicates debuggerskip False", ""), + ("skip_predicates", "debuggerskip : False"), + ("step", "---> 2 def wrapped_fn"), + ("step", "----> 3 __debuggerskip__"), + ("step", "----> 4 helper_1()"), + ("step", "---> 1 def helper_1():"), + ("next", "----> 2 helpers_helper()"), + ("next", "--Return--"), + ("next", "----> 5 __debuggerskip__ = False"), + ]: + child.expect("ipdb>") + child.sendline(input_) + child.expect_exact(input_) + child.expect_exact(expected) + + child.close() + + +@pytest.mark.skip(reason="recently fail for unknown reason on CI") +@pytest.mark.skipif(platform.python_implementation() == "PyPy", reason="issues on PyPy") +@skip_win32 +def test_decorator_skip_with_breakpoint(): + """test that decorator frame skipping can be disabled""" + + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + env["PROMPT_TOOLKIT_NO_CPR"] = "1" + + child = pexpect.spawn( + sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env + ) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.str_last_chars = 500 + + child.expect("IPython") + child.expect("\n") + + child.timeout = 5 * IPYTHON_TESTING_TIMEOUT_SCALE + + ### we need a filename, so we need to exec the full block with a filename + with NamedTemporaryFile(suffix=".py", dir=".", delete=True) as tf: + name = tf.name[:-3].split("/")[-1] + tf.write("\n".join([dedent(x) for x in skip_decorators_blocks[:-1]]).encode()) + tf.flush() + codeblock = f"from {name} import f" + + dedented_blocks = [ + codeblock, + "f()", + ] + + in_prompt_number = 1 + for cblock in dedented_blocks: + child.expect_exact(f"In [{in_prompt_number}]:") + in_prompt_number += 1 + for line in cblock.splitlines(): + child.sendline(line) + child.expect_exact(line) + child.sendline("") + + # From 3.13, set_trace()/breakpoint() stop on the line where they're + # called, instead of the next line. + if sys.version_info >= (3, 14): + child.expect_exact(" 46 ipdb.set_trace()") + extra_step = [("step", "--> 47 bar(3, 4)")] + elif sys.version_info >= (3, 13): + child.expect_exact("--> 46 ipdb.set_trace()") + extra_step = [("step", "--> 47 bar(3, 4)")] + else: + child.expect_exact("--> 47 bar(3, 4)") + extra_step = [] + + for input_, expected in ( + [ + (f"b {name}.py:3", ""), + ] + + extra_step + + [ + ("step", "1---> 3 pass # should not stop here except"), + ("step", "---> 38 @pdb_skipped_decorator"), + ("continue", ""), + ] + ): + child.expect("ipdb>") + child.sendline(input_) + child.expect_exact(input_) + child.expect_exact(expected) + + child.close() + + +@skip_win32 +def test_where_erase_value(): + """Test that `where` does not access f_locals and erase values.""" + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + + child = pexpect.spawn( + sys.executable, ["-m", "IPython", "--colors=nocolor"], env=env + ) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + + child.expect("IPython") + child.expect("\n") + child.expect_exact("In [1]") + + block = dedent( + """ + def simple_f(): + myvar = 1 + print(myvar) + 1/0 + print(myvar) + simple_f() """ + ) + + for line in block.splitlines(): + child.sendline(line) + child.expect_exact(line) + child.expect_exact("ZeroDivisionError") + child.expect_exact("In [2]:") + + child.sendline("%debug") + + ## + child.expect("ipdb>") + + child.sendline("myvar") + child.expect("1") + + ## + child.expect("ipdb>") + + child.sendline("myvar = 2") + + ## + child.expect_exact("ipdb>") + + child.sendline("myvar") + + child.expect_exact("2") + + ## + child.expect("ipdb>") + child.sendline("where") + + ## + child.expect("ipdb>") + child.sendline("myvar") + + child.expect_exact("2") + child.expect("ipdb>") + + child.close() + + +@skip_win32 +def test_ignore_module_basic_functionality(): + """Test basic ignore/unignore functionality and error handling.""" + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + + with TemporaryDirectory() as temp_dir: + main_path = create_test_modules(temp_dir) + + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + # Test listing modules when none are ignored + child.sendline("ignore_module") + child.expect_exact("No modules are currently ignored.") + child.expect("ipdb>") + + # Test ignoring a module + child.sendline("ignore_module level2_module") + child.expect("ipdb>") + + # Test listing ignored modules + child.sendline("ignore_module") + child.expect_exact("Currently ignored modules: ['level2_module']") + child.expect("ipdb>") + + # Test wildcard pattern + child.sendline("ignore_module testpkg.*") + child.expect("ipdb>") + + child.sendline("ignore_module") + child.expect_exact("Currently ignored modules: ['level2_module', 'testpkg.*']") + child.expect("ipdb>") + + # Test error handling - removing non-existent module + child.sendline("unignore_module nonexistent") + child.expect_exact("Module nonexistent is not currently ignored") + child.expect("ipdb>") + + # Test successful removal + child.sendline("unignore_module level2_module") + child.expect("ipdb>") + + child.sendline("ignore_module") + child.expect_exact("Currently ignored modules: ['testpkg.*']") + child.expect("ipdb>") + + # Test removing already removed module + child.sendline("unignore_module level2_module") + child.expect_exact("Module level2_module is not currently ignored") + child.expect("ipdb>") + + # Remove wildcard pattern + child.sendline("unignore_module testpkg.*") + child.expect("ipdb>") + + child.sendline("ignore_module") + child.expect_exact("No modules are currently ignored.") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + +# Helper function for creating temporary modules +def create_test_modules(temp_dir): + """Create a comprehensive module hierarchy for testing all debugger commands.""" + + temp_path = Path(temp_dir) + + # Create package structure for wildcard testing + package_dir = temp_path / "testpkg" + package_dir.mkdir() + + # Package __init__.py + (package_dir / "__init__.py").write_text("# Test package") + + # testpkg/submod1.py + (package_dir / "submod1.py").write_text( + dedent( + """ + def submod1_func(): + x = 1 + y = 2 + return x + y + """ + ) + ) + + # testpkg/submod2.py + (package_dir / "submod2.py").write_text( + dedent( + """ + def submod2_func(): + z = 10 + return z * 2 + """ + ) + ) + + # Level 1 (top level module) + (temp_path / "level1_module.py").write_text( + dedent( + """ + from level2_module import level2_func + + def level1_func(): + return level2_func() + """ + ) + ) + + # Level 2 (middle level module) + (temp_path / "level2_module.py").write_text( + dedent( + """ + from level3_module import level3_func + from testpkg.submod1 import submod1_func + from testpkg.submod2 import submod2_func + + def level2_func(): + # Call package functions for step/next testing + result1 = submod1_func() + result2 = submod2_func() + return level3_func() + result1 + result2 + """ + ) + ) + + # Level 3 (bottom level with debugger) + (temp_path / "level3_module.py").write_text( + dedent( + """ + from level4_module import level4_func + + from IPython.core.debugger import set_trace + + def level3_func(): + set_trace() + pass + result = level4_func() + return result + """ + ) + ) + + # Level 4 (bottom level with debugger) + (temp_path / "level4_module.py").write_text( + dedent( + """ + def level4_func(): + a = 70 + b = 30 + return a + b + """ + ) + ) + + # Main runner + main_path = temp_path / "main_runner.py" + main_path.write_text( + dedent( + """ + import sys + sys.path.insert(0, '.') + from level1_module import level1_func + + if __name__ == "__main__": + result = level1_func() + print(f"Final result: {result}") + """ + ) + ) + + return str(main_path) + + +@skip_win32 +def test_ignore_module_all_commands(): + """Comprehensive test for all debugger commands (up/down/step/next) with ignore functionality.""" + import pexpect + + env = os.environ.copy() + env["IPY_TEST_SIMPLE_PROMPT"] = "1" + + with TemporaryDirectory() as temp_dir: + main_path = create_test_modules(temp_dir) + + # Test UP and DOWN commands + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + # Test up without ignores (baseline) + child.sendline("up") + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("level2_module") + child.expect("ipdb>") + + # Reset position + child.sendline("down") + child.expect("ipdb>") + + # Test up with single module ignore + child.sendline("ignore_module level2_module") + child.expect("ipdb>") + child.sendline("up") + child.expect_exact( + "[... skipped 1 frame(s): 0 hidden frames + 1 ignored modules]" + ) + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("level1_module") + child.expect("ipdb>") + + # Test up with wildcard ignore + child.sendline("down") + child.expect_exact( + "[... skipped 1 frame(s): 0 hidden frames + 1 ignored modules]" + ) + child.expect("ipdb>") + child.sendline("unignore_module level2_module") + child.expect("ipdb>") + child.sendline("ignore_module level*") + child.expect("ipdb>") + child.sendline("up") + child.expect_exact( + "[... skipped 2 frame(s): 0 hidden frames + 2 ignored modules]" + ) + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("__main__") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + # Test STEP command + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + # Test step without ignores (should step into module) + child.sendline("until 9") + child.expect("ipdb>") + child.sendline("step") + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("level4_module") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + # Test step with single module ignore + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + child.sendline("ignore_module level4_module") + child.expect("ipdb>") + child.sendline("until 9") + child.expect("ipdb>") + child.sendline("step") + child.expect_exact("[... skipped 1 ignored module(s)]") + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("level3_module") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + # Test NEXT command + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + # Test next without ignores + child.sendline("until 9") + child.expect("ipdb>") + child.sendline("next") + child.expect("ipdb>") + child.sendline("__name__") + child.expect_exact("level3_module") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + # Test next with module ignore + child = pexpect.spawn(sys.executable, [main_path], env=env, cwd=temp_dir) + child.timeout = 15 * IPYTHON_TESTING_TIMEOUT_SCALE + child.expect("ipdb>") + + child.sendline("ignore_module level2_module") + child.expect("ipdb>") + child.sendline("return") + child.expect("ipdb>") + child.sendline("next") + child.expect_exact("[... skipped 1 ignored module(s)]") + child.expect("ipdb>") + + child.sendline("continue") + child.close() + + +# ----------------------------------------------------------------------------- +# Signature compatibility with stdlib's ``pdb.Pdb`` +# ----------------------------------------------------------------------------- + +import inspect +import pdb as _stdlib_pdb + +from IPython.terminal.debugger import TerminalPdb + +_PDB_SUBCLASSES = [debugger.Pdb, debugger.InterruptiblePdb, TerminalPdb] + +# TerminalPdb instantiates a prompt_toolkit session, which needs a real +# console and cannot be created on Windows CI (NoConsoleScreenBufferError), +# so we skip instantiating it there. +_PDB_SUBCLASSES_INSTANTIABLE = [ + debugger.Pdb, + debugger.InterruptiblePdb, + pytest.param(TerminalPdb, marks=skip_win32), +] + + +@pytest.mark.parametrize( + "cls", _PDB_SUBCLASSES, ids=lambda c: c.__name__ +) +def test_pdb_subclass_signature_compatible(cls): + """IPython debuggers derived from ``pdb.Pdb`` should be drop-in + replacements, i.e. accept every keyword argument that the stdlib + ``pdb.Pdb`` accepts (directly or via ``**kwargs``).""" + assert issubclass(cls, _stdlib_pdb.Pdb) + + stdlib_params = inspect.signature(_stdlib_pdb.Pdb.__init__).parameters + ip_params = inspect.signature(cls.__init__).parameters + accepts_var_keyword = any( + p.kind is inspect.Parameter.VAR_KEYWORD for p in ip_params.values() + ) + + for name, param in stdlib_params.items(): + if name == "self": + continue + if param.kind in ( + inspect.Parameter.VAR_POSITIONAL, + inspect.Parameter.VAR_KEYWORD, + ): + continue + assert accepts_var_keyword or name in ip_params, ( + f"{cls.__name__} does not accept the {name!r} argument " + "supported by stdlib pdb.Pdb" + ) + + +@pytest.mark.parametrize( + "cls", _PDB_SUBCLASSES_INSTANTIABLE, ids=lambda c: c.__name__ +) +@pytest.mark.parametrize("mode", [None, "inline", "cli"]) +def test_pdb_subclass_accepts_mode(cls, mode): + """The ``mode`` argument (added to ``pdb.Pdb`` in Python 3.14) should be + accepted on every supported Python version and stored on the instance.""" + inst = cls(mode=mode) + try: + assert inst.mode == mode + finally: + if isinstance(inst, TerminalPdb): + _cleanup_terminal_pdb(inst) + + +# ----------------------------------------------------------------------------- +# In-process Pdb tests. +# +# These drive the debugger post-mortem style: the Pdb instance is set up on a +# traceback and commands are dispatched with ``onecmd`` (or a full +# ``interaction`` with a fake stdin). No trace function is installed for most +# tests, which keeps them fast and deterministic. Sessions that end with +# quit/continue call ``sys.settrace(None)``, so those tests save and restore +# the original trace function (e.g. for coverage.py). +# ----------------------------------------------------------------------------- + +_ANSI_ESCAPE_RE = re_module.compile(r"\x1b\[[0-9;]*m") + + +def _uncolor(text): + """Remove ANSI color escapes from ``text``.""" + return _ANSI_ESCAPE_RE.sub("", text) + + +def _make_pdb(**kwargs): + """Create a Pdb instance writing to a StringIO, with colors disabled.""" + kwargs.setdefault("readrc", False) + p = debugger.Pdb(stdout=io.StringIO(), **kwargs) + p.set_theme_name("nocolor") + return p + + +def _post_mortem_pdb(tb_or_exc, cls=debugger.Pdb, **kwargs): + """Create a Pdb instance set up post-mortem on a traceback/exception.""" + kwargs.setdefault("readrc", False) + p = cls(stdout=io.StringIO(), **kwargs) + p.set_theme_name("nocolor") + p.reset() + tb = ( + tb_or_exc.__traceback__ + if isinstance(tb_or_exc, BaseException) + else tb_or_exc + ) + p.setup(None, tb) + return p + + +def _run_pdb_session(commands, tb_or_exc, cls=debugger.Pdb, **kwargs): + """Run a full interactive post-mortem session, feeding ``commands``. + + Quitting the debugger calls ``sys.settrace(None)``, so the original trace + function is restored afterwards (e.g. for coverage.py). + """ + kwargs.setdefault("readrc", False) + stdout = io.StringIO() + p = cls(stdin=_FakeInput(list(commands)), stdout=stdout, **kwargs) + p.set_theme_name("nocolor") + p.reset() + old_trace = sys.gettrace() + try: + p.interaction(None, tb_or_exc) + finally: + sys.settrace(old_trace) + return p, stdout.getvalue() + + +def _simple_exc(): + """Return a ValueError whose traceback contains a frame with locals.""" + + def fail(): + myvar = 42 + raise ValueError("simple-boom %s" % myvar) + + try: + fail() + except ValueError as exc: + return exc + + +def _mixed_hidden_exc(): + """Exception with both hidden and visible frames in its traceback.""" + + def raiser(): + __tracebackhide__ = True + raise ValueError("mixed-boom") + + def hidden_mid(): + __tracebackhide__ = True + return raiser() + + def visible_top(): + return hidden_mid() + + try: + visible_top() + except ValueError as exc: + return exc + + +def _chained_exc(): + try: + try: + 1 / 0 + except ZeroDivisionError as inner: + raise ValueError("chained-boom") from inner + except ValueError as exc: + return exc + + +_FAKE_MODULE_SOURCE = '''\ +"""Fake module for debugger tests.""" + + +class ExampleClass: + """Docstring for ExampleClass.""" + + +def example_function(x, y=3): + """Docstring for example_function.""" + return x + y + + +def fail(): + value = example_function(1) + raise ValueError("failing-module %s" % value) + + +fail() +''' + + +def _exec_failing_module(tmp_path, name="pdb_fake_mod"): + """Execute a small failing module from a real file, return (exc, path).""" + path = tmp_path / (name + ".py") + path.write_text(_FAKE_MODULE_SOURCE, encoding="utf-8") + ns = {"__name__": name, "__file__": str(path)} + try: + exec(compile(_FAKE_MODULE_SOURCE, str(path), "exec"), ns) + except ValueError as exc: + return exc, str(path) + raise AssertionError("fake module should have raised") + + +@pytest.fixture +def restore_pdb_predicates(): + """``Pdb._predicates`` aliases the class-level ``default_predicates`` + dict, so tests toggling predicates must restore its contents.""" + saved = dict(debugger.Pdb.default_predicates) + yield + debugger.Pdb.default_predicates.clear() + debugger.Pdb.default_predicates.update(saved) + + +def test_bdbquit_excepthook_is_deprecated(): + with pytest.raises(ValueError, match="deprecated"): + debugger.BdbQuit_excepthook(None, None, None) + + +def test_strip_indentation_and_doc_decoration(): + assert debugger.strip_indentation("hello\n world") == "hello\nworld" + # do_quit is decorated with the stripped stdlib docstring + assert debugger.Pdb.do_quit.__doc__.startswith("q(uit)") + assert debugger.Pdb.do_q.__doc__ == debugger.Pdb.do_quit.__doc__ + + +def test_pdb_context_argument(): + assert _make_pdb(context=None).context == 5 + assert _make_pdb(context="7").context == 7 + p = _make_pdb(context=3) + assert p.context == 3 + p.context = "9" + assert p.context == 9 + with pytest.raises(ValueError): + _make_pdb(context="not-a-number") + with pytest.raises(AssertionError): + p.context = -1 + + +def test_do_context_command(): + p = _post_mortem_pdb(_simple_exc()) + p.onecmd("context 11") + assert p.context == 11 + p.onecmd("context 0") + assert "positive integer" in p.stdout.getvalue() + assert p.context == 11 + p.onecmd("context banana") + assert p.context == 11 + + +def test_set_colors_is_deprecated(): + p = _make_pdb() + with pytest.warns(DeprecationWarning, match="set_theme_name"): + p.set_colors("nocolor") + assert p._theme_name == "nocolor" + assert p.theme is PyColorize.theme_table["nocolor"] + + +def test_get_stack_hides_bdb_internal_frames(): + src = ( + "def runcall():\n" + " def inner():\n" + " raise ValueError('fake bdb error')\n" + " try:\n" + " inner()\n" + " except ValueError as exc:\n" + " holder.append(exc)\n" + "runcall()\n" + ) + holder = [] + exec(compile(src, "bdb.py", "exec"), {"holder": holder}) + exc = holder[0] + tb = exc.__traceback__ + + p = _make_pdb() + # 'runcall' in a file named bdb.py is considered internal ... + assert p._is_internal_frame(tb.tb_frame) is True + # ... but other functions in it are not, nor are frames of other files + assert p._is_internal_frame(tb.tb_next.tb_frame) is False + assert p._is_internal_frame(sys._getframe()) is False + + stack, pos = p.get_stack(None, tb) + assert [f.f_code.co_name for f, _ in stack] == ["inner"] + assert pos == 0 + + +def test_hidden_predicate_readonly_files(restore_pdb_predicates): + p = _make_pdb() + frame = sys._getframe() + # no __tracebackhide__ local, not read-only: not hidden + assert p._hidden_predicate(frame) is False + p._predicates["readonly"] = True + with patch("IPython.core.debugger.os.access", return_value=False): + assert p._hidden_predicate(frame) is True + p._predicates["readonly"] = False + # with the tbhide predicate disabled nothing is ever hidden + p._predicates["tbhide"] = False + assert p._hidden_predicate(_hidden_frame_capture()) is False + + +def test_do_skip_predicates_command(restore_pdb_predicates, capsys): + p = _make_pdb() + + p.do_skip_predicates("") + out = capsys.readouterr().out + assert "current predicates:" in out + assert "tbhide" in out + + p.do_skip_predicates("tbhide") # wrong number of arguments + assert "Usage: skip_predicates" in capsys.readouterr().out + + p.do_skip_predicates("nonsense true") + assert "not in" in capsys.readouterr().out + + p.do_skip_predicates("tbhide banana") + assert "is invalid" in capsys.readouterr().out + + p.do_skip_predicates("tbhide false") + assert p._predicates["tbhide"] is False + + for key in list(p._predicates): + p.do_skip_predicates(f"{key} false") + assert "may not have any effects" in capsys.readouterr().out + + +def test_do_skip_hidden_command(restore_pdb_predicates, capsys): + p = _make_pdb() + p.do_skip_hidden("") + assert "skip_hidden = True" in capsys.readouterr().out + p.do_skip_hidden("false") + assert p.skip_hidden is False + p.do_skip_hidden("yes") + assert p.skip_hidden is True + for key in list(p._predicates): + p._predicates[key] = False + p.do_skip_hidden("true") + assert "may not have any effects" in capsys.readouterr().out + + +def test_where_and_navigation_with_hidden_frames(capsys): + p = _post_mortem_pdb(_mixed_hidden_exc()) + names = [f.f_code.co_name for f, _ in p.stack] + assert names[-3:] == ["visible_top", "hidden_mid", "raiser"] + assert p.curindex == len(p.stack) - 1 + + # hidden_mid is skipped; raiser is the current frame so it is shown + p.onecmd("where") + out = _uncolor(p.stdout.getvalue()) + assert "[... skipping 1 hidden frame(s)]" in out + assert "raiser" in out + + p.onecmd("up") + assert p.curframe.f_code.co_name == "visible_top" + assert "1 hidden frames + 0 ignored modules" in _uncolor( + capsys.readouterr().out + ) + + # now both hidden_mid and raiser are hidden, at the end of the stack + p.onecmd("where") + assert "[... skipping 2 hidden frame(s)]" in _uncolor(p.stdout.getvalue()) + + # every frame below the current one is hidden + p.onecmd("down") + assert "all frames below skipped" in p.stdout.getvalue() + + p.onecmd("skip_hidden false") + p.onecmd("down") + assert p.curframe.f_code.co_name == "hidden_mid" + # not at the newest frame: an unparsable count is reported + p.onecmd("down banana") + assert "Invalid frame count" in p.stdout.getvalue() + p.onecmd("down") + assert p.curframe.f_code.co_name == "raiser" + p.onecmd("down") + assert "Newest frame" in p.stdout.getvalue() + + p.onecmd("up -1") + assert p.curindex == 0 + p.onecmd("up") + assert "Oldest frame" in p.stdout.getvalue() + p.onecmd("down -1") + assert p.curindex == len(p.stack) - 1 + + p.onecmd("up banana") + assert "Invalid frame count" in p.stdout.getvalue() + + p.onecmd("up 99") + assert "all frames above skipped" in p.stdout.getvalue() + + p.onecmd("w 1") + p.onecmd("where banana") + assert "***" in p.stdout.getvalue() + + +def test_navigation_with_ignored_modules(tmp_path, capsys): + exc, path = _exec_failing_module(tmp_path, name="pdb_ignored_mod") + p = _post_mortem_pdb(exc) + assert p.curframe.f_code.co_name == "fail" + + p.onecmd("ignore_module") + assert "No modules are currently ignored." in capsys.readouterr().out + + p.onecmd("ignore_module pdb_ignored_mod") + p.onecmd("ignore_module") + assert "pdb_ignored_mod" in capsys.readouterr().out + + # the module-level frame of the fake module is skipped when going up + p.onecmd("up") + assert p.curframe.f_code.co_name == "_exec_failing_module" + assert "0 hidden frames + 1 ignored modules" in _uncolor( + capsys.readouterr().out + ) + + # going down is impossible: every frame below is in the ignored module + p.onecmd("down") + assert "all frames below skipped" in p.stdout.getvalue() + + p.onecmd("unignore_module nonexistent") + assert "Module nonexistent is not currently ignored" in capsys.readouterr().out + + p.onecmd("unignore_module pdb_ignored_mod") + p.onecmd("ignore_module") + assert "No modules are currently ignored." in capsys.readouterr().out + + p.onecmd("down") + assert p.curframe.f_code.co_name == "" + + +def test_down_reports_skipped_hidden_frames(capsys): + def raiser(): + raise ValueError("down-boom") + + def hidden_mid(): + __tracebackhide__ = True + return raiser() + + try: + hidden_mid() + except ValueError as e: + exc = e + + p = _post_mortem_pdb(exc) + p.onecmd("up") # skips hidden_mid on the way up + capsys.readouterr() + p.onecmd("down") # ... and again on the way down + assert p.curframe.f_code.co_name == "raiser" + assert "1 hidden frames + 0 ignored modules" in _uncolor( + capsys.readouterr().out + ) + + +def test_unignore_module_with_no_ignore_list(capsys): + p = _make_pdb() + assert p.skip is None + p.onecmd("unignore_module") + assert "No modules are currently ignored." in capsys.readouterr().out + assert p.skip == set() + + +def test_do_list_and_longlist(tmp_path): + exc, path = _exec_failing_module(tmp_path) + p = _post_mortem_pdb(exc) + + p.onecmd("list") + out = _uncolor(p.stdout.getvalue()) + assert "raise ValueError" in out + p.onecmd("list") # continue from the last listed position + p.onecmd("list .") # jump back to the current frame + p.onecmd("list 1,5") + assert "Fake module for debugger tests" in _uncolor(p.stdout.getvalue()) + p.onecmd("list 8,2") # last < first is treated as a count + p.onecmd("list 4") + p.onecmd("l 1,3") + # evaluates but cannot be converted to an int + p.onecmd("list 'banana'") + assert "*** Error in argument:" in p.stdout.getvalue() + + p.onecmd("longlist") + assert "def fail():" in _uncolor(p.stdout.getvalue()) + + # 'll' on a module-level frame prints the whole module + p.onecmd("up") + assert p.curframe.f_code.co_name == "" + p.onecmd("ll") + assert "class ExampleClass" in _uncolor(p.stdout.getvalue()) + + +def test_longlist_error_and_exec_filename(tmp_path): + src = "def fail():\n raise ValueError('nofile-boom')\n\nfail()\n" + try: + exec(compile(src, "", "exec"), {}) + except ValueError as e: + exc = e + + p = _post_mortem_pdb(exc) + # the source of a '' frame is not available + p.onecmd("longlist") + assert "***" in p.stdout.getvalue() + + # ... unless _exec_filename points at a real file + path = tmp_path / "exec_source.py" + path.write_text(src, encoding="utf-8") + p._exec_filename = str(path) + p.onecmd("list 1,4") + assert "nofile-boom" in _uncolor(p.stdout.getvalue()) + + +def test_list_shows_breakpoint_markers(tmp_path): + exc, path = _exec_failing_module(tmp_path) + p = _post_mortem_pdb(exc) + try: + p.onecmd(f"break {path}:10") + breaks = p.get_breaks(path, 10) + assert len(breaks) == 1 + bp = breaks[-1] + + p.onecmd("list 8,11") + assert str(bp.number) in _uncolor(p.stdout.getvalue()) + + # disabled breakpoints are rendered with a different token + p.onecmd(f"disable {bp.number}") + p.onecmd("list 8,11") + p.onecmd(f"enable {bp.number}") + p.onecmd("longlist") + finally: + p.clear_all_breaks() + + +def test_format_stack_entry_return_and_args(tmp_path): + exc, path = _exec_failing_module(tmp_path) + p = _post_mortem_pdb(exc) + p._curframe_locals["__return__"] = "some-return-value" + p._curframe_locals["__args__"] = (1, 2, 3) + out = _uncolor(p.format_stack_entry(p.stack[p.curindex])) + assert "some-return-value" in out + assert "(1, 2, 3)" in out + assert "fail" in out + + # formatting of a frame which is not the current one + out2 = _uncolor(p.format_stack_entry(p.stack[p.curindex - 1])) + assert "" in out2 + + # a context of 0 is reported as invalid + p.context = 0 + p.format_stack_entry(p.stack[p.curindex]) + assert "Context must be a positive integer" in p.stdout.getvalue() + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_do_exceptions_navigation(): + exc = _chained_exc() + p = _make_pdb() + p.reset() + exceptions, tb = p._get_tb_and_exceptions(exc) + assert [type(e) for e in exceptions] == [ZeroDivisionError, ValueError] + p.setup(None, tb) + with p._hold_exceptions(exceptions): + p.onecmd("exceptions") + out = p.stdout.getvalue() + assert "ZeroDivisionError" in out + assert "chained-boom" in out + + p.onecmd("exceptions 0") + assert p.curframe.f_code.co_name == "_chained_exc" + assert "1 / 0" in _uncolor(p.stdout.getvalue()) + + p.onecmd("exceptions not-a-number") + assert "Argument must be an integer" in p.stdout.getvalue() + + p.onecmd("exceptions 99") + assert "No exception with that number" in p.stdout.getvalue() + + p.onecmd("exception 1") # alias, switch back to the ValueError + assert "raise ValueError" in _uncolor(p.stdout.getvalue()) + + # _hold_exceptions cleans up the exception references + assert p._chained_exceptions == tuple() + assert p._chained_exception_index == 0 + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_do_exceptions_without_traceback(): + try: + raise ValueError("outer-boom") from KeyError("never-raised") + except ValueError as e: + exc = e + + p = _make_pdb() + p.reset() + exceptions, tb = p._get_tb_and_exceptions(exc) + p.setup(None, tb) + with p._hold_exceptions(exceptions): + p.onecmd("exceptions") + assert "never-raised" in p.stdout.getvalue() + # the cause was never raised, so it cannot be selected + p.onecmd("exceptions 0") + assert "does not have a traceback" in p.stdout.getvalue() + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_do_exceptions_without_chain(): + p = _post_mortem_pdb(_simple_exc().__traceback__) + p.onecmd("exceptions") + assert "Did not find chained exceptions" in p.stdout.getvalue() + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_do_exceptions_truncates_long_reprs(): + try: + raise ValueError("x" * 200) + except ValueError as e: + exc = e + p = _make_pdb() + p.reset() + exceptions, tb = p._get_tb_and_exceptions(exc) + p.setup(None, tb) + with p._hold_exceptions(exceptions): + p.onecmd("exceptions") + out = p.stdout.getvalue() + assert "..." in out + assert "x" * 200 not in out + + +@pytest.mark.skipif( + not debugger.CHAIN_EXCEPTIONS, + reason="chained exception navigation is not available", +) +def test_get_tb_and_exceptions_edge_cases(): + p = _make_pdb() + + # a plain traceback is passed through unchanged + exc = _simple_exc() + exceptions, tb = p._get_tb_and_exceptions(exc.__traceback__) + assert exceptions == tuple() + assert tb is exc.__traceback__ + + # cycles in the exception chain do not cause an infinite loop + e1, e2 = ValueError("one"), KeyError("two") + e1.__context__ = e2 + e2.__context__ = e1 + exceptions, _ = p._get_tb_and_exceptions(e1) + assert exceptions == (e2, e1) + + # overly long chains are truncated with a message + p.MAX_CHAINED_EXCEPTION_DEPTH = 2 + a, b, c = ValueError("a"), KeyError("b"), TypeError("c") + a.__context__ = b + b.__context__ = c + exceptions, _ = p._get_tb_and_exceptions(a) + assert len(exceptions) == 2 + assert "More than 2 chained exceptions found" in p.stdout.getvalue() + + +def test_pinfo_family_commands(tmp_path, capsys): + exc, path = _exec_failing_module(tmp_path) + p = _post_mortem_pdb(exc) + + p.onecmd("pdef example_function") + assert "example_function(x, y=3)" in _uncolor(capsys.readouterr().out) + + p.onecmd("pdoc ExampleClass") + assert "Docstring for ExampleClass" in _uncolor(capsys.readouterr().out) + + p.onecmd("pinfo value") + assert "int" in _uncolor(capsys.readouterr().out) + + p.onecmd("pinfo2 example_function") + assert "Docstring for example_function" in _uncolor(capsys.readouterr().out) + + p.onecmd("psource example_function") + assert "return x + y" in _uncolor(capsys.readouterr().out) + + p.onecmd("pfile example_function") + assert "Fake module for debugger tests" in _uncolor(capsys.readouterr().out) + + +def test_precmd_question_mark_rewriting(): + p = _make_pdb() + assert p.precmd("foo?") == "pinfo foo" + assert p.precmd("foo??") == "pinfo2 foo" + assert p.precmd("list") == "list" + + +def test_interaction_session_with_exception(): + exc = _simple_exc() + p, out = _run_pdb_session(["myvar + 1", "q"], exc) + assert "ipdb>" in out + assert "43" in out + + +def test_interaction_session_with_traceback_object(): + exc = _simple_exc() + p, out = _run_pdb_session(["myvar", "quit"], exc.__traceback__) + assert "42" in out + + +def test_cmdloop_resumes_after_keyboard_interrupt(): + exc = _simple_exc() + p, out = _run_pdb_session( + ["raise KeyboardInterrupt()", "myvar", "q"], exc + ) + # '--KeyboardInterrupt--' from cmdloop up to Python 3.12, + # '*** KeyboardInterrupt' from onecmd's error handling on 3.13+ + assert "KeyboardInterrupt" in out + assert "42" in out + + +def test_interruptible_pdb_aborts_session_on_keyboard_interrupt(): + exc = _simple_exc() + # on Python <= 3.12 the KeyboardInterrupt aborts the session and the + # trailing 'q' is never consumed; on 3.13+ onecmd reports the exception + # ('*** KeyboardInterrupt') and the session needs the 'q' to end + p, out = _run_pdb_session( + ["raise KeyboardInterrupt()", "q"], exc, cls=debugger.InterruptiblePdb + ) + assert "KeyboardInterrupt" in out + + +@pytest.mark.skipif( + sys.version_info >= (3, 15), + reason="the recursive debugger reads from real stdin on Python 3.15", +) +def test_do_debug_runs_recursive_debugger(): + exc = _simple_exc() + p = _post_mortem_pdb(exc) + p.stdin = _FakeInput(["c"]) + old_trace = sys.gettrace() + try: + p.onecmd("debug myvar + 1") + finally: + sys.settrace(old_trace) + out = p.stdout.getvalue() + assert "ENTERING RECURSIVE DEBUGGER" in out + assert "LEAVING RECURSIVE DEBUGGER" in out + + +def _frame_tagged_with_debuggerskip(): + __debuggerskip__ = True + return sys._getframe() + + +def _plain_frame_capture(): + return sys._getframe() + + +def _frame_with_skipping_parent(): + __debuggerskip__ = True + return _plain_frame_capture() + + +def test_break_anywhere_and_debuggerskip(restore_pdb_predicates): + p = _make_pdb() + tagged = _frame_tagged_with_debuggerskip() + child = _frame_with_skipping_parent() + plain = _plain_frame_capture() + + assert p.break_anywhere(tagged) is True + assert p.break_anywhere(child) is True + assert p.break_anywhere(plain) is False + + # a breakpoint in the frame's file short-circuits the predicates + assert p.set_break(p.canonic(plain.f_code.co_filename), plain.f_lineno) is None + try: + assert p.break_anywhere(plain) + finally: + p.clear_all_breaks() + + assert p._is_in_decorator_internal_and_should_skip(tagged) is True + assert p._cachable_skip(child) is True + assert p._cached_one_parent_frame_debuggerskip(plain) is None + + p._predicates["debuggerskip"] = False + assert p.break_anywhere(plain) is False + assert p._is_in_decorator_internal_and_should_skip(tagged) is False + + +def _hidden_frame_capture(): + __tracebackhide__ = True + return sys._getframe() + + +def test_stop_here_reports_hidden_and_ignored_frames(capsys): + p = _make_pdb() + p.reset() + + # frames in decorator internals tagged with __debuggerskip__ never stop + assert p.stop_here(_frame_tagged_with_debuggerskip()) is False + + hidden = _hidden_frame_capture() + assert p.stop_here(hidden) is True + assert "[... skipped 1 hidden frame(s)]" in _uncolor(capsys.readouterr().out) + + src = "def capture():\n holder.append(sys._getframe())\ncapture()\n" + holder = [] + exec( + compile(src, "", "exec"), + {"holder": holder, "sys": sys, "__name__": "pdb_skip_mod"}, + ) + mod_frame = holder[0] + p.skip = {"pdb_skip_mod"} + assert p.stop_here(mod_frame) is False + assert "[... skipped 1 ignored module(s)]" in _uncolor(capsys.readouterr().out) + + +def test_getsourcelines_module_object(): + p = _make_pdb() + lines, lineno = p.getsourcelines(debugger) + assert lineno == 1 + assert any("class Pdb" in line for line in lines) + + +def test_pdb_creates_shell_when_no_ipython(monkeypatch): + # when there is no IPython instance a terminal shell is created + monkeypatch.setattr(debugger, "get_ipython", lambda: None) + main_before = sys.modules["__main__"] + p = _make_pdb() + assert p.shell is not None + assert sys.modules["__main__"] is main_before + + +def test_set_trace_function_with_header(capsys): + old_trace = sys.gettrace() + try: + with PdbTestInput(["continue"]): + debugger.set_trace(header="custom-pdb-header") + finally: + sys.settrace(old_trace) + out = capsys.readouterr().out + assert "custom-pdb-header" in out + + +# ----------------------------------------------------------------------------- +# TerminalPdb tests +# ----------------------------------------------------------------------------- + + +def _cleanup_terminal_pdb(p): + # Wait for the worker thread, if the executor ever started one: leaving it + # alive keeps the process multi-threaded for every later test, and + # ``os.fork()`` warns about that since Python 3.12. + p.thread_executor.shutdown() + loop = getattr(p, "pt_loop", None) + if loop is not None: + loop.close() + + +@skip_win32 +@pytest.mark.skipif( + sys.version_info >= (3, 15), + reason="pdb internals changed in Python 3.15", +) +def test_terminal_pdb_cmdloop_requires_rawinput(): + p = TerminalPdb(stdout=io.StringIO(), readrc=False) + try: + with pytest.raises(ValueError, match="use_rawinput"): + p.cmdloop() + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_pdb_cmdqueue_session(capsys): + exc = _simple_exc() + p = TerminalPdb(readrc=False) + try: + p.set_theme_name("nocolor") + p.cmdqueue = ["where 1", "myvar", "q"] + p.reset() + p.setup(None, exc.__traceback__) + old_trace = sys.gettrace() + try: + p.cmdloop(intro="TERMINAL-PDB-INTRO") + finally: + sys.settrace(old_trace) + out = _uncolor(capsys.readouterr().out) + assert "TERMINAL-PDB-INTRO" in out + assert "42" in out + + # the completer offers the debugger command names + matches = p._ptcomp.ipy_completer.custom_matchers[0]("whe") + assert "where" in matches + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_pdb_reuses_shell_history(monkeypatch): + from prompt_toolkit.history import InMemoryHistory + + shell = _make_pdb().shell + hist = InMemoryHistory() + monkeypatch.setattr(shell, "debugger_history", hist) + p = TerminalPdb(readrc=False) + try: + assert p.debugger_history is hist + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_pdb_simple_prompt_input(monkeypatch, capsys): + import IPython.terminal.debugger as tdebugger + + monkeypatch.setattr(tdebugger, "_use_simple_prompt", True) + exc = _simple_exc() + p = TerminalPdb(readrc=False) + try: + p.set_theme_name("nocolor") + answers = iter(["myvar * 2", "q"]) + monkeypatch.setattr(builtins, "input", lambda prompt="": next(answers)) + p.reset() + old_trace = sys.gettrace() + try: + p.interaction(None, exc) + finally: + sys.settrace(old_trace) + assert "84" in capsys.readouterr().out + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_pdb_prompt_eof_quits(monkeypatch): + exc = _simple_exc() + p = TerminalPdb(readrc=False) + try: + p.set_theme_name("nocolor") + + def raise_eof(): + raise EOFError + + monkeypatch.setattr(p, "_prompt", raise_eof) + p.reset() + old_trace = sys.gettrace() + try: + p.interaction(None, exc) + finally: + sys.settrace(old_trace) + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_pdb_do_interact(monkeypatch): + # do_interact imports this lazily, so patch the embed module itself + from IPython.terminal import embed as tembed + + calls = {} + + class FakeEmbeddedShell: + def __init__(self, **kwargs): + calls["init"] = kwargs + + def __call__(self, module=None, local_ns=None): + calls["module"] = module + calls["local_ns"] = local_ns + + monkeypatch.setattr(tembed, "InteractiveShellEmbed", FakeEmbeddedShell) + exc = _simple_exc() + p = TerminalPdb(readrc=False) + try: + p.reset() + p.setup(None, exc.__traceback__) + p.do_interact("") + assert calls["init"]["banner1"] == "*interactive*" + assert calls["local_ns"]["myvar"] == 42 + finally: + _cleanup_terminal_pdb(p) + + +@skip_win32 +def test_terminal_debugger_set_trace_uses_caller_frame(monkeypatch): + import IPython.terminal.debugger as tdebugger + + recorded = {} + + def fake_set_trace(self, frame=None): + recorded["frame"] = frame + recorded["self"] = self + + monkeypatch.setattr(TerminalPdb, "set_trace", fake_set_trace) + tdebugger.set_trace() + try: + assert ( + recorded["frame"].f_code.co_name + == "test_terminal_debugger_set_trace_uses_caller_frame" + ) + finally: + _cleanup_terminal_pdb(recorded["self"]) diff --git a/tests/test_debugger_backport.py b/tests/test_debugger_backport.py new file mode 100644 index 00000000000..496bb1eadae --- /dev/null +++ b/tests/test_debugger_backport.py @@ -0,0 +1,171 @@ +"""Tests for IPython.core.debugger_backport. + +``PdbClosureBackport`` is a backport of the CPython 3.13 pdb changes making +closures work in the debugger (gh-83151). It is mixed into +``IPython.core.debugger.Pdb`` on Python < 3.13 only, so the tests going +through ``Pdb`` commands are skipped on newer versions, while the +``_exec_in_closure`` unit tests always run. +""" + +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. + +import io +import sys + +import pytest + +from IPython.core import debugger +from IPython.core.debugger_backport import PdbClosureBackport + +backport_in_use = pytest.mark.skipif( + sys.version_info >= (3, 13), + reason="the closure backport is only used on Python < 3.13", +) + + +class _FakeInput: + """Fake stdin feeding predefined lines to the debugger.""" + + def __init__(self, lines): + self.lines = iter(lines) + + def readline(self): + line = next(self.lines) + print(line) + return line + "\n" + + +def _post_mortem_pdb(): + """Return a Pdb instance set up post-mortem on a small traceback.""" + + def fail(): + value = 3 + raise ValueError("backport-boom %s" % value) + + try: + fail() + except ValueError as exc: + err = exc + + p = debugger.Pdb(stdout=io.StringIO(), readrc=False) + p.set_theme_name("nocolor") + p.reset() + p.setup(None, err.__traceback__) + assert p.curframe_locals["value"] == 3 + return p + + +# ----------------------------------------------------------------------------- +# _exec_in_closure unit tests (run on every Python version) +# ----------------------------------------------------------------------------- + + +def test_exec_in_closure_returns_false_for_flat_source(): + # no nested code object: the caller should fall back to a plain exec + ns = {"x": 1} + assert PdbClosureBackport()._exec_in_closure("x + 1", {}, ns) is False + + +def test_exec_in_closure_prints_expression_result(capsys): + ns = {"x": 2} + assert ( + PdbClosureBackport()._exec_in_closure( + "sum(x * i for i in range(3))", {}, ns + ) + is True + ) + assert "6" in capsys.readouterr().out + + +def test_exec_in_closure_none_result_is_not_printed(capsys): + ns = {"x": 2} + assert PdbClosureBackport()._exec_in_closure("(lambda: None)()", {}, ns) is True + assert "None" not in capsys.readouterr().out + + +def test_exec_in_closure_writes_locals_back(): + ns = {"x": 5} + src = "def f_local():\n return x\nresult = f_local()" + assert PdbClosureBackport()._exec_in_closure(src, {}, ns) is True + assert ns["result"] == 5 + assert "f_local" in ns + # the internal evaluation scaffolding must not leak into the locals + assert "__pdb_eval__" not in ns + + +def test_exec_in_closure_bad_local_names_fall_back(): + # "a-b" is not a valid identifier: building the closure source fails + # and the method reports False so a plain exec is used instead + assert ( + PdbClosureBackport()._exec_in_closure( + "def f():\n return 1\nf()", {}, {"a-b": 1} + ) + is False + ) + + +def test_exec_in_closure_error_in_code_falls_back(): + src = "def f():\n raise ValueError('inner-err')\nf()" + assert PdbClosureBackport()._exec_in_closure(src, {}, {"x": 1}) is False + + +# ----------------------------------------------------------------------------- +# default() through IPython's Pdb (only on Python versions using the backport) +# ----------------------------------------------------------------------------- + + +@backport_in_use +def test_default_executes_expressions(): + p = _post_mortem_pdb() + p.onecmd("value + 1") + assert "4" in p.stdout.getvalue() + + +@backport_in_use +def test_default_strips_bang_prefix(): + p = _post_mortem_pdb() + p.onecmd("!value * 10") + assert "30" in p.stdout.getvalue() + + +@backport_in_use +def test_default_closure_expression(): + p = _post_mortem_pdb() + # a generator expression needs the closure machinery to see `value`; + # default() redirects sys.stdout to the debugger stdout while executing + p.onecmd("sum(value * i for i in range(3))") + assert "9" in p.stdout.getvalue() + + +@backport_in_use +def test_default_assignment_updates_locals(): + p = _post_mortem_pdb() + p.onecmd("squares = [i * i for i in range(4)]") + assert p.curframe_locals["squares"] == [0, 1, 4, 9] + p.onecmd("squares") + assert "[0, 1, 4, 9]" in p.stdout.getvalue() + + +@backport_in_use +def test_default_reports_errors(): + p = _post_mortem_pdb() + p.onecmd("undefined_name_xyz") + out = p.stdout.getvalue() + assert "***" in out + assert "NameError" in out + + +@backport_in_use +def test_default_multiline_command(): + # The multi-line code path of the backported default() relies on + # pdb._disable_command_completion which only exists on Python >= 3.13, + # so on the versions actually using the backport it reports an error + # instead of silently hanging. + p = _post_mortem_pdb() + p.stdin = _FakeInput([" y = 1", ""]) + p.use_rawinput = False + p.onecmd("if True:") + out = p.stdout.getvalue() + assert "***" in out + assert "AttributeError" in out diff --git a/IPython/testing/tests/test_decorators.py b/tests/test_decorators.py similarity index 70% rename from IPython/testing/tests/test_decorators.py rename to tests/test_decorators.py index 8bdc471e018..cd4854a2301 100644 --- a/IPython/testing/tests/test_decorators.py +++ b/tests/test_decorators.py @@ -1,5 +1,4 @@ -"""Tests for the decorators we've created for IPython. -""" +"""Tests for the decorators we've created for IPython.""" # Module imports # Std lib @@ -9,10 +8,12 @@ # Our own from IPython.testing import decorators as dec from IPython.testing.skipdoctest import skip_doctest +from IPython.utils.text import dedent -#----------------------------------------------------------------------------- +# ----------------------------------------------------------------------------- # Utilities + # Note: copied from OInspect, kept here so the testing stuff doesn't create # circular dependencies and is easier to reuse. def getargspec(obj): @@ -31,15 +32,16 @@ def getargspec(obj): elif inspect.ismethod(obj): func_obj = obj.__func__ else: - raise TypeError('arg is not a Python function') + raise TypeError("arg is not a Python function") args, varargs, varkw = inspect.getargs(func_obj.__code__) return args, varargs, varkw, func_obj.__defaults__ -#----------------------------------------------------------------------------- + +# ----------------------------------------------------------------------------- # Testing functions -@dec.as_unittest -def trivial(): + +def test_trivial(): """A trivial test""" pass @@ -47,31 +49,32 @@ def trivial(): @dec.skip() def test_deliberately_broken(): """A deliberately broken test - we want to skip this one.""" - 1/0 + 1 / 0 + -@dec.skip('Testing the skip decorator') +@dec.skip("Testing the skip decorator") def test_deliberately_broken2(): """Another deliberately broken test - we want to skip this one.""" - 1/0 + 1 / 0 # Verify that we can correctly skip the doctest for a function at will, but # that the docstring itself is NOT destroyed by the decorator. @skip_doctest -def doctest_bad(x,y=1,**k): +def doctest_bad(x, y=1, **k): """A function whose doctest we need to skip. >>> 1+1 3 """ - print('x:',x) - print('y:',y) - print('k:',k) + print("x:", x) + print("y:", y) + print("k:", k) def call_doctest_bad(): """Check that we can still call the decorated functions. - + >>> doctest_bad(3,y=4) x: 3 y: 4 @@ -81,18 +84,18 @@ def call_doctest_bad(): def test_skip_dt_decorator(): - """Doctest-skipping decorator should preserve the docstring. - """ + """Doctest-skipping decorator should preserve the docstring.""" # Careful: 'check' must be a *verbatim* copy of the doctest_bad docstring! check = """A function whose doctest we need to skip. >>> 1+1 3 """ + # Fetch the docstring from doctest_bad after decoration. val = doctest_bad.__doc__ - - assert check == val, "doctest_bad docstrings don't match" + + assert dedent(check) == dedent(val), "doctest_bad docstrings don't match" # Doctest skipping should work for class methods too @@ -106,7 +109,7 @@ class FooClass(object): """ @skip_doctest - def __init__(self,x): + def __init__(self, x): """Make a FooClass. Example: @@ -114,11 +117,11 @@ def __init__(self,x): >>> f = FooClass(3) junk """ - print('Making a FooClass.') + print("Making a FooClass.") self.x = x - + @skip_doctest - def bar(self,y): + def bar(self, y): """Example: >>> ff = FooClass(3) @@ -127,9 +130,9 @@ def bar(self,y): >>> 1/0 bam! """ - return 1/y + return 1 / y - def baz(self,y): + def baz(self, y): """Example: >>> ff2 = FooClass(3) @@ -137,30 +140,15 @@ def baz(self,y): >>> ff2.baz(3) True """ - return self.x==y + return self.x == y def test_skip_dt_decorator2(): - """Doctest-skipping decorator should preserve function signature. - """ + """Doctest-skipping decorator should preserve function signature.""" # Hardcoded correct answer - dtargs = (['x', 'y'], None, 'k', (1,)) + dtargs = (["x", "y"], None, "k", (1,)) # Introspect out the value dtargsr = getargspec(doctest_bad) - assert dtargsr==dtargs, \ - "Incorrectly reconstructed args for doctest_bad: %s" % (dtargsr,) - - -@dec.skip_linux -def test_linux(): - assert sys.platform.startswith("linux") is False, "This test can't run under linux" - - -@dec.skip_win32 -def test_win32(): - assert sys.platform != "win32", "This test can't run under windows" - - -@dec.skip_osx -def test_osx(): - assert sys.platform != "darwin", "This test can't run under osx" + assert dtargsr == dtargs, "Incorrectly reconstructed args for doctest_bad: %s" % ( + dtargsr, + ) diff --git a/IPython/utils/tests/test_decorators.py b/tests/test_decorators_2.py similarity index 85% rename from IPython/utils/tests/test_decorators.py rename to tests/test_decorators_2.py index 38e871deb7e..04c87b6594b 100644 --- a/IPython/utils/tests/test_decorators.py +++ b/tests/test_decorators_2.py @@ -1,10 +1,11 @@ from IPython.utils import decorators + def test_flag_calls(): @decorators.flag_calls def f(): pass - + assert not f.called f() - assert f.called \ No newline at end of file + assert f.called diff --git a/tests/test_deepreload.py b/tests/test_deepreload.py new file mode 100644 index 00000000000..4eeaa11c18b --- /dev/null +++ b/tests/test_deepreload.py @@ -0,0 +1,316 @@ +# -*- coding: utf-8 -*- +"""Test suite for the deepreload module.""" + +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. + +import sys +import types +from pathlib import Path + +import pytest +from tempfile import TemporaryDirectory + +from IPython.lib import deepreload +from IPython.lib.deepreload import modules_reloading +from IPython.lib.deepreload import reload as dreload +from IPython.utils.syspathcontext import prepended_to_syspath + + +def test_deepreload(): + "Test that dreload does deep reloads and skips excluded modules." + with TemporaryDirectory() as tmpdir: + with prepended_to_syspath(tmpdir): + tmpdirpath = Path(tmpdir) + with open(tmpdirpath / "A.py", "w", encoding="utf-8") as f: + f.write("class Object:\n pass\nok = True\n") + with open(tmpdirpath / "B.py", "w", encoding="utf-8") as f: + f.write("import A\nassert A.ok, 'we are fine'\n") + import A + import B + + # Test that A is not reloaded. + obj = A.Object() + dreload(B, exclude=["A"]) + assert isinstance(obj, A.Object) is True + + # Test that an import failure will not blow-up us. + A.ok = False + with pytest.raises(AssertionError, match="we are fine"): + dreload(B, exclude=["A"]) + assert len(modules_reloading) == 0 + assert not A.ok + + # Test that A is reloaded. + obj = A.Object() + A.ok = False + dreload(B) + assert A.ok + assert isinstance(obj, A.Object) is False + + +def test_deepreload_package_relative_imports(): + """Reloading a package exercises dotted, relative and star imports.""" + with TemporaryDirectory() as tmpdir: + with prepended_to_syspath(tmpdir): + pkgdir = Path(tmpdir) / "dpkg" + pkgdir.mkdir() + (pkgdir / "__init__.py").write_text( + "from dpkg import dmod1\n__all__ = ['dmod1', 'dmod2']\n", + encoding="utf-8", + ) + (pkgdir / "dmod1.py").write_text( + "from . import dmod2\nfrom .dmod2 import val\n", encoding="utf-8" + ) + (pkgdir / "dmod2.py").write_text("val = 1\n", encoding="utf-8") + main = Path(tmpdir) / "dmain.py" + main.write_text( + "import dpkg.dmod1\nfrom dpkg import dmod2\nfrom dpkg import *\n", + encoding="utf-8", + ) + + import dmain + import dpkg + + # mutate state that only a re-execution of the modules restores + dpkg.dmod2.val = 999 + newmain = dreload(dmain) + assert newmain is dmain + # submodules reachable through relative imports were re-executed + assert dpkg.dmod2.val == 1 + assert dmain.dmod2.val == 1 + assert dmain.dmod1.val == 1 + assert len(modules_reloading) == 0 + + for name in list(sys.modules): + if name == "dmain" or name.startswith("dpkg"): + del sys.modules[name] + + +def test_not_module(): + pytest.raises(TypeError, dreload, "modulename") + + +def test_not_in_sys_modules(): + fake_module = types.ModuleType("fake_module") + with pytest.raises(ImportError, match="not in sys.modules"): + dreload(fake_module) + + +def test_reload_types_module_is_noop(): + # the types module is hardcoded to never be reloaded + assert dreload(types) is types + + +class TestGetParent: + def test_no_level(self): + assert deepreload.get_parent({"__package__": "os"}, 0) == (None, "") + + def test_globals_not_dict(self): + assert deepreload.get_parent(None, 1) == (None, "") + + def test_package_not_string(self): + with pytest.raises(ValueError, match="__package__ set to non-string"): + deepreload.get_parent({"__package__": 42}, 1) + + def test_relative_import_in_non_package(self): + with pytest.raises(ValueError, match="non-package"): + deepreload.get_parent({"__package__": ""}, 1) + + def test_empty_package_negative_level(self): + assert deepreload.get_parent({"__package__": ""}, -1) == (None, "") + + def test_package_set(self): + parent, name = deepreload.get_parent({"__package__": "os"}, 1) + assert parent is sys.modules["os"] + assert name == "os" + + def test_no_name(self): + assert deepreload.get_parent({}, 1) == (None, "") + + def test_name_with_path_is_package(self): + import json + + globals_ = {"__name__": "json", "__path__": []} + parent, name = deepreload.get_parent(globals_, 1) + assert parent is json + assert name == "json" + # get_parent fills in __package__ as a side effect + assert globals_["__package__"] == "json" + + def test_plain_module_infers_package(self): + globals_ = {"__name__": "os.path"} + parent, name = deepreload.get_parent(globals_, 1) + assert parent is sys.modules["os"] + assert name == "os" + assert globals_["__package__"] == "os" + + def test_toplevel_module_relative_import(self): + with pytest.raises(ValueError, match="non-package"): + deepreload.get_parent({"__name__": "os"}, 1) + + def test_toplevel_module_absolute_import(self): + globals_ = {"__name__": "os"} + assert deepreload.get_parent(globals_, -1) == (None, "") + assert globals_["__package__"] is None + + def test_relative_import_beyond_toplevel(self): + with pytest.raises(ValueError, match="beyond top-level"): + deepreload.get_parent({"__package__": "os"}, 2) + + def test_parent_not_loaded_relative(self): + with pytest.raises(SystemError, match="not loaded"): + deepreload.get_parent({"__package__": "not_a_real_module_xyz"}, 1) + + def test_parent_not_found_absolute(self): + with pytest.warns(UserWarning, match="not found"): + parent, name = deepreload.get_parent( + {"__package__": "not_a_real_module_xyz"}, -1 + ) + assert parent is None + assert name == "not_a_real_module_xyz" + + +class TestLoadNext: + def test_empty_name(self): + mod = types.ModuleType("mod") + assert deepreload.load_next(mod, None, "", "buf") == (mod, None, "buf") + + def test_dot_prefixed_name(self): + with pytest.raises(ValueError, match="Empty module name"): + deepreload.load_next(None, None, ".foo", "") + + def test_import_failure(self, monkeypatch): + monkeypatch.setattr( + deepreload, "import_submodule", lambda mod, subname, fullname: None + ) + with pytest.raises(ImportError, match="No module named"): + deepreload.load_next(None, None, "foo", "") + + def test_altmod_fallback(self, monkeypatch): + """When the parent lookup fails, load_next retries with altmod.""" + sentinel = types.ModuleType("sentinel") + mod = types.ModuleType("mod") + calls = [] + + def fake_import_submodule(m, subname, fullname): + calls.append((m, subname, fullname)) + return sentinel if m is None else None + + monkeypatch.setattr(deepreload, "import_submodule", fake_import_submodule) + result, next_, buf = deepreload.load_next(mod, None, "foo.bar", "pfx") + assert result is sentinel + assert next_ == "bar" + assert buf == "foo" + assert calls == [(mod, "foo", "pfx.foo"), (None, "foo", "foo")] + + +class TestEnsureFromlist: + def test_no_path_attribute(self): + # modules without __path__ (i.e. not packages) are ignored + mod = types.ModuleType("plain") + assert deepreload.ensure_fromlist(mod, ["anything"], "plain", 0) is None + + def test_fromlist_item_not_string(self): + pkg = types.ModuleType("fakepkg") + pkg.__path__ = [] + with pytest.raises(TypeError, match="not a string"): + deepreload.ensure_fromlist(pkg, [42], "fakepkg", 0) + + def test_star_without_all(self): + pkg = types.ModuleType("fakepkg") + pkg.__path__ = [] + # no __all__: '*' is silently ignored + assert deepreload.ensure_fromlist(pkg, ["*"], "fakepkg", 0) is None + + def test_star_recursive_is_skipped(self): + pkg = types.ModuleType("fakepkg") + pkg.__path__ = [] + pkg.__all__ = ["*"] + # a '*' inside __all__ must not recurse endlessly + assert deepreload.ensure_fromlist(pkg, ["*"], "fakepkg", 1) is None + + def test_existing_attribute_not_reimported(self, monkeypatch): + pkg = types.ModuleType("fakepkg") + pkg.__path__ = [] + pkg.present = True + + def boom(mod, subname, fullname): + raise AssertionError("should not be called") + + monkeypatch.setattr(deepreload, "import_submodule", boom) + deepreload.ensure_fromlist(pkg, ["present"], "fakepkg", 0) + + def test_missing_attribute_imported(self, monkeypatch): + pkg = types.ModuleType("fakepkg") + pkg.__path__ = [] + imported = [] + monkeypatch.setattr( + deepreload, + "import_submodule", + lambda mod, subname, fullname: imported.append((subname, fullname)), + ) + deepreload.ensure_fromlist(pkg, ["missing"], "fakepkg", 0) + assert imported == [("missing", "fakepkg.missing")] + + +class TestImportSubmodule: + def test_already_found(self, monkeypatch): + monkeypatch.setitem(deepreload.found_now, "os", 1) + assert deepreload.import_submodule(None, "os", "os") is sys.modules["os"] + + def test_fresh_import(self, capsys): + """A module not yet in sys.modules is imported, not reloaded.""" + with TemporaryDirectory() as tmpdir: + with prepended_to_syspath(tmpdir): + (Path(tmpdir) / "fresh_mod_xyz.py").write_text( + "fresh = True\n", encoding="utf-8" + ) + try: + m = deepreload.import_submodule( + None, "fresh_mod_xyz", "fresh_mod_xyz" + ) + assert m.fresh is True + assert "Reloading fresh_mod_xyz" in capsys.readouterr().out + finally: + sys.modules.pop("fresh_mod_xyz", None) + deepreload.found_now.clear() + + def test_failed_reload_restores_module(self, monkeypatch, capsys): + modname = "fake_failing_module" + oldm = types.ModuleType(modname) + monkeypatch.setitem(sys.modules, modname, oldm) + + def failing_reload(m): + del sys.modules[modname] + raise RuntimeError("reload failed") + + monkeypatch.setattr(deepreload.importlib, "reload", failing_reload) + with pytest.raises(RuntimeError, match="reload failed"): + deepreload.import_submodule(None, modname, modname) + # the original module object must be restored + assert sys.modules[modname] is oldm + assert "Reloading fake_failing_module" in capsys.readouterr().out + deepreload.found_now.clear() + + +class TestAddSubmodule: + def test_mod_none_is_noop(self): + assert deepreload.add_submodule(None, None, "foo", "foo") is None + + def test_sets_attribute(self): + mod = types.ModuleType("parent") + sub = types.ModuleType("parent.child") + deepreload.add_submodule(mod, sub, "parent.child", "child") + assert mod.child is sub + + def test_submod_none_looked_up_in_sys_modules(self): + mod = types.ModuleType("parent") + deepreload.add_submodule(mod, None, "os", "os") + assert mod.os is sys.modules["os"] + + +class TestDeepImportHook: + def test_empty_module_name(self): + with pytest.raises(ValueError, match="Empty module name"): + deepreload.deep_import_hook("") diff --git a/tests/test_demo.py b/tests/test_demo.py new file mode 100644 index 00000000000..9226c45e105 --- /dev/null +++ b/tests/test_demo.py @@ -0,0 +1,434 @@ +# -*- coding: utf-8 -*- +"""Tests for the IPython.lib.demo module.""" + +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. + +import builtins +import io + +import pytest + +from IPython.lib import demo as demo_module +from IPython.lib.demo import ( + ClearDemo, + ClearIPDemo, + Demo, + IPythonDemo, + IPythonLineDemo, + LineDemo, + slide, +) + +SAMPLE_DEMO = """\ +print('hello') + +# stop + +x = 1 +y = 2 + +# stop +# silent + +z = x + y + +# stop +# auto +print('auto block') + +# --- stop --- + +print('last block') +""" + + +@pytest.fixture +def make_demo(tmp_path): + """Factory building demo objects from source text, closing files on exit.""" + demos = [] + + def _make(src_text, cls=Demo, filename="sample_demo.py", **kwargs): + fname = tmp_path / filename + fname.write_text(src_text, encoding="utf-8") + d = cls(str(fname), **kwargs) + demos.append(d) + return d + + yield _make + for d in demos: + d.fobj.close() + + +def run_to_completion(d): + """Run all remaining blocks of an automatic demo.""" + while not d.finished: + d() + + +def test_demo_parsing(make_demo): + d = make_demo(SAMPLE_DEMO) + assert d.nblocks == 5 + assert d._silent == [False, False, True, False, False] + assert d._auto == [False, False, False, True, False] + assert d.auto_all is False + assert d.block_index == 0 + assert d.finished is False + assert d.title == "sample_demo.py" + # stop markers are removed by the block splitting, auto tags stripped + assert " stop" not in "".join(d.src_blocks) + assert " auto" not in d.src_blocks[3] + assert "auto block" in d.src_blocks[3] + + +def test_demo_title_and_argv(make_demo): + d = make_demo(SAMPLE_DEMO, title="My Demo", arg_str="--opt value") + assert d.title == "My Demo" + assert d.sys_argv[1:] == ["--opt", "value"] + + +def test_demo_from_filelike(): + src = io.StringIO("print('from filelike')\n") + d = Demo(src) + assert d.fname == "from a file-like object" + assert d.title == "from a file-like object" + assert d.nblocks == 1 + src.close() + + src2 = io.StringIO("print('named')\n") + d2 = Demo(src2, title="named demo") + assert d2.title == "named demo" + src2.close() + + +def test_demo_auto_all_tag(make_demo): + src = "# auto_all\na = 1\n# stop\nb = 2\n" + d = make_demo(src) + assert d.auto_all is True + # the auto_all marker must be stripped from the first block + assert "auto_all" not in d.src_blocks[0] + run_to_completion(d) + assert d.user_ns["a"] == 1 + assert d.user_ns["b"] == 2 + + +def test_demo_run_and_finish(make_demo, capsys): + d = make_demo(SAMPLE_DEMO, auto_all=True) + run_to_completion(d) + out = capsys.readouterr().out + assert "hello" in out + assert "auto block" in out + assert "last block" in out + assert "Executing silent block" in out + assert "END OF DEMO" in out + assert d.finished is True + assert d.user_ns["z"] == 3 + # the interactive namespace is updated at each block + assert d.ip_ns["z"] == 3 + + # calling a finished demo only prints a message + capsys.readouterr() + d() + out = capsys.readouterr().out + assert "Demo finished" in out + # explicitly running one block by index still works on a finished demo + d(0) + out = capsys.readouterr().out + assert "hello" in out + + +def test_demo_interactive_confirm(make_demo, capsys, monkeypatch): + d = make_demo("run_me = True\n") + monkeypatch.setattr("builtins.input", lambda prompt="": "") + d() + out = capsys.readouterr().out + assert "Press to quit" in out + assert d.user_ns["run_me"] is True + + +def test_demo_interactive_quit(make_demo, capsys, monkeypatch): + d = make_demo("skipped = True\n") + monkeypatch.setattr("builtins.input", lambda prompt="": "q") + d() + out = capsys.readouterr().out + assert "Block NOT executed" in out + assert "skipped" not in d.user_ns + + +def test_demo_seek_back_jump_again(make_demo, capsys): + d = make_demo(SAMPLE_DEMO, auto_all=True) + d() # block 0 + d() # block 1 + assert d.block_index == 2 + d.back() + assert d.block_index == 1 + d.jump(1) + assert d.block_index == 2 + d.seek(0) + assert d.block_index == 0 + # negative indices seek from the end + d.seek(-1) + assert d.block_index == d.nblocks - 1 + run_to_completion(d) + assert d.finished is True + # seeking resets the finished flag + d.seek(1) + assert d.finished is False + # again() re-runs the previous block + d() + capsys.readouterr() + d.again() + assert d.block_index == 2 + out = capsys.readouterr().out + assert "block # 1" in out + + +def test_demo_invalid_index(make_demo): + d = make_demo(SAMPLE_DEMO, auto_all=True) + with pytest.raises(ValueError, match="invalid block index"): + d.seek(d.nblocks) + with pytest.raises(ValueError, match="invalid block index"): + d(-1) + with pytest.raises(ValueError, match="invalid block index"): + d.jump(1000) + + +def test_demo_reload(make_demo): + d = make_demo(SAMPLE_DEMO, auto_all=True) + run_to_completion(d) + # reload() re-reads the source (closing the previous file) and resets + d.reload() + assert d.block_index == 0 + assert d.finished is False + assert d.nblocks == 5 + + +def test_demo_show_and_edit_when_finished(make_demo, capsys): + d = make_demo("done = 1\n", auto_all=True) + run_to_completion(d) + capsys.readouterr() + # show() and edit() on a finished demo just print a message + d.show() + assert "Demo finished" in capsys.readouterr().out + d.edit() + assert "Demo finished" in capsys.readouterr().out + + +def test_demo_reset(make_demo): + d = make_demo(SAMPLE_DEMO, auto_all=True) + run_to_completion(d) + assert d.finished is True + d.reset() + assert d.block_index == 0 + assert d.finished is False + assert d.user_ns == {} + + +def test_demo_show(make_demo, capsys): + d = make_demo(SAMPLE_DEMO) + d.show(0) + out = capsys.readouterr().out + assert "block # 0" in out + assert "4 remaining" in out + assert "hello" in out + + +def test_demo_show_all(make_demo, capsys): + d = make_demo(SAMPLE_DEMO) + d.show_all() + out = capsys.readouterr().out + # every block is shown, silent ones marked as such + assert "block # 0" in out + assert "SILENT block # 2" in out + assert "last block" in out + + +def test_demo_exception_shows_traceback(make_demo, monkeypatch): + d = make_demo("1/0\n", auto_all=True) + tracebacks = [] + monkeypatch.setattr( + d, "ip_showtb", lambda *a, **kw: tracebacks.append(kw), raising=False + ) + d() + assert tracebacks == [{"filename": d.fname}] + assert d.finished is True + + +def test_demo_outside_ipython(make_demo, monkeypatch, capsys): + monkeypatch.delattr(builtins, "get_ipython") + d = make_demo("standalone = 42\n", auto_all=True) + assert d.inside_ipython is False + run_to_completion(d) + assert d.user_ns["standalone"] == 42 + assert "END OF DEMO" in capsys.readouterr().out + + +def test_demo_edit(make_demo, monkeypatch, capsys): + d = make_demo("first = 1\n# stop\nsecond = 2\n", auto_all=True) + d() # run block 0 + + def fake_editor(filename, linenum=None, *args, **kwargs): + with open(filename, "w", encoding="utf-8") as f: + f.write("first = 100\n") + + monkeypatch.setattr(d.shell.hooks, "editor", fake_editor, raising=False) + d.edit() + # the edited block was stored and re-executed + assert d.src_blocks[0] == "first = 100\n" + assert d.user_ns["first"] == 100 + assert d.block_index == 1 + + +def test_demo_marquee(): + src = io.StringIO("pass\n") + d = Demo(src) + mq = d.marquee("hello", width=20, mark="*") + assert "hello" in mq + assert "*" in mq + src.close() + + +def test_ipython_demo(make_demo, capsys): + d = make_demo("via_ip = 11\nprint('ip ran')\n", cls=IPythonDemo, auto_all=True) + run_to_completion(d) + out = capsys.readouterr().out + assert "ip ran" in out + # IPythonDemo runs code through the real shell namespace + assert d.shell.user_ns["via_ip"] == 11 + + +def test_line_demo(make_demo): + d = make_demo("a = 1\n\nb = 2\nc = a + b\n", cls=LineDemo) + # blank lines are dropped, each remaining line is a block + assert d.nblocks == 3 + assert d.auto_all is True + assert d._silent == [False] * 3 + assert d._auto == [True] * 3 + d() + assert d.user_ns["a"] == 1 + assert "b" not in d.user_ns + run_to_completion(d) + assert d.user_ns["c"] == 3 + assert d.finished is True + + +def test_ipython_line_demo(make_demo): + d = make_demo("line_demo_x = 5\n", cls=IPythonLineDemo) + run_to_completion(d) + assert d.shell.user_ns["line_demo_x"] == 5 + + +def test_clear_demo(make_demo, monkeypatch, capsys): + cleared = [] + from IPython.utils import terminal + + monkeypatch.setattr(terminal, "_term_clear", lambda: cleared.append(True)) + d = make_demo("cleared_var = 1\n", cls=ClearDemo, auto_all=True) + # ClearMixin uses empty marquees + assert d.marquee("anything") == "" + run_to_completion(d) + out = capsys.readouterr().out + # empty marquee suppresses the END OF DEMO banner + assert "END OF DEMO" not in out + assert cleared == [True] + assert d.user_ns["cleared_var"] == 1 + assert d.finished is True + + +def test_clear_ip_demo(make_demo, monkeypatch): + from IPython.utils import terminal + + monkeypatch.setattr(terminal, "_term_clear", lambda: None) + d = make_demo("clear_ip_var = 7\n", cls=ClearIPDemo, auto_all=True) + assert d.marquee("x") == "" + run_to_completion(d) + assert d.shell.user_ns["clear_ip_var"] == 7 + + +def test_demo_format_rst(make_demo): + src = '"""A docstring long enough for rst.\n\nMore text.\n"""\n# a comment\nx = 1\n' + d = make_demo(src, format_rst=True) + assert d.format_rst is True + assert hasattr(d, "rst_lexer") + colored = d.src_blocks_colored[0] + assert "comment" in colored + assert "x" in colored + # highlight() can also be called directly on new content + assert "y" in d.highlight("y = 2 # another comment") + + +def test_slide(tmp_path, monkeypatch, capsys): + fname = tmp_path / "slides.py" + fname.write_text("s1 = 1\n# stop\ns2 = 2\n", encoding="utf-8") + + created = [] + + class TrackingDemo(Demo): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + created.append(self) + + monkeypatch.setattr(demo_module, "Demo", TrackingDemo) + monkeypatch.setattr("builtins.input", lambda prompt="": "") + try: + slide(str(fname), noclear=True, auto_all=True, format_rst=False) + (d,) = created + assert d.finished is True + assert d.user_ns["s2"] == 2 + out = capsys.readouterr().out + # the delimiter prompt is emitted between slides + assert "END OF DEMO" in out + finally: + for d in created: + d.fobj.close() + + +def test_slide_with_clear(tmp_path, monkeypatch, capsys): + from IPython.utils import terminal + + fname = tmp_path / "slides_clear.py" + fname.write_text("c1 = 1\n", encoding="utf-8") + + created = [] + + class TrackingClearDemo(ClearDemo): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + created.append(self) + + monkeypatch.setattr(demo_module, "ClearDemo", TrackingClearDemo) + monkeypatch.setattr("builtins.input", lambda prompt="": "") + monkeypatch.setattr(terminal, "_term_clear", lambda: None) + try: + slide(str(fname), noclear=False, auto_all=True, format_rst=False) + (d,) = created + assert isinstance(d, ClearDemo) + assert d.finished is True + assert d.user_ns["c1"] == 1 + finally: + for d in created: + d.fobj.close() + + +def test_slide_keyboard_interrupt(tmp_path, monkeypatch): + fname = tmp_path / "slides2.py" + fname.write_text("s1 = 1\n", encoding="utf-8") + + created = [] + + class TrackingDemo(Demo): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + created.append(self) + + def raise_interrupt(prompt=""): + raise KeyboardInterrupt + + monkeypatch.setattr(demo_module, "Demo", TrackingDemo) + monkeypatch.setattr("builtins.input", raise_interrupt) + try: + with pytest.raises(SystemExit): + slide(str(fname), noclear=True, auto_all=True, format_rst=False) + finally: + for d in created: + d.fobj.close() diff --git a/IPython/utils/tests/test_dir2.py b/tests/test_dir2.py similarity index 97% rename from IPython/utils/tests/test_dir2.py rename to tests/test_dir2.py index d35b110e413..bf7f5e57ea2 100644 --- a/IPython/utils/tests/test_dir2.py +++ b/tests/test_dir2.py @@ -19,7 +19,6 @@ def test_base(): def test_SubClass(): - class SubClass(Base): y = 2 @@ -53,7 +52,7 @@ def some_method(self): class SillierWithDir(MisbehavingGetattr): def __dir__(self): - return ['some_method'] + return ["some_method"] for bad_klass in (MisbehavingGetattr, SillierWithDir): obj = bad_klass() diff --git a/tests/test_display.py b/tests/test_display.py new file mode 100644 index 00000000000..ad4acb0670f --- /dev/null +++ b/tests/test_display.py @@ -0,0 +1,341 @@ +"""Tests for IPython.lib.display.""" + +# ----------------------------------------------------------------------------- +# Copyright (c) 2012, the IPython Development Team. +# +# Distributed under the terms of the Modified BSD License. +# +# The full license is in the file COPYING.txt, distributed with this software. +# ----------------------------------------------------------------------------- + +# ----------------------------------------------------------------------------- +# Imports +# ----------------------------------------------------------------------------- +from tempfile import NamedTemporaryFile, mkdtemp +from os.path import split, join as pjoin, dirname +import pathlib +from unittest import mock +import struct +import wave +from io import BytesIO + +# Third-party imports +import pytest + +try: + import numpy +except ImportError: + pass + +# Our own imports +from IPython.lib import display + +from IPython.testing.decorators import skipif_not_numpy + +# ----------------------------------------------------------------------------- +# Classes and functions +# ----------------------------------------------------------------------------- + +# -------------------------- +# FileLink tests +# -------------------------- + + +def test_instantiation_FileLink(): + """FileLink: Test class can be instantiated""" + fl = display.FileLink("example.txt") + # TODO: remove if when only Python >= 3.6 is supported + fl = display.FileLink(pathlib.PurePath("example.txt")) + + +def test_warning_on_non_existent_path_FileLink(): + """FileLink: Calling _repr_html_ on non-existent files returns a warning""" + fl = display.FileLink("example.txt") + assert fl._repr_html_().startswith("Path (example.txt)") + + +def test_existing_path_FileLink(): + """FileLink: Calling _repr_html_ functions as expected on existing filepath""" + with NamedTemporaryFile() as tf: + fl = display.FileLink(tf.name) + actual = fl._repr_html_() + expected = "%s
" % (tf.name, tf.name) + assert actual == expected + + +def test_existing_path_FileLink_repr(): + """FileLink: Calling repr() functions as expected on existing filepath""" + with NamedTemporaryFile() as tf: + fl = display.FileLink(tf.name) + actual = repr(fl) + expected = tf.name + assert actual == expected + + +def test_error_on_directory_to_FileLink(): + """FileLink: Raises error when passed directory""" + td = mkdtemp() + pytest.raises(ValueError, display.FileLink, td) + + +# -------------------------- +# FileLinks tests +# -------------------------- + + +def test_instantiation_FileLinks(): + """FileLinks: Test class can be instantiated""" + fls = display.FileLinks("example") + + +def test_warning_on_non_existent_path_FileLinks(): + """FileLinks: Calling _repr_html_ on non-existent files returns a warning""" + fls = display.FileLinks("example") + assert fls._repr_html_().startswith("Path (example)") + + +def test_existing_path_FileLinks(): + """FileLinks: Calling _repr_html_ functions as expected on existing dir""" + td = mkdtemp() + with NamedTemporaryFile(dir=td) as tf1, NamedTemporaryFile(dir=td) as tf2: + fl = display.FileLinks(td) + actual = fl._repr_html_() + actual = actual.split("\n") + actual.sort() + # the links should always have forward slashes, even on windows, so replace + # backslashes with forward slashes here + expected = [ + "%s/
" % td, + " %s
" + % (tf2.name.replace("\\", "/"), split(tf2.name)[1]), + " %s
" + % (tf1.name.replace("\\", "/"), split(tf1.name)[1]), + ] + expected.sort() + # We compare the sorted list of links here as that's more reliable + assert actual == expected + + +def test_existing_path_FileLinks_alt_formatter(): + """FileLinks: Calling _repr_html_ functions as expected w/ an alt formatter""" + td = mkdtemp() + with NamedTemporaryFile(dir=td) as tf1, NamedTemporaryFile(dir=td) as tf2: + + def fake_formatter(dirname, fnames, included_suffixes): + return ["hello", "world"] + + fl = display.FileLinks(td, notebook_display_formatter=fake_formatter) + actual = fl._repr_html_() + actual = actual.split("\n") + actual.sort() + expected = ["hello", "world"] + expected.sort() + # We compare the sorted list of links here as that's more reliable + assert actual == expected + + +def test_existing_path_FileLinks_repr(): + """FileLinks: Calling repr() functions as expected on existing directory""" + td = mkdtemp() + with NamedTemporaryFile(dir=td) as tf1, NamedTemporaryFile(dir=td) as tf2: + fl = display.FileLinks(td) + actual = repr(fl) + actual = actual.split("\n") + actual.sort() + expected = ["%s/" % td, " %s" % split(tf1.name)[1], " %s" % split(tf2.name)[1]] + expected.sort() + # We compare the sorted list of links here as that's more reliable + assert actual == expected + + +def test_existing_path_FileLinks_repr_alt_formatter(): + """FileLinks: Calling repr() functions as expected w/ alt formatter""" + td = mkdtemp() + with NamedTemporaryFile(dir=td) as tf1, NamedTemporaryFile(dir=td) as tf2: + + def fake_formatter(dirname, fnames, included_suffixes): + return ["hello", "world"] + + fl = display.FileLinks(td, terminal_display_formatter=fake_formatter) + actual = repr(fl) + actual = actual.split("\n") + actual.sort() + expected = ["hello", "world"] + expected.sort() + # We compare the sorted list of links here as that's more reliable + assert actual == expected + + +def test_error_on_file_to_FileLinks(): + """FileLinks: Raises error when passed file""" + td = mkdtemp() + with NamedTemporaryFile(dir=td) as tf1: + pytest.raises(ValueError, display.FileLinks, tf1.name) + + +def test_recursive_FileLinks(): + """FileLinks: Does not recurse when recursive=False""" + td = mkdtemp() + subtd = mkdtemp(dir=td) + with NamedTemporaryFile(dir=td) as tf, NamedTemporaryFile(dir=subtd) as subtf: + fl = display.FileLinks(td) + actual = str(fl) + actual = actual.split("\n") + assert len(actual) == 4, actual + fl = display.FileLinks(td, recursive=False) + actual = str(fl) + actual = actual.split("\n") + assert len(actual) == 2, actual + + +def test_escaped_names_FileLinks(): + """FileLinks: html metacharacters in file names are escaped""" + td = mkdtemp() + # links are emitted as href='...', so the apostrophe is what breaks out of + # the attribute; "<" and ">" are not usable as they are invalid on windows + name = "a' onmouseover='alert(1)&.txt" + with open(pjoin(td, name), "w"): + pass + actual = display.FileLinks(td)._repr_html_() + assert "a' onmouseover='alert(1)&.txt" in actual + assert name not in actual + + +def test_audio_from_file(): + path = pjoin(dirname(__file__), "test.wav") + display.Audio(filename=path) + + +def test_escaped_url_Audio(): + """Audio: quotes in url and element_id do not break out of the attribute""" + audio = display.Audio(url='http://example.com/a.wav" onerror="alert(1)') + assert ( + 'src="http://example.com/a.wav" onerror="alert(1)"' + in audio._repr_html_() + ) + + audio = display.Audio( + url="http://example.com/a.wav", element_id='x" onload="alert(1)' + ) + assert 'id="x" onload="alert(1)"' in audio._repr_html_() + + +@skipif_not_numpy +def test_audio_from_numpy_array(): + test_tone = get_test_tone() + audio = display.Audio(test_tone, rate=44100) + assert len(read_wav(audio.data)) == len(test_tone) + + +@skipif_not_numpy +def test_audio_from_list(): + test_tone = get_test_tone() + audio = display.Audio(list(test_tone), rate=44100) + assert len(read_wav(audio.data)) == len(test_tone) + + +@skipif_not_numpy +def test_audio_from_numpy_array_without_rate_raises(): + pytest.raises(ValueError, display.Audio, get_test_tone()) + + +@skipif_not_numpy +def test_audio_data_normalization(): + expected_max_value = numpy.iinfo(numpy.int16).max + for scale in [1, 0.5, 2]: + audio = display.Audio(get_test_tone(scale), rate=44100) + actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) + assert actual_max_value == expected_max_value + + +@skipif_not_numpy +def test_audio_data_without_normalization(): + max_int16 = numpy.iinfo(numpy.int16).max + for scale in [1, 0.5, 0.2]: + test_tone = get_test_tone(scale) + test_tone_max_abs = numpy.max(numpy.abs(test_tone)) + expected_max_value = int(max_int16 * test_tone_max_abs) + audio = display.Audio(test_tone, rate=44100, normalize=False) + actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) + assert actual_max_value == expected_max_value + + +def test_audio_data_without_normalization_raises_for_invalid_data(): + pytest.raises(ValueError, display.Audio, [1.001], rate=44100, normalize=False) + pytest.raises(ValueError, display.Audio, [-1.001], rate=44100, normalize=False) + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_from_numpy_array_no_numpy(): + test_tone = get_test_tone() + audio = display.Audio(test_tone, rate=44100) + assert len(read_wav(audio.data)) == len(test_tone) + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_from_list_no_numpy(): + test_tone = get_test_tone() + audio = display.Audio(list(test_tone), rate=44100) + assert len(read_wav(audio.data)) == len(test_tone) + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_from_numpy_array_without_rate_raises_no_numpy(): + pytest.raises(ValueError, display.Audio, get_test_tone()) + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_data_normalization_no_numpy(): + expected_max_value = numpy.iinfo(numpy.int16).max + for scale in [1, 0.5, 2]: + audio = display.Audio(get_test_tone(scale), rate=44100) + actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) + assert actual_max_value == expected_max_value + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_data_without_normalization_no_numpy(): + max_int16 = numpy.iinfo(numpy.int16).max + for scale in [1, 0.5, 0.2]: + test_tone = get_test_tone(scale) + test_tone_max_abs = numpy.max(numpy.abs(test_tone)) + expected_max_value = int(max_int16 * test_tone_max_abs) + audio = display.Audio(test_tone, rate=44100, normalize=False) + actual_max_value = numpy.max(numpy.abs(read_wav(audio.data))) + assert actual_max_value == expected_max_value + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_data_without_normalization_raises_for_invalid_data_no_numpy(): + pytest.raises(ValueError, display.Audio, [1.001], rate=44100, normalize=False) + pytest.raises(ValueError, display.Audio, [-1.001], rate=44100, normalize=False) + + +@mock.patch("numpy.array", mock.MagicMock(side_effect=ImportError)) +@skipif_not_numpy +def test_audio_raises_for_nested_list(): + stereo_signal = [list(get_test_tone())] * 2 + pytest.raises(TypeError, display.Audio, stereo_signal, rate=44100) + + +@skipif_not_numpy +def get_test_tone(scale=1): + return numpy.sin(2 * numpy.pi * 440 * numpy.linspace(0, 1, 44100)) * scale + + +def read_wav(data): + with wave.open(BytesIO(data)) as wave_file: + wave_data = wave_file.readframes(wave_file.getnframes()) + num_samples = wave_file.getnframes() * wave_file.getnchannels() + return struct.unpack("<%sh" % num_samples, wave_data) + + +def test_code_from_file(): + c = display.Code(filename=__file__) + assert c._repr_html_().startswith("" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Utilities" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Define functions to render Markdown using the notebook and Pandoc." - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [], - "source": [ - "from IPython.nbconvert.utils.pandoc import pandoc\n", - "from IPython.display import HTML, Javascript, display\n", - "\n", - "from IPython.nbconvert.filters import citation2latex, strip_files_prefix, \\\n", - " markdown2html, markdown2latex\n", - "\n", - "def pandoc_render(markdown):\n", - " \"\"\"Render Pandoc Markdown->LaTeX content.\"\"\"\n", - " \n", - " ## Convert the markdown directly to latex. This is what nbconvert does.\n", - " #latex = pandoc(markdown, \"markdown\", \"latex\")\n", - " #html = pandoc(markdown, \"markdown\", \"html\", [\"--mathjax\"])\n", - " \n", - " # nbconvert template conversions\n", - " html = strip_files_prefix(markdown2html(markdown))\n", - " latex = markdown2latex(citation2latex(markdown))\n", - " display(HTML(data=\"

\" \\\n", - " \"

NBConvert Latex Output

\" \\\n", - " \"

\" + latex + \"

\"\\\n", - " \"

\" \\\n", - " \"

NBViewer Output

\" \\\n", - " \"

\" + html + \"

\" \\\n", - " \"

\"))\n", - " javascript = \"\"\"\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n", - "\"\"\"\n", - " display(Javascript(data=javascript))\n", - "\n", - "def notebook_render(markdown):\n", - " javascript = \"\"\"\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\"\"\" + markdown.replace(\"\\\\\", \"\\\\\\\\\").replace(\"'\", \"\\'\").replace(\"\\n\", \"\\\\n\") + \"\"\"');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

')\n", - " .removeClass()\n", - " .css('background', '#AAAAFF')\n", - " .css('width', '100 %')\n", - " .html('Notebook Output')\n", - "\n", - ");\n", - "container.show()\n", - "\"\"\"\n", - " display(Javascript(data=javascript))\n", - "\n", - " \n", - "def pandoc_html_render(markdown):\n", - " \"\"\"Render Pandoc Markdown->LaTeX content.\"\"\"\n", - " \n", - " # Convert the markdown directly to latex. This is what nbconvert does.\n", - " latex = pandoc(markdown, \"markdown\", \"latex\")\n", - " \n", - " # Convert the pandoc generated latex to HTML so it can be rendered in \n", - " # the web browser.\n", - " html = pandoc(latex, \"latex\", \"html\", [\"--mathjax\"])\n", - " display(HTML(data=\"

HTML Pandoc Output

\" \\\n", - " \"

\" + html + \"

\"))\n", - " return html\n", - " \n", - "def compare_render(markdown):\n", - " notebook_render(markdown)\n", - " pandoc_render(markdown)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Outputs" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "name": "stdout", - "output_type": "stream", - "text": [ - "LXML found!\n" - ] - } - ], - "source": [ - "try:\n", - " import lxml\n", - " print 'LXML found!'\n", - "except:\n", - " print 'Warning! No LXML found - the old citation2latex filter will not work'" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## General markdown" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Heading level 6 is not supported by Pandoc." - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n\\n# Heading 1 \\n## Heading 2 \\n### Heading 3 \\n#### Heading 4 \\n##### Heading 5 \\n###### Heading 6');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

\\section{Heading 1}\n",
-       "\n",
-       "\\subsection{Heading 2}\n",
-       "\n",
-       "\\subsubsection{Heading 3}\n",
-       "\n",
-       "\\paragraph{Heading 4}\n",
-       "\n",
-       "\\subparagraph{Heading 5}\n",
-       "\n",
-       "Heading 6

NBViewer Output

Heading 1

\n", - "

Heading 2

\n", - "

Heading 3

\n", - "

Heading 4

\n", - "

Heading 5

\n", - "

Heading 6

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "\n", - "# Heading 1 \n", - "## Heading 2 \n", - "### Heading 3 \n", - "#### Heading 4 \n", - "##### Heading 5 \n", - "###### Heading 6\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Headers aren't recognized by (Pandoc on Windows?) if there isn't a blank line above the headers." - ] - }, - { - "cell_type": "code", - "execution_count": 3, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n# Heading 1 \\n## Heading 2 \\n### Heading 3 \\n#### Heading 4 \\n##### Heading 5 \\n###### Heading 6 ');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

\\section{Heading 1}\n",
-       "\n",
-       "\\subsection{Heading 2}\n",
-       "\n",
-       "\\subsubsection{Heading 3}\n",
-       "\n",
-       "\\paragraph{Heading 4}\n",
-       "\n",
-       "\\subparagraph{Heading 5}\n",
-       "\n",
-       "Heading 6

NBViewer Output

Heading 1

\n", - "

Heading 2

\n", - "

Heading 3

\n", - "

Heading 4

\n", - "

Heading 5

\n", - "

Heading 6

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n" - ] - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "# Heading 1 \n", - "## Heading 2 \n", - "### Heading 3 \n", - "#### Heading 4 \n", - "##### Heading 5 \n", - "###### Heading 6 \"\"\")\n", - "\n", - "print(\"\\n\"*10)" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "If internal links are defined, these will not work in nbviewer and latex as the local link is not existing." - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n[Link2Heading](http://127.0.0.1:8888/0a2d8086-ee24-4e5b-a32b-f66b525836cb#General-markdown)\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

\\href{http://127.0.0.1:8888/0a2d8086-ee24-4e5b-a32b-f66b525836cb\\#General-markdown}{Link2Heading}

NBViewer Output

Link2Heading

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "[Link2Heading](http://127.0.0.1:8888/0a2d8086-ee24-4e5b-a32b-f66b525836cb#General-markdown)\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Basic Markdown bold and italic works." - ] - }, - { - "cell_type": "code", - "execution_count": 5, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\nThis is Markdown **bold** and *italic* text.\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

This is Markdown \\textbf{bold} and \\emph{italic} text.

NBViewer Output

This is Markdown bold and italic text.

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "This is Markdown **bold** and *italic* text.\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Nested lists work as well" - ] - }, - { - "cell_type": "code", - "execution_count": 6, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n- li 1\\n- li 2\\n 1. li 3\\n 1. li 4\\n- li 5\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

\\begin{itemize}\n",
-       "\\itemsep1pt\\parskip0pt\\parsep0pt\n",
-       "\\item\n",
-       "  li 1\n",
-       "\\item\n",
-       "  li 2\n",
-       "\n",
-       "  \\begin{enumerate}\n",
-       "  \\def\\labelenumi{\\arabic{enumi}.}\n",
-       "  \\itemsep1pt\\parskip0pt\\parsep0pt\n",
-       "  \\item\n",
-       "    li 3\n",
-       "  \\item\n",
-       "    li 4\n",
-       "  \\end{enumerate}\n",
-       "\\item\n",
-       "  li 5\n",
-       "\\end{itemize}

NBViewer Output

li 1
li 2\n", - "
1. li 3
2. li 4
li 5

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "- li 1\n", - "- li 2\n", - " 1. li 3\n", - " 1. li 4\n", - "- li 5\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Unicode support" - ] - }, - { - "cell_type": "code", - "execution_count": 7, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\nüberschuß +***^°³³ α β θ\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

überschuß +\\emph{*}\\^{}°³³ α β θ

NBViewer Output

überschuß +*^°³³ α β θ

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(ur\"\"\"\n", - "überschuß +***^°³³ α β θ\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Pandoc may produce invalid latex, e.g \\sout is not allowed in headings" - ] - }, - { - "cell_type": "code", - "execution_count": 8, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n\\n# Heading 1 ~~strikeout~~\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

\\section{Heading 1 \\sout{strikeout}}

NBViewer Output

Heading 1 strikeout

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "\n", - "# Heading 1 ~~strikeout~~\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Horizontal lines work just fine" - ] - }, - { - "cell_type": "code", - "execution_count": 9, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\nabove\\n\\n--------\\n\\nbelow\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

above\n",
-       "\n",
-       "\\begin{center}\\rule{3in}{0.4pt}\\end{center}\n",
-       "\n",
-       "below

NBViewer Output

above

\n", - "

below

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "above\n", - "\n", - "--------\n", - "\n", - "below\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Extended markdown of pandoc" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "(maybe we should deactivate this) " - ] - }, - { - "cell_type": "code", - "execution_count": 10, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\nThis is Markdown ~subscript~ and ^superscript^ text.\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

This is Markdown \\textsubscript{subscript} and\n",
-       "\\textsuperscript{superscript} text.

NBViewer Output

This is Markdown _subscript and ^superscript text.

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "This is Markdown ~subscript~ and ^superscript^ text.\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "No space before underline behaves inconsistent (Pandoc extension: intraword_underscores - deactivate?)" - ] - }, - { - "cell_type": "code", - "execution_count": 11, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\nThis is Markdown not_italic_.\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

NBConvert Latex Output

This is Markdown not\\_italic\\_.

NBViewer Output

This is Markdown not_italic_.

" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, - { - "data": { - "application/javascript": [ - "\n", - " $.getScript(\"https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js\");\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "compare_render(r\"\"\"\n", - "This is Markdown not_italic_.\n", - "\"\"\")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Pandoc allows to define tex macros which are respected for all output formats, the notebook not. " - ] - }, - { - "cell_type": "code", - "execution_count": 12, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "application/javascript": [ - "\n", - "var mdcell = new IPython.MarkdownCell();\n", - "mdcell.create_element();\n", - "mdcell.set_text('\\n\\\\newcommand{\\\\tuple}[1]{\\\\langle #1 \\\\rangle}\\n\\n$\\\\tuple{a, b, c}$\\n');\n", - "mdcell.render();\n", - "$(element).append(mdcell.element)\n", - ".removeClass()\n", - ".css('left', '66%')\n", - ".css('position', 'absolute')\n", - ".css('width', '30%')\n", - "mdcell.element.prepend(\n", - " $('

" - ], - "text/plain": [ - "

\n", - "a\n", - "	\n", - "b\n", - "
\n", - "c\n", - "	\n", - "d\n", - "

Right Aligned	Center Aligned	Left Aligned
Why	does	this
actually	work?	Who
knows	...

{head}

' + title + '

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Heading 1 strikeout