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 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
|
#! /usr/bin/env python3
# $Id: test_character_level_inline_markup.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 inline markup in docutils/parsers/rst/states.py
with the "character-level-inline-markup" setting.
Experimental.
"""
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 = ''
settings.character_level_inline_markup = True
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['emphasis'] = [
[r"""some punctuation is allowed around inline markup, e.g.
/*emphasis*/, -*emphasis*-, and :*emphasis*: (delimiters),
(*emphasis*), [*emphasis*], <*emphasis*>, {*emphasis*} (open/close pairs)
*emphasis*., *emphasis*,, *emphasis*!, and *emphasis*\ (closing delimiters),
With simple-inline-markup also
)*emphasis*(, ]*emphasis*[, >*emphasis*>, }*emphasis*{ (close/open pairs),
x*2* or 2*x* (alphanumeric char before),
but not
(*), [*], '*' or '"*"' ("quoted" start-string),
\*args or * (escaped; whitespace behind start-string),
or *the\* *stars\* *inside* (escaped; whitespace before end-string).
However, '*args' triggers a warning.
Also *this**.
""",
"""\
<document source="test data">
<paragraph>
some punctuation is allowed around inline markup, e.g.
/
<emphasis>
emphasis
/, -
<emphasis>
emphasis
-, and :
<emphasis>
emphasis
: (delimiters),
(
<emphasis>
emphasis
), [
<emphasis>
emphasis
], <
<emphasis>
emphasis
>, {
<emphasis>
emphasis
} (open/close pairs)
<emphasis>
emphasis
., \n\
<emphasis>
emphasis
,, \n\
<emphasis>
emphasis
!, and \n\
<emphasis>
emphasis
(closing delimiters),
<paragraph>
With simple-inline-markup also
)
<emphasis>
emphasis
(, ]
<emphasis>
emphasis
[, >
<emphasis>
emphasis
>, }
<emphasis>
emphasis
{ (close/open pairs),
x
<emphasis>
2
or 2
<emphasis>
x
(alphanumeric char before),
<paragraph>
but not
(*), [*], '*' or '"*"' ("quoted" start-string),
*args or * (escaped; whitespace behind start-string),
or \n\
<emphasis>
the* *stars* *inside
(escaped; whitespace before end-string).
<paragraph>
However, '
<problematic ids="problematic-1" refid="system-message-1">
*
args' triggers a warning.
<system_message backrefs="problematic-1" ids="system-message-1" level="2" line="15" source="test data" type="WARNING">
<paragraph>
Inline emphasis start-string without end-string.
<paragraph>
Also \n\
<emphasis>
this
<problematic ids="problematic-2" refid="system-message-2">
*
.
<system_message backrefs="problematic-2" ids="system-message-2" level="2" line="17" source="test data" type="WARNING">
<paragraph>
Inline emphasis start-string without end-string.
"""],
[r"""
Emphasized asterisk: *\**
Emphasized double asterisk: *\*\** (requires two escape chars).
""",
"""\
<document source="test data">
<paragraph>
Emphasized asterisk: \n\
<emphasis>
*
<paragraph>
Emphasized double asterisk: \n\
<emphasis>
**
(requires two escape chars).
"""],
]
totest['strong'] = [
[r"""
(**strong**) but not (**) or '(** '
However, '**kwargs' and x**2 are recognized as strong markup
and \**kwargs or ** as emphasized.
""",
"""\
<document source="test data">
<paragraph>
(
<strong>
strong
) but not (**) or '(** '
<paragraph>
However, '
<strong>
kwargs' and x
2 are recognized as strong markup
and *
<emphasis>
kwargs or *
as emphasized.
"""],
["""\
Strong asterisk: **\\***
and
strong double asterisk: **\\*\\***
require escaping with simple-inline-markup.
""",
"""\
<document source="test data">
<paragraph>
Strong asterisk: \n\
<strong>
*
\n\
and
strong double asterisk: \n\
<strong>
**
\n\
require escaping with simple-inline-markup.
"""],
]
totest['literal'] = [
["""\
With simple-inline-markup, this is ```interpreted text``` in backquotes!
""",
"""\
<document source="test data">
<paragraph>
With simple-inline-markup, this is \n\
<literal>
`interpreted text
` in backquotes!
"""],
["""\
``literal without closing backquotes
""",
"""\
<document source="test data">
<paragraph>
<problematic ids="problematic-1" refid="system-message-1">
``
literal without closing backquotes
<system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
<paragraph>
Inline literal start-string without end-string.
"""],
[r"""
Python ``list``s use square bracket syntax.
""",
"""\
<document source="test data">
<paragraph>
Python \n\
<literal>
list
s use square bracket syntax.
"""],
]
totest['references'] = [
["""\
ref_, r_, r_e-f_, -ref_, and anonymousref__,
beware of _ref_ or __attr__ or object.__attr__
""",
"""\
<document source="test data">
<paragraph>
<reference name="ref" refname="ref">
ref
, \n\
<reference name="r" refname="r">
r
, \n\
<reference name="r_e-f" refname="r_e-f">
r_e-f
, -
<reference name="ref" refname="ref">
ref
, and \n\
<reference anonymous="1" name="anonymousref">
anonymousref
,
beware of _
<reference name="ref" refname="ref">
ref
or __
<reference anonymous="1" name="attr">
attr
or object.__
<reference anonymous="1" name="attr">
attr
"""],
]
totest['embedded_uris'] = [
[r"""
Escape chars in URIs:
`<reference\:1>`_
`<anonymous\\call>`__
`<anonymous\_call>`__
""",
"""\
<document source="test data">
<paragraph>
Escape chars in URIs:
<paragraph>
<reference name="reference:1" refuri="reference:1">
reference:1
<target ids="reference-1" names="reference:1" refuri="reference:1">
<paragraph>
<reference name="anonymous\\call" refuri="anonymous\\call">
anonymous\\call
<paragraph>
<reference name="anonymous_call" refuri="anonymous_call">
anonymous_call
"""],
]
totest['inline_targets'] = [
["""\
This isn't a _target; targets require backquotes.
With simple-inline-markup, _`this`_ is a a target followed by an
underscore.
""",
"""\
<document source="test data">
<paragraph>
This isn't a _target; targets require backquotes.
<paragraph>
With simple-inline-markup, \n\
<target ids="this" names="this">
this
_ is a a target followed by an
underscore.
"""],
]
totest['footnote_reference'] = [
["""\
Adjacent footnote refs are possible with simple-inline-markup:
[*]_[#label]_ [#]_[2]_ [1]_[*]_
.. [#] test1
.. [*] test2
""",
"""\
<document source="test data">
<paragraph>
Adjacent footnote refs are possible with simple-inline-markup:
<footnote_reference auto="*" ids="footnote-reference-1">
<footnote_reference auto="1" ids="footnote-reference-2" refname="label">
\n\
<footnote_reference auto="1" ids="footnote-reference-3">
<footnote_reference ids="footnote-reference-4" refname="2">
2
\n\
<footnote_reference ids="footnote-reference-5" refname="1">
1
<footnote_reference auto="*" ids="footnote-reference-6">
<footnote auto="1" ids="footnote-1">
<paragraph>
test1
<footnote auto="*" ids="footnote-2">
<paragraph>
test2
"""],
]
totest['citation_reference'] = [
["""\
Adjacent citation refs are possible with simple-inline-markup:
[citation]_[CIT1]_
""",
"""\
<document source="test data">
<paragraph>
Adjacent citation refs are possible with simple-inline-markup:
<citation_reference ids="citation-reference-1" refname="citation">
citation
<citation_reference ids="citation-reference-2" refname="cit1">
CIT1
"""],
]
totest['substitution_references'] = [
["""\
|sub|ref
""",
"""\
<document source="test data">
<paragraph>
<substitution_reference refname="sub">
sub
ref
"""],
]
totest['standalone_hyperlink'] = [
[r"""
Valid URLs with escaped markup characters:
http://example.com/\*content\*/whatever
Invalid with the simple-inline-markup setting:
http://example.com/\*content*/whatever
http://example.com/rST_for_all.html
""",
"""\
<document source="test data">
<paragraph>
Valid URLs with escaped markup characters:
<paragraph>
<reference refuri="http://example.com/*content*/whatever">
http://example.com/*content*/whatever
<paragraph>
Invalid with the simple-inline-markup setting:
<paragraph>
<reference refuri="http://example.com/*content">
http://example.com/*content
<problematic ids="problematic-1" refid="system-message-1">
*
/whatever
<reference refuri="http://example.com/">
http://example.com/
<reference name="rST_for" refname="rst_for">
rST_for
all.html
<system_message backrefs="problematic-1" ids="system-message-1" level="2" line="8" source="test data" type="WARNING">
<paragraph>
Inline emphasis start-string without end-string.
"""],
]
totest['markup_recognition_rules'] = [
["""\
__This__ is an anonymous reference with simple-inline-markup.
""",
"""\
<document source="test data">
<paragraph>
__
<reference anonymous="1" name="This">
This
is an anonymous reference with simple-inline-markup.
"""],
[r"""
Character-level m*a***r**``k``\ `u`:title:\p
with backslash-escaped whitespace, including new\
lines.
""",
"""\
<document source="test data">
<paragraph>
Character-level m
<emphasis>
a
<strong>
r
<literal>
k
<title_reference>
u
p
with backslash-escaped whitespace, including newlines.
"""],
["""\
text-*separated*\u2010*by*\u2011*various*\u2012*dashes*\u2013*and*\u2014*hyphens*.
\u00bf*punctuation*? \u00a1*examples*!\xa0*no-break-space*\xa0.
""",
"""\
<document source="test data">
<paragraph>
text-
<emphasis>
separated
\u2010
<emphasis>
by
\u2011
<emphasis>
various
\u2012
<emphasis>
dashes
\u2013
<emphasis>
and
\u2014
<emphasis>
hyphens
.
\xbf
<emphasis>
punctuation
? \xa1
<emphasis>
examples
!\xa0
<emphasis>
no-break-space
\xa0.
"""],
# Whitespace characters:
["""\
inline markup surrounded by various whitespace characters:
*newline*
or *space* or one of
\xa0*NO-BREAK SPACE*\xa0,
\u1680*OGHAM SPACE MARK*\u1680,
\u180e*MONGOLIAN VOWEL SEPARATOR*\u180e,
\u2000*EN QUAD*\u2000,
\u2001*EM QUAD*\u2001,
\u2002*EN SPACE*\u2002,
\u2003*EM SPACE*\u2003,
\u2004*THREE-PER-EM SPACE*\u2004,
\u2005*FOUR-PER-EM SPACE*\u2005,
\u2006*SIX-PER-EM SPACE*\u2006,
\u2007*FIGURE SPACE*\u2007,
\u2008*PUNCTUATION SPACE*\u2008,
\u2009*THIN SPACE*\u2009,
\u200a*HAIR SPACE*\u200a,
\u202f*NARROW NO-BREAK SPACE*\u202f,
\u205f*MEDIUM MATHEMATICAL SPACE*\u205f,
\u3000*IDEOGRAPHIC SPACE*\u3000,
\u2028*LINE SEPARATOR*\u2028
""",
"""\
<document source="test data">
<paragraph>
inline markup surrounded by various whitespace characters:
<emphasis>
newline
\n\
or \n\
<emphasis>
space
or one of
\xa0
<emphasis>
NO-BREAK SPACE
\xa0,
\u1680
<emphasis>
OGHAM SPACE MARK
\u1680,
\u180e
<emphasis>
MONGOLIAN VOWEL SEPARATOR
\u180e,
\u2000
<emphasis>
EN QUAD
\u2000,
\u2001
<emphasis>
EM QUAD
\u2001,
\u2002
<emphasis>
EN SPACE
\u2002,
\u2003
<emphasis>
EM SPACE
\u2003,
\u2004
<emphasis>
THREE-PER-EM SPACE
\u2004,
\u2005
<emphasis>
FOUR-PER-EM SPACE
\u2005,
\u2006
<emphasis>
SIX-PER-EM SPACE
\u2006,
\u2007
<emphasis>
FIGURE SPACE
\u2007,
\u2008
<emphasis>
PUNCTUATION SPACE
\u2008,
\u2009
<emphasis>
THIN SPACE
\u2009,
\u200a
<emphasis>
HAIR SPACE
\u200a,
\u202f
<emphasis>
NARROW NO-BREAK SPACE
\u202f,
\u205f
<emphasis>
MEDIUM MATHEMATICAL SPACE
\u205f,
\u3000
<emphasis>
IDEOGRAPHIC SPACE
\u3000,
<paragraph>
<emphasis>
LINE SEPARATOR
"""],
["""\
no inline markup due to whitespace inside and behind: *
newline
*
* space * or one of
*\xa0NO-BREAK SPACE\xa0*
*\u1680OGHAM SPACE MARK\u1680*
*\u2000EN QUAD\u2000*
*\u2001EM QUAD\u2001*
*\u2002EN SPACE\u2002*
*\u2003EM SPACE\u2003*
*\u2004THREE-PER-EM SPACE\u2004*
*\u2005FOUR-PER-EM SPACE\u2005*
*\u2006SIX-PER-EM SPACE\u2006*
*\u2007FIGURE SPACE\u2007*
*\u2008PUNCTUATION SPACE\u2008*
*\u2009THIN SPACE\u2009*
*\u200aHAIR SPACE\u200a*
*\u202fNARROW NO-BREAK SPACE\u202f*
*\u205fMEDIUM MATHEMATICAL SPACE\u205f*
*\u3000IDEOGRAPHIC SPACE\u3000*
*\u2028LINE SEPARATOR\u2028*
""",
"""\
<document source="test data">
<paragraph>
no inline markup due to whitespace inside and behind: *
newline
*
* space * or one of
*\xa0NO-BREAK SPACE\xa0*
*\u1680OGHAM SPACE MARK\u1680*
*\u2000EN QUAD\u2000*
*\u2001EM QUAD\u2001*
*\u2002EN SPACE\u2002*
*\u2003EM SPACE\u2003*
*\u2004THREE-PER-EM SPACE\u2004*
*\u2005FOUR-PER-EM SPACE\u2005*
*\u2006SIX-PER-EM SPACE\u2006*
*\u2007FIGURE SPACE\u2007*
*\u2008PUNCTUATION SPACE\u2008*
*\u2009THIN SPACE\u2009*
*\u200aHAIR SPACE\u200a*
*\u202fNARROW NO-BREAK SPACE\u202f*
*\u205fMEDIUM MATHEMATICAL SPACE\u205f*
*\u3000IDEOGRAPHIC SPACE\u3000*
*
LINE SEPARATOR
*
"""],
# « * » ‹ * › « * » ‹ * › « * » ‹ * › French,
["""\
"Quoted" markup start-string (matched openers & closers) -> no markup:
'*' "*" (*) <*> [*] {*}
⁅*⁆
Some international quoting styles:
‘*’ “*” English, ...,
„*“ ‚*‘ »*« ›*‹ German, Czech, ...,
„*” «*» Romanian,
“*„ ‘*‚ Greek,
「*」 『*』traditional Chinese,
”*” ’*’ »*» ›*› Swedish, Finnish,
„*” ‚*’ Polish,
„*” »*« ’*’ Hungarian,
But this is „*’ emphasized »*‹.
""",
"""\
<document source="test data">
<paragraph>
"Quoted" markup start-string (matched openers & closers) -> no markup:
<paragraph>
'*' "*" (*) <*> [*] {*}
⁅*⁆
<paragraph>
Some international quoting styles:
‘*’ “*” English, ...,
„*“ ‚*‘ »*« ›*‹ German, Czech, ...,
„*” «*» Romanian,
“*„ ‘*‚ Greek,
「*」 『*』traditional Chinese,
”*” ’*’ »*» ›*› Swedish, Finnish,
„*” ‚*’ Polish,
„*” »*« ’*’ Hungarian,
<paragraph>
But this is „
<emphasis>
’ emphasized »
‹.
"""],
]
if __name__ == '__main__':
unittest.main()
|