Merge pull request #13546 from Carreau/cleanup-dep-magic

Update some deprecated ip.magic() to run_line-magic in tests

IPython/core/tests/test_alias.py

@@ -1,66 +1,66 b''
 from IPython.utils.capture import capture_output
 
 import pytest
 
 def test_alias_lifecycle():
     name = 'test_alias1'
     cmd = 'echo "Hello"'
     am = _ip.alias_manager
     am.clear_aliases()
     am.define_alias(name, cmd)
     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))
         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')
     # capture stderr:
     with capture_output() as cap:
         _ip.run_cell('parts 1')
 
     assert cap.stderr.split(":")[0] == "UsageError"
 
 
 def test_alias_args_commented():
     """Check that alias correctly ignores 'commented out' args"""
-    _ip.magic('alias commetarg echo this is %%s a commented out arg')
-    
+    _ip.run_line_magic("alias", "commentarg echo this is %%s a commented out arg")
+
     with capture_output() as cap:
-        _ip.run_cell('commetarg')
-    
+        _ip.run_cell("commentarg")
+
     # 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'
 
 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'
     
     am.define_alias(alias_name, cmd)
     assert am.is_alias(alias_name)
     
     thealias = am.get_alias(alias_name)
     assert thealias.nargs == 1

IPython/core/tests/test_handlers.py

@@ -1,91 +1,97 b''
 """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.magic('autocall 0')
+    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.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.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.magic('autocall 1')
+    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 == []

IPython/core/tests/test_history.py

@@ -1,229 +1,229 b''
 # 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.magic('%hist 2-500')
+            ip.run_line_magic("hist", "2-500")
 
             # Check that we can write non-ascii characters to a file
-            ip.magic("%%hist -f %s" % (tmp_path / "test1"))
-            ip.magic("%%hist -pf %s" % (tmp_path / "test2"))
-            ip.magic("%%hist -nf %s" % (tmp_path / "test3"))
-            ip.magic("%%save %s 1-10" % (tmp_path / "test4"))
+            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.magic("save " + str(testfilename) + " ~1/1-3")
+            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