git @ Cat's Eye Technologies Feedmark / master src / feedmark / models.pyi
master

Tree @master (Download .tar.gz)

models.pyi @master — raw · history · blame 

 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
# Copyright (c) 2026 Chris Pressey, Cat's Eye Technologies
# This file is distributed under an MIT license.  See LICENSES/ directory.
# SPDX-License-Identifier: LicenseRef-MIT-X-Feedmark

from collections import OrderedDict
from datetime import datetime
from typing import Any, Iterator, Mapping, TypeAlias, TypedDict

from marko.block import LinkRefDefs
from marko.element import Element
from marko.md_renderer import MarkdownRenderer

JSONObject: TypeAlias = dict[str, Any]
Refdex: TypeAlias = JSONObject
RefdexMapping: TypeAlias = Mapping[str, Mapping[str, Any]]
Properties: TypeAlias = OrderedDict[str, str | list[str]]

class _ImageRecordBase(TypedDict):
    description: str
    source: str

class ImageRecord(_ImageRecordBase, total=False):
    link: str

def rewrite_link_ref_defs(
    refdex: RefdexMapping, link_ref_defs: LinkRefDefs
) -> LinkRefDefs: ...

class PropertyCollection:
    renderer: MarkdownRenderer
    properties: Properties
    def __init__(self) -> None: ...
    def add_property(self, kind: str, key: str, value: str) -> None: ...
    def parse_property(self, listitem_text: str) -> tuple[str, str, str]: ...
    def add_property_listitem(self, element: Element) -> None: ...

class Document(PropertyCollection):
    filename: str
    title: str
    sections: list[Section]
    link_ref_defs: LinkRefDefs
    def __init__(
        self,
        *args: Any,
        renderer: MarkdownRenderer | None = None,
        filename: str | None = None,
        **kwargs: Any,
    ) -> None: ...
    def set_title(self, title: str) -> None: ...
    @property
    def header_comment(self) -> str: ...
    def has_header_comment(self) -> bool: ...
    def add_to_header_comment(self, element: Element) -> None: ...
    @property
    def preamble(self) -> str: ...
    def add_to_preamble(self, element: Element) -> None: ...
    def has_preamble(self) -> bool: ...
    def rewrite_link_ref_defs(self, refdex: RefdexMapping) -> None: ...
    def global_link_ref_defs(self) -> LinkRefDefs: ...
    def to_json_data(
        self,
        htmlize: bool = False,
        ordered: bool = False,
        link_ref_defs: LinkRefDefs | None = None,
    ) -> dict[str, Any]: ...

class Section(PropertyCollection):
    document: Document | None
    title: str
    images: list[ImageRecord]
    def __init__(
        self,
        title: str,
        *args: Any,
        renderer: MarkdownRenderer | None = None,
        **kwargs: Any,
    ) -> None: ...
    def collect_image_children(self, element: Element) -> Iterator[ImageRecord]: ...
    def add_image_paragraph(self, element: Element) -> None: ...
    @property
    def body(self) -> str: ...
    def add_to_body(self, element: Element) -> None: ...
    @property
    def publication_date(self) -> datetime: ...
    @property
    def anchor(self) -> str: ...
    def to_json_data(
        self,
        htmlize: bool = False,
        ordered: bool = False,
        link_ref_defs: LinkRefDefs | None = None,
    ) -> dict[str, Any]: ...