##// END OF EJS Templates
Older versions render a little less pretty
Older versions render a little less pretty

File last commit:

r24882:442bcbd4
r24882:442bcbd4
Show More
test_oinspect.py
474 lines | 13.1 KiB | text/x-python | PythonLexer
Fernando Perez
Add function signature info to calltips....
r3051 """Tests for the object inspection functionality.
"""
Min RK
Get signatures directly from classes...
r22171 # Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
Fernando Perez
Add function signature info to calltips....
r3051
Philipp A
Fix signature rendering
r24881 from inspect import signature, Signature, Parameter
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290 import os
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434 import re
Thomas Kluyver
Add sys import
r21314 import sys
Fernando Perez
Add function signature info to calltips....
r3051
import nose.tools as nt
from .. import oinspect
Fernando Perez
Add tests for object inspector with magics of all types.
r6995 from IPython.core.magic import (Magics, magics_class, line_magic,
cell_magic, line_cell_magic,
register_line_magic, register_cell_magic,
register_line_cell_magic)
MinRK
remove decorator from external
r20813 from decorator import decorator
Min RK
deprecate IPython.utils.signatures...
r23020 from IPython import get_ipython
Min RK
include docstring in detail_level=1 if no source is found...
r23021 from IPython.testing.tools import AssertPrints, AssertNotPrints
Thomas Kluyver
Update tests for info changes
r20578 from IPython.utils.path import compress_user
Fernando Perez
Add function signature info to calltips....
r3051
Philipp A
Older versions render a little less pretty
r24882
Fernando Perez
Add function signature info to calltips....
r3051 #-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
inspector = oinspect.Inspector()
Fernando Perez
Add tests for object inspector with magics of all types.
r6995 ip = get_ipython()
Fernando Perez
Add function signature info to calltips....
r3051
#-----------------------------------------------------------------------------
# Local utilities
#-----------------------------------------------------------------------------
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290 # WARNING: since this test checks the line number where a function is
# defined, if any code is inserted above, the following line will need to be
# updated. Do NOT insert any whitespace between the next line and the function
# definition below.
Hugo
Remove redundant Python 2 code
r24010 THIS_LINE_NUMBER = 41 # Put here the actual number of this line
Matthias Bussonnier
Start refactoring handling of color....
r22911
from unittest import TestCase
class Test(TestCase):
def test_find_source_lines(self):
Hugo
Remove redundant Python 2 code
r24010 self.assertEqual(oinspect.find_source_lines(Test.test_find_source_lines),
Matthias Bussonnier
Start refactoring handling of color....
r22911 THIS_LINE_NUMBER+6)
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434 # A couple of utilities to ensure these tests work the same from a source or a
# binary install
def pyfile(fname):
Jörgen Stenarson
Moving os.path.normcase call to pyfile function.
r7452 return os.path.normcase(re.sub('.py[co]$', '.py', fname))
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434
def match_pyfiles(f1, f2):
Jörgen Stenarson
Moving os.path.normcase call to pyfile function.
r7452 nt.assert_equal(pyfile(f1), pyfile(f2))
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290 def test_find_file():
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434 match_pyfiles(oinspect.find_file(test_find_file), os.path.abspath(__file__))
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290
Fernando Perez
Add extra tests for checking decorator logic with __wrapped__.
r7432 def test_find_file_decorated1():
@decorator
def noop1(f):
Min RK
deprecate IPython.utils.signatures...
r23020 def wrapper(*a, **kw):
Fernando Perez
Add extra tests for checking decorator logic with __wrapped__.
r7432 return f(*a, **kw)
return wrapper
@noop1
def f(x):
"My docstring"
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434 match_pyfiles(oinspect.find_file(f), os.path.abspath(__file__))
Fernando Perez
Add extra tests for checking decorator logic with __wrapped__.
r7432 nt.assert_equal(f.__doc__, "My docstring")
def test_find_file_decorated2():
@decorator
def noop2(f, *a, **kw):
return f(*a, **kw)
@noop2
Min RK
handle multiple decorators in oinspect...
r21505 @noop2
@noop2
Fernando Perez
Add extra tests for checking decorator logic with __wrapped__.
r7432 def f(x):
"My docstring 2"
Fernando Perez
Fix failure due to .pyc/.py mismatch detected by test_pr.
r7434 match_pyfiles(oinspect.find_file(f), os.path.abspath(__file__))
Fernando Perez
Add extra tests for checking decorator logic with __wrapped__.
r7432 nt.assert_equal(f.__doc__, "My docstring 2")
Fernando Perez
Fix finding of file info for magics and decorated functions....
r7290 def test_find_file_magic():
run = ip.find_line_magic('run')
nt.assert_not_equal(oinspect.find_file(run), None)
Fernando Perez
Add function signature info to calltips....
r3051 # A few generic objects we can then inspect in the tests below
class Call(object):
"""This is the class docstring."""
def __init__(self, x, y=1):
"""This is the constructor docstring."""
def __call__(self, *a, **kw):
"""This is the call docstring."""
def method(self, x, z=2):
"""Some method's docstring"""
Bernardo B. Marques
remove all trailling spaces
r4872
Min RK
Get signatures directly from classes...
r22171 class HasSignature(object):
"""This is the class docstring."""
__signature__ = Signature([Parameter('test', Parameter.POSITIONAL_OR_KEYWORD)])
def __init__(self, *args):
"""This is the init docstring"""
Thomas Kluyver
Don't introspect __call__ for simple callables...
r15362 class SimpleClass(object):
def method(self, x, z=2):
"""Some method's docstring"""
Fernando Perez
Add tests for object inspector with magics of all types.
r6995
Thomas Kluyver
Tweak Inspector.info() so it doesn't fail on old style classes. Added test....
r3867 class OldStyle:
"""An old-style class for testing."""
pass
Fernando Perez
Add function signature info to calltips....
r3051
Fernando Perez
Add tests for object inspector with magics of all types.
r6995
Fernando Perez
Add function signature info to calltips....
r3051 def f(x, y=2, *a, **kw):
"""A simple function."""
Fernando Perez
Add tests for object inspector with magics of all types.
r6995
Fernando Perez
Add function signature info to calltips....
r3051 def g(y, z=3, *a, **kw):
pass # no docstring
Fernando Perez
Add tests for object inspector with magics of all types.
r6995 @register_line_magic
def lmagic(line):
"A line magic"
@register_cell_magic
def cmagic(line, cell):
"A cell magic"
@register_line_cell_magic
def lcmagic(line, cell=None):
"A line/cell magic"
@magics_class
class SimpleMagics(Magics):
@line_magic
def Clmagic(self, cline):
"A class-based line magic"
@cell_magic
def Ccmagic(self, cline, ccell):
"A class-based cell magic"
@line_cell_magic
def Clcmagic(self, cline, ccell=None):
"A class-based line/cell magic"
Thomas Kluyver
Catch some pathological cases inside oinspect...
r11058 class Awkward(object):
def __getattr__(self, name):
raise Exception(name)
Pierre Gerold
Tests thanks @carreau
r21886 class NoBoolCall:
"""
callable with `__bool__` raising should still be inspect-able.
"""
def __call__(self):
"""does nothing"""
pass
def __bool__(self):
"""just raise NotImplemented"""
raise NotImplementedError('Must be implemented')
Thomas Kluyver
Catch some pathological cases inside oinspect...
r11058
Thomas Kluyver
Add test for infinite looping on attribute access
r21906 class SerialLiar(object):
"""Attribute accesses always get another copy of the same class.
unittest.mock.call does something similar, but it's not ideal for testing
as the failure mode is to eat all your RAM. This gives up after 10k levels.
"""
def __init__(self, max_fibbing_twig, lies_told=0):
if lies_told > 10000:
raise RuntimeError('Nose too long, honesty is the best policy')
self.max_fibbing_twig = max_fibbing_twig
self.lies_told = lies_told
max_fibbing_twig[0] = max(max_fibbing_twig[0], lies_told)
def __getattr__(self, item):
return SerialLiar(self.max_fibbing_twig, self.lies_told + 1)
Fernando Perez
Add function signature info to calltips....
r3051 #-----------------------------------------------------------------------------
# Tests
#-----------------------------------------------------------------------------
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 def test_info():
"Check that Inspector.info fills out various fields as expected."
i = inspector.info(Call, oname='Call')
nt.assert_equal(i['type_name'], 'type')
Thomas Kluyver
test_oinspect works with Python 3.
r4760 expted_class = str(type(type)) # <class 'type'> (Python 3) or <type 'type'>
nt.assert_equal(i['base_class'], expted_class)
Paul Ivanov
remove sys_version for Python 3...
r22959 nt.assert_regex(i['string_form'], "<class 'IPython.core.tests.test_oinspect.Call'( at 0x[0-9a-f]{1,9})?>")
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 fname = __file__
if fname.endswith(".pyc"):
fname = fname[:-1]
Min RK
fix various tests on Windows...
r4105 # case-insensitive comparison needed on some filesystems
# e.g. Windows:
Min RK
fix compress_user comparison...
r20826 nt.assert_equal(i['file'].lower(), compress_user(fname).lower())
MinRK
Update signature presentation in pinfo classes...
r15711 nt.assert_equal(i['definition'], None)
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 nt.assert_equal(i['docstring'], Call.__doc__)
Thomas Kluyver
Tweak test_oinspect to only use a common subset of nt.assert_* functions.
r3869 nt.assert_equal(i['source'], None)
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 nt.assert_true(i['isclass'])
Srinivas Reddy Thatiparthy
cleanup
r23096 nt.assert_equal(i['init_definition'], "Call(x, y=1)")
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 nt.assert_equal(i['init_docstring'], Call.__init__.__doc__)
Bernardo B. Marques
remove all trailling spaces
r4872
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 i = inspector.info(Call, detail_level=1)
Thomas Kluyver
Tweak test_oinspect to only use a common subset of nt.assert_* functions.
r3869 nt.assert_not_equal(i['source'], None)
nt.assert_equal(i['docstring'], None)
Bernardo B. Marques
remove all trailling spaces
r4872
Thomas Kluyver
Add test that Inspector.info fills out various fields as expected.
r3859 c = Call(1)
c.__doc__ = "Modified instance docstring"
i = inspector.info(c)
nt.assert_equal(i['type_name'], 'Call')
nt.assert_equal(i['docstring'], "Modified instance docstring")
nt.assert_equal(i['class_docstring'], Call.__doc__)
nt.assert_equal(i['init_docstring'], Call.__init__.__doc__)
MinRK
Update signature presentation in pinfo classes...
r15711 nt.assert_equal(i['call_docstring'], Call.__call__.__doc__)
Bernardo B. Marques
remove all trailling spaces
r4872
Min RK
Get signatures directly from classes...
r22171 def test_class_signature():
info = inspector.info(HasSignature, 'HasSignature')
Matthias Bussonnier
Fix test failing because of extra newline.
r22536 nt.assert_equal(info['init_definition'], "HasSignature(test)")
Min RK
Get signatures directly from classes...
r22171 nt.assert_equal(info['init_docstring'], HasSignature.__init__.__doc__)
Thomas Kluyver
Catch some pathological cases inside oinspect...
r11058 def test_info_awkward():
# Just test that this doesn't throw an error.
Matthias Bussonnier
Fix test failing because of extra newline.
r22536 inspector.info(Awkward())
Thomas Kluyver
Catch some pathological cases inside oinspect...
r11058
Pierre Gerold
Tests thanks @carreau
r21886 def test_bool_raise():
inspector.info(NoBoolCall())
Thomas Kluyver
Add test for infinite looping on attribute access
r21906 def test_info_serialliar():
fib_tracker = [0]
Matthias Bussonnier
Start refactoring handling of color....
r22911 inspector.info(SerialLiar(fib_tracker))
Thomas Kluyver
Add test for infinite looping on attribute access
r21906
# Nested attribute access should be cut off at 100 levels deep to avoid
# infinite loops: https://github.com/ipython/ipython/issues/9122
nt.assert_less(fib_tracker[0], 9000)
Thomas Kluyver
Don't introspect __call__ for simple callables...
r15362 def test_calldef_none():
# We should ignore __call__ for all of these.
for obj in [f, SimpleClass().method, any, str.upper]:
print(obj)
i = inspector.info(obj)
nt.assert_is(i['call_def'], None)
Matthias Bussonnier
Start refactoring handling of color....
r22911 def f_kwarg(pos, *, kwonly):
pass
Thomas Kluyver
Fix the display of functions with keyword-only arguments on Python 3.
r15335
def test_definition_kwonlyargs():
i = inspector.info(f_kwarg, oname='f_kwarg') # analysis:ignore
Sylvain Corlay
pinfo magic return mime bundle
r22460 nt.assert_equal(i['definition'], "f_kwarg(pos, *, kwonly)")
Thomas Kluyver
Fix the display of functions with keyword-only arguments on Python 3.
r15335
Thomas Kluyver
Add test for oinspect.getdoc
r5538 def test_getdoc():
class A(object):
"""standard docstring"""
pass
Sylvain Corlay
pinfo magic return mime bundle
r22460
Thomas Kluyver
Add test for oinspect.getdoc
r5538 class B(object):
"""standard docstring"""
def getdoc(self):
return "custom docstring"
Thomas Kluyver
Test for getdoc() returning None.
r5573 class C(object):
"""standard docstring"""
def getdoc(self):
return None
Thomas Kluyver
Add test for oinspect.getdoc
r5538 a = A()
b = B()
Thomas Kluyver
Test for getdoc() returning None.
r5573 c = C()
Thomas Kluyver
Add test for oinspect.getdoc
r5538
nt.assert_equal(oinspect.getdoc(a), "standard docstring")
nt.assert_equal(oinspect.getdoc(b), "custom docstring")
Thomas Kluyver
Test for getdoc() returning None.
r5573 nt.assert_equal(oinspect.getdoc(c), "standard docstring")
Thomas Kluyver
Add failing test for gh-1914
r7460
immerrr
Print sources for property fget/fset/fdel methods...
r17023
def test_empty_property_has_no_source():
i = inspector.info(property(), detail_level=1)
nt.assert_is(i['source'], None)
def test_property_sources():
madhu94
Add signature to the display of functions in the shell
r24026 import posixpath
# A simple adder whose source and signature stays
# the same across Python distributions
def simple_add(a, b):
"Adds two numbers"
return a + b
immerrr
Print sources for property fget/fset/fdel methods...
r17023 class A(object):
@property
def foo(self):
return 'bar'
foo = foo.setter(lambda self, v: setattr(self, 'bar', v))
madhu94
Add signature to the display of functions in the shell
r24026 dname = property(posixpath.dirname)
adder = property(simple_add)
immerrr
Print sources for property fget/fset/fdel methods...
r17023
i = inspector.info(A.foo, detail_level=1)
nt.assert_in('def foo(self):', i['source'])
nt.assert_in('lambda self, v:', i['source'])
madhu94
Add signature to the display of functions in the shell
r24026 i = inspector.info(A.dname, detail_level=1)
nt.assert_in('def dirname(p)', i['source'])
i = inspector.info(A.adder, detail_level=1)
nt.assert_in('def simple_add(a, b)', i['source'])
immerrr
Print sources for property fget/fset/fdel methods...
r17023
def test_property_docstring_is_in_info_for_detail_level_0():
class A(object):
@property
Matthias Bussonnier
A few style fixes:...
r22354 def foobar(self):
immerrr
Print sources for property fget/fset/fdel methods...
r17023 """This is `foobar` property."""
pass
ip.user_ns['a_obj'] = A()
Min RK
include docstring in detail_level=1 if no source is found...
r23021 nt.assert_equal(
immerrr
Print sources for property fget/fset/fdel methods...
r17023 'This is `foobar` property.',
ip.object_inspect('a_obj.foobar', detail_level=0)['docstring'])
ip.user_ns['a_cls'] = A
Min RK
include docstring in detail_level=1 if no source is found...
r23021 nt.assert_equal(
immerrr
Print sources for property fget/fset/fdel methods...
r17023 'This is `foobar` property.',
ip.object_inspect('a_cls.foobar', detail_level=0)['docstring'])
Thomas Kluyver
Add failing test for gh-1914
r7460 def test_pdef():
# See gh-1914
def foo(): pass
inspector.pdef(foo, 'foo')
Thomas Kluyver
Add test for non-ascii characters in docstrings...
r11067
Min RK
get signature from init if top-level signature fails...
r22539
Thomas Kluyver
Add test for non-ascii characters in docstrings...
r11067 def test_pinfo_nonascii():
# See gh-1177
from . import nonascii2
ip.user_ns['nonascii2'] = nonascii2
ip._inspect('pinfo', 'nonascii2', detail_level=1)
Thomas Kluyver
Add test for pinfo with magics
r20699
Min RK
get signature from init if top-level signature fails...
r22539
Min RK
include docstring in detail_level=1 if no source is found...
r23021 def test_pinfo_docstring_no_source():
"""Docstring should be included with detail_level=1 if there is no source"""
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'str.format', detail_level=0)
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'str.format', detail_level=1)
def test_pinfo_no_docstring_if_source():
"""Docstring should not be included with detail_level=1 if source is found"""
def foo():
"""foo has a docstring"""
ip.user_ns['foo'] = foo
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'foo', detail_level=0)
with AssertPrints('Source:'):
ip._inspect('pinfo', 'foo', detail_level=1)
with AssertNotPrints('Docstring:'):
ip._inspect('pinfo', 'foo', detail_level=1)
ryan thielke
Add test for ?? to show docstring if no source code available #10534
r23660 def test_pinfo_docstring_if_detail_and_no_source():
""" Docstring should be displayed if source info not available """
obj_def = '''class Foo(object):
""" This is a docstring for Foo """
def bar(self):
""" This is a docstring for Foo.bar """
pass
'''
ip.run_cell(obj_def)
ip.run_cell('foo = Foo()')
with AssertNotPrints("Source:"):
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'foo', detail_level=0)
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'foo', detail_level=1)
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'foo.bar', detail_level=0)
with AssertNotPrints('Docstring:'):
with AssertPrints('Source:'):
ip._inspect('pinfo', 'foo.bar', detail_level=1)
Thomas Kluyver
Add test for pinfo with magics
r20699 def test_pinfo_magic():
with AssertPrints('Docstring:'):
ip._inspect('pinfo', 'lsmagic', detail_level=0)
with AssertPrints('Source:'):
ip._inspect('pinfo', 'lsmagic', detail_level=1)
Min RK
get signature from init if top-level signature fails...
r22539
def test_init_colors():
# ensure colors are not present in signature info
info = inspector.info(HasSignature)
init_def = info['init_definition']
nt.assert_not_in('[0m', init_def)
def test_builtin_init():
info = inspector.info(list)
init_def = info['init_definition']
Hugo
Drop support for Python 3.3
r24260 nt.assert_is_not_none(init_def)
Min RK
get signature from init if top-level signature fails...
r22539
Philipp A
Fix signature rendering
r24881
def test_render_signature_short():
Philipp A
Older versions render a little less pretty
r24882 def short_fun(a=1): pass
Philipp A
Fix signature rendering
r24881 sig = oinspect._render_signature(
signature(short_fun),
short_fun.__name__,
)
Philipp A
Older versions render a little less pretty
r24882 nt.assert_equal(sig, 'short_fun(a=1)')
Philipp A
Fix signature rendering
r24881
def test_render_signature_long():
from typing import Optional
def long_function(
a_really_long_parameter: int,
and_another_long_one: bool = False,
let_us_make_sure_this_is_looong: Optional[str] = None,
) -> bool: pass
sig = oinspect._render_signature(
signature(long_function),
long_function.__name__,
)
Philipp A
Older versions render a little less pretty
r24882 nt.assert_in(sig, [
# Python >=3.7
'''\
Philipp A
Fix signature rendering
r24881 long_function(
a_really_long_parameter: int,
and_another_long_one: bool = False,
let_us_make_sure_this_is_looong: Union[str, NoneType] = None,
) -> bool\
Philipp A
Older versions render a little less pretty
r24882 ''', # Python <=3.6
'''\
long_function(
a_really_long_parameter:int,
and_another_long_one:bool=False,
let_us_make_sure_this_is_looong:Union[str, NoneType]=None,
) -> bool\
''',
])