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
|
import unittest
from mistletoe import block_token, span_token
from mistletoe.block_token import Document
from mistletoe.markdown_renderer import MarkdownRenderer
class TestMarkdownRenderer(unittest.TestCase):
@staticmethod
def roundtrip(input, **rendererArgs):
"""Parses the given markdown input and renders it back to markdown again."""
with MarkdownRenderer(**rendererArgs) as renderer:
return renderer.render(Document(input))
def test_empty_document(self):
input = []
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_paragraphs_and_blank_lines(self):
input = [
"Paragraph 1. Single line. Followed by two white-space-only lines.\n",
"\n",
"\n",
"Paragraph 2. Two\n",
"lines, no final line break.",
]
output = self.roundtrip(input)
# note: a line break is always added at the end of a paragraph.
self.assertEqual(output, "".join(input) + "\n")
def test_line_breaks(self):
input = [
"soft line break\n",
"hard line break (backslash)\\\n",
"another hard line break (double spaces) \n",
"yet another hard line break \n",
"that's all.\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_emphasized_and_strong(self):
input = ["*emphasized* __strong__ _**emphasized and strong**_\n"]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_strikethrough(self):
input = ["~~strikethrough~~\n"]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_escaped_chars(self):
input = ["\\*escaped, not emphasized\\*\n"]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_html_span(self):
input = ["so <p>hear ye</p><h1>\n"]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_code_span(self):
input = [
"a) `code span` b) ``trailing space, double apostrophes `` c) ` leading and trailing space `\n"
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_code_span_with_embedded_line_breaks(self):
input = [
"a `multi-line\n",
"code\n",
"span`.\n"
]
output = self.roundtrip(input)
expected = [
"a `multi-line code span`.\n"
]
self.assertEqual(output, "".join(expected))
def test_images_and_links(self):
input = [
"[a link](#url (title))\n",
"[another link](<url-in-angle-brackets> '*emphasized\n",
"title*')\n",
'![an \\[*image*\\], escapes and emphasis](#url "title")\n',
"<http://auto.link>\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_multiline_fragment(self):
input = [
"[a link](<url-in-angle-brackets> '*emphasized\n",
"title\n",
"spanning\n",
"many\n",
"lines*')\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_thematic_break(self):
input = [
" ** * ** * ** * **\n",
"followed by a paragraph of text\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_atx_headings(self):
input = [
"## atx *heading* ##\n",
"# another atx heading, without trailing hashes\n",
"###\n",
"^ empty atx heading\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_setext_headings(self):
input = [
"*setext*\n",
"heading!\n",
"===============\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_numbered_list(self):
input = [
" 22) *emphasized list item*\n",
" 96) \n",
" 128) here begins a nested list.\n",
" + apples\n",
" + bananas\n",
]
output = self.roundtrip(input)
expected = [
" 22) *emphasized list item*\n",
" 96) \n",
" 128) here begins a nested list.\n",
" + apples\n",
" + bananas\n",
]
self.assertEqual(output, "".join(expected))
def test_bulleted_list(self):
input = [
"* **test case**:\n",
" testing a link as the first item on a continuation line\n",
" [links must be indented][properly].\n",
"\n",
"[properly]: uri\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_list_item_margin_indentation_preserved(self):
# 0 to 4 spaces of indentation from the margin
input = [
"- 0 space: ok.\n",
" subsequent line.\n",
" - 1 space: ok.\n",
" subsequent line.\n",
" - 2 spaces: ok.\n",
" subsequent line.\n",
" - 3 spaces: ok.\n",
" subsequent line.\n",
" - 4 spaces: in the paragraph of the above list item.\n",
" subsequent line.\n",
]
output = self.roundtrip(input)
expected = [
"- 0 space: ok.\n",
" subsequent line.\n",
" - 1 space: ok.\n",
" subsequent line.\n",
" - 2 spaces: ok.\n",
" subsequent line.\n",
# note: we still always normalize the indentation of all list item lines:
" - 3 spaces: ok.\n",
" subsequent line.\n",
" - 4 spaces: in the paragraph of the above list item.\n",
" subsequent line.\n",
]
self.assertEqual(output, "".join(expected))
def test_list_item_margin_indentation_normalized(self):
# 0 to 4 spaces of indentation from the margin
input = [
"- 0 space: ok.\n",
" subsequent line.\n",
" - 1 space: ok.\n",
" subsequent line.\n",
" - 2 spaces: ok.\n",
" subsequent line.\n",
" - 3 spaces: ok.\n",
" subsequent line.\n",
" - 4 spaces: in the paragraph of the above list item.\n",
" subsequent line.\n",
]
output = self.roundtrip(input, normalize_whitespace=True)
expected = [
"- 0 space: ok.\n",
" subsequent line.\n",
"- 1 space: ok.\n",
" subsequent line.\n",
"- 2 spaces: ok.\n",
" subsequent line.\n",
"- 3 spaces: ok.\n",
" subsequent line.\n",
" - 4 spaces: in the paragraph of the above list item.\n",
" subsequent line.\n",
]
self.assertEqual(output, "".join(expected))
def test_list_item_indentation_after_leader_preserved(self):
# leaders followed by 1 to 5 spaces
input = [
"- 1 space: ok.\n",
" subsequent line.\n",
"- 2 spaces: ok.\n",
" subsequent line.\n",
"- 3 spaces: ok.\n",
" subsequent line.\n",
"- 4 spaces: ok.\n",
" subsequent line.\n",
"- 5 spaces: list item starting with indented code.\n",
" subsequent line.\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_list_item_indentation_after_leader_normalized(self):
# leaders followed by 1 to 5 spaces
input = [
"- 1 space: ok.\n",
" subsequent line.\n",
"- 2 spaces: ok.\n",
" subsequent line.\n",
"- 3 spaces: ok.\n",
" subsequent line.\n",
"- 4 spaces: ok.\n",
" subsequent line.\n",
"- 5 spaces: list item starting with indented code.\n",
" subsequent line.\n",
]
output = self.roundtrip(input, normalize_whitespace=True)
expected = [
"- 1 space: ok.\n",
" subsequent line.\n",
"- 2 spaces: ok.\n",
" subsequent line.\n",
"- 3 spaces: ok.\n",
" subsequent line.\n",
"- 4 spaces: ok.\n",
" subsequent line.\n",
"- 5 spaces: list item starting with indented code.\n",
" subsequent line.\n",
]
self.assertEqual(output, "".join(expected))
def test_code_blocks(self):
input = [
" this is an indented code block\n",
" on two lines \n",
" with some extra whitespace here and there, to be preserved \n",
" just as it is.\n",
"```\n",
"now for a fenced code block \n",
" where indentation is also preserved. as are the double spaces at the end of this line: \n",
"```\n",
" ~~~this is an info string: behold the fenced code block with tildes!\n",
" *tildes are great*\n",
" ~~~\n",
"1. a list item with an embedded\n",
"\n",
" indented code block.\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_blank_lines_following_code_block(self):
input = [
" code block\n",
"\n",
"paragraph.\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_html_block(self):
input = [
"<h1>some text <img src='https://cdn.rawgit.com/' align='right'></h1>\n",
"<br>\n",
"\n",
"+ <h1>html block embedded in list <img src='https://cdn.rawgit.com/' align='right'></h1>\n",
" <br>\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_block_quote(self):
input = [
"> a block quote\n",
"> > and a nested block quote\n",
"> 1. > and finally, a list with a nested block quote\n",
"> > which continues on a second line.\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_link_reference_definition(self):
input = [
"[label]: https://domain.com\n",
"\n",
"paragraph [with a link][label-2], etc, etc.\n",
"and [a *second* link][label] as well\n",
"shortcut [label] & collapsed [label][]\n",
"\n",
"[label-2]: <https://libraries.io/> 'title\n",
"with line break'\n",
"[label-not-referred-to]: https://foo (title)\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_table(self):
input = [
"| Emoji | Description |\n",
"| :---: | ------------------------- |\n",
"| 📚 | Update documentation. |\n",
"| 🐎 | Performance improvements. |\n",
"etc, etc\n",
]
output = self.roundtrip(input)
self.assertEqual(output, "".join(input))
def test_table_with_varying_column_counts(self):
input = [
" | header | x | \n",
" | --- | ---: | \n",
" | . | Performance improvements. | an extra column | \n",
"etc, etc\n",
]
output = self.roundtrip(input)
expected = [
"| header | x | |\n",
"| ------ | ------------------------: | --------------- |\n",
"| . | Performance improvements. | an extra column |\n",
"etc, etc\n",
]
self.assertEqual(output, "".join(expected))
def test_table_with_narrow_column(self):
input = [
"| xyz | ? |\n",
"| --- | - |\n",
"| a | p |\n",
"| b | q |\n",
]
output = self.roundtrip(input)
expected = [
"| xyz | ? |\n",
"| --- | --- |\n",
"| a | p |\n",
"| b | q |\n",
]
self.assertEqual(output, "".join(expected))
def test_direct_rendering_of_block_token(self):
input = [
"Line 1\n",
"Line 2\n",
]
paragraph = block_token.Paragraph(input)
with MarkdownRenderer() as renderer:
lines = renderer.render(paragraph)
assert lines == "".join(input)
def test_direct_rendering_of_span_token(self):
input = "some text"
raw_text = span_token.RawText(input)
with MarkdownRenderer() as renderer:
lines = renderer.render(raw_text)
assert lines == input + "\n"
class TestMarkdownFormatting(unittest.TestCase):
def test_wordwrap_plain_paragraph(self):
with MarkdownRenderer() as renderer:
# given a paragraph with only plain text and soft line breaks
paragraph = block_token.Paragraph(
[
"A \n",
"short paragraph \n",
" without any \n",
"long words \n",
"or hard line breaks.\n",
]
)
# when reflowing with the max line length set medium long
renderer.max_line_length = 30
lines = renderer.render(paragraph)
# then the content is reflowed accordingly
assert lines == (
"A short paragraph without any\n"
"long words or hard line\n"
"breaks.\n"
)
# when reflowing with the max line length set lower than the longest word: "paragraph", 9 chars
renderer.max_line_length = 8
lines = renderer.render(paragraph)
# then the content is reflowed so that the max line length is only exceeded for long words
assert lines == (
"A short\n"
"paragraph\n"
"without\n"
"any long\n"
"words or\n"
"hard\n"
"line\n"
"breaks.\n"
)
def test_wordwrap_paragraph_with_emphasized_words(self):
with MarkdownRenderer() as renderer:
# given a paragraph with emphasized words
paragraph = block_token.Paragraph(
["*emphasized* _nested *emphasis* too_\n"]
)
# when reflowing with the max line length set very short
renderer.max_line_length = 1
lines = renderer.render(paragraph)
# then the content is reflowed to make the lines as short as possible (but not shorter).
assert lines == (
"*emphasized*\n"
"_nested\n"
"*emphasis*\n"
"too_\n"
)
def test_wordwrap_paragraph_with_inline_code(self):
with MarkdownRenderer() as renderer:
# given a paragraph with inline code
paragraph = block_token.Paragraph(
[
"`inline code` and\n",
"`` inline with\n",
"line break ``\n",
]
)
# when reflowing with the max line length set very short
renderer.max_line_length = 1
lines = renderer.render(paragraph)
# then the content is reflowed to make the lines as short as possible (but not shorter).
# line breaks within the inline code are NOT preserved.
# however, padding at the end of the inline code may not be word wrapped.
assert lines == (
"`inline\n"
"code`\n"
"and\n"
"`` inline\n"
"with\n"
"line\n"
"break ``\n"
)
def test_wordwrap_paragraph_with_hard_line_breaks(self):
with MarkdownRenderer() as renderer:
# given a paragraph with hard line breaks
paragraph = block_token.Paragraph(
[
"A short paragraph \n",
" without any\\\n",
"very long\n",
"words.\n",
]
)
# when reflowing with the max line length set to normal
renderer.max_line_length = 80
lines = renderer.render(paragraph)
# then the content is reflowed with hard line breaks preserved
assert lines == (
"A short paragraph \n"
"without any\\\n"
"very long words.\n"
)
def test_wordwrap_paragraph_with_link(self):
with MarkdownRenderer() as renderer:
# given a paragraph with a link
paragraph = block_token.Paragraph(
[
"A paragraph\n",
"containing [a link](<link destination with non-breaking spaces> 'which\n",
"has a rather long title\n",
"spanning multiple lines.')\n",
]
)
# when reflowing with the max line length set very short
renderer.max_line_length = 1
lines = renderer.render(paragraph)
# then the content is reflowed to make the lines as short as possible (but not shorter)
assert lines == (
"A\n"
"paragraph\n"
"containing\n"
"[a\n"
"link](<link destination with non-breaking spaces>\n"
"'which\n"
"has\n"
"a\n"
"rather\n"
"long\n"
"title\n"
"spanning\n"
"multiple\n"
"lines.')\n"
)
def test_wordwrap_text_in_setext_heading(self):
with MarkdownRenderer() as renderer:
# given a paragraph with a setext heading
document = block_token.Document(
[
"A \n",
"setext heading \n",
" without any \n",
"long words \n",
"or hard line breaks.\n",
"=====\n",
]
)
# when reflowing with the max line length set medium long
renderer.max_line_length = 30
lines = renderer.render(document)
# then the content is reflowed accordingly
assert lines == (
"A setext heading without any\n"
"long words or hard line\n"
"breaks.\n"
"=====\n"
)
def test_wordwrap_text_in_link_reference_definition(self):
with MarkdownRenderer() as renderer:
# given some markdown with link reference definitions
document = block_token.Document(
[
"[This is\n",
" the *link label*.]:<a long, non-breakable link reference> 'title (with parens). new\n",
"lines allowed.'\n",
"[*]:url 'Another link reference\tdefinition'\n",
]
)
# when reflowing with the max line length set medium long
renderer.max_line_length = 30
lines = renderer.render(document)
# then the content is reflowed accordingly
assert lines == (
"[This is the *link label*.]:\n"
"<a long, non-breakable link reference>\n"
"'title (with parens). new\n"
"lines allowed.'\n"
"[*]: url 'Another link\n"
"reference definition'\n"
)
def test_wordwrap_paragraph_in_list(self):
with MarkdownRenderer() as renderer:
# given some markdown with a nested list
document = block_token.Document(
[
"1. List item\n",
"2. A second list item including:\n",
" * Nested list.\n",
" This is a continuation line\n",
]
)
# when reflowing with the max line length set medium long
renderer.max_line_length = 25
lines = renderer.render(document)
# then the content is reflowed accordingly
assert lines == (
"1. List item\n"
"2. A second list item\n"
" including:\n"
" * Nested list. This is\n"
" a continuation line\n"
)
def test_wordwrap_paragraph_in_block_quote(self):
with MarkdownRenderer() as renderer:
# given some markdown with nested block quotes
document = block_token.Document(
[
"> Devouring Time, blunt thou the lion's paws,\n",
"> And make the earth devour her own sweet brood;\n",
"> > When Dawn strides out to wake a dewy farm\n",
"> > Across green fields and yellow hills of hay\n",
]
)
# when reflowing with the max line length set medium long
renderer.max_line_length = 30
lines = renderer.render(document)
# then the content is reflowed accordingly
assert lines == (
"> Devouring Time, blunt thou\n"
"> the lion's paws, And make\n"
"> the earth devour her own\n"
"> sweet brood;\n"
"> > When Dawn strides out to\n"
"> > wake a dewy farm Across\n"
"> > green fields and yellow\n"
"> > hills of hay\n"
)
def test_wordwrap_tables(self):
with MarkdownRenderer(max_line_length=30) as renderer:
# given a markdown table
input = [
"| header | x | |\n",
"| ------ | ------------------------: | --------------- |\n",
"| . | Performance improvements. | an extra column |\n",
]
document = block_token.Document(input)
# when reflowing
lines = renderer.render(document)
# then the table is rendered without any word wrapping
assert lines == "".join(input)
|