File: test_doctest_example.py

package info (click to toggle)
xdoctest 1.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,512 kB
  • sloc: python: 10,963; sh: 815; cpp: 33; makefile: 19
file content (443 lines) | stat: -rw-r--r-- 11,862 bytes parent folder | download
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
from xdoctest import doctest_example
from xdoctest import exceptions
from xdoctest import utils
from xdoctest import constants
from xdoctest import checker


def test_exit_test_exception():
    """
    pytest tests/test_doctest_example.py::test_exit_test_exception
    """
    string = utils.codeblock(
        '''
        >>> from xdoctest import ExitTestException
        >>> raise ExitTestException()
        >>> 0 / 0  # should never reach this
        2
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_failed_assign_want():
    """
    pytest tests/test_doctest_example.py::test_exit_test_exception
    """
    string = utils.codeblock(
        '''
        >>> name = 'foo'
        'anything'
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='return', verbose=0)
    assert result['failed']
    fail_text = '\n'.join(self.repr_failure())
    assert 'Got nothing' in fail_text


def test_continue_ambiguity():
    """
    pytest tests/test_doctest_example.py::test_exit_test_exception
    """
    string = utils.codeblock(
        '''
        >>> class Lowerer:
        ...     def __init__(self):
        ...         self.cache = LRI()
        ...
        ...     def lower(self, text):
        ...         return text.lower()
        ...
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='return', verbose=3)
    assert result['passed']


def test_contination_want_ambiguity():
    """
    xdoctest ~/code/xdoctest/tests/test_doctest_example.py test_contination_want_ambiguity
    """
    string = utils.codeblock(
        '''
        >>> class Lowerer:
        ...     def __init__(self):
        ...         self.cache = LRI()
        ...
        ...     def lower(self, text):
        ...         return text.lower()
        ...
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='return', verbose=3)
    assert result['passed']


def test_multiline_list():
    """
    pytest tests/test_doctest_example.py::test_multiline_list
    """
    string = utils.codeblock(
        '''
        >>> x = [1, 2, 3,
        >>>      4, 5, 6]
        >>> print(len(x))
        6
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_failure():
    string = utils.codeblock(
        '''
        >>> i = 0
        >>> 0 / i
        2
        ''')
    self = doctest_example.DocTest(docsrc=string, lineno=1000)
    self._parse()
    try:
        self.run(on_error='raise')
    except ZeroDivisionError:
        pass
    else:
        raise AssertionError('should have gotten zero division')

    result = self.run(on_error='return')
    assert not result['passed']


def test_format_src():
    """
    python tests/test_doctest_example.py test_format_src

    pytest tests/test_doctest_example.py::test_format_src -s -v
    """
    string = utils.codeblock(
        '''
        >>> i = 0
        >>> 0 / i
        2
        ''')
    string_with_lineno = utils.codeblock(
        '''
        1 >>> i = 0
        2 >>> 0 / i
          2
        ''').replace('!', ' ')
    self = doctest_example.DocTest(docsrc=string)
    self._parse()

    assert self.format_src(colored=0, linenos=1) == string_with_lineno
    assert self.format_src(colored=0, linenos=0) == string
    assert utils.strip_ansi(self.format_src(colored=1, linenos=1)) == string_with_lineno
    assert utils.strip_ansi(self.format_src(colored=1, linenos=0)) == string


def test_eval_expr_capture():
    """
    pytest tests/test_doctest_example.py::test_eval_expr_capture -s
    """
    docsrc = utils.codeblock(
        '''
        >>> x = 3
        >>> y = x + 2
        >>> y + 2
        2
        ''')
    self = doctest_example.DocTest(docsrc=docsrc)
    self._parse()
    p1, p2 = self._parts

    # test_globals = {}
    # code1 = compile(p1.source, '<string>', 'exec')
    # exec(code1, test_globals)
    # code2 = compile(p2.source, '<string>', 'eval')
    # result = eval(code2, test_globals)
    try:
        self.run()
    except Exception as ex:
        assert hasattr(ex, 'output_difference')
        msg = ex.output_difference(colored=False)
        assert msg == utils.codeblock(
            '''
            Expected:
                2
            Got:
                7
            ''')


def test_run_multi_want():
    docsrc = utils.codeblock(
        '''
        >>> x = 2
        >>> x
        2
        >>> 'string'
        'string'
        >>> print('string')
        string
        ''')
    self = doctest_example.DocTest(docsrc=docsrc)
    self.run()

    result = self.run()

    assert result['passed']
    assert list(self.logged_stdout.values()) == ['', '', '', 'string\n']
    assert list(self.logged_evals.values()) == [constants.NOT_EVALED, 2, 'string', None]


def test_comment():
    docsrc = utils.codeblock(
        '''
        >>> # foobar
        ''')
    self = doctest_example.DocTest(docsrc=docsrc)
    self._parse()
    assert len(self._parts) == 1
    self.run(verbose=0)

    docsrc = utils.codeblock(
        '''
        >>> # foobar
        >>> # bazbiz
        ''')
    self = doctest_example.DocTest(docsrc=docsrc)
    self._parse()
    assert len(self._parts) == 1
    self.run(verbose=0)

    docsrc = utils.codeblock(
        '''
        >>> # foobar
        >>> x = 0
        >>> x / 0
        >>> # bazbiz
        ''')
    self = doctest_example.DocTest(docsrc=docsrc, lineno=1)
    self._parse()
    assert len(self._parts) == 1
    result = self.run(on_error='return', verbose=0)
    assert not result['passed']

    assert self.failed_lineno() == 3


def test_want_error_msg():
    """
    python tests/test_doctest_example.py test_want_error_msg
    pytest tests/test_doctest_example.py::test_want_error_msg
    """
    string = utils.codeblock(
        '''
        >>> raise Exception('everything is fine')
        Traceback (most recent call last):
        Exception: everything is fine
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_want_error_msg_failure():
    """
    python tests/test_doctest_example.py test_want_error_msg_failure
    pytest tests/test_doctest_example.py::test_want_error_msg_failure
    """
    string = utils.codeblock(
        '''
        >>> raise Exception('everything is NOT fine')
        Traceback (most recent call last):
        Exception: everything is fine
        ''')

    self = doctest_example.DocTest(docsrc=string)
    import pytest
    with pytest.raises(checker.GotWantException):
        self.run(on_error='raise')


def test_await():
    """
    python tests/test_doctest_example.py test_await
    pytest tests/test_doctest_example.py::test_await
    """
    string = utils.codeblock(
        '''
        >>> import asyncio
        >>> res = await asyncio.sleep(0, result="slept")
        >>> print(res)
        slept
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_async_for():
    """
    python tests/test_doctest_example.py test_async_for
    pytest tests/test_doctest_example.py::test_async_for
    """
    string = utils.codeblock(
        '''
        >>> async def test_gen():
        >>>     yield 5
        >>>     yield 6
        >>> async for i in test_gen():
        >>>     print(i)
        5
        6
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_async_with():
    """
    python tests/test_doctest_example.py test_async_with
    pytest tests/test_doctest_example.py::test_async_with
    """
    string = utils.codeblock(
        '''
        >>> from contextlib import asynccontextmanager
        >>> import asyncio
        >>> @asynccontextmanager
        >>> async def gen():
        >>>     try:
        >>>         yield 1
        >>>     finally:
        >>>         await asyncio.sleep(0)
        >>> async with gen() as res:
        >>>     print(res)
        1
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_async_future_without_directive():
    """
    python tests/test_doctest_example.py test_async_future_without_directive
    pytest tests/test_doctest_example.py::test_async_future_without_directive
    """
    string = utils.codeblock(
        '''
        >>> import asyncio
        >>> future = asyncio.get_running_loop().create_future()
        >>> future.set_result("ok")
        >>> print(await future)
        ok
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='return')
    assert result['failed']


def test_async_future_with_directive():
    """
    python tests/test_doctest_example.py test_async_future_with_directive
    pytest tests/test_doctest_example.py::test_async_future_with_directive
    """
    string = utils.codeblock(
        '''
        >>> # xdoctest: +ASYNC
        >>> import asyncio
        >>> future = asyncio.get_running_loop().create_future()
        >>> future.set_result("ok")
        >>> print(await future)
        ok
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_await_in_running_loop():
    """
    python tests/test_doctest_example.py test_await_in_running_loop
    pytest tests/test_doctest_example.py::test_await_in_running_loop
    """
    string = utils.codeblock(
        '''
        >>> import asyncio
        >>> res = await asyncio.sleep(0, result="slept")
        >>> print(res)
        slept
        ''')
    import asyncio
    import pytest
    self = doctest_example.DocTest(docsrc=string)
    async def run_in_loop(doctest, on_error, verbose=None):
        return doctest.run(on_error=on_error, verbose=verbose)

    with pytest.raises(exceptions.ExistingEventLoopError):
        asyncio.run(run_in_loop(self, 'raise'))

    self = doctest_example.DocTest(docsrc=string)
    res = asyncio.run(run_in_loop(self, 'return', verbose=3))

    assert res['failed']
    assert self.repr_failure()


def test_async_def():
    """
    python tests/test_doctest_example.py test_async_def
    pytest tests/test_doctest_example.py::test_async_def
    """
    string = utils.codeblock(
        '''
        >>> import asyncio
        >>> async def run_async():
        >>>     return await asyncio.sleep(0, result="slept")
        >>> res = asyncio.run(run_async())
        >>> print(res)
        slept
        ''')
    self = doctest_example.DocTest(docsrc=string)
    result = self.run(on_error='raise')
    assert result['passed']


def test_tabs_in_doctest():
    """
    pytest tests/test_doctest_example.py::test_tabs_in_doctest
    """
    from xdoctest import utils
    from xdoctest import doctest_example
    tab = '\t'
    assert ord(tab) == 9
    string = utils.codeblock(
        f'''
        >>> text = "tab{tab}sep{tab}val"
        >>> print(repr(text))
        >>> assert chr(9) in text
        >>> assert ord("{tab}") == 9
        ''')
    self = doctest_example.DocTest(docsrc=string)

    # This was ok in version 1.2.0
    assert tab in self.docsrc

    # Failed in 1.2.0
    result = self.run(on_error='raise', verbose=3)
    assert result['passed']

if __name__ == '__main__':
    """
    CommandLine:
        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
        python ~/code/xdoctest/tests/test_doctest_example.py
        xdoctest ~/code/xdoctest/tests/test_doctest_example.py zero-args
    """
    import xdoctest
    xdoctest.doctest_module(__file__)