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
|
#! /usr/bin/env python3
# $Id: test_transitions.py 10128 2025-05-13 20:49:24Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Test module for misc.Transitions transform.
"""
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[2]))
from docutils.frontend import get_default_settings
from docutils.parsers import rst, docutils_xml
from docutils.transforms.misc import Transitions
from docutils.transforms.universal import TestMessages
from docutils.utils import new_document
class TransformTestCase(unittest.TestCase):
maxDiff = None
def test_transforms(self):
parser = rst.Parser()
settings = get_default_settings(rst.Parser)
settings.warning_stream = ''
for name, (transforms, 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)
# Don't do a ``populate_from_components()`` because that
# would enable the Transformer's default transforms.
document.transformer.add_transforms(transforms)
document.transformer.add_transform(TestMessages)
document.transformer.apply_transforms()
output = document.pformat()
self.assertEqual(case_expected, output)
def test_transfroms_x(self):
# test samples given as Docutils XML in `totest_x`
# (for document trees that cannot be generated from rST)
parser = docutils_xml.Parser()
settings = get_default_settings(docutils_xml.Parser)
settings.warning_stream = ''
for name, (transforms, cases) in totest_x.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)
# Don't do a ``populate_from_components()`` because that
# would enable the Transformer's default transforms.
document.transformer.add_transforms(transforms)
document.transformer.add_transform(TestMessages)
document.transformer.apply_transforms()
output = document.pformat()
self.assertEqual(case_expected, output)
totest = {} # rST samples and expected pseudoXML
totest_x = {} # XML samples and expected pseudoXML
totest['transitions'] = ((Transitions,), [
["""\
Section 1
=========
Subsection 1
------------
A transition at the end of a section is moved behind the section.
----------
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>
A transition at the end of a section is moved behind the section.
<transition>
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<paragraph>
Some text.
"""],
["""\
A paragraph.
----------
Section 1
=========
Paragraph.
""",
"""\
<document source="test data">
<paragraph>
A paragraph.
<transition>
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<paragraph>
Paragraph.
"""],
["""\
--------
A system message warns about invalid placement of transitions.
""",
"""\
<document source="test data">
<transition>
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<paragraph>
A system message warns about invalid placement of transitions.
"""],
["""\
The DTD specifies ...
--------
--------
... that two transitions may not be adjacent:
""",
"""\
<document source="test data">
<paragraph>
The DTD specifies ...
<transition>
<transition>
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
<paragraph>
... 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">
<paragraph>
The DTD also specifies that a section or document
may not end with a transition.
<transition>
<system_message level="2" line="4" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
"""],
["""\
Sections with transitions at beginning and end.
Section 1
=========
----------
Some text after transition.
Section 2
=========
Some text before the transition.
----------
""",
"""\
<document source="test data">
<paragraph>
Sections with transitions at beginning and end.
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<transition>
<system_message level="2" line="6" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<paragraph>
Some text after transition.
<section ids="section-2" names="section\\ 2">
<title>
Section 2
<paragraph>
Some text before the transition.
<transition>
<system_message level="2" line="15" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
"""],
["""\
A paragraph and two transitions.
----------
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph and two transitions.
<transition>
<transition>
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
"""],
["""\
A paragraph, two transitions, and a blank line.
----------
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph, two transitions, and a blank line.
<transition>
<transition>
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
"""],
["""\
----------
Document beginning with a transition.
""",
"""\
<document source="test data">
<transition>
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<paragraph>
Document beginning with a transition.
"""],
["""\
.. meta:: :keywords: transition test
----------
Document beginning with a transition (meta elements don't count).
""",
"""\
<document source="test data">
<meta content="transition test" name="keywords">
<transition>
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<paragraph>
Document beginning with a transition (meta elements don't count).
"""],
["""\
.. header:: a header
----------
Document beginning with a transition (decoration elements don't count).
""",
"""\
<document source="test data">
<decoration>
<header>
<paragraph>
a header
<transition>
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<paragraph>
Document beginning with a transition (decoration elements don't count).
"""],
["""\
Section 1
=========
----------
----------
----------
Implementation Detail
=====================
If the element containing the transition is invalid after replacing the
transition with a body element, the system_message is appended at the end
of the document (by the "universal.Messages" transform).
This check can lead to overcautious behaviour if there are other
validity violations (here: several misplaced transitions).
""",
"""\
<document source="test data">
<section ids="section-1" names="section\\ 1">
<title>
Section 1
<transition>
<transition>
<transition>
<section ids="implementation-detail" names="implementation\\ detail">
<title>
Implementation Detail
<paragraph>
If the element containing the transition is invalid after replacing the
transition with a body element, the system_message is appended at the end
of the document (by the "universal.Messages" transform).
This check can lead to overcautious behaviour if there are other
validity violations (here: several misplaced transitions).
<system_message level="2" line="4" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<system_message level="2" line="6" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
<system_message level="2" line="8" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
"""],
["""\
----------
----------
----------
""",
# The placement of <system_message>s in this sample is an implementation
# detail, see the remarks in the preceding test nr. 11.
"""\
<document source="test data">
<transition>
<transition>
<transition>
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Document or section may not begin with a transition.
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
<system_message level="2" line="5" source="test data" type="WARNING">
<paragraph>
At least one body element must separate transitions; adjacent transitions are not allowed.
"""],
["""\
A paragraph.
----------
""",
"""\
<document source="test data">
<paragraph>
A paragraph.
<transition>
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Document may not end with a transition.
"""],
])
totest_x['transitions extra'] = ((Transitions,), [
# currently, a <transition> is only valid inside <document> or <section>
["""\
<document>
<paragraph>Some text.</paragraph>
<transition />
<paragraph>Some text.</paragraph>
<block_quote>
<paragraph>Some text.</paragraph>
<transition />
<paragraph>Some text.</paragraph>
</block_quote>
<paragraph>A <transition /> in a paragraph.</paragraph>
</document>
""",
"""\
<document source="test data">
<paragraph>
Some text.
<transition>
<paragraph>
Some text.
<block_quote>
<paragraph>
Some text.
<transition>
<system_message level="2" line="7" source="test data" type="WARNING">
<paragraph>
Transition must be child of <document> or <section>.
<paragraph>
Some text.
<paragraph>
A \n\
<transition>
in a paragraph.
<system_message level="2" line="10" source="test data" type="WARNING">
<paragraph>
Transition must be child of <document> or <section>.
"""],
])
if __name__ == '__main__':
unittest.main()
|
