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
|
#! /usr/bin/env python3
# $Id: test_sidebars.py 9425 2023-06-30 14:56:47Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for the "sidebar" directive.
"""
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[4]))
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 = ''
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(case_expected, output)
totest = {}
totest['sidebars'] = [
["""\
.. sidebar:: Outer
.. sidebar:: Nested
Body.
""",
"""\
<document source="test data">
<sidebar>
<title>
Outer
<system_message level="3" line="3" source="test data" type="ERROR">
<paragraph>
The "sidebar" directive may not be used within a sidebar element.
<literal_block xml:space="preserve">
.. sidebar:: Nested
\n\
Body.
"""],
["""\
.. sidebar:: Margin Notes
:subtitle: with options
:class: margin
:name: note:Options
Body.
""",
"""\
<document source="test data">
<sidebar classes="margin" ids="note-options" names="note:options">
<title>
Margin Notes
<subtitle>
with options
<paragraph>
Body.
"""],
["""\
.. sidebar::
The title is optional.
""",
"""\
<document source="test data">
<sidebar>
<paragraph>
The title is optional.
"""],
["""\
.. sidebar:: Outer
.. topic:: Topic
.. sidebar:: Inner
text
""",
"""\
<document source="test data">
<sidebar>
<title>
Outer
<topic>
<title>
Topic
<system_message level="3" line="5" source="test data" type="ERROR">
<paragraph>
The "sidebar" directive may not be used within topics or body elements.
<literal_block xml:space="preserve">
.. sidebar:: Inner
\n\
text
"""],
]
if __name__ == '__main__':
unittest.main()
|
