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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
|
#! /usr/bin/env python3
# $Id: test_docinfo.py 10039 2025-03-08 18:53:20Z aa-turner $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for docutils.transforms.frontmatter.DocInfo.
"""
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.rst import Parser
from docutils.transforms.frontmatter import DocInfo
from docutils.transforms.universal import FilterMessages, TestMessages
from docutils.utils import new_document
class TransformTestCase(unittest.TestCase):
maxDiff = None
settings = get_default_settings(Parser)
settings.warning_stream = ''
parser = Parser()
def check_output(self, samples, settings):
# yield (output, expected) for each test sample
for key, (transforms, cases) in samples.items():
for casenum, (case_input, case_expected) in enumerate(cases):
with self.subTest(id=f'samples[{key!r}][{casenum}]'):
document = new_document('test data', settings)
self.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)
# Filter INFOs with increased priority so that
# messages added by `TestMessages` are filtered, too:
document.transformer.add_transform(FilterMessages, 890)
document.transformer.apply_transforms()
self.assertEqual(case_expected, document.pformat())
def test_transforms(self):
self.check_output(totest, self.settings)
def test_transforms_de(self):
settings = self.settings.copy()
settings.language_code = 'de'
self.check_output(totest_de, settings)
def test_transforms_ru(self):
settings = self.settings.copy()
settings.language_code = 'ru'
self.check_output(totest_ru, settings)
totest = {}
totest_de = {}
totest_ru = {}
totest['bibliographic_field_lists'] = ((DocInfo,), [
["""\
.. Bibliographic element extraction.
:Abstract:
There can only be one abstract.
It is automatically moved to the end of the other bibliographic elements.
:Author: E. *Xample*
:Version: 1
:Date: 2001-08-11
:Parameter i: integer
""",
"""\
<document source="test data">
<docinfo>
<author>
E. \n\
<emphasis>
Xample
<version>
1
<date>
2001-08-11
<field classes="parameter-i">
<field_name>
Parameter i
<field_body>
<paragraph>
integer
<topic classes="abstract">
<title>
Abstract
<paragraph>
There can only be one abstract.
<paragraph>
It is automatically moved to the end of the other bibliographic elements.
<comment xml:space="preserve">
Bibliographic element extraction.
"""],
["""\
.. Bibliographic element extraction.
:Abstract: Abstract 1.
:Author: Me
:Address: 123 My Street
Example, EX
:Contact: me@my.org
:Version: 1
:Abstract: Abstract 2 (should generate a warning).
:Date: 2001-08-11
:Parameter i: integer
""",
"""\
<document source="test data">
<docinfo>
<author>
Me
<address xml:space="preserve">
123 My Street
Example, EX
<contact>
<reference refuri="mailto:me@my.org">
me@my.org
<version>
1
<field classes="abstract">
<field_name>
Abstract
<field_body>
<paragraph>
Abstract 2 (should generate a warning).
<system_message level="2" line="9" source="test data" type="WARNING">
<paragraph>
There can only be one "Abstract" field.
<date>
2001-08-11
<field classes="parameter-i">
<field_name>
Parameter i
<field_body>
<paragraph>
integer
<topic classes="abstract">
<title>
Abstract
<paragraph>
Abstract 1.
<comment xml:space="preserve">
Bibliographic element extraction.
"""],
["""\
:Author: - must be a paragraph
:Status: a *simple* paragraph
:Date: But only one
paragraph.
:Version:
.. and not empty either
""",
"""\
<document source="test data">
<docinfo>
<field classes="author">
<field_name>
Author
<field_body>
<bullet_list bullet="-">
<list_item>
<paragraph>
must be a paragraph
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Bibliographic field "Author"
must contain a single <paragraph>, not a <bullet_list>.
<status>
a \n\
<emphasis>
simple
paragraph
<field classes="date">
<field_name>
Date
<field_body>
<paragraph>
But only one
<paragraph>
paragraph.
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Bibliographic field "Date"
must contain a single <paragraph>, not [<paragraph>, <paragraph>].
<field classes="version">
<field_name>
Version
<field_body>
<system_message level="2" line="6" source="test data" type="WARNING">
<paragraph>
Cannot extract empty bibliographic field "Version".
<comment xml:space="preserve">
and not empty either
"""],
["""\
:Authors: Me, Myself, **I**
:Authors: PacMan; Ms. PacMan; PacMan, Jr.
:Authors:
Here
There
*Everywhere*
:Authors: - First
- Second
- Third
""",
"""\
<document source="test data">
<docinfo>
<authors>
<author>
Me
<author>
Myself
<author>
I
<authors>
<author>
PacMan
<author>
Ms. PacMan
<author>
PacMan, Jr.
<authors>
<author>
Here
<author>
There
<author>
<emphasis>
Everywhere
<authors>
<author>
First
<author>
Second
<author>
Third
"""],
["""\
:Authors: Only One
:Authors: One, Only;
""",
"""\
<document source="test data">
<docinfo>
<authors>
<author>
Only One
<authors>
<author>
One, Only
"""],
[r""":Authors: Me\, Myself; **I**
:Authors: Pac\;Man\\; Ms. Pac\Man; Pac\ Man, Jr.
:Authors:
Here
The\re
*Every\ where*
:Authors: - First\\
- Se\ cond
- Thir\d
""",
"""\
<document source="test data">
<docinfo>
<authors>
<author>
Me, Myself
<author>
I
<authors>
<author>
Pac;Man\\
<author>
Ms. PacMan
<author>
PacMan, Jr.
<authors>
<author>
Here
<author>
There
<author>
<emphasis>
Everywhere
<authors>
<author>
First\\
<author>
Second
<author>
Third
"""],
["""\
:Authors:
:Authors: A. Einstein
B. Shaw
:Authors:
-
-
:Authors:
- One
Two
:Authors:
- One
Two
""",
"""\
<document source="test data">
<docinfo>
<field classes="authors">
<field_name>
Authors
<field_body>
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Cannot extract empty bibliographic field "Authors".
<field classes="authors">
<field_name>
Authors
<field_body>
<enumerated_list enumtype="upperalpha" prefix="" suffix=".">
<list_item>
<paragraph>
Einstein
<list_item>
<paragraph>
Shaw
<system_message level="2" line="3" source="test data" type="WARNING">
<paragraph>
Cannot extract "Authors" from bibliographic field:
Bibliographic field "Authors" must contain either
a single paragraph (with author names separated by a character from the set ";,"),
multiple paragraphs (one per author),
or a bullet list with one author name per item.
Note: Leading initials can cause (mis)recognizing names as enumerated list.
<field classes="authors">
<field_name>
Authors
<field_body>
<bullet_list bullet="-">
<list_item>
<list_item>
<system_message level="2" line="6" source="test data" type="WARNING">
<paragraph>
Cannot extract "Authors" from bibliographic field:
Bibliographic field "Authors" must contain either
a single paragraph (with author names separated by a character from the set ";,"),
multiple paragraphs (one per author),
or a bullet list with one author name per item.
Note: Leading initials can cause (mis)recognizing names as enumerated list.
<field classes="authors">
<field_name>
Authors
<field_body>
<bullet_list bullet="-">
<list_item>
<paragraph>
One
<paragraph>
Two
<system_message level="2" line="10" source="test data" type="WARNING">
<paragraph>
Cannot extract "Authors" from bibliographic field:
Bibliographic field "Authors" must contain either
a single paragraph (with author names separated by a character from the set ";,"),
multiple paragraphs (one per author),
or a bullet list with one author name per item.
Note: Leading initials can cause (mis)recognizing names as enumerated list.
<field classes="authors">
<field_name>
Authors
<field_body>
<bullet_list bullet="-">
<list_item>
<paragraph>
One
<paragraph>
Two
<system_message level="2" line="15" source="test data" type="WARNING">
<paragraph>
Cannot extract "Authors" from bibliographic field:
Bibliographic field "Authors" must contain either
a single paragraph (with author names separated by a character from the set ";,"),
multiple paragraphs (one per author),
or a bullet list with one author name per item.
Note: Leading initials can cause (mis)recognizing names as enumerated list.
"""],
["""\
.. RCS keyword extraction.
:Status: (some text) $""" + """RCSfile: test_docinfo.py,v $ (more text)
:Date: (some text) $""" + """Date: 2002/10/08 01:34:23 $ (more text)
:Date: (some text) $""" + """Date: 2005-03-26T16:21:28.693201Z $ (more text)
:Version: (some text) $""" + """Revision: 1.1 $ (more text)
""", # NoQA: ISC003
"""\
<document source="test data">
<docinfo>
<status>
(some text) test_docinfo.py (more text)
<date>
(some text) 2002-10-08 (more text)
<date>
(some text) 2005-03-26 (more text)
<version>
(some text) 1.1 (more text)
<comment xml:space="preserve">
RCS keyword extraction.
"""],
])
totest_de['bibliographic_field_lists_de'] = ((DocInfo,), [
["""\
.. Bibliographic element extraction for a German document.
:Zusammenfassung: Abstract 1.
:Autor: Me
:Adresse: 123 My Street
Example, EX
:Kontakt: me@my.org
:Version: 1
:Datum: 2001-08-11
:Parameter i: integer
""",
"""\
<document source="test data">
<docinfo>
<author>
Me
<address xml:space="preserve">
123 My Street
Example, EX
<contact>
<reference refuri="mailto:me@my.org">
me@my.org
<version>
1
<date>
2001-08-11
<field classes="parameter-i">
<field_name>
Parameter i
<field_body>
<paragraph>
integer
<topic classes="abstract">
<title>
Zusammenfassung
<paragraph>
Abstract 1.
<comment xml:space="preserve">
Bibliographic element extraction for a German document.
"""]
])
totest_ru['bibliographic_field_lists_ru'] = ((DocInfo,), [
["""\
.. Bibliographic element extraction for a Russian document.
:аннотация: Abstract 1.
:автор: Me
:адрес: 123 My Street
Example, EX
:контакт: me@my.org
:версия: 1
:дата: 2001-08-11
:Parameter i: integer
""",
"""\
<document source="test data">
<docinfo>
<author>
Me
<address xml:space="preserve">
123 My Street
Example, EX
<contact>
<reference refuri="mailto:me@my.org">
me@my.org
<version>
1
<date>
2001-08-11
<field classes="parameter-i">
<field_name>
Parameter i
<field_body>
<paragraph>
integer
<topic classes="abstract">
<title>
Аннотация
<paragraph>
Abstract 1.
<comment xml:space="preserve">
Bibliographic element extraction for a Russian document.
"""]
])
if __name__ == '__main__':
unittest.main()
|