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
|
"""Tests for :mod:`sphinx.ext.napoleon.__init__` module."""
from __future__ import annotations
import functools
from collections import namedtuple
from unittest import mock
import pytest
from sphinx.application import Sphinx
from sphinx.ext.napoleon import Config, _process_docstring, _skip_member, setup
def simple_decorator(f):
"""A simple decorator that does nothing, for tests to use."""
@functools.wraps(f)
def wrapper(*args, **kwargs):
return f(*args, **kwargs)
return wrapper
def _private_doc():
"""module._private_doc.DOCSTRING"""
pass
def _private_undoc():
pass
def __special_doc__(): # NoQA: N807
"""module.__special_doc__.DOCSTRING"""
pass
def __special_undoc__(): # NoQA: N807
pass
class SampleClass:
def _private_doc(self):
"""SampleClass._private_doc.DOCSTRING"""
pass
def _private_undoc(self):
pass
def __special_doc__(self): # NoQA: PLW3201
"""SampleClass.__special_doc__.DOCSTRING"""
pass
def __special_undoc__(self): # NoQA: PLW3201
pass
@simple_decorator
def __decorated_func__(self): # NoQA: PLW3201
"""Doc"""
pass
class SampleError(Exception):
def _private_doc(self):
"""SampleError._private_doc.DOCSTRING"""
pass
def _private_undoc(self):
pass
def __special_doc__(self): # NoQA: PLW3201
"""SampleError.__special_doc__.DOCSTRING"""
pass
def __special_undoc__(self): # NoQA: PLW3201
pass
SampleNamedTuple = namedtuple('SampleNamedTuple', 'user_id block_type def_id') # NoQA: PYI024
class TestProcessDocstring:
def test_modify_in_place(self):
lines = [
'Summary line.',
'',
'Args:',
' arg1: arg1 description',
]
app = mock.Mock()
app.config = Config()
_process_docstring(
app,
'class',
'SampleClass',
SampleClass,
mock.Mock(),
lines,
)
expected = [
'Summary line.',
'',
':param arg1: arg1 description',
'',
]
assert lines == expected
class TestSetup:
def test_unknown_app_type(self):
setup(object()) # type: ignore[arg-type]
def test_add_config_values(self):
app = mock.Mock(Sphinx)
setup(app)
for name, _default, _rebuild, _types in Config._config_values:
has_config = False
for method_name, args, _kwargs in app.method_calls:
if method_name == 'add_config_value' and args[0] == name:
has_config = True
if not has_config:
pytest.fail('Config value was not added to app %s' % name)
has_process_docstring = False
has_skip_member = False
for method_name, args, _kwargs in app.method_calls:
if method_name == 'connect':
if (
args[0] == 'autodoc-process-docstring'
and args[1] == _process_docstring
):
has_process_docstring = True
elif args[0] == 'autodoc-skip-member' and args[1] == _skip_member:
has_skip_member = True
if not has_process_docstring:
pytest.fail('autodoc-process-docstring never connected')
if not has_skip_member:
pytest.fail('autodoc-skip-member never connected')
class TestSkipMember:
def assert_skip(
self,
what: str,
member: str,
obj: object,
expect_default_skip: bool,
config_name: str,
) -> None:
skip = True
app = mock.Mock()
app.config = Config()
setattr(app.config, config_name, True)
if expect_default_skip:
assert None is _skip_member(app, what, member, obj, skip, mock.Mock())
else:
assert _skip_member(app, what, member, obj, skip, mock.Mock()) is False
setattr(app.config, config_name, False)
assert None is _skip_member(app, what, member, obj, skip, mock.Mock())
def test_namedtuple(self):
# Since python 3.7, namedtuple._asdict() has not been documented
# because there is no way to check the method is a member of the
# namedtuple class. This testcase confirms only it does not
# raise an error on building document
# See: https://github.com/sphinx-doc/sphinx/issues/1455
self.assert_skip(
'class',
'_asdict',
SampleNamedTuple._asdict,
True,
'napoleon_include_private_with_doc',
)
def test_class_private_doc(self):
self.assert_skip(
'class',
'_private_doc',
SampleClass._private_doc,
False,
'napoleon_include_private_with_doc',
)
def test_class_private_undoc(self):
self.assert_skip(
'class',
'_private_undoc',
SampleClass._private_undoc,
True,
'napoleon_include_private_with_doc',
)
def test_class_special_doc(self):
self.assert_skip(
'class',
'__special_doc__',
SampleClass.__special_doc__,
False,
'napoleon_include_special_with_doc',
)
def test_class_special_undoc(self):
self.assert_skip(
'class',
'__special_undoc__',
SampleClass.__special_undoc__,
True,
'napoleon_include_special_with_doc',
)
def test_class_decorated_doc(self):
self.assert_skip(
'class',
'__decorated_func__',
SampleClass.__decorated_func__,
False,
'napoleon_include_special_with_doc',
)
def test_exception_private_doc(self):
self.assert_skip(
'exception',
'_private_doc',
SampleError._private_doc,
False,
'napoleon_include_private_with_doc',
)
def test_exception_private_undoc(self):
self.assert_skip(
'exception',
'_private_undoc',
SampleError._private_undoc,
True,
'napoleon_include_private_with_doc',
)
def test_exception_special_doc(self):
self.assert_skip(
'exception',
'__special_doc__',
SampleError.__special_doc__,
False,
'napoleon_include_special_with_doc',
)
def test_exception_special_undoc(self):
self.assert_skip(
'exception',
'__special_undoc__',
SampleError.__special_undoc__,
True,
'napoleon_include_special_with_doc',
)
def test_module_private_doc(self):
self.assert_skip(
'module',
'_private_doc',
_private_doc,
False,
'napoleon_include_private_with_doc',
)
def test_module_private_undoc(self):
self.assert_skip(
'module',
'_private_undoc',
_private_undoc,
True,
'napoleon_include_private_with_doc',
)
def test_module_special_doc(self):
self.assert_skip(
'module',
'__special_doc__',
__special_doc__,
False,
'napoleon_include_special_with_doc',
)
def test_module_special_undoc(self):
self.assert_skip(
'module',
'__special_undoc__',
__special_undoc__,
True,
'napoleon_include_special_with_doc',
)
|
