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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
# Copyright (c) 2016-2018, 2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2016, 2019 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2016 Derek Gustafson <degustaf@gmail.com>
# Copyright (c) 2016 Glenn Matthews <glenn@e-dad.net>
# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
"""Unit tests for the yield documentation checking in the
`DocstringChecker` in :mod:`pylint.extensions.check_docs`
"""
# pylint: disable=too-many-public-methods
import astroid
from pylint.extensions.docparams import DocstringParameterChecker
from pylint.testutils import CheckerTestCase, Message, set_config
class TestDocstringCheckerYield(CheckerTestCase):
"""Tests for pylint_plugin.RaiseDocChecker"""
CHECKER_CLASS = DocstringParameterChecker
def test_ignores_no_docstring(self) -> None:
yield_node = astroid.extract_node(
"""
def my_func(self):
yield False #@
"""
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
@set_config(accept_no_yields_doc=False)
def test_warns_no_docstring(self) -> None:
node = astroid.extract_node(
"""
def my_func(self):
yield False
"""
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-doc", node=node),
Message(msg_id="missing-yield-type-doc", node=node),
):
self.checker.visit_yield(yield_node)
def test_ignores_unknown_style(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring."""
yield False #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_warn_partial_sphinx_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:returns: Always False
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-type-doc", node=node)
):
self.checker.visit_yield(yield_node)
def test_warn_partial_sphinx_yields_type(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:rtype: bool
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(Message(msg_id="missing-yield-doc", node=node)):
self.checker.visit_yield(yield_node)
def test_warn_missing_sphinx_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self, doc_type):
"""This is a docstring.
:param doc_type: Sphinx
:type doc_type: str
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-doc", node=node),
Message(msg_id="missing-yield-type-doc", node=node),
):
self.checker.visit_yield(yield_node)
def test_warn_partial_google_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
Always False
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-type-doc", node=node)
):
self.checker.visit_yield(yield_node)
def test_warn_partial_google_yields_type(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
bool:
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(Message(msg_id="missing-yield-doc", node=node)):
self.checker.visit_yield(yield_node)
def test_warn_missing_google_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self, doc_type):
"""This is a docstring.
Parameters:
doc_type (str): Google
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-doc", node=node),
Message(msg_id="missing-yield-type-doc", node=node),
):
self.checker.visit_yield(yield_node)
def test_warn_missing_numpy_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self, doc_type):
"""This is a docstring.
Arguments
---------
doc_type : str
Numpy
"""
yield False
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(
Message(msg_id="missing-yield-doc", node=node),
Message(msg_id="missing-yield-type-doc", node=node),
):
self.checker.visit_yield(yield_node)
def test_find_sphinx_yields(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:return: Always False
:rtype: bool
"""
yield False #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_find_google_yields(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
bool: Always False
"""
yield False #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_find_numpy_yields(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
bool
Always False
"""
yield False #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_sphinx_yield_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:returns: An object
:rtype: :class:`mymodule.Class`
"""
yield mymodule.Class() #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_google_yield_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
mymodule.Class: An object
"""
yield mymodule.Class() #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_numpy_yield_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
mymodule.Class
An object
"""
yield mymodule.Class() #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_sphinx_yield_list_of_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:returns: An object
:rtype: list(:class:`mymodule.Class`)
"""
yield [mymodule.Class()] #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_google_yield_list_of_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
list(:class:`mymodule.Class`): An object
"""
yield [mymodule.Class()] #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_finds_numpy_yield_list_of_custom_class(self) -> None:
yield_node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
list(:class:`mymodule.Class`)
An object
"""
yield [mymodule.Class()] #@
'''
)
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_warns_sphinx_yield_list_of_custom_class_without_description(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
:rtype: list(:class:`mymodule.Class`)
"""
yield [mymodule.Class()]
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(Message(msg_id="missing-yield-doc", node=node)):
self.checker.visit_yield(yield_node)
def test_warns_google_yield_list_of_custom_class_without_description(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
list(:class:`mymodule.Class`):
"""
yield [mymodule.Class()]
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(Message(msg_id="missing-yield-doc", node=node)):
self.checker.visit_yield(yield_node)
def test_warns_numpy_yield_list_of_custom_class_without_description(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
list(:class:`mymodule.Class`)
"""
yield [mymodule.Class()]
'''
)
yield_node = node.body[0]
with self.assertAddsMessages(Message(msg_id="missing-yield-doc", node=node)):
self.checker.visit_yield(yield_node)
# No such thing as redundant yield documentation for sphinx because it
# doesn't support yield documentation
def test_ignores_google_redundant_yield_doc_multiple_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
int or None: One, or sometimes None.
"""
if a_func():
yield None
yield 1
'''
)
with self.assertNoMessages():
self.checker.visit_functiondef(node)
def test_ignores_numpy_redundant_yield_doc_multiple_yields(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
int
One
None
Sometimes
"""
if a_func():
yield None
yield 1
'''
)
with self.assertNoMessages():
self.checker.visit_functiondef(node)
# No such thing as redundant yield documentation for sphinx because it
# doesn't support yield documentation
def test_warns_google_redundant_yield_doc_return(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields:
int: One
"""
return 1
'''
)
with self.assertAddsMessages(Message(msg_id="redundant-yields-doc", node=node)):
self.checker.visit_functiondef(node)
def test_warns_numpy_redundant_yield_doc_return(self) -> None:
node = astroid.extract_node(
'''
def my_func(self):
"""This is a docstring.
Yields
-------
int
One
"""
return 1
'''
)
with self.assertAddsMessages(Message(msg_id="redundant-yields-doc", node=node)):
self.checker.visit_functiondef(node)
def test_sphinx_missing_yield_type_with_annotations(self) -> None:
node = astroid.extract_node(
'''
import typing
def generator() -> typing.Iterator[int]:
"""A simple function for checking type hints.
:returns: The number 0
"""
yield 0
'''
)
yield_node = node.body[0]
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
def test_google_missing_yield_type_with_annotations(self) -> None:
node = astroid.extract_node(
'''
import typing
def generator() -> typing.Iterator[int]:
"""A simple function for checking type hints.
Yields:
The number 0
"""
yield 0
'''
)
yield_node = node.body[0]
with self.assertNoMessages():
self.checker.visit_yield(yield_node)
|
