1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
"""
Need to enhance the tracebacks to spit out something more useful
"""
from xdoctest import utils
from xdoctest.utils.util_misc import _run_case
def test_fail_call_onefunc():
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore")
text = _run_case(utils.codeblock(
'''
def func(a):
"""
Example:
>>> a = 1
>>> func(a)
"""
a = []()
return a
'''))
assert '>>> func(a)' in text
assert 'rel: 2, abs: 5' in text
def test_fail_call_twofunc():
"""
python ~/code/xdoctest/tests/test_traceback.py test_fail_call_twofunc
"""
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore")
text = _run_case(utils.codeblock(
'''
def func(a):
"""
Example:
>>> a = 1
>>> func(a)
"""
a = []()
return a
def func2(a):
"""
Example:
>>> pass
"""
pass
'''))
assert text
assert '>>> func(a)' in text
assert 'rel: 2, abs: 5,' in text
def test_fail_inside_twofunc():
"""
python ~/code/xdoctest/tests/test_traceback.py test_fail_inside_twofunc
"""
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore")
text = _run_case(utils.codeblock(
'''
def func(a):
"""
Example:
>>> print('not failed')
>>> # just a comment
>>> print(("foo"
... "bar"))
>>> a = []()
>>> func(a)
"""
return a
def func2(a):
"""
Example:
>>> pass
"""
pass
'''))
assert text
assert '>>> a = []()' in text
assert 'rel: 5, abs: 8' in text
def test_fail_inside_onefunc():
"""
python ~/code/xdoctest/tests/test_traceback.py test_fail_inside_onefunc
"""
text = _run_case(utils.codeblock(
'''
def func(a):
"""
Example:
>>> x = 1
>>> # just a comment
>>> print(("foo"
... "bar"))
foobar
>>> a = []()
>>> func(a)
"""
return a
'''))
assert text
assert '>>> a = []()' in text
assert 'rel: 6, abs: 9,' in text
def test_failure_linenos():
"""
Example:
python ~/code/xdoctest/tests/test_linenos.py test_failure_linenos
Example:
>>> test_failure_linenos()
"""
text = _run_case(utils.codeblock(
r'''
def bar(a):
return a
class Foo:
@bar
@staticmethod
def func(a):
"""
Example:
>>> # Perform some passing tests before we call failing code
>>> Foo.func(0)
0
>>> # call the failing code
>>> if True:
>>> assert 1 == 2
>>> # Do stuff that wont be executed
>>> Foo.func(0)
0
>>> Foo.func(1)
1
"""
return a
'''))
assert 'line 15' in text
assert 'line 6' in text
assert text
# There are three different types of traceback failure
# (1) failure of code within the doctest
# (2) failure of code called by the doctest
# (3) failure of doctest got/want syntax
# TODO: Add checks on the line numbers reported in the tracebacks for these
# function.
# TODO: Check that the formatting of the tracebacks for each case are user
# friendly
"""
SeeAlso:
# This plugin tests also checks line numbers. Make sure we dont break it
pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno -v -s
"""
def test_lineno_failcase_gotwant():
"""
python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_gotwant
"""
text = _run_case(utils.codeblock(
'''
def func(a):
"""
Example:
>>> got = func('foo')
>>> print(got)
bar
"""
return a
'''))
assert text
assert 'line 3' in text
assert 'line 6' in text
def test_lineno_failcase_called_code():
"""
python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_called_code
python ~/code/xdoctest/tests/test_linenos.py
"""
text = _run_case(utils.codeblock(
r'''
def func(a):
"""
Example:
>>> func(0)
>>> # this doesnt do anything
>>> print('this passes')
this passes
>>> # call the failing code
>>> func(3)
"""
if a > 0:
nested_failure(a)
return a
def nested_failure(a):
if a > 0:
nested_failure(a - 1)
else:
raise Exception('fail case')
'''))
assert 'rel: 6, abs: 9,' in text
assert text
def test_lineno_failcase_doctest_code():
"""
python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_doctest_code
"""
text = _run_case(utils.codeblock(
r'''
def bar():
pass
def func(a):
"""
Example:
>>> # Perform some passing tests before we call failing code
>>> func(0)
0
>>> # call the failing code
>>> assert 1 == 2
>>> # Do stuff that wont be executed
>>> func(0)
0
>>> func(1)
1
"""
return a
'''))
assert 'rel: 5, abs: 11,' in text
assert text
if __name__ == '__main__':
"""
CommandLine:
export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
python ~/code/xdoctest/tests/test_traceback.py
pytest ~/code/xdoctest/tests/test_traceback.py -s
"""
import xdoctest
xdoctest.doctest_module(__file__)
|
