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
|
"""Tests for missing-param-doc and missing-type-doc for Google style docstrings
with accept-no-param-doc = no
Styleguide:
https://google.github.io/styleguide/pyguide.html#doc-function-args
"""
# pylint: disable=invalid-name, unused-argument, undefined-variable
# pylint: disable=line-too-long, too-few-public-methods, missing-class-docstring
# pylint: disable=missing-function-docstring, function-redefined, inconsistent-return-statements
# pylint: disable=dangerous-default-value, too-many-arguments
def test_multi_line_parameters(param: int) -> None:
"""Checks that multi line parameters lists are checked correctly
See https://github.com/pylint-dev/pylint/issues/5452
Args:
param:
a description
"""
print(param)
def test_missing_func_params_in_google_docstring( # [missing-param-doc, missing-type-doc]
x, y, z
):
"""Example of a function with missing Google style parameter
documentation in the docstring
Args:
x: bla
z (int): bar
some other stuff
"""
def test_missing_func_params_with_annotations_in_google_docstring(x: int, y: bool, z):
"""Example of a function with missing Google style parameter
documentation in the docstring.
Args:
x: bla
y: blah blah
z (int): bar
some other stuff
"""
def test_missing_type_doc_google_docstring_exempt_kwonly_args(
arg1: int, arg2: int, *, value1: str, value2: str
):
"""Code to show failure in missing-type-doc
Args:
arg1: First argument.
arg2: Second argument.
value1: First kwarg.
value2: Second kwarg.
"""
print("NOTE: It doesn't like anything after the '*'.")
def test_default_arg_with_annotations_in_google_docstring(
x: int, y: bool, z: int = 786
):
"""Example of a function with missing Google style parameter
documentation in the docstring.
Args:
x: bla
y: blah blah
z: bar
some other stuff
"""
def test_missing_func_params_with_partial_annotations_in_google_docstring( # [missing-type-doc]
x, y: bool, z
):
"""Example of a function with missing Google style parameter
documentation in the docstring.
Args:
x: bla
y: blah blah
z (int): bar
some other stuff
"""
def test_non_builtin_annotations_in_google_docstring(
bottomleft: Point, topright: Point
) -> float:
"""Example of a function with missing Google style parameter
documentation in the docstring.
Args:
bottomleft: bottom left point of rectangle
topright: top right point of rectangle
"""
def test_non_builtin_annotations_for_returntype_in_google_docstring(
bottomleft: Point, topright: Point
) -> Point:
"""Example of a function with missing Google style parameter
documentation in the docstring.
Args:
bottomleft: bottom left point of rectangle
topright: top right point of rectangle
"""
def test_func_params_and_keyword_params_in_google_docstring(this, other, that=True):
"""Example of a function with Google style parameter split
in Args and Keyword Args in the docstring
Args:
this (str): Printed first
other (int): Other args
Keyword Args:
that (bool): Printed second
"""
print(this, that, other)
def test_func_params_and_wrong_keyword_params_in_google_docstring( # [missing-param-doc, missing-type-doc, differing-param-doc, differing-type-doc]
this, other, that=True
):
"""Example of a function with Google style parameter split
in Args and Keyword Args in the docstring but with wrong keyword args
Args:
this (str): Printed first
other (int): Other args
Keyword Args:
these (bool): Printed second
"""
print(this, that, other)
class Foo:
def test_missing_method_params_in_google_docstring( # [missing-param-doc, missing-type-doc]
self, x, y
):
"""Example of a class method with missing parameter documentation in
the Google style docstring
missing parameter documentation
Args:
x: bla
"""
def test_existing_func_params_in_google_docstring(xarg, yarg, zarg, warg):
"""Example of a function with correctly documented parameters and
return values (Google style)
Args:
xarg (int): bla xarg
yarg (my.qualified.type): bla
bla yarg
zarg (int): bla zarg
warg (my.qualified.type): bla warg
Returns:
float: sum
"""
return xarg + yarg
def test_wrong_name_of_func_params_in_google_docstring_one( # [missing-param-doc, missing-type-doc, differing-param-doc, differing-type-doc]
xarg, yarg, zarg
):
"""Example of functions with inconsistent parameter names in the
signature and in the Google style documentation
Args:
xarg1 (int): bla xarg
yarg (float): bla yarg
zarg1 (str): bla zarg
"""
return xarg + yarg
def test_wrong_name_of_func_params_in_google_docstring_two( # [differing-param-doc, differing-type-doc]
xarg, yarg
):
"""Example of functions with inconsistent parameter names in the
signature and in the Google style documentation
Args:
yarg1 (float): bla yarg
For the other parameters, see bla.
"""
return xarg + yarg
def test_see_sentence_for_func_params_in_google_docstring(xarg, yarg):
"""Example for the usage of "For the other parameters, see" to avoid
too many repetitions, e.g. in functions or methods adhering to a
given interface (Google style)
Args:
yarg (float): bla yarg
For the other parameters, see :func:`bla`
"""
return xarg + yarg
class ClassFoo: # [missing-param-doc, missing-type-doc]
"""test_constr_params_in_class_google
Example of a class with missing constructor parameter documentation
(Google style)
Everything is completely analogous to functions.
Args:
y: bla
missing constructor parameter documentation
"""
def __init__(self, x, y):
pass
class ClassFoo:
def __init__(self, x, y): # [missing-param-doc, missing-type-doc]
"""test_constr_params_in_init_google
Example of a class with missing constructor parameter documentation
(Google style)
Args:
y: bla
missing constructor parameter documentation
"""
class ClassFoo: # [multiple-constructor-doc,missing-param-doc, missing-type-doc]
"""test_constr_params_in_class_and_init_google
Example of a class with missing constructor parameter documentation
in both the init docstring and the class docstring
(Google style)
Everything is completely analogous to functions.
Args:
y: bla
missing constructor parameter documentation
"""
def __init__(self, x, y): # [missing-param-doc, missing-type-doc]
"""docstring foo
Args:
y: bla
missing constructor parameter documentation
"""
def test_warns_missing_args_google(named_arg, *args): # [missing-param-doc]
"""The docstring
Args:
named_arg (object): Returned
Returns:
object or None: Maybe named_arg
"""
if args:
return named_arg
def test_warns_missing_kwargs_google(named_arg, **kwargs): # [missing-param-doc]
"""The docstring
Args:
named_arg (object): Returned
Returns:
object or None: Maybe named_arg
"""
if kwargs:
return named_arg
def test_finds_args_without_type_google(named_arg, *args):
"""The docstring
Args:
named_arg (object): Returned
*args: Optional arguments
Returns:
object or None: Maybe named_arg
"""
if args:
return named_arg
def test_finds_kwargs_without_type_google(named_arg, **kwargs):
"""The docstring
Args:
named_arg (object): Returned
**kwargs: Keyword arguments
Returns:
object or None: Maybe named_arg
"""
if kwargs:
return named_arg
def test_finds_kwargs_without_asterisk_google(named_arg, **kwargs):
"""The docstring
Args:
named_arg (object): Returned
kwargs: Keyword arguments
Returns:
object or None: Maybe named_arg
"""
if kwargs:
return named_arg
def test_finds_escaped_args_google(value: int, *args: Any) -> None:
"""This is myfunc.
Args:
\\*args: this is args
value: this is value
"""
print(*args, value)
def test_finds_args_with_xref_type_google(named_arg, **kwargs):
"""The docstring
Args:
named_arg (`example.value`): Returned
**kwargs: Keyword arguments
Returns:
`example.value`: Maybe named_arg
"""
if kwargs:
return named_arg
def test_ignores_optional_specifier_google(
param1, param2, param3=(), param4=[], param5=[], param6=True
):
"""Do something.
Args:
param1 (str): Description.
param2 (dict(str, int)): Description.
param3 (tuple(str), optional): Defaults to empty. Description.
param4 (List[str], optional): Defaults to empty. Description.
param5 (list[tuple(str)], optional): Defaults to empty. Description.
param6 (bool, optional): Defaults to True. Description.
Returns:
int: Description.
"""
return param1, param2, param3, param4, param5, param6
def test_finds_multiple_complex_types_google(
named_arg_one,
named_arg_two,
named_arg_three,
named_arg_four,
named_arg_five,
named_arg_six,
named_arg_seven,
named_arg_eight,
named_arg_nine,
named_arg_ten,
):
"""The google docstring
Args:
named_arg_one (dict(str, str)): Returned
named_arg_two (dict[str, str]): Returned
named_arg_three (int or str): Returned
named_arg_four (tuple(int or str)): Returned
named_arg_five (tuple(int) or list(int)): Returned
named_arg_six (tuple(int or str) or list(int or str)): Returned
named_arg_seven (dict(str,str)): Returned
named_arg_eight (dict[str,str]): Returned
named_arg_nine (tuple(int)): Returned
named_arg_ten (list[tokenize.TokenInfo]): Returned
Returns:
dict(str, str): named_arg_one
dict[str, str]: named_arg_two
int or str: named_arg_three
tuple(int or str): named_arg_four
tuple(int) or list(int): named_arg_five
tuple(int or str) or list(int or str): named_arg_six
dict(str,str): named_arg_seven
dict[str,str]: named_arg_eight
tuple(int): named_arg_nine
list[tokenize.TokenInfo]: named_arg_ten
"""
return (
named_arg_one,
named_arg_two,
named_arg_three,
named_arg_four,
named_arg_five,
named_arg_six,
named_arg_seven,
named_arg_eight,
named_arg_nine,
named_arg_ten,
)
def test_escape_underscore(something: int, raise_: bool = False) -> bool:
"""Tests param with escaped _ is handled correctly.
Args:
something: the something
raise\\_: the other
Returns:
something
"""
return something and raise_
|