-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample_code.py
More file actions
444 lines (308 loc) · 5.29 KB
/
Copy pathexample_code.py
File metadata and controls
444 lines (308 loc) · 5.29 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
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
def missing_in_docstring(foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
"""
def has_self(self, foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
def missing_in_docstring_with_self(self, foo, bar, baz):
"""
Does something.
:param bar:
:param baz:
"""
def docstring_wrong_order(self, foo, bar, baz):
"""
Does something.
:param bar:
:param foo:
:param baz:
"""
def missing_in_signature(foo, bar):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
def missing_in_signature_with_self(self, foo, bar):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
class ClassMissingDocstring:
"""
A class.
:param foo:
:param bar:
"""
def __init__(self, foo, bar, baz):
pass
@classmethod
def is_classmethod(cls, foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
@classmethod
def missing_in_docstring_with_classmethod(cls, foo, bar, baz):
"""
Does something.
:param foo:
:param baz:
"""
@classmethod
def missing_in_signature_with_classmethod(cls, foo, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
@property
def a_property(self):
"""
A property.
"""
@a_property.setter
def a_property(self, val):
"""
A property.
"""
class ClassMissingSignature:
"""
A class.
:param foo:
:param bar:
:param baz:
"""
def __init__(self, foo, bar):
pass
class ClassWrongOrder:
"""
A class.
:param bar:
:param foo:
:param baz:
"""
def __init__(self, foo, bar, baz):
pass
class ClassNoInit:
"""
A class.
:param foo:
:param bar:
:param baz:
"""
class ClassNoDocstring:
def __init__(self, foo, bar, baz):
pass
class ClassInitDocstring:
def __init__(self, foo, bar, baz):
"""
Setup the function.
:param foo:
:param bar:
:param baz:
"""
class GoodClass:
"""
A class.
:param foo:
:param bar:
:param baz:
"""
def __init__(self, foo, bar, baz):
pass
# 3rd party
import click
@click.argument("-f", "--foo")
@click.command()
def a_command(foo):
"""
Command line entry point.
"""
def no_docstring(foo, bar, baz):
pass
async def missing_in_docstring_async(foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
"""
async def has_self_async(self, foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
async def missing_in_docstring_with_self_async(self, foo, bar, baz):
"""
Does something.
:param bar:
:param baz:
"""
async def docstring_wrong_order_async(self, foo, bar, baz):
"""
Does something.
:param bar:
:param foo:
:param baz:
"""
async def missing_in_signature_async(foo, bar):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
async def missing_in_signature_with_self_async(self, foo, bar):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
class AsyncClass:
"""
A class.
"""
@classmethod
async def is_classmethod(cls, foo, bar, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
@classmethod
async def missing_in_docstring_with_classmethod(cls, foo, bar, baz):
"""
Does something.
:param foo:
:param baz:
"""
@classmethod
async def missing_in_signature_with_classmethod(cls, foo, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
async def no_docstring_async(foo, bar, baz):
pass
def missing_args(foo, bar, *baz):
"""
Does something.
:param foo:
:param bar:
"""
def has_args(foo, bar, *baz):
r"""
Does something.
:param foo:
:param bar:
:param \*baz:
"""
def missing_kwargs(foo, bar, **baz):
"""
Does something.
:param foo:
:param bar:
"""
def has_kwargs(foo, bar, **baz):
r"""
Does something.
:param foo:
:param bar:
:param \*\*baz:
"""
def keyword_only(foo, bar, *, baz=None):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
def positional_only(foo, /, bar, baz):
"""
Does something.
:param foo:
:param bar:
:param baz:
"""
# stdlib
from typing import Optional, Tuple, overload
class MyTuple(Tuple[int, str, int]): # noqa: SLOT001
def __new__(cls, a: int, b: str, c: int = 0) -> "MyTuple":
"""
Create a new :class:`~.MyTuple`.
:rtype: :class:`~.MyTuple`.
"""
return super().__new__((a, b, c)) # type: ignore[arg-type]
# stdlib
from abc import ABC
class MyABC(ABC):
def __init_subclass__(cls, swallow, **kwargs) -> None:
r"""
Setup something in the subclass.
:param \*\*kwargs:
"""
# 3rd party
import pytest
@pytest.fixture()
def a_fixture(foo) -> str:
"""
A pytest fixture .
"""
return "abc"
click_command = click.command
@click.argument("-f", "--foo")
@click_command()
def another_command(foo):
"""
Command line entry point.
"""
def duplicated_params(tree: list) -> None:
"""
Does something.
:param tree:
:param tree:
"""
def has_underscores(foo, bar, baz_):
r"""
Does something.
:param foo:
:param bar:
:param baz\_:
"""
class FRange:
"""
A class with overloaded __init__.
:param start:
:param stop:
:param step:
"""
@overload
def __init__(self, stop: float) -> None: ...
@overload
def __init__(self, start: float, stop: float, step: float = ...) -> None: ...
def __init__( # type: ignore[misc]
self,
start: Optional[float] = None,
stop: Optional[float] = None,
step: float = 1.0,
) -> None:
pass