File: test_line_numbers.py

package info (click to toggle)
python-mistletoe 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 864 kB
  • sloc: python: 5,649; sh: 66; makefile: 40
file content (57 lines) | stat: -rw-r--r-- 2,201 bytes parent folder | download
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
import unittest

import mistletoe.block_token as block_token
import mistletoe.span_token as span_token
from mistletoe.markdown_renderer import (
    LinkReferenceDefinition,
    LinkReferenceDefinitionBlock,
)


class TestLineNumbers(unittest.TestCase):
    def setUp(self) -> None:
        block_token.add_token(block_token.HTMLBlock)
        span_token.add_token(span_token.HTMLSpan)
        block_token.remove_token(block_token.Footnote)
        block_token.add_token(LinkReferenceDefinitionBlock)
        return super().setUp()

    def tearDown(self) -> None:
        span_token.reset_tokens()
        block_token.reset_tokens()
        return super().tearDown()

    def test_main(self):
        # see line_numbers.md for a description of how the test works.
        NUMBER_OF_LINE_NUMBERS_TO_BE_CHECKED = 13
        with open("test/samples/line_numbers.md", "r") as fin:
            document = block_token.Document(fin)
        count = self.check_line_numbers(document)
        self.assertEqual(count, NUMBER_OF_LINE_NUMBERS_TO_BE_CHECKED)

    def check_line_numbers(self, token: block_token.BlockToken):
        """Check the line number on the given block token and its children, if possible."""
        count = 0
        line_number = self.get_expected_line_number(token)
        if line_number:
            self.assertEqual(token.line_number, line_number)
            count += 1

        if isinstance(token, block_token.Table):
            count += self.check_line_numbers(token.header)

        for child in token.children:
            if isinstance(child, block_token.BlockToken):
                count += self.check_line_numbers(child)

        return count

    def get_expected_line_number(self, token: block_token.BlockToken):
        # the expected line number, if it exists, should be wrapped in an inline
        # code token and be an immediate child of the token.
        # or it could be the title of a link reference definition.
        for child in token.children:
            if isinstance(child, span_token.InlineCode):
                return int(child.children[0].content)
            if isinstance(child, LinkReferenceDefinition):
                return int(child.title)