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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
"""Tests for the Griffe extension."""
import pytest
from griffe import DocstringSectionKind, Extensions, GriffeLoader, temporary_visited_package
from griffe_typingdoc import TypingDocExtension
typing_imports = (
"from typing import Annotated, Doc, Generator, Iterator, Name, NotRequired, Raises, TypedDict, Unpack, Warns"
)
warning_imports = "from warnings import deprecated"
# NOTE: Important! The value in calls to `Doc` will be parsed as a Name expression
# if it is valid Python syntax for names. To make sure it is correctly parsed as a string,
# it must contain invalid syntax for names, such as a dot at the end.
# The alternative solution would be to add `from __future__ import annotations`
# at the beginning of each temporary visited module.
def test_extension_on_itself() -> None:
"""Load our own package using the extension, assert a parameters section is added to the parsed docstring."""
loader = GriffeLoader(extensions=Extensions(TypingDocExtension()))
typingdoc = loader.load("griffe_typingdoc")
sections = typingdoc["TypingDocExtension.on_function_instance"].docstring.parsed
assert len(sections) == 2
assert sections[1].kind is DocstringSectionKind.parameters
assert sections[1].value[1].description == "The Griffe function just instantiated."
def test_attribute_doc() -> None:
"""Read documentation for attributes."""
with temporary_visited_package(
"package",
modules={"__init__.py": f"{typing_imports}\na: Annotated[str, Doc('Hello.')]"},
extensions=Extensions(TypingDocExtension()),
) as package:
assert package["a"].docstring.value == "Hello."
def test_parameter_doc() -> None:
"""Read documentation for parameters."""
with temporary_visited_package(
"package",
modules={"__init__.py": f"{typing_imports}\ndef f(a: Annotated[str, Doc('Hello.')]): ..."},
extensions=Extensions(TypingDocExtension()),
) as package:
assert package["f"].docstring.parsed[1].value[0].description == "Hello."
def test_other_parameter_doc() -> None:
"""Read documentation for other parameters, in unpack/typeddict annotations."""
with temporary_visited_package(
"package",
modules={
"__init__.py": f"""
{typing_imports}
class OtherParameters(TypedDict, total=False):
param1: Annotated[NotRequired[str], Doc("Hello.")]
def f(**kwargs: Annotated[Unpack[OtherParameters], Doc("See other parameters.")]):
...
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
assert package["f"].docstring.parsed[2].value[0].description == "Hello."
def test_iterator_doc() -> None:
"""Read documentation in iterator annotations."""
with temporary_visited_package(
"package",
modules={
"__init__.py": f"""
{typing_imports}
def f() -> Iterator[Annotated[int, Doc("Yielded hello.")]]:
...
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
assert package["f"].docstring.parsed[1].value[0].description == "Yielded hello."
def test_generator_doc() -> None:
"""Read documentation in generator annotations."""
with temporary_visited_package(
"package",
modules={
"__init__.py": f"""
{typing_imports}
def f() -> Generator[
Annotated[int, Doc("Yielded hello.")],
Annotated[int, Doc("Received hello.")],
Annotated[int, Doc("Returned hello.")],
]:
...
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert sections[1].value[0].description == "Yielded hello."
assert sections[2].value[0].description == "Received hello."
assert sections[3].value[0].description == "Returned hello."
def test_generator_tuples() -> None:
"""Read documentation in generator annotations (in tuples)."""
with temporary_visited_package(
"package",
modules={
"__init__.py": f"""
{typing_imports}
def f() -> Generator[
tuple[
Annotated[int, Doc("First yielded.")],
Annotated[float, Doc("Second yielded.")],
],
tuple[
Annotated[int, Doc("First received.")],
Annotated[float, Doc("Second received.")],
],
tuple[
Annotated[int, Doc("First returned.")],
Annotated[float, Doc("Second returned.")],
],
]:
...
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert sections[1].value[0].description == "First yielded."
assert sections[1].value[1].description == "Second yielded."
assert sections[2].value[0].description == "First received."
assert sections[2].value[1].description == "Second received."
assert sections[3].value[0].description == "First returned."
assert sections[3].value[1].description == "Second returned."
def test_return_doc() -> None:
"""Read documentation for return value."""
with temporary_visited_package(
"package",
modules={"__init__.py": f"{typing_imports}\ndef f() -> Annotated[int, Doc('Hello.')]: ..."},
extensions=Extensions(TypingDocExtension()),
) as package:
assert package["f"].docstring.parsed[1].value[0].description == "Hello."
def test_unpacking_typed_dict() -> None:
"""Unpack typed dicts, resolving them to their right location."""
with temporary_visited_package(
"package",
{
"__init__.py": """
from typing import TypedDict
from typing_extensions import Annotated, Doc, Unpack
from package import module
class Options(TypedDict):
foo: Annotated[int, Doc("Foo's description.")]
class A:
def __init__(self, **kwargs: Unpack[Options]) -> None:
'''Init.'''
self.options = kwargs
class B:
def __init__(self, **kwargs: Unpack[module.Options]) -> None:
'''Init.'''
self.options = kwargs
""",
"module.py": """
from typing import TypedDict
from typing_extensions import Annotated, Doc
class Options(TypedDict):
bar: Annotated[str, Doc("Bar's description.")]
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["A.__init__"].docstring.parsed
assert len(sections) == 2
assert sections[0].kind is DocstringSectionKind.text
assert sections[1].kind is DocstringSectionKind.other_parameters
foo = sections[1].value[0]
assert foo.name == "foo"
assert foo.description == "Foo's description."
assert str(foo.annotation).startswith("Annotated[int")
sections = package["B.__init__"].docstring.parsed
assert len(sections) == 2
assert sections[0].kind is DocstringSectionKind.text
assert sections[1].kind is DocstringSectionKind.other_parameters
bar = sections[1].value[0]
assert bar.name == "bar"
assert bar.description == "Bar's description."
assert str(bar.annotation).startswith("Annotated[str")
@pytest.mark.parametrize(
"annotation",
["int", "Annotated[int, '']"],
)
def test_ignore_unannotated_params(annotation: str) -> None:
"""Ignore parameters that are not annotated with `Doc`."""
with temporary_visited_package(
"package",
{
"__init__.py": f"{typing_imports}\ndef f(a: {annotation}):\n '''Docstring.'''",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert len(sections) == 1
assert sections[0].kind is DocstringSectionKind.text
@pytest.mark.parametrize(
"annotation",
["int", "Annotated[int, '']"],
)
def test_ignore_unannotated_other_params(annotation: str) -> None:
"""Ignore other parameters that are not annotated with `Doc`."""
with temporary_visited_package(
"package",
{
"__init__.py": f"""
{typing_imports}
from typing import TypedDict
class Kwargs(TypedDict):
a: {annotation}
def f(**kwargs: Unpack[Kwargs]):
'''Docstring.'''
""",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert len(sections) == 1
assert sections[0].kind is DocstringSectionKind.text
@pytest.mark.parametrize(
"annotation",
["int", "Annotated[int, '']"],
)
def test_ignore_unannotated_returns(annotation: str) -> None:
"""Ignore return values that are not annotated with `Doc`."""
with temporary_visited_package(
"package",
{
"__init__.py": f"{typing_imports}\ndef f() -> {annotation}:\n '''Docstring.'''",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert len(sections) == 1
assert sections[0].kind is DocstringSectionKind.text
@pytest.mark.parametrize(
"annotation",
["int", "Annotated[int, '']"],
)
def test_ignore_unannotated_yields(annotation: str) -> None:
"""Ignore yields that are not annotated with `Doc`."""
with temporary_visited_package(
"package",
{
"__init__.py": f"{typing_imports}\ndef f() -> Iterator[{annotation}]:\n '''Docstring.'''",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert len(sections) == 1
assert sections[0].kind is DocstringSectionKind.text
@pytest.mark.parametrize(
"annotation",
["int", "Annotated[int, '']"],
)
def test_ignore_unannotated_receives(annotation: str) -> None:
"""Ignore receives that are not annotated with `Doc`."""
with temporary_visited_package(
"package",
{
"__init__.py": f"{typing_imports}\ndef f() -> Generator[int, {annotation}, None]:\n '''Docstring.'''",
},
extensions=Extensions(TypingDocExtension()),
) as package:
sections = package["f"].docstring.parsed
assert len(sections) == 1
assert sections[0].kind is DocstringSectionKind.text
|
