summaryrefslogtreecommitdiff
path: root/creole/shared/document_tree.py
blob: fdcc863820953872114b9bde1313b6f156173770 (plain)
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


"""
    python-creole
    ~~~~~~~~~~~~~


    :copyleft: 2008-2020 by python-creole team, see AUTHORS for more details.
    :license: GNU GPL v3 or above, see LICENSE for more details.
"""

import inspect
import warnings

from creole.shared.utils import dict2string


class DocNode:
    """
    A node in the document tree for html2creole and creole2html.

    The Document tree would be created in the parser and used in the emitter.
    """

    def __init__(self, kind='', parent=None, content=None, attrs=[], level=None):
        self.kind = kind

        self.children = []
        self.parent = parent
        if self.parent is not None:
            self.parent.children.append(self)

        self.attrs = dict(attrs)
        if content:
            assert isinstance(content, str), f"Given content {content!r} is not unicode, it's type: {type(content)}"

        self.content = content
        self.level = level

    def get_attrs_as_string(self):
        """
        FIXME: Find a better was to do this.

        >>> node = DocNode(attrs={'foo':"bar", "no":123})
        >>> node.get_attrs_as_string()
        'foo="bar" no=123'

        >>> node = DocNode(attrs={"foo":'bar', "no":"ABC"})
        >>> node.get_attrs_as_string()
        'foo="bar" no="ABC"'
        """
        return dict2string(self.attrs)

    def __str__(self):
        return str(self.__repr__())

    def __repr__(self):
        return f"<DocNode {self.kind}: {self.content!r}>"
#        return "<DocNode %s (parent: %r): %r>" % (self.kind, self.parent, self.content)

    def debug(self):
        """
        >>> node = DocNode(kind="test", content="foo", attrs={"a":1}, level=0)
        >>> node.debug() # doctest: +NORMALIZE_WHITESPACE +REPORT_NDIFF
        ________________________________________________________________________________
            DocNode - debug:
        str(): <DocNode test: 'foo'>
        attributes:
                       attrs: {'a': 1}
                    children: []
                     content: 'foo'
                        kind: 'test'
                       level: 0
                      parent: None
        """
        print("_" * 80)
        print("\tDocNode - debug:")
        print(f"str(): {self}")
        print("attributes:")
        for i in dir(self):
            if i.startswith("_") or i == "debug":
                continue
            if callable(getattr(self, i)):
                continue
            print(f"{i:>20}: {getattr(self, i, '---')!r}")


class DebugList(list):
    def __init__(self, html2creole):
        self.html2creole = html2creole
        super().__init__()

    def append(self, item):
        #        for stack_frame in inspect.stack(): print(stack_frame)

        line, method = inspect.stack()[1][2:4]
        msg = "%-8s   append: %-35r (%-15s line:%s)" % (
            self.html2creole.getpos(), item,
            method, line
        )
        warnings.warn(msg)
        list.append(self, item)


if __name__ == '__main__':
    import doctest
    print(doctest.testmod())