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
|
"""Tests for the handlers.base module."""
from __future__ import annotations
from textwrap import dedent
from typing import TYPE_CHECKING
import pytest
from dirty_equals import IsStr
from jinja2.exceptions import TemplateNotFound
from markdown import Markdown
from mkdocstrings import Highlighter
if TYPE_CHECKING:
from pathlib import Path
from mkdocstrings import MkdocstringsPlugin
@pytest.mark.parametrize("extension_name", ["codehilite", "pymdownx.highlight"])
def test_highlighter_without_pygments(extension_name: str) -> None:
"""Assert that it's possible to disable Pygments highlighting.
Arguments:
extension_name: The "user-chosen" Markdown extension for syntax highlighting.
"""
configs = {extension_name: {"use_pygments": False, "css_class": "hiiii"}}
md = Markdown(extensions=[extension_name], extension_configs=configs)
hl = Highlighter(md)
assert (
hl.highlight("import foo", language="python")
== '<pre class="hiiii"><code class="language-python">import foo</code></pre>'
)
assert (
hl.highlight("import foo", language="python", inline=True)
== f'<code class="{"" if extension_name == "codehilite" else "hiiii"} language-python">import foo</code>'
)
@pytest.mark.parametrize("extension_name", [None, "codehilite", "pymdownx.highlight"])
@pytest.mark.parametrize("inline", [False, True])
def test_highlighter_basic(extension_name: str | None, inline: bool) -> None:
"""Assert that Pygments syntax highlighting works.
Arguments:
extension_name: The "user-chosen" Markdown extension for syntax highlighting.
inline: Whether the highlighting was inline.
"""
md = Markdown(extensions=[extension_name], extension_configs={extension_name: {}}) if extension_name else Markdown()
hl = Highlighter(md)
actual = hl.highlight("import foo", language="python", inline=inline)
assert "import" in actual
assert "import foo" not in actual # Highlighting has split it up.
def test_extended_templates(tmp_path: Path, plugin: MkdocstringsPlugin) -> None:
"""Test the extended templates functionality.
Parameters:
tmp_path: Temporary folder.
plugin: Instance of our plugin.
"""
handler = plugin._handlers.get_handler("python") # type: ignore[union-attr]
# monkeypatch Jinja env search path
search_paths = [
base_theme := tmp_path / "base_theme",
base_fallback_theme := tmp_path / "base_fallback_theme",
extended_theme := tmp_path / "extended_theme",
extended_fallback_theme := tmp_path / "extended_fallback_theme",
]
handler.env.loader.searchpath = search_paths # type: ignore[union-attr]
# assert "new" template is not found
with pytest.raises(expected_exception=TemplateNotFound):
handler.env.get_template("new.html")
# check precedence: base theme, base fallback theme, extended theme, extended fallback theme
# start with last one and go back up
handler.env.cache = None
extended_fallback_theme.mkdir()
extended_fallback_theme.joinpath("new.html").write_text("extended fallback new")
assert handler.env.get_template("new.html").render() == "extended fallback new"
extended_theme.mkdir()
extended_theme.joinpath("new.html").write_text("extended new")
assert handler.env.get_template("new.html").render() == "extended new"
base_fallback_theme.mkdir()
base_fallback_theme.joinpath("new.html").write_text("base fallback new")
assert handler.env.get_template("new.html").render() == "base fallback new"
base_theme.mkdir()
base_theme.joinpath("new.html").write_text("base new")
assert handler.env.get_template("new.html").render() == "base new"
@pytest.mark.parametrize(
"ext_markdown",
[{"markdown_extensions": [{"toc": {"permalink": True}}]}],
indirect=["ext_markdown"],
)
def test_nested_autodoc(ext_markdown: Markdown) -> None:
"""Assert that nested autodocs render well and do not mess up the TOC."""
output = ext_markdown.convert(
dedent(
"""
# ::: tests.fixtures.nesting.Class
options:
members: false
show_root_heading: true
""",
),
)
assert 'id="tests.fixtures.nesting.Class"' in output
assert 'id="tests.fixtures.nesting.Class.method"' in output
assert ext_markdown.toc_tokens == [ # type: ignore[attr-defined]
{
"level": 1,
"id": "tests.fixtures.nesting.Class",
"html": IsStr(),
"name": "Class",
"data-toc-label": "Class",
"children": [
{
"level": 2,
"id": "tests.fixtures.nesting.Class.method",
"html": IsStr(),
"name": "method",
"data-toc-label": "method",
"children": [],
},
],
},
]
|
