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
|
#! /usr/bin/env python3
# $Id$
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for transition markers.
"""
from pathlib import Path
import sys
import unittest
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[3]))
from docutils.frontend import get_default_settings
from docutils.parsers.rst import Parser
from docutils.utils import new_document
class ParserTestCase(unittest.TestCase):
def test_parser(self):
parser = Parser()
settings = get_default_settings(Parser)
settings.warning_stream = ''
settings.halt_level = 5
for name, cases in totest.items():
for casenum, (case_input, case_expected) in enumerate(cases):
with self.subTest(id=f'totest[{name!r}][{casenum}]'):
document = new_document('test data', settings.copy())
parser.parse(case_input, document)
output = document.pformat()
self.assertEqual(output, case_expected)
totest = {}
# Each dictionary key (test type name) maps to a list of tests. Each
# test is a list: input, expected output.
totest['transitions'] = [
["""\
Test transition markers.
--------
Paragraph
""",
"""\
<document source="test data">
<paragraph>
Test transition markers.
<transition>
<paragraph>
Paragraph
"""],
["""\
Section 1
=========
First text division of section 1.
--------
Second text division of section 1.
Section 2
---------
Paragraph 2 in section 2.
""",
"""\
<document source="test data">
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<paragraph>
First text division of section 1.
<transition>
<paragraph>
Second text division of section 1.
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<paragraph>
Paragraph 2 in section 2.
"""],
# TODO: disable this test case, as it endorses non-standard results?
["""\
--------
According to the DTD, a section or document may not begin with a transition.
Note: There is currently no warning, but in future these
DTD violations should be prevented or at least trigger a warning.
Alternatively, the DTD may be relaxed to accomodate for more use cases.
The DTD specifies that two transitions may not
be adjacent:
--------
--------
--------
The DTD also specifies that a section or document
may not end with a transition.
--------
""",
"""\
<document source="test data">
<transition>
<paragraph>
According to the DTD, a section or document may not begin with a transition.
<paragraph>
Note: There is currently no warning, but in future these
DTD violations should be prevented or at least trigger a warning.
Alternatively, the DTD may be relaxed to accomodate for more use cases.
<paragraph>
The DTD specifies that two transitions may not
be adjacent:
<transition>
<transition>
<transition>
<paragraph>
The DTD also specifies that a section or document
may not end with a transition.
<transition>
"""],
["""\
Test unexpected transition markers.
Block quote.
--------
Paragraph.
""",
"""\
<document source="test data">
<paragraph>
Test unexpected transition markers.
<block_quote>
<paragraph>
Block quote.
<system_message level="4" line="5" source="test data" type="SEVERE">
<paragraph>
Unexpected section title or transition.
<literal_block xml:space="preserve">
--------
<paragraph>
Paragraph.
"""],
["""\
Short transition marker.
---
Paragraph
""",
"""\
<document source="test data">
<paragraph>
Short transition marker.
<paragraph>
---
<paragraph>
Paragraph
"""],
["""\
Sections with transitions at beginning and end.
Section 1
=========
----------
The next transition is legal:
----------
Section 2
=========
----------
""",
"""\
<document source="test data">
<paragraph>
Sections with transitions at beginning and end.
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<transition>
<paragraph>
The next transition is legal:
<transition>
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<transition>
"""],
["""\
A paragraph, two transitions, and a blank line.
----------
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph, two transitions, and a blank line.
<transition>
<transition>
"""],
["""\
A paragraph and two transitions.
----------
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph and two transitions.
<transition>
<transition>
"""],
["""\
----------
Document beginning with a transition.
""",
"""\
<document source="test data">
<transition>
<paragraph>
Document beginning with a transition.
"""],
["""\
Section 1
=========
Subsection 1
------------
Some text.
----------
Section 2
=========
Some text.
""",
"""\
<document source="test data">
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<section ids="subsection-1" names="subsection\\ 1">
<title>
Subsection 1
<paragraph>
Some text.
<transition>
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<paragraph>
Some text.
"""],
["""\
Section 1
=========
----------
----------
----------
Section 2
=========
Some text.
""",
"""\
<document source="test data">
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<transition>
<transition>
<transition>
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<paragraph>
Some text.
"""],
["""\
----------
----------
----------
""",
"""\
<document source="test data">
<transition>
<transition>
<transition>
"""],
["""\
A paragraph.
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph.
<transition>
"""],
]
if __name__ == '__main__':
unittest.main()
|
