test_magic.py
388 lines
| 9.5 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 sys | |||
Fernando Perez
|
r1955 | import tempfile | |
import types | |||
Fernando Perez
|
r2188 | from cStringIO import StringIO | |
Fernando Perez
|
r1848 | ||
import nose.tools as nt | |||
Brian Granger
|
r2498 | from IPython.utils.path import get_long_path_name | |
Fernando Perez
|
r1762 | from IPython.testing import decorators as dec | |
Fernando Perez
|
r1955 | from IPython.testing import tools as tt | |
Fernando Perez
|
r1848 | #----------------------------------------------------------------------------- | |
# Test functions begin | |||
Fernando Perez
|
r2414 | #----------------------------------------------------------------------------- | |
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) | |||
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-') | |||
Fernando Perez
|
r2092 | In [11]: %hist -n -f $tfile 3 | |
Fernando Perez
|
r2450 | ||
In [13]: import os; os.unlink(tfile) | |||
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 | ||
Fernando Perez
|
r2441 | In [3]: %hist -r 2 | |
x=1 # random | |||
%hist -r 2 | |||
Fernando Perez
|
r1762 | """ | |
Fernando Perez
|
r2441 | def doctest_hist_op(): | |
"""Test %hist -op | |||
In [1]: class b: | |||
...: pass | |||
...: | |||
In [2]: class s(b): | |||
...: def __str__(self): | |||
...: return 's' | |||
...: | |||
In [3]: | |||
In [4]: class r(b): | |||
...: def __repr__(self): | |||
...: return 'r' | |||
...: | |||
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() | |||
In [11]: bb | |||
Out[11]: <...b instance at ...> | |||
In [12]: ss | |||
Out[12]: <...s instance at ...> | |||
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() | |||
>>> bb | |||
<...b instance at ...> | |||
>>> ss | |||
<...s instance at ...> | |||
>>> | |||
""" | |||
Fernando Perez
|
r1859 | ||
Fernando Perez
|
r1762 | def test_shist(): | |
Fernando Perez
|
r1848 | # Simple tests of ShadowHist class - test generator. | |
Fernando Perez
|
r1762 | import os, shutil, tempfile | |
Brian Granger
|
r2267 | from IPython.utils import pickleshare | |
Brian Granger
|
r2053 | from IPython.core.history import ShadowHist | |
Fernando Perez
|
r1762 | ||
tfile = tempfile.mktemp('','tmp-ipython-') | |||
db = pickleshare.PickleShareDB(tfile) | |||
Fernando Perez
|
r3136 | s = ShadowHist(db, get_ipython()) | |
Fernando Perez
|
r1762 | s.add('hello') | |
s.add('world') | |||
s.add('hello') | |||
s.add('hello') | |||
s.add('karhu') | |||
yield nt.assert_equals,s.all(),[(1, 'hello'), (2, 'world'), (3, 'karhu')] | |||
yield nt.assert_equal,s.get(2),'world' | |||
shutil.rmtree(tfile) | |||
Fernando Perez
|
r2392 | ||
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
|
r2106 | # Multiple tests for clipboard pasting | |
Fernando Perez
|
r2411 | @dec.parametric | |
Fernando Perez
|
r2106 | def test_paste(): | |
Brian Granger
|
r2245 | _ip = get_ipython() | |
Fernando Perez
|
r2189 | def paste(txt, flags='-q'): | |
"""Paste input text, by default in quiet mode""" | |||
Fernando Perez
|
r2106 | hooks.clipboard_get = lambda : txt | |
Fernando Perez
|
r2188 | _ip.magic('paste '+flags) | |
Fernando Perez
|
r2106 | ||
# Inject fake clipboard hook but save original so we can restore it later | |||
Brian Granger
|
r2205 | hooks = _ip.hooks | |
Fernando Perez
|
r2106 | user_ns = _ip.user_ns | |
original_clip = hooks.clipboard_get | |||
try: | |||
Fernando Perez
|
r2143 | # This try/except with an emtpy except clause is here only because | |
# try/yield/finally is invalid syntax in Python 2.4. This will be | |||
# removed when we drop 2.4-compatibility, and the emtpy except below | |||
# will be changed to a finally. | |||
Fernando Perez
|
r2106 | # Run tests with fake clipboard function | |
user_ns.pop('x', None) | |||
paste('x=1') | |||
Fernando Perez
|
r2411 | yield nt.assert_equal(user_ns['x'], 1) | |
Fernando Perez
|
r2106 | ||
user_ns.pop('x', None) | |||
paste('>>> x=2') | |||
Fernando Perez
|
r2411 | yield nt.assert_equal(user_ns['x'], 2) | |
Fernando Perez
|
r2106 | ||
paste(""" | |||
>>> x = [1,2,3] | |||
>>> y = [] | |||
>>> for i in x: | |||
... y.append(i**2) | |||
... | |||
""") | |||
Fernando Perez
|
r2411 | yield nt.assert_equal(user_ns['x'], [1,2,3]) | |
yield nt.assert_equal(user_ns['y'], [1,4,9]) | |||
Fernando Perez
|
r2106 | ||
Fernando Perez
|
r2188 | # Now, test that paste -r works | |
user_ns.pop('x', None) | |||
Fernando Perez
|
r2411 | yield nt.assert_false('x' in user_ns) | |
Fernando Perez
|
r2188 | _ip.magic('paste -r') | |
Fernando Perez
|
r2411 | yield nt.assert_equal(user_ns['x'], [1,2,3]) | |
Fernando Perez
|
r2188 | ||
Fernando Perez
|
r2189 | # Also test paste echoing, by temporarily faking the writer | |
Fernando Perez
|
r2188 | w = StringIO() | |
Brian Granger
|
r2205 | writer = _ip.write | |
_ip.write = w.write | |||
Fernando Perez
|
r2188 | code = """ | |
a = 100 | |||
b = 200""" | |||
try: | |||
Fernando Perez
|
r2189 | paste(code,'') | |
Fernando Perez
|
r2188 | out = w.getvalue() | |
finally: | |||
Brian Granger
|
r2205 | _ip.write = writer | |
Fernando Perez
|
r2411 | yield nt.assert_equal(user_ns['a'], 100) | |
yield nt.assert_equal(user_ns['b'], 200) | |||
yield nt.assert_equal(out, code+"\n## -- End pasted text --\n") | |||
Fernando Perez
|
r2188 | ||
finally: | |||
# This should be in a finally clause, instead of the bare except above. | |||
# Restore original hook | |||
hooks.clipboard_get = original_clip | |||
Fernando Perez
|
r2411 | ||
def test_time(): | |||
_ip.magic('time None') | |||
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 | |||
""" | |||
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.""" | |||
curpath = lambda :os.path.splitdrive(os.getcwd())[1].replace('\\','/') | |||
startdir = os.getcwd() | |||
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 | ||
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('\n') | |||
src.write(code) | |||
src.write('\n--\n') | |||
src.seek(0) | |||
stdin_save = sys.stdin | |||
sys.stdin = src | |||
try: | |||
_ip.magic('cpaste') | |||
except: | |||
if not should_fail: | |||
raise AssertionError("Failure not expected : '%s'" % | |||
code) | |||
else: | |||
assert _ip.user_ns['code_ran'] | |||
if should_fail: | |||
raise AssertionError("Failure expected : '%s'" % code) | |||
finally: | |||
sys.stdin = stdin_save | |||
def test_cpaste(): | |||
"""Test cpaste magic""" | |||
def run(): | |||
"""Marker function: sets a flag when executed. | |||
""" | |||
_ip.user_ns['code_ran'] = True | |||
return 'run' # return string so '+ run()' doesn't result in success | |||
tests = {'pass': ["> > > run()", | |||
">>> > run()", | |||
"+++ run()", | |||
"++ run()", | |||
" >>> run()"], | |||
'fail': ["+ + run()", | |||
" ++ run()"]} | |||
_ip.user_ns['run'] = run | |||
for code in tests['pass']: | |||
check_cpaste(code) | |||
for code in tests['fail']: | |||
check_cpaste(code, should_fail=True) | |||
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) | |||
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'] | |||
""" |