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
|
import os
import sys
import doctest
from formencode import compound
from formencode import htmlfill
from formencode import htmlgen
from formencode import national
from formencode import schema
from formencode import validators
import pytest
"""Modules that will have their doctests tested."""
modules = [compound, htmlfill, htmlgen, national, schema, validators]
"""Text files that will have their doctests tested."""
text_files = [
"docs/htmlfill.txt",
"docs/Validator.txt",
"tests/non_empty.txt",
]
"""Used to resolve text files to absolute paths."""
base = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
def doctest_file(document, verbose, raise_error):
failure_count, test_count = doctest.testfile(
document,
module_relative=False,
optionflags=doctest.ELLIPSIS | doctest.IGNORE_EXCEPTION_DETAIL,
verbose=verbose,
)
if raise_error:
assert test_count > 0
assert failure_count == 0
def doctest_module(document, verbose, raise_error):
failure_count, test_count = doctest.testmod(
document,
optionflags=doctest.ELLIPSIS | doctest.IGNORE_EXCEPTION_DETAIL,
verbose=verbose,
)
if raise_error:
assert test_count > 0
assert failure_count == 0
def set_func_description(fn, description):
"""Wrap function and set description attr for pytest to display."""
def _wrapper(*a_test_args):
fn(*a_test_args)
_wrapper.description = description
return _wrapper
def collect_functions():
verbose = False
raise_error = True
for document in text_files + modules:
if isinstance(document, str):
name = "Doctests for %s" % (document,)
if not document.startswith(os.sep):
document = os.path.join(base, document)
yield set_func_description(
doctest_file, name
), document, verbose, raise_error
else:
name = "Doctests for %s" % (document.__name__,)
yield set_func_description(
doctest_module, name
), document, verbose, raise_error
@pytest.mark.parametrize(
"testfn,document,verbose,raise_error", list(collect_functions())
)
def test_doctests(testfn, document, verbose, raise_error):
"""Generate each doctest."""
testfn(document, verbose, raise_error)
if __name__ == "__main__":
# Call this file directly if you want to test doctests.
args = sys.argv[1:]
verbose = False
if "-v" in args:
args.remove("-v")
verbose = True
if not args:
args = text_files + modules
raise_error = False
for fn in args:
if isinstance(fn, str):
fn = os.path.join(base, fn)
doctest_file(fn, verbose, raise_error)
else:
doctest_module(fn, verbose, raise_error)
|
