Repository navigation
Expand file tree
/
Copy pathtest_rendering.py
More file actions
227 lines (194 loc) · 7.72 KB
/
Copy pathtest_rendering.py
File metadata and controls
227 lines (194 loc) · 7.72 KB
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
"""Tests for the `rendering` module."""
from __future__ import annotations
import re
from dataclasses import dataclass
from types import SimpleNamespace
from typing import TYPE_CHECKING, Any, Callable, cast
import pytest
from griffe import Alias, ModulesCollection, Object, temporary_visited_module
from mkdocstrings_handlers.python._internal import rendering
from mkdocstrings_handlers.python._internal.rendering import AutorefsHook
if TYPE_CHECKING:
from markupsafe import Markup
@pytest.mark.parametrize(
"code",
[
"print('Hello')",
"aaaaa(bbbbb, ccccc=1) + ddddd.eeeee[ffff] or {ggggg: hhhhh, iiiii: jjjjj}",
],
)
@pytest.mark.parametrize(
"formatter",
[
rendering._get_black_formatter(),
rendering._get_ruff_formatter(),
rendering._get_formatter(),
],
)
def test_format_code(code: str, formatter: Callable[[str, int], str]) -> None:
"""Assert code can be formatted.
Parameters:
code: Code to format.
"""
for length in (5, 100):
assert formatter(code, length)
@pytest.mark.parametrize(
("name", "signature"),
[("Class.method", "(param: str = 'hello') -> 'OtherClass'")],
)
def test_format_signature(name: Markup, signature: str) -> None:
"""Assert signatures can be formatted.
Parameters:
signature: Signature to format.
"""
for length in (5, 100):
assert rendering._format_signature(name, signature, length)
def test_restore_crossrefs() -> None:
"""Restore multiple stashed cross-references without replacing partial keys."""
stash = {"_short": "<autoref>short</autoref>", "_shorter": "<autoref>shorter</autoref>"}
restored = rendering._restore_crossrefs("_short + _shorter + x_short + _shorterx", stash)
assert restored == "<autoref>short</autoref> + <autoref>shorter</autoref> + x_short + _shorterx"
assert not stash
@dataclass
class _FakeObject:
name: str
inherited: bool = False
parent: None = None
is_alias: bool = False
@pytest.mark.parametrize(
("names", "filter_params", "expected_names"),
[
(["aa", "ab", "ac", "da"], {"filters": [(re.compile("^a[^b]"), True)]}, {"ab", "da"}),
(["aa", "ab", "ac", "da"], {"members_list": ["aa", "ab"]}, {"aa", "ab"}),
],
)
def test_filter_objects(names: list[str], filter_params: dict[str, Any], expected_names: set[str]) -> None:
"""Assert the objects filter works correctly.
Parameters:
names: Names of the objects.
filter_params: Parameters passed to the filter function.
expected_names: Names expected to be kept.
"""
objects = {name: _FakeObject(name) for name in names}
filtered = rendering.do_filter_objects(cast("dict[str, Object | Alias]", objects), **filter_params)
filtered_names = {obj.name for obj in filtered}
assert set(filtered_names) == set(expected_names)
@pytest.mark.parametrize(
("members", "inherited_members", "expected_names"),
[
(True, True, {"base", "main"}),
(True, False, {"main"}),
(True, ["base"], {"base", "main"}),
(True, [], {"main"}),
(False, True, {"base"}),
(False, False, set()),
(False, ["base"], {"base"}),
(False, [], set()),
([], True, {"base"}),
([], False, set()),
([], ["base"], {"base"}),
([], [], set()),
(None, True, {"base", "main"}),
(None, False, {"main"}),
(None, ["base"], {"base", "main"}),
(None, [], {"main"}),
(["base"], True, {"base"}),
(["base"], False, set()),
(["base"], ["base"], {"base"}),
(["base"], [], set()),
(["main"], True, {"main"}),
(["main"], False, {"main"}),
(["main"], ["base"], {"base", "main"}),
(["main"], [], {"main"}),
],
)
def test_filter_inherited_members(
members: bool | list[str] | None,
inherited_members: bool | list[str],
expected_names: list[str],
) -> None:
"""Test inherited members filtering.
Parameters:
members: Members option (parametrized).
inherited_members: Inherited members option (parametrized).
expected_names: The expected result as a list of member names.
"""
collection = ModulesCollection()
with temporary_visited_module(
"""
class Base:
def base(self): ...
class Main(Base):
def main(self): ...
""",
modules_collection=collection,
) as module:
collection["module"] = module
objects = module["Main"].all_members
filtered = rendering.do_filter_objects(objects, members_list=members, inherited_members=inherited_members)
names = {obj.name for obj in filtered}
assert names == expected_names
@pytest.mark.parametrize(
("order", "members_list", "expected_names"),
[
("alphabetical", None, ["a", "b", "c"]),
("source", None, ["c", "b", "a"]),
("alphabetical", ["c", "b"], ["c", "b"]),
("source", ["a", "c"], ["a", "c"]),
("alphabetical", [], ["a", "b", "c"]),
("source", [], ["c", "b", "a"]),
("alphabetical", True, ["a", "b", "c"]),
("source", False, ["c", "b", "a"]),
],
)
def test_ordering_members(order: rendering.Order, members_list: list[str | None], expected_names: list[str]) -> None:
"""Assert the objects are correctly ordered.
Parameters:
order: The order to use (alphabetical or source).
members_list: The user specified members list.
expected_names: The expected ordered list of object names.
"""
class Obj:
def __init__(self, name: str, lineno: int | None = None, *, is_alias: bool = False) -> None:
self.name = name
self.lineno = lineno
self.alias_lineno = lineno
self.is_alias = is_alias
members = [Obj("a", 10, is_alias=True), Obj("b", 9, is_alias=False), Obj("c", 8, is_alias=True)]
ordered = rendering.do_order_members(members, order, members_list) # type: ignore[arg-type]
assert [obj.name for obj in ordered] == expected_names
def test_expand_identifier_relative_crossref_in_inherited_member() -> None:
"""Relative cross-references in inherited members expand against the defining object.
The docstring of an inherited member is rendered in the docs of the inheriting
class, where the current object is an alias living under that class. Dots in
relative references must still climb the tree of the class the docstring was
written on, not the consumer's tree.
"""
collection = ModulesCollection()
with temporary_visited_module(
'''
class Base:
MAPPING = {}
"""The mapping to use for each [`Thing`][....Thing]."""
''',
module_name="pkga",
modules_collection=collection,
) as module:
collection["pkga"] = module
with temporary_visited_module(
"""
from pkga import Base
class Derived(Base): ...
""",
module_name="pkgb",
modules_collection=collection,
) as module_b:
collection["pkgb"] = module_b
config = SimpleNamespace(relative_crossrefs=True, scoped_crossrefs=False)
# Control: a non-inherited object expands relative references in its own tree.
direct = AutorefsHook(collection["pkga"]["Base"]["MAPPING"], config) # type: ignore[arg-type]
assert direct.expand_identifier("....Thing") == "pkga.Thing"
# Inherited member: the current object is an alias under pkgb.Derived,
# but the docstring was written on pkga.Base.MAPPING.
inherited = AutorefsHook(collection["pkgb"]["Derived"]["MAPPING"], config) # type: ignore[arg-type]
assert inherited.expand_identifier("....Thing") == "pkga.Thing"