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
|
import __future__
import pytest
from testfixtures import compare
from sybil import Example, Sybil
from sybil.parsers.myst import PythonCodeBlockParser, CodeBlockParser
from .helpers import check_excinfo, parse, check_path, sample_path
def test_basic():
examples, namespace = parse('myst-codeblock.md', PythonCodeBlockParser(), expected=7)
namespace['y'] = namespace['z'] = 0
assert examples[0].evaluate() is None
assert namespace['y'] == 1
assert namespace['z'] == 0
with pytest.raises(Exception) as excinfo:
examples[1].evaluate()
compare(examples[1].parsed, expected="raise Exception('boom!')\n", show_whitespace=True)
assert examples[1].line == 10
check_excinfo(examples[1], excinfo, 'boom!', lineno=11)
assert examples[2].evaluate() is None
assert namespace['y'] == 1
assert namespace['z'] == 1
assert examples[3].evaluate() is None
assert namespace['bin'] == b'x'
assert namespace['uni'] == u'x'
assert examples[4].evaluate() is None
assert 'NoVars' in namespace
assert examples[5].evaluate() is None
assert namespace['define_this'] == 1
assert examples[6].evaluate() is None
assert 'YesVars' in namespace
assert '__builtins__' not in namespace
def test_complicated_nesting():
# This has no code blocks, but should still parse fine:
parse('myst-complicated-nesting.md', PythonCodeBlockParser(), expected=0)
def test_doctest_at_end_of_fenced_codeblock():
examples, namespace = parse('myst-codeblock-doctests-end-of-fenced-codeblocks.md',
PythonCodeBlockParser(), expected=2)
assert examples[0].evaluate() is None
assert examples[1].evaluate() is None
assert namespace['b'] == 2
def test_other_language_composition_pass():
def oh_hai(example):
assert isinstance(example, Example)
assert 'HAI' in example.parsed
parser = CodeBlockParser(language='lolcode', evaluator=oh_hai)
examples, namespace = parse('myst-codeblock.md', parser, expected=1)
assert examples[0].evaluate() is None
def test_other_language_composition_fail():
def oh_noez(example):
if 'KTHXBYE' in example.parsed:
raise ValueError('oh noez')
parser = CodeBlockParser(language='lolcode', evaluator=oh_noez)
examples, namespace = parse('myst-codeblock.md', parser, expected=1)
with pytest.raises(ValueError):
examples[0].evaluate()
def test_other_language_no_evaluator():
parser = CodeBlockParser('foo')
with pytest.raises(NotImplementedError):
parser.evaluate(...)
class LolCodeCodeBlockParser(CodeBlockParser):
language = 'lolcode'
def evaluate(self, example: Example):
if example.parsed != 'HAI\n':
raise ValueError(repr(example.parsed))
def test_other_language_inheritance():
examples, namespace = parse('myst-codeblock-lolcode.md', LolCodeCodeBlockParser(), expected=2)
examples[0].evaluate()
with pytest.raises(ValueError) as excinfo:
examples[1].evaluate()
assert str(excinfo.value) == "'KTHXBYE\\n'"
class IgnoringPythonCodeBlockParser(CodeBlockParser):
def __call__(self, document):
for region in super().__call__(document):
options = region.lexemes.get('options')
if options and 'ignore' in options:
continue
yield region
class IgnoringCodeBlockParser(PythonCodeBlockParser):
codeblock_parser_class = IgnoringPythonCodeBlockParser
def test_other_functionality_inheritance():
examples, namespace = parse(
'myst-codeblock-subclassing.md', IgnoringCodeBlockParser(), expected=2
)
examples[0].evaluate()
examples[1].evaluate()
def future_import_checks(*future_imports):
parser = PythonCodeBlockParser(future_imports)
examples, namespace = parse('myst-codeblock-future-imports.md', parser, expected=3)
with pytest.raises(Exception) as excinfo:
examples[0].evaluate()
# check the line number of the first block, which is the hardest case:
check_excinfo(examples[0], excinfo, 'Boom 1', lineno=3)
with pytest.raises(Exception) as excinfo:
examples[1].evaluate()
# check the line number of the second block:
check_excinfo(examples[1], excinfo, 'Boom 2', lineno=9)
examples[2].evaluate()
# check the line number of the third block:
assert namespace['foo'].__code__.co_firstlineno == 15
return namespace['foo']
def test_no_future_imports():
future_import_checks()
def test_single_future_import():
future_import_checks('barry_as_FLUFL')
def test_multiple_future_imports():
future_import_checks('barry_as_FLUFL', 'print_function')
def test_functional_future_imports():
foo = future_import_checks('annotations')
# This will keep working but not be an effective test once PEP 563 finally lands:
assert foo.__code__.co_flags & __future__.annotations.compiler_flag
def test_blank_lines():
examples, namespace = parse(
'myst-codeblock-blank-lines.md', PythonCodeBlockParser(), expected=1
)
example, = examples
compare(example.parsed, expected=''.join((
'\n',
'y = 0\n',
'# now a blank line:\n',
'\n',
'y += 1\n',
'# two blank lines:\n',
'\n',
'\n',
"assert not y, 'Boom!'\n",
)))
with pytest.raises(AssertionError) as excinfo:
example.evaluate()
# check the line number in the exception:
check_excinfo(example, excinfo, 'Boom!', lineno=12)
def test_blank_lines_indented():
examples, namespace = parse(
"myst-codeblock-blank-lines-indented.md", PythonCodeBlockParser(), expected=1
)
(example,) = examples
compare(
example.parsed,
expected="".join(
(
"\n",
"y = 0\n",
"# now a blank line:\n",
"\n",
"y += 1\n",
"# two blank lines:\n",
"\n",
"\n",
"assert not y, 'Boom!'\n",
)
),
)
with pytest.raises(AssertionError) as excinfo:
example.evaluate()
# check the line number in the exception:
check_excinfo(example, excinfo, "Boom!", lineno=12)
def test_code_directive():
sybil = Sybil([PythonCodeBlockParser()])
check_path(sample_path('myst-code.md'), sybil, expected=1)
def test_sourcecode_directive():
sybil = Sybil([PythonCodeBlockParser()])
check_path(sample_path('myst-sourcecode.md'), sybil, expected=1)
|
