##// END OF EJS Templates
test_oinspect works with Python 3.
Thomas Kluyver -
Show More
@@ -1,133 +1,136 b''
1 1 """Tests for the object inspection functionality.
2 2 """
3 3 #-----------------------------------------------------------------------------
4 4 # Copyright (C) 2010 The IPython Development Team.
5 5 #
6 6 # Distributed under the terms of the BSD License.
7 7 #
8 8 # The full license is in the file COPYING.txt, distributed with this software.
9 9 #-----------------------------------------------------------------------------
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Imports
13 13 #-----------------------------------------------------------------------------
14 14 from __future__ import print_function
15 15
16 16 # Stdlib imports
17 17
18 18 # Third-party imports
19 19 import nose.tools as nt
20 20
21 21 # Our own imports
22 22 from .. import oinspect
23 from IPython.utils import py3compat
23 24
24 25 #-----------------------------------------------------------------------------
25 26 # Globals and constants
26 27 #-----------------------------------------------------------------------------
27 28
28 29 inspector = oinspect.Inspector()
29 30
30 31 #-----------------------------------------------------------------------------
31 32 # Local utilities
32 33 #-----------------------------------------------------------------------------
33 34
34 35 # A few generic objects we can then inspect in the tests below
35 36
36 37 class Call(object):
37 38 """This is the class docstring."""
38 39
39 40 def __init__(self, x, y=1):
40 41 """This is the constructor docstring."""
41 42
42 43 def __call__(self, *a, **kw):
43 44 """This is the call docstring."""
44 45
45 46 def method(self, x, z=2):
46 47 """Some method's docstring"""
47 48
48 49 class OldStyle:
49 50 """An old-style class for testing."""
50 51 pass
51 52
52 53 def f(x, y=2, *a, **kw):
53 54 """A simple function."""
54 55
55 56 def g(y, z=3, *a, **kw):
56 57 pass # no docstring
57 58
58 59
59 60 def check_calltip(obj, name, call, docstring):
60 61 """Generic check pattern all calltip tests will use"""
61 62 info = inspector.info(obj, name)
62 63 call_line, ds = oinspect.call_tip(info)
63 64 nt.assert_equal(call_line, call)
64 65 nt.assert_equal(ds, docstring)
65 66
66 67 #-----------------------------------------------------------------------------
67 68 # Tests
68 69 #-----------------------------------------------------------------------------
69 70
70 71 def test_calltip_class():
71 72 check_calltip(Call, 'Call', 'Call(x, y=1)', Call.__init__.__doc__)
72 73
73 74
74 75 def test_calltip_instance():
75 76 c = Call(1)
76 77 check_calltip(c, 'c', 'c(*a, **kw)', c.__call__.__doc__)
77 78
78 79
79 80 def test_calltip_method():
80 81 c = Call(1)
81 82 check_calltip(c.method, 'c.method', 'c.method(x, z=2)', c.method.__doc__)
82 83
83 84
84 85 def test_calltip_function():
85 86 check_calltip(f, 'f', 'f(x, y=2, *a, **kw)', f.__doc__)
86 87
87 88
88 89 def test_calltip_function2():
89 90 check_calltip(g, 'g', 'g(y, z=3, *a, **kw)', '<no docstring>')
90 91
91 92
92 93 def test_calltip_builtin():
93 94 check_calltip(sum, 'sum', None, sum.__doc__)
94 95
95 96 def test_info():
96 97 "Check that Inspector.info fills out various fields as expected."
97 98 i = inspector.info(Call, oname='Call')
98 99 nt.assert_equal(i['type_name'], 'type')
99 nt.assert_equal(i['base_class'], "<type 'type'>")
100 expted_class = str(type(type)) # <class 'type'> (Python 3) or <type 'type'>
101 nt.assert_equal(i['base_class'], expted_class)
100 102 nt.assert_equal(i['string_form'], "<class 'IPython.core.tests.test_oinspect.Call'>")
101 103 fname = __file__
102 104 if fname.endswith(".pyc"):
103 105 fname = fname[:-1]
104 106 # case-insensitive comparison needed on some filesystems
105 107 # e.g. Windows:
106 108 nt.assert_equal(i['file'].lower(), fname.lower())
107 109 nt.assert_equal(i['definition'], 'Call(self, *a, **kw)\n')
108 110 nt.assert_equal(i['docstring'], Call.__doc__)
109 111 nt.assert_equal(i['source'], None)
110 112 nt.assert_true(i['isclass'])
111 113 nt.assert_equal(i['init_definition'], "Call(self, x, y=1)\n")
112 114 nt.assert_equal(i['init_docstring'], Call.__init__.__doc__)
113 115
114 116 i = inspector.info(Call, detail_level=1)
115 117 nt.assert_not_equal(i['source'], None)
116 118 nt.assert_equal(i['docstring'], None)
117 119
118 120 c = Call(1)
119 121 c.__doc__ = "Modified instance docstring"
120 122 i = inspector.info(c)
121 123 nt.assert_equal(i['type_name'], 'Call')
122 124 nt.assert_equal(i['docstring'], "Modified instance docstring")
123 125 nt.assert_equal(i['class_docstring'], Call.__doc__)
124 126 nt.assert_equal(i['init_docstring'], Call.__init__.__doc__)
125 127 nt.assert_equal(i['call_docstring'], c.__call__.__doc__)
126 128
127 129 # Test old-style classes, which for example may not have an __init__ method.
128 i = inspector.info(OldStyle)
129 nt.assert_equal(i['type_name'], 'classobj')
130
131 i = inspector.info(OldStyle())
132 nt.assert_equal(i['type_name'], 'instance')
133 nt.assert_equal(i['docstring'], OldStyle.__doc__)
130 if not py3compat.PY3:
131 i = inspector.info(OldStyle)
132 nt.assert_equal(i['type_name'], 'classobj')
133
134 i = inspector.info(OldStyle())
135 nt.assert_equal(i['type_name'], 'instance')
136 nt.assert_equal(i['docstring'], OldStyle.__doc__)
General Comments 0
You need to be logged in to leave comments. Login now