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
|
# This file is part of python-markups module
# License: 3-clause BSD, see LICENSE file
# Copyright: (C) Dmitry Shachnev, 2012-2024
from __future__ import annotations
import importlib
import os
import re
import warnings
from collections.abc import Iterable, Iterator
from typing import Any
import markups.common as common
from markups.abstract import AbstractMarkup, ConvertedMarkup
try:
import yaml
HAVE_YAML = True
except ImportError:
HAVE_YAML = False
MATHJAX2_CONFIG = """<script type="text/x-mathjax-config">
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/TeX", "input/AsciiMath", "output/HTML-CSS", "output/NativeMML"],
extensions: ["MathMenu.js", "MathZoom.js"],
TeX: {
extensions: ["AMSmath.js", "AMSsymbols.js"],
equationNumbers: {autoNumber: "AMS"}
}
});
</script>
"""
# Taken from:
# https://docs.mathjax.org/en/latest/upgrading/v2.html?highlight=upgrading#changes-in-the-mathjax-api
MATHJAX3_CONFIG = """
<script>
MathJax = {
options: {
renderActions: {
find: [10, function (doc) {
for (const node of document.querySelectorAll('script[type^="math/tex"]')) {
const display = !!node.type.match(/; *mode=display/);
const math = new doc.options.MathItem(node.textContent, doc.inputJax[0], display);
const text = document.createTextNode('');
node.parentNode.replaceChild(text, node);
math.start = {node: text, delim: '', n: 0};
math.end = {node: text, delim: '', n: 0};
doc.math.push(math);
}
}, '']
}
}
};
</script>
""" # noqa: E501
extensions_re = re.compile(r"required.extensions: (.+)", flags=re.IGNORECASE)
extension_name_re = re.compile(r"[a-z0-9_.]+(?:\([^)]+\))?", flags=re.IGNORECASE)
_canonicalized_ext_names: dict[str, str] = {}
_name_and_config = tuple[str, dict[str, Any]]
class MarkdownMarkup(AbstractMarkup):
"""Markup class for Markdown language.
Inherits :class:`~markups.abstract.AbstractMarkup`.
:param extensions: list of extension names
:type extensions: list
"""
name = "Markdown"
attributes = {
common.LANGUAGE_HOME_PAGE: "https://daringfireball.net/projects/markdown/",
common.MODULE_HOME_PAGE: "https://github.com/Python-Markdown/markdown",
common.SYNTAX_DOCUMENTATION: "https://daringfireball.net/projects/markdown/syntax",
}
file_extensions = (".md", ".mkd", ".mkdn", ".mdwn", ".mdown", ".markdown")
default_extension = ".mkd"
@staticmethod
def available() -> bool:
try:
import markdown
importlib.import_module("mdx_math")
except ImportError:
return False
return getattr(markdown, "__version_info__", (2,)) >= (3,)
def _load_extensions_list_from_txt_file(
self,
filename: str,
) -> Iterator[_name_and_config]:
with open(filename) as extensions_file:
for line in extensions_file:
if not line.startswith("#"):
yield self._split_extension_config(line.rstrip())
def _load_extensions_list_from_yaml_file(
self,
filename: str,
) -> Iterator[_name_and_config]:
with open(filename) as extensions_file:
try:
data = yaml.safe_load(extensions_file)
except yaml.YAMLError as ex:
warnings.warn(f"Failed parsing {filename}: {ex}", SyntaxWarning)
raise OSError from ex
if isinstance(data, list):
for item in data:
if isinstance(item, dict):
yield from item.items()
elif isinstance(item, str):
yield item, {}
def _get_global_extensions(
self,
filename: str | None,
) -> Iterator[_name_and_config]:
local_directory = os.path.dirname(filename) if filename else ""
choices = [
os.path.join(local_directory, "markdown-extensions.yaml"),
os.path.join(local_directory, "markdown-extensions.txt"),
os.path.join(common.CONFIGURATION_DIR, "markdown-extensions.yaml"),
os.path.join(common.CONFIGURATION_DIR, "markdown-extensions.txt"),
]
for choice in choices:
if choice.endswith(".yaml") and not HAVE_YAML:
continue
try:
if choice.endswith(".txt"):
yield from self._load_extensions_list_from_txt_file(choice)
else:
yield from self._load_extensions_list_from_yaml_file(choice)
except OSError:
continue # Cannot open file, move to the next choice
else:
break # File loaded successfully, skip the remaining choices
def _get_document_extensions(self, text: str) -> Iterator[_name_and_config]:
lines = text.splitlines()
match = extensions_re.search(lines[0]) if lines else None
if match:
extensions = extension_name_re.findall(match.group(1))
yield from self._split_extensions_configs(extensions)
def _canonicalize_extension_name(self, extension_name: str) -> str | None:
prefixes = ("markdown.extensions.", "", "mdx_")
for prefix in prefixes:
try:
module = importlib.import_module(prefix + extension_name)
if not hasattr(module, "makeExtension"):
continue
except (ImportError, ValueError, TypeError):
pass
else:
return prefix + extension_name
return None
def _split_extension_config(self, extension_name: str) -> _name_and_config:
"""Splits the configuration options from the extension name."""
lb = extension_name.find("(")
if lb == -1:
return extension_name, {}
extension_name, parameters = extension_name[:lb], extension_name[lb + 1 : -1]
pairs = [x.split("=") for x in parameters.split(",")]
return extension_name, {x.strip(): y.strip() for (x, y) in pairs}
def _split_extensions_configs(
self,
extensions: Iterable[str],
) -> Iterator[_name_and_config]:
"""Splits the configuration options from a list of strings.
:returns: a generator of (name, config) tuples
"""
for extension in extensions:
yield self._split_extension_config(extension)
def _apply_extensions(
self,
document_extensions: Iterable[_name_and_config] | None = None,
) -> None:
extensions = self.global_extensions.copy()
extensions.extend(self._split_extensions_configs(self.requested_extensions))
if document_extensions is not None:
extensions.extend(document_extensions)
extension_names = {"markdown.extensions.extra", "mdx_math"}
extension_configs = {}
for name, config in extensions:
if name == "mathjax":
mathjax_config = {"enable_dollar_delimiter": True}
extension_configs["mdx_math"] = mathjax_config
elif name == "remove_extra":
if "markdown.extensions.extra" in extension_names:
extension_names.remove("markdown.extensions.extra")
if "mdx_math" in extension_names:
extension_names.remove("mdx_math")
else:
if name in _canonicalized_ext_names:
canonical_name = _canonicalized_ext_names[name]
else:
candidate = self._canonicalize_extension_name(name)
if candidate is None:
warnings.warn(
f'Extension "{name}" does not exist.',
ImportWarning,
)
continue
canonical_name = candidate
_canonicalized_ext_names[name] = canonical_name
extension_names.add(canonical_name)
extension_configs[canonical_name] = config
self.md = self.markdown.Markdown(
extensions=sorted(extension_names),
extension_configs=extension_configs,
output_format="html5",
)
self.extensions = extension_names
self.extension_configs = extension_configs
def __init__(
self,
filename: str | None = None,
extensions: list[str] | None = None,
):
AbstractMarkup.__init__(self, filename)
import markdown
self.markdown = markdown
self.requested_extensions = extensions or []
self.global_extensions: list[_name_and_config] = []
if extensions is None:
self.global_extensions.extend(self._get_global_extensions(filename))
self._apply_extensions()
def convert(self, text: str) -> ConvertedMarkdown:
# Determine body
self.md.reset()
self._apply_extensions(self._get_document_extensions(text))
body = self.md.convert(text) + "\n"
# Determine title
if hasattr(self.md, "Meta") and "title" in self.md.Meta:
title = str.join(" ", self.md.Meta["title"])
else:
title = ""
# Determine stylesheet
css_class = None
if "markdown.extensions.codehilite" in self.extensions:
config = self.extension_configs.get("markdown.extensions.codehilite", {})
css_class = config.get("css_class", "codehilite")
stylesheet = common.get_pygments_stylesheet(f".{css_class}")
elif "pymdownx.highlight" in self.extensions:
config = self.extension_configs.get("pymdownx.highlight", {})
css_class = config.get("css_class", "highlight")
stylesheet = common.get_pygments_stylesheet(f".{css_class}")
else:
stylesheet = ""
return ConvertedMarkdown(body, title, stylesheet)
class ConvertedMarkdown(ConvertedMarkup):
def get_javascript(self, webenv: bool = False) -> str:
if '<script type="math/' not in self.body:
return ""
mathjax_url, mathjax_version = common.get_mathjax_url_and_version(webenv)
config = MATHJAX3_CONFIG if mathjax_version == 3 else MATHJAX2_CONFIG
async_attr = " async" if mathjax_version == 3 else ""
script_tag = '<script type="text/javascript" src="%s"%s></script>'
return config + script_tag % (mathjax_url, async_attr)
|