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
|
#!/usr/bin/env python3
# :Copyright: © 2024 Günter Milde.
# :License: Released under the terms of the `2-Clause BSD license`_, in short:
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.
# This file is offered as-is, without any warranty.
#
# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
"""Various tests for the XML parser.
Test parsing + transformations with `publish_string()`.
"""
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.core import publish_string
from docutils.parsers import docutils_xml
class XMLParserTests(unittest.TestCase):
maxDiff = None
mysettings = {'_disable_config': True,
'output_encoding': 'unicode',
'warning_stream': '',
}
def test_publish(self):
for name, (settings, cases) in totest.items():
settings = self.mysettings | settings
for casenum, (case_input, case_expected) in enumerate(cases):
with self.subTest(id=f'totest[{name!r}][{casenum}]'):
output = publish_string(case_input,
parser=docutils_xml.Parser(),
settings_overrides=settings)
self.assertEqual(case_expected, output)
totest = {}
totest['decoration'] = ({'datestamp': 'pi-day'}, # generate footer
[
["""\
<decoration>
<footer>
<paragraph>myfooter</paragraph>
</footer>
</decoration>
""",
"""\
<document source="<string>">
<decoration>
<footer>
<paragraph>
myfooter
<paragraph>
Generated on: pi-day.
"""],
])
totest['hyperlinks'] = ({}, # resolve hyperlinks
[
["""\
<document source="test data">
<paragraph>A <reference anonymous="1" name="link">link</reference> to Docutils.</paragraph>
<target anonymous="1" ids="target-1" refuri="http://docutils.sourceforge.io"/>
</document>
""",
"""\
<document source="test data">
<paragraph>
A \n\
<reference anonymous="1" name="link" refuri="http://docutils.sourceforge.io">
link
to Docutils.
<target anonymous="1" ids="target-1" refuri="http://docutils.sourceforge.io">
"""],
# duplicate ids are an error
["""\
<tip ids="i1 i2">
<paragraph><strong ids="i2 i3"></strong></paragraph>
</tip>
""",
"""\
<document source="<string>">
<tip ids="i1 i2">
<paragraph>
<strong ids="i2 i3">
<section classes="system-messages">
<title>
Docutils System Messages
<system_message level="3" line="2" source="<string>" type="ERROR">
<paragraph>
Duplicate ID: "i2" used by <tip ids="i1 i2"> and <strong ids="i2 i3">
"""],
])
totest['substitutions'] = ({}, # resolve substitutions
[
["""\
<document source="test data">
<substitution_definition ltrim="0" names="holla">Mara</substitution_definition>
<paragraph>Das ist
<substitution_reference refname="Holla">Holla</substitution_reference>
die Waldfee</paragraph>
</document>
""",
"""\
<document source="test data">
<substitution_definition ltrim="0" names="holla">
Mara
<paragraph>
Das ist
Mara
\n\
die Waldfee
"""],
])
if __name__ == '__main__':
unittest.main()
|
