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: test_comments.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 states.py.
"""
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 = ''
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['comments'] = [
["""\
.. A comment
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment
<paragraph>
Paragraph.
"""],
["""\
.. A comment
block.
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment
block.
<paragraph>
Paragraph.
"""],
["""\
..
A comment consisting of multiple lines
starting on the line after the
explicit markup start.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment consisting of multiple lines
starting on the line after the
explicit markup start.
"""],
["""\
.. A comment.
.. Another.
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment.
<comment xml:space="preserve">
Another.
<paragraph>
Paragraph.
"""],
["""\
.. A comment
no blank line
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment
<system_message level="2" line="2" source="test data" type="WARNING">
<paragraph>
Explicit markup ends without a blank line; unexpected unindent.
<paragraph>
no blank line
<paragraph>
Paragraph.
"""],
["""\
.. A comment.
.. Another.
no blank line
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment.
<comment xml:space="preserve">
Another.
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Explicit markup ends without a blank line; unexpected unindent.
<paragraph>
no blank line
<paragraph>
Paragraph.
"""],
["""\
.. A comment::
Paragraph.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
A comment::
<paragraph>
Paragraph.
"""],
["""\
..
comment::
The extra newline before the comment text prevents
the parser from recognizing a directive.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
comment::
<paragraph>
The extra newline before the comment text prevents
the parser from recognizing a directive.
"""],
["""\
..
_comment: http://example.org
The extra newline before the comment text prevents
the parser from recognizing a hyperlink target.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
_comment: http://example.org
<paragraph>
The extra newline before the comment text prevents
the parser from recognizing a hyperlink target.
"""],
["""\
..
[comment] Not a citation.
The extra newline before the comment text prevents
the parser from recognizing a citation.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
[comment] Not a citation.
<paragraph>
The extra newline before the comment text prevents
the parser from recognizing a citation.
"""],
["""\
..
|comment| image:: bogus.png
The extra newline before the comment text prevents
the parser from recognizing a substitution definition.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
|comment| image:: bogus.png
<paragraph>
The extra newline before the comment text prevents
the parser from recognizing a substitution definition.
"""],
["""\
.. Next is an empty comment, which serves to end this comment and
prevents the following block quote being swallowed up.
..
A block quote.
""",
"""\
<document source="test data">
<comment xml:space="preserve">
Next is an empty comment, which serves to end this comment and
prevents the following block quote being swallowed up.
<comment xml:space="preserve">
<block_quote>
<paragraph>
A block quote.
"""],
["""\
term 1
definition 1
.. a comment
term 2
definition 2
""",
"""\
<document source="test data">
<definition_list>
<definition_list_item>
<term>
term 1
<definition>
<paragraph>
definition 1
<comment xml:space="preserve">
a comment
<definition_list_item>
<term>
term 2
<definition>
<paragraph>
definition 2
"""],
["""\
term 1
definition 1
.. a comment
term 2
definition 2
""",
"""\
<document source="test data">
<definition_list>
<definition_list_item>
<term>
term 1
<definition>
<paragraph>
definition 1
<comment xml:space="preserve">
a comment
<definition_list>
<definition_list_item>
<term>
term 2
<definition>
<paragraph>
definition 2
"""],
["""\
+ bullet paragraph 1
bullet paragraph 2
.. comment between bullet paragraphs 2 and 3
bullet paragraph 3
""",
"""\
<document source="test data">
<bullet_list bullet="+">
<list_item>
<paragraph>
bullet paragraph 1
<paragraph>
bullet paragraph 2
<comment xml:space="preserve">
comment between bullet paragraphs 2 and 3
<paragraph>
bullet paragraph 3
"""],
["""\
+ bullet paragraph 1
.. comment between bullet paragraphs 1 (leader) and 2
bullet paragraph 2
""",
"""\
<document source="test data">
<bullet_list bullet="+">
<list_item>
<paragraph>
bullet paragraph 1
<comment xml:space="preserve">
comment between bullet paragraphs 1 (leader) and 2
<paragraph>
bullet paragraph 2
"""],
["""\
+ bullet
.. trailing comment
""",
"""\
<document source="test data">
<bullet_list bullet="+">
<list_item>
<paragraph>
bullet
<comment xml:space="preserve">
trailing comment
"""],
]
if __name__ == '__main__':
unittest.main()
|