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
|
from os.path import join
import warnings
import pytest
from xdoctest import runner
from xdoctest import core
from xdoctest import exceptions
from xdoctest import utils
from xdoctest.utils.util_misc import _run_case
# def _check_syntaxerror_behavior():
# import ubelt as ub
# source_block = ub.codeblock(
# '''
# x = 3
# 3 = 5
# ''')
# try:
# compile(source_block, filename='<string>', mode='exec')
# except SyntaxError as ex1:
# print('ex1.text = {!r}'.format(ex1.text))
# print('ex1.offset = {!r}'.format(ex1.offset))
# print('ex1.lineno = {!r}'.format(ex1.lineno))
# import ast
# try:
# pt = ast.parse(source_block)
# except SyntaxError as ex2:
# print('ex2.text = {!r}'.format(ex2.text))
# print('ex2.offset = {!r}'.format(ex2.offset))
# print('ex2.lineno = {!r}'.format(ex2.lineno))
# fpath = join(ub.ensure_app_cache_dir('xdoctest', 'test'), 'source.py')
# ub.writeto(fpath, source_block)
# try:
# compile(source_block, filename=fpath, mode='exec')
# except SyntaxError as ex2:
# print('ex2.text = {!r}'.format(ex2.text))
# print('ex2.offset = {!r}'.format(ex2.offset))
# print('ex2.lineno = {!r}'.format(ex2.lineno))
# import tempfile
# import ast
# temp = tempfile.NamedTemporaryFile()
# temp.file.write((source_block + '\n').encode('utf8'))
# temp.file.seek(0)
# try:
# ast.parse(source_block, temp.name)
# except SyntaxError as ex2:
# print('ex2.text = {!r}'.format(ex2.text))
# print('ex2.offset = {!r}'.format(ex2.offset))
# print('ex2.lineno = {!r}'.format(ex2.lineno))
# raise
def test_parse_syntax_error():
"""
CommandLine:
python tests/test_errors.py test_parse_syntax_error
"""
docstr = utils.codeblock(
'''
Example:
>>> x = 0
>>> 3 = 5
''')
info = {'callname': 'test_synerr', 'lineno': 42}
# Eager parsing should cause no doctests with errors to be found
# and warnings should be raised
with warnings.catch_warnings(record=True) as f_warnlist:
f_doctests = list(core.parse_docstr_examples(docstr, style='freeform',
**info))
with warnings.catch_warnings(record=True) as g_warnlist:
g_doctests = list(core.parse_docstr_examples(docstr, style='google',
**info))
for w in g_warnlist:
print(w.message)
for w in f_warnlist:
print(w.message)
assert len(g_warnlist) == 1
assert len(f_warnlist) == 1
assert len(g_doctests) == 0
assert len(f_doctests) == 0
# Google style can find doctests with bad syntax, but parsing them
# results in an error.
g_doctests2 = list(core.parse_google_docstr_examples(docstr,
eager_parse=False,
**info))
assert len(g_doctests2) == 1
for example in g_doctests2:
with pytest.raises(exceptions.DoctestParseError):
example._parse()
def test_runner_syntax_error():
"""
python tests/test_errors.py test_runner_syntax_error
pytest tests/test_errors.py -k test_runner_syntax_error
xdoctest -m tests/test_errors.py test_runner_syntax_error
"""
source = utils.codeblock(
r'''
def demo_parsetime_syntax_error1():
"""
Example:
>>> from __future__ import print_function
>>> print 'Parse-Time Syntax Error'
"""
def demo_parsetime_syntax_error2():
"""
Example:
>>> def bad_syntax() return for
"""
def demo_runtime_error():
"""
Example:
>>> print('Runtime Error {}'.format(5 / 0))
"""
def demo_runtime_name_error():
"""
Example:
>>> print('Name Error {}'.format(foo))
"""
def demo_runtime_warning():
"""
Example:
>>> import warnings
>>> warnings.warn('in-code warning')
"""
''')
temp = utils.TempDir(persist=True)
temp.ensure()
dpath = temp.dpath
modpath = join(dpath, 'demo_runner_syntax_error.py')
with open(modpath, 'w') as file:
file.write(source)
with utils.CaptureStdout() as cap:
runner.doctest_module(modpath, 'all', argv=[''], style='freeform',
verbose=1)
print('CAPTURED [[[[[[[[')
print(utils.indent(cap.text))
print(']]]]]]]] # CAPTURED')
captext = cap.text
assert '1 run-time warnings' in captext
assert '2 parse-time warnings' in captext
# Assert summary line
assert '3 warnings' in captext
assert '2 failed' in captext
assert '1 passed' in captext
def test_parse_doctset_error():
source = utils.codeblock(
'''
def func_with_an_unparsable_google_docstr(a):
"""
This function will have an unparsable google docstr
Args:
a (int): a number
Example:
>>> a = "\\''' + '''n"
>>> func(a)
"""
pass
''')
text = _run_case(source, style='google')
text = _run_case(source, style='freeform')
del text
def test_extract_got_exception():
"""
Make a repr that fails
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_errors.py test_extract_got_exception
"""
source = utils.codeblock(
'''
class MyObj:
"""
Example:
>>> a = MyObj()
>>> a
you cant always get what you want
"""
def __repr__(self):
raise Exception('this repr fails')
''')
text = _run_case(source, style='google')
assert 'ExtractGotReprException' in text
if __name__ == '__main__':
"""
CommandLine:
export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
python ~/code/xdoctest/tests/test_errors.py
pytest ~/code/xdoctest/tests/test_errors.py -s --verbose
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_errors.py test_extract_got_exception zero
"""
import xdoctest
xdoctest.doctest_module(__file__)
|
