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
|
# This file is part of python-markups module
# License: 3-clause BSD, see LICENSE file
# Copyright: (C) Dmitry Shachnev, 2012-2024
from importlib.metadata import entry_points
from typing import Literal, overload
from markups.abstract import AbstractMarkup
from markups.asciidoc import AsciiDocMarkup
from markups.markdown import MarkdownMarkup
from markups.restructuredtext import ReStructuredTextMarkup
from markups.textile import TextileMarkup
__version_tuple__ = (4, 1, 1)
__version__ = ".".join(map(str, __version_tuple__))
__all__ = [
"AbstractMarkup",
"AsciiDocMarkup",
"MarkdownMarkup",
"ReStructuredTextMarkup",
"TextileMarkup",
"find_markup_class_by_name",
"get_all_markups",
"get_available_markups",
"get_markup_for_file_name",
]
builtin_markups = [
MarkdownMarkup,
ReStructuredTextMarkup,
TextileMarkup,
AsciiDocMarkup,
]
# Public API
def get_all_markups() -> list[type[AbstractMarkup]]:
"""
:returns: list of all markups (both standard and custom ones)
"""
entrypoints = entry_points(group="pymarkups")
return [entry_point.load() for entry_point in entrypoints]
def get_available_markups() -> list[type[AbstractMarkup]]:
"""
:returns: list of all available markups (markups whose
:meth:`~markups.abstract.AbstractMarkup.available`
method returns True)
"""
available_markups = []
for markup in get_all_markups():
if markup.available():
available_markups.append(markup)
return available_markups
@overload
def get_markup_for_file_name(
filename: str,
return_class: Literal[False] = False,
) -> AbstractMarkup | None: ...
@overload
def get_markup_for_file_name(
filename: str,
return_class: Literal[True],
) -> type[AbstractMarkup] | None: ...
def get_markup_for_file_name(
filename: str,
return_class: bool = False,
) -> AbstractMarkup | type[AbstractMarkup] | None:
"""
:param filename: name of the file
:param return_class: if true, this function will return
a class rather than an instance
:returns: a markup with
:attr:`~markups.abstract.AbstractMarkup.file_extensions`
attribute containing extension of `filename`, if found,
otherwise ``None``
>>> import markups
>>> markup = markups.get_markup_for_file_name('foo.mkd')
>>> markup.convert('**Test**').get_document_body()
'<p><strong>Test</strong></p>\\n'
>>> markups.get_markup_for_file_name('bar.rst', return_class=True)
<class 'markups.restructuredtext.ReStructuredTextMarkup'>
"""
markup_class = None
for markup in get_all_markups():
for extension in markup.file_extensions:
if filename.endswith(extension):
markup_class = markup
if return_class:
return markup_class
if markup_class and markup_class.available():
return markup_class(filename=filename)
return None
def find_markup_class_by_name(name: str) -> type[AbstractMarkup] | None:
"""
:returns: a markup with
:attr:`~markups.abstract.AbstractMarkup.name`
attribute matching `name`, if found, otherwise ``None``
>>> import markups
>>> markups.find_markup_class_by_name('textile')
<class 'markups.textile.TextileMarkup'>
"""
for markup in get_all_markups():
if markup.name.lower() == name.lower():
return markup
return None
|
