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
|
"""Test cases for Highlight."""
from .. import util
import pymdownx.arithmatex as arithmatex
from pymdownx.inlinehilite import InlineHiliteException
import warnings
def _format(src, language, class_name, md):
"""Inline math formatter."""
return '<span class="lang-{} {}">{}</span>'.format(language, class_name, src)
def _default_format(src, language, class_name, md):
"""Inline math formatter."""
return '<custom class="lang-{} {}">{}</custom>'.format(language, class_name, src)
def _format_exploder(src, language, class_name, md):
"""Inline math formatter."""
raise Exception('Boom!')
def _format_exploder_fail(src, language, class_name, md):
"""Inline math formatter."""
raise InlineHiliteException('Boom!')
class TestInlineHilite(util.MdCase):
"""Test general cases for inline highlight."""
extension = [
'markdown.extensions.attr_list',
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'style_plain_text': True,
'css_class': 'inlinehilite'
}
}
def test_language(self):
"""Test language handling."""
# Test #! original syntax
self.check_markdown(
r'`#!python import module`.',
r'<p><code class="inlinehilite"><span class="kn">import</span> <span class="nn">module</span></code>.</p>'
)
# Test ::: syntax
self.check_markdown(
r'`:::python import module`.',
r'<p><code class="inlinehilite"><span class="kn">import</span> <span class="nn">module</span></code>.</p>'
)
# Test escaping language with space
self.check_markdown(
r'` #!python import module`.',
r'<p><code class="inlinehilite">#!python import module</code>.</p>'
)
# Test bad language
self.check_markdown(
r'`#!bad import module`.',
r'<p><code class="inlinehilite">import module</code>.</p>'
)
def test_escape(self):
"""Test backtick escape logic."""
self.check_markdown(
r'`Code`',
r'<p><code class="inlinehilite">Code</code></p>'
)
self.check_markdown(
r'\`Not code`',
r'<p>`Not code`</p>'
)
self.check_markdown(
r'\\`Code`',
r'<p>\<code class="inlinehilite">Code</code></p>'
)
self.check_markdown(
r'\\\`Not code`',
r'<p>\`Not code`</p>'
)
self.check_markdown(
r'\\\\`Code`',
r'<p>\\<code class="inlinehilite">Code</code></p>'
)
def test_attributes(self):
"""Test with attribute extension."""
self.check_markdown(
r'`#!python import module`{: .test}',
r'<p><code class="inlinehilite test">'
r'<span class="kn">import</span> <span class="nn">module</span>'
r'</code></p>'
)
class TestInlineHilitePlainText(util.MdCase):
"""Test inline highlight when not styling plain text."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'style_plain_text': False
}
}
def test_unstyled_plaintext(self):
"""Test unstyled plain text."""
self.check_markdown(
r'Lets test inline highlight no guessing and no text styling `import module`.',
r'<p>Lets test inline highlight no guessing and no text styling <code>import module</code>.</p>'
)
class TestInlineHiliteNoClass(util.MdCase):
"""Test with no class."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.highlight': {
'css_class': ''
}
}
def test_no_class(self):
"""Test with no class."""
self.check_markdown(
r'Lets test inline highlight no guessing and no text styling `#!python import module`.',
r'<p>Lets test inline highlight no guessing and no text styling <code><span class="kn">import</span> <span class="nn">module</span></code>.</p>' # noqa: E501
)
class TestInlineHiliteNoClassNoPygments(util.MdCase):
"""Test with no class and no Pygments."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.highlight': {
'css_class': '',
'use_pygments': False
}
}
def test_no_class_no_pygments(self):
"""Test with no class and no Pygments."""
self.check_markdown(
r'Lets test inline highlight no guessing and no text styling `#!python import module`.',
r'<p>Lets test inline highlight no guessing and no text styling <code class="language-python">import module</code>.</p>' # noqa: E501
)
class TestInlineHiliteNoPygments(util.MdCase):
"""Test inline highlight without Pygments."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.highlight': {
'use_pygments': False
},
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite'
}
}
def test_no_pygments(self):
"""Ensure proper behavior when disabling Pygments."""
self.check_markdown(
r'`#!python import module`.',
r'<p><code class="language-python inlinehilite">import module</code>.</p>'
)
class TestInlineHiliteGuess(util.MdCase):
"""Test inline highlight with guessing."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.highlight': {
'guess_lang': True
},
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'style_plain_text': True
}
}
def test_guessing(self):
"""Ensure guessing can be enabled."""
self.check_markdown(
r'`import module`.',
r'<p><code class="inlinehilite"><span class="kn">import</span><span class="w"> </span><span class="nn">module</span></code>.</p>' # noqa: E501
)
class TestInlineHiliteGuessInline(util.MdCase):
"""Test inline highlight with guessing set to be inline only."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
'pymdownx.superfences'
]
extension_configs = {
'pymdownx.highlight': {
'guess_lang': 'inline'
},
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'style_plain_text': True
}
}
def test_guessing_inline(self):
"""Ensure guessing can be enabled for inline only."""
self.check_markdown(
r'`import module`.',
r'<p><code class="inlinehilite"><span class="kn">import</span><span class="w"> </span><span class="nn">module</span></code>.</p>' # noqa: E501
)
def test_no_guessing_block(self):
"""Ensure block is not guessed when set as inline only."""
self.check_markdown(
r'''
```
<!DOCTYPE html>
<html>
<body>
<h1>My great test</h1>
<p>Thou shalt be re-educated through labour should this test ever fails.</p>
</body>
</html>
```
''',
r'''
<div class="highlight"><pre><span></span><code><!DOCTYPE html>
<html>
<body>
<h1>My great test</h1>
<p>Thou shalt be re-educated through labour should this test ever fails.</p>
</body>
</html>
</code></pre></div>
''',
True
)
class TestInlineHiliteCodeHilite(util.MdCase):
"""Test inline highlight with CodeHilite."""
extension = [
'markdown.extensions.codehilite',
'pymdownx.inlinehilite',
]
extension_configs = {
'markdown.extensions.codehilite': {
'guess_lang': False
},
'pymdownx.inlinehilite': {
'style_plain_text': True
}
}
def test_codehilite(self):
"""Test CodeHilite."""
# Test #! original syntax
self.check_markdown(
r'`#!python import module`.',
r'<p><code class="highlight"><span class="kn">import</span> <span class="nn">module</span></code>.</p>'
)
# Test ::: syntax
self.check_markdown(
r'`:::python import module`.',
r'<p><code class="highlight"><span class="kn">import</span> <span class="nn">module</span></code>.</p>'
)
# Test escaping language with space
self.check_markdown(
r'` #!python import module`.',
r'<p><code class="highlight">#!python import module</code>.</p>'
)
# Test bad language
self.check_markdown(
r'`#!bad import module`.',
r'<p><code class="highlight">import module</code>.</p>'
)
class TestInlineHiliteCustom1(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.arithmatex_inline_format(mode='mathjax')
}
]
}
}
def test_arithmatex(self):
"""Test Arithmatex."""
self.check_markdown(
r'`#!math 3 + 3`',
r'''
<p><span class="arithmatex"><script type="math/tex">3 + 3</script></span></p>
''',
True
)
class TestLegacyInlineHiliteCustom1(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.inline_mathjax_format
}
]
}
}
def test_legacy_arithmatex(self):
"""Test Arithmatex."""
with warnings.catch_warnings(record=True) as w:
self.check_markdown(
r'`#!math 3 + 3`',
r'''
<p><span class="arithmatex"><script type="math/tex">3 + 3</script></span></p>
''',
True
)
self.assertTrue(len(w) == 1)
self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
class TestInlineHiliteCustom2(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.arithmatex_inline_format(mode="mathjax", preview=True)
}
]
}
}
def test_preview_arithmatex(self):
"""Test preview Arithmatex."""
self.check_markdown(
r'`#!math 3 + 3`',
r'<p><span class="arithmatex"><span class="MathJax_Preview">3 + 3</span>'
r'<script type="math/tex">3 + 3</script></span></p>'
)
class TestLegacyInlineHiliteCustom2(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.inline_mathjax_preview_format
}
]
}
}
def test_legacy_preview_arithmatex(self):
"""Test preview Arithmatex."""
with warnings.catch_warnings(record=True) as w:
self.check_markdown(
r'`#!math 3 + 3`',
r'<p><span class="arithmatex"><span class="MathJax_Preview">3 + 3</span>'
r'<script type="math/tex">3 + 3</script></span></p>'
)
self.assertTrue(len(w) == 1)
self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
class TestInlineHiliteCustom3(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.arithmatex_inline_format(mode="generic")
}
]
}
}
def test_arithmatex_generic(self):
"""Test generic Arithmatex."""
self.check_markdown(
r'`#!math 3 + 3`',
r'<p><span class="arithmatex">\(3 + 3\)</span></p>'
)
class TestLegacyInlineHiliteCustom3(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'math',
'class': 'arithmatex',
'format': arithmatex.inline_generic_format
}
]
}
}
def test_legacy_arithmatex_generic(self):
"""Test generic Arithmatex."""
with warnings.catch_warnings(record=True) as w:
self.check_markdown(
r'`#!math 3 + 3`',
r'<p><span class="arithmatex">\(3 + 3\)</span></p>'
)
self.assertTrue(len(w) == 1)
self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
class TestInlineHiliteCustom4(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': 'test',
'class': 'class-test',
'format': _format
}
]
}
}
def test_custom(self):
"""Test custom formatter."""
self.check_markdown(
r'`#!test src test`',
r'<p><span class="lang-test class-test">src test</span></p>'
)
class TestInlineHiliteCustom5(util.MdCase):
"""Test custom InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'css_class': 'inlinehilite',
'custom_inline': [
{
'name': '*',
'class': 'overwrite',
'format': _default_format
},
{
'name': 'test',
'class': 'class-test',
'format': _format
}
]
}
}
def test_custom(self):
"""Test custom formatter."""
self.check_markdown(
r'`#!test src test` `#!python src test`',
r'<p><span class="lang-test class-test">src test</span> <custom class="lang-python overwrite">src test</custom></p>' # noqa: E501
)
class TestInlineHiliteCustomBrokenFormatter(util.MdCase):
"""Test custom broken InlineHilite cases."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'custom_inline': [
{
'name': 'test',
'class': 'test',
'format': _format_exploder
}
]
}
}
def test_broken(self):
"""Test custom broken formatter."""
self.check_markdown(
r'`#!test boom`',
r'<p>`#!test boom`</p>'
)
class TestInlineHiliteCustomBrokenFormatterFail(util.MdCase):
"""Test custom broken InlineHilite cases fails."""
extension = [
'pymdownx.highlight',
'pymdownx.inlinehilite',
]
extension_configs = {
'pymdownx.inlinehilite': {
'custom_inline': [
{
'name': 'test',
'class': 'test',
'format': _format_exploder_fail
}
]
}
}
def test_broken(self):
"""Test custom broken formatter."""
with self.assertRaises(InlineHiliteException):
self.check_markdown(
r'`#!test boom`',
r''
)
|