test_magic.py
342 lines
| 8.3 KiB
| text/x-python
|
PythonLexer
Fernando Perez
|
r1848 | """Tests for various magic functions. | ||
Ville M. Vainio
|
r1735 | |||
Fernando Perez
|
r1848 | Needs to be run by nose (to make ipython session available). | ||
Ville M. Vainio
|
r1735 | """ | ||
Fernando Perez
|
r2414 | from __future__ import absolute_import | ||
Fernando Perez
|
r1762 | |||
Fernando Perez
|
r2414 | #----------------------------------------------------------------------------- | ||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
Fernando Perez
|
r1848 | import os | ||
import nose.tools as nt | ||||
Fernando Perez
|
r1762 | from IPython.testing import decorators as dec | ||
Fernando Perez
|
r1955 | from IPython.testing import tools as tt | ||
Thomas Kluyver
|
r4895 | from IPython.utils import py3compat | ||
Fernando Perez
|
r1955 | |||
Fernando Perez
|
r1848 | #----------------------------------------------------------------------------- | ||
# Test functions begin | ||||
Fernando Perez
|
r2414 | #----------------------------------------------------------------------------- | ||
Fernando Perez
|
r5436 | |||
Ville M. Vainio
|
r1735 | def test_rehashx(): | ||
# clear up everything | ||||
Brian Granger
|
r2245 | _ip = get_ipython() | ||
_ip.alias_manager.alias_table.clear() | ||||
Ville M. Vainio
|
r1735 | del _ip.db['syscmdlist'] | ||
_ip.magic('rehashx') | ||||
# Practically ALL ipython development systems will have more than 10 aliases | ||||
Brian Granger
|
r2245 | yield (nt.assert_true, len(_ip.alias_manager.alias_table) > 10) | ||
Thomas Kluyver
|
r3114 | for key, val in _ip.alias_manager.alias_table.iteritems(): | ||
Ville M. Vainio
|
r1735 | # we must strip dots from alias names | ||
Fernando Perez
|
r2092 | nt.assert_true('.' not in key) | ||
Ville M. Vainio
|
r1735 | |||
# rehashx must fill up syscmdlist | ||||
scoms = _ip.db['syscmdlist'] | ||||
Fernando Perez
|
r2092 | yield (nt.assert_true, len(scoms) > 10) | ||
Fernando Perez
|
r1762 | |||
Fernando Perez
|
r2450 | def test_magic_parse_options(): | ||
"""Test that we don't mangle paths when parsing magic options.""" | ||||
ip = get_ipython() | ||||
path = 'c:\\x' | ||||
opts = ip.parse_options('-f %s' % path,'f:')[0] | ||||
# argv splitting is os-dependent | ||||
if os.name == 'posix': | ||||
expected = 'c:x' | ||||
else: | ||||
expected = path | ||||
nt.assert_equals(opts['f'], expected) | ||||
MinRK
|
r5147 | |||
@dec.skip_without('sqlite3') | ||||
Fernando Perez
|
r1762 | def doctest_hist_f(): | ||
"""Test %hist -f with temporary filename. | ||||
In [9]: import tempfile | ||||
In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') | ||||
Thomas Kluyver
|
r3396 | In [11]: %hist -nl -f $tfile 3 | ||
Fernando Perez
|
r2450 | |||
In [13]: import os; os.unlink(tfile) | ||||
Fernando Perez
|
r1762 | """ | ||
MinRK
|
r5147 | @dec.skip_without('sqlite3') | ||
Fernando Perez
|
r1762 | def doctest_hist_r(): | ||
"""Test %hist -r | ||||
Fernando Perez
|
r2441 | XXX - This test is not recording the output correctly. For some reason, in | ||
testing mode the raw history isn't getting populated. No idea why. | ||||
Disabling the output checking for now, though at least we do run it. | ||||
Fernando Perez
|
r1762 | |||
Fernando Perez
|
r2441 | In [1]: 'hist' in _ip.lsmagic() | ||
Out[1]: True | ||||
Fernando Perez
|
r2092 | |||
Fernando Perez
|
r2441 | In [2]: x=1 | ||
Fernando Perez
|
r1762 | |||
Thomas Kluyver
|
r3396 | In [3]: %hist -rl 2 | ||
Fernando Perez
|
r2441 | x=1 # random | ||
%hist -r 2 | ||||
Fernando Perez
|
r1762 | """ | ||
MinRK
|
r5147 | |||
@dec.skip_without('sqlite3') | ||||
Fernando Perez
|
r2441 | def doctest_hist_op(): | ||
"""Test %hist -op | ||||
Thomas Kluyver
|
r4895 | In [1]: class b(float): | ||
...: pass | ||||
Fernando Perez
|
r2441 | ...: | ||
Thomas Kluyver
|
r4895 | In [2]: class s(object): | ||
...: def __str__(self): | ||||
...: return 's' | ||||
Fernando Perez
|
r2441 | ...: | ||
In [3]: | ||||
In [4]: class r(b): | ||||
Thomas Kluyver
|
r4895 | ...: def __repr__(self): | ||
...: return 'r' | ||||
Fernando Perez
|
r2441 | ...: | ||
In [5]: class sr(s,r): pass | ||||
...: | ||||
In [6]: | ||||
In [7]: bb=b() | ||||
In [8]: ss=s() | ||||
In [9]: rr=r() | ||||
In [10]: ssrr=sr() | ||||
Thomas Kluyver
|
r4895 | In [11]: 4.5 | ||
Out[11]: 4.5 | ||||
Fernando Perez
|
r2441 | |||
Thomas Kluyver
|
r4895 | In [12]: str(ss) | ||
Out[12]: 's' | ||||
Fernando Perez
|
r2441 | |||
In [13]: | ||||
In [14]: %hist -op | ||||
>>> class b: | ||||
... pass | ||||
... | ||||
>>> class s(b): | ||||
... def __str__(self): | ||||
... return 's' | ||||
... | ||||
>>> | ||||
>>> class r(b): | ||||
... def __repr__(self): | ||||
... return 'r' | ||||
... | ||||
>>> class sr(s,r): pass | ||||
>>> | ||||
>>> bb=b() | ||||
>>> ss=s() | ||||
>>> rr=r() | ||||
>>> ssrr=sr() | ||||
Thomas Kluyver
|
r4895 | >>> 4.5 | ||
4.5 | ||||
>>> str(ss) | ||||
's' | ||||
Fernando Perez
|
r2441 | >>> | ||
""" | ||||
MinRK
|
r5147 | |||
@dec.skip_without('sqlite3') | ||||
Thomas Kluyver
|
r3385 | def test_macro(): | ||
ip = get_ipython() | ||||
ip.history_manager.reset() # Clear any existing history. | ||||
cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] | ||||
Thomas Kluyver
|
r3396 | for i, cmd in enumerate(cmds, start=1): | ||
ip.history_manager.store_inputs(i, cmd) | ||||
Thomas Kluyver
|
r3385 | ip.magic("macro test 1-3") | ||
nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") | ||||
Thomas Kluyver
|
r3386 | # List macros. | ||
assert "test" in ip.magic("macro") | ||||
Fernando Perez
|
r2392 | |||
MinRK
|
r5147 | |||
@dec.skip_without('sqlite3') | ||||
Thomas Kluyver
|
r3414 | def test_macro_run(): | ||
"""Test that we can run a multi-line macro successfully.""" | ||||
ip = get_ipython() | ||||
ip.history_manager.reset() | ||||
Thomas Kluyver
|
r4895 | cmds = ["a=10", "a+=1", py3compat.doctest_refactor_print("print a"), | ||
"%macro test 2-3"] | ||||
Thomas Kluyver
|
r3414 | for cmd in cmds: | ||
Thomas Kluyver
|
r4995 | ip.run_cell(cmd, store_history=True) | ||
Thomas Kluyver
|
r4895 | nt.assert_equal(ip.user_ns["test"].value, | ||
py3compat.doctest_refactor_print("a+=1\nprint a\n")) | ||||
Thomas Kluyver
|
r4903 | with tt.AssertPrints("12"): | ||
Thomas Kluyver
|
r3414 | ip.run_cell("test") | ||
Thomas Kluyver
|
r4903 | with tt.AssertPrints("13"): | ||
Thomas Kluyver
|
r3414 | ip.run_cell("test") | ||
Fernando Perez
|
r1762 | |||
Fernando Perez
|
r2392 | # XXX failing for now, until we get clearcmd out of quarantine. But we should | ||
# fix this and revert the skip to happen only if numpy is not around. | ||||
#@dec.skipif_not_numpy | ||||
Brian Granger
|
r2792 | @dec.skip_known_failure | ||
Fernando Perez
|
r1848 | def test_numpy_clear_array_undec(): | ||
Brian Granger
|
r2124 | from IPython.extensions import clearcmd | ||
Fernando Perez
|
r2092 | |||
Fernando Perez
|
r1848 | _ip.ex('import numpy as np') | ||
_ip.ex('a = np.empty(2)') | ||||
Fernando Perez
|
r2092 | yield (nt.assert_true, 'a' in _ip.user_ns) | ||
Fernando Perez
|
r1848 | _ip.magic('clear array') | ||
Fernando Perez
|
r2092 | yield (nt.assert_false, 'a' in _ip.user_ns) | ||
Fernando Perez
|
r1848 | |||
Fernando Perez
|
r1762 | |||
Fernando Perez
|
r2411 | def test_time(): | ||
_ip.magic('time None') | ||||
Thomas Kluyver
|
r4895 | @py3compat.doctest_refactor_print | ||
Fernando Perez
|
r2411 | def doctest_time(): | ||
""" | ||||
In [10]: %time None | ||||
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | ||||
Wall time: 0.00 s | ||||
Thomas Kluyver
|
r3478 | |||
In [11]: def f(kmjy): | ||||
....: %time print 2*kmjy | ||||
In [12]: f(3) | ||||
6 | ||||
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | ||||
Wall time: 0.00 s | ||||
Fernando Perez
|
r2411 | """ | ||
Fernando Perez
|
r2426 | |||
Fernando Perez
|
r2650 | |||
Fernando Perez
|
r2426 | def test_doctest_mode(): | ||
"Toggle doctest_mode twice, it should be a no-op and run without error" | ||||
_ip.magic('doctest_mode') | ||||
_ip.magic('doctest_mode') | ||||
Fernando Perez
|
r2650 | |||
def test_parse_options(): | ||||
"""Tests for basic options parsing in magics.""" | ||||
# These are only the most minimal of tests, more should be added later. At | ||||
# the very least we check that basic text/unicode calls work OK. | ||||
nt.assert_equal(_ip.parse_options('foo', '')[1], 'foo') | ||||
nt.assert_equal(_ip.parse_options(u'foo', '')[1], u'foo') | ||||
Fernando Perez
|
r2426 | |||
Fernando Perez
|
r2650 | def test_dirops(): | ||
"""Test various directory handling operations.""" | ||||
Min RK
|
r4105 | # curpath = lambda :os.path.splitdrive(os.getcwdu())[1].replace('\\','/') | ||
curpath = os.getcwdu | ||||
Thomas Kluyver
|
r3451 | startdir = os.getcwdu() | ||
Fernando Perez
|
r2650 | ipdir = _ip.ipython_dir | ||
try: | ||||
_ip.magic('cd "%s"' % ipdir) | ||||
nt.assert_equal(curpath(), ipdir) | ||||
_ip.magic('cd -') | ||||
nt.assert_equal(curpath(), startdir) | ||||
_ip.magic('pushd "%s"' % ipdir) | ||||
nt.assert_equal(curpath(), ipdir) | ||||
_ip.magic('popd') | ||||
nt.assert_equal(curpath(), startdir) | ||||
finally: | ||||
os.chdir(startdir) | ||||
Fernando Perez
|
r2655 | |||
Fernando Perez
|
r3146 | def test_xmode(): | ||
# Calling xmode three times should be a no-op | ||||
xmode = _ip.InteractiveTB.mode | ||||
for i in range(3): | ||||
_ip.magic("xmode") | ||||
nt.assert_equal(_ip.InteractiveTB.mode, xmode) | ||||
Thomas Kluyver
|
r3522 | |||
def test_reset_hard(): | ||||
monitor = [] | ||||
class A(object): | ||||
def __del__(self): | ||||
monitor.append(1) | ||||
def __repr__(self): | ||||
return "<A instance>" | ||||
_ip.user_ns["a"] = A() | ||||
_ip.run_cell("a") | ||||
nt.assert_equal(monitor, []) | ||||
Thomas Kluyver
|
r3523 | _ip.magic_reset("-f") | ||
Thomas Kluyver
|
r3522 | nt.assert_equal(monitor, [1]) | ||
Thomas Kluyver
|
r3824 | |||
class TestXdel(tt.TempFileMixin): | ||||
def test_xdel(self): | ||||
"""Test that references from %run are cleared by xdel.""" | ||||
src = ("class A(object):\n" | ||||
" monitor = []\n" | ||||
" def __del__(self):\n" | ||||
" self.monitor.append(1)\n" | ||||
"a = A()\n") | ||||
self.mktmp(src) | ||||
Thomas Kluyver
|
r3832 | # %run creates some hidden references... | ||
Thomas Kluyver
|
r3824 | _ip.magic("run %s" % self.fname) | ||
Thomas Kluyver
|
r3832 | # ... as does the displayhook. | ||
Thomas Kluyver
|
r3824 | _ip.run_cell("a") | ||
Thomas Kluyver
|
r3844 | |||
Thomas Kluyver
|
r3824 | monitor = _ip.user_ns["A"].monitor | ||
nt.assert_equal(monitor, []) | ||||
Thomas Kluyver
|
r3832 | |||
Thomas Kluyver
|
r3844 | _ip.magic("xdel a") | ||
Thomas Kluyver
|
r3832 | |||
# Check that a's __del__ method has been called. | ||||
Thomas Kluyver
|
r3824 | nt.assert_equal(monitor, [1]) | ||
MinRK
|
r3332 | |||
def doctest_who(): | ||||
"""doctest for %who | ||||
In [1]: %reset -f | ||||
In [2]: alpha = 123 | ||||
In [3]: beta = 'beta' | ||||
In [4]: %who int | ||||
alpha | ||||
In [5]: %who str | ||||
beta | ||||
In [6]: %whos | ||||
Variable Type Data/Info | ||||
---------------------------- | ||||
alpha int 123 | ||||
beta str beta | ||||
In [7]: %who_ls | ||||
Out[7]: ['alpha', 'beta'] | ||||
MinRK
|
r3350 | """ | ||
Thomas Kluyver
|
r4895 | @py3compat.u_format | ||
MinRK
|
r3350 | def doctest_precision(): | ||
"""doctest for %precision | ||||
In [1]: f = get_ipython().shell.display_formatter.formatters['text/plain'] | ||||
In [2]: %precision 5 | ||||
Thomas Kluyver
|
r4895 | Out[2]: {u}'%.5f' | ||
MinRK
|
r3350 | |||
In [3]: f.float_format | ||||
Thomas Kluyver
|
r4895 | Out[3]: {u}'%.5f' | ||
MinRK
|
r3350 | |||
In [4]: %precision %e | ||||
Thomas Kluyver
|
r4895 | Out[4]: {u}'%e' | ||
MinRK
|
r3350 | |||
In [5]: f(3.1415927) | ||||
Thomas Kluyver
|
r4895 | Out[5]: {u}'3.141593e+00' | ||
MinRK
|
r3350 | """ | ||