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
|
"""
Module docstring.
Attributes:
DESCRIBED_IN_MODULE_DOCSTRING: Described in module docstring.
DESCRIBED_AND_ANNOTATED_IN_MODULE_DOCSTRING (bool): Described and annotated in module docstring.
DESCRIBED_IN_BOTH: Described in both.
DESCRIBED_AND_ANNOTATED_IN_BOTH (bool): Described and annotated in both.
"""
from datetime import datetime
from typing import Optional, Tuple
from marshmallow import Schema, fields
from pydantic import BaseModel
NO_DOC_NO_TYPE = 0
NO_TYPE = 1
"""No type."""
NO_DOC_NO_VALUE: int
NO_VALUE: str
"""No value."""
NO_DOC: int = 2
FULL: int = 3
"""Full."""
DESCRIBED_IN_MODULE_DOCSTRING: bool = True
DESCRIBED_AND_ANNOTATED_IN_MODULE_DOCSTRING = True
DESCRIBED_IN_BOTH: bool = True
"""Described in both."""
DESCRIBED_AND_ANNOTATED_IN_BOTH: bool = True
"""Described and annotated in both."""
COMPLEX_TYPE: Optional[Tuple[int, str]] = None
"""Complex type."""
ATTRIBUTE_C1: "C"
"""Forward reference for type."""
ATTRIBUTE_C2: Optional["C"] = None
"""Optional forward reference for type."""
class C:
"""
Class doctring.
Attributes:
DESCRIBED_IN_CLASS_DOCSTRING: Described in class docstring.
DESCRIBED_AND_ANNOTATED_IN_CLASS_DOCSTRING (bool): Described and annotated in class docstring.
DESCRIBED_IN_BOTH: Described in both.
DESCRIBED_AND_ANNOTATED_IN_BOTH (bool): Described and annotated in both.
described_in_class_docstring: Described in class docstring.
described_and_annotated_in_class_docstring (bool): Described and annotated in class docstring.
described_in_both: Described in both.
described_and_annotated_in_both (bool): Described and annotated in both.
"""
IN_CLASS = 0
"""In class."""
DESCRIBED_IN_CLASS_DOCSTRING: bool = True
DESCRIBED_AND_ANNOTATED_IN_CLASS_DOCSTRING = True
DESCRIBED_IN_BOTH: bool = True
"""Described in both."""
DESCRIBED_AND_ANNOTATED_IN_BOTH: bool = True
"""Described and annotated in both."""
both_class_and_instance_attribute: Optional[bool] = None
def __init__(self) -> None:
self.in_init = True
"""In init."""
self.annotated_in_init: bool = True
"""Annotated in init."""
self.described_in_class_docstring: bool = True
self.described_and_annotated_in_class_docstring = True
self.described_in_both: bool = True
"""Described in both."""
self.described_and_annotated_in_both: bool = True
"""Described and annotated in both."""
non_attribute: bool = True
"""Non attribute."""
if not self.both_class_and_instance_attribute:
self.both_class_and_instance_attribute = True
class D:
def __init__(self) -> None:
"""
Init doctring.
Attributes:
described_in_class_docstring: Described in class docstring.
described_and_annotated_in_class_docstring (bool): Described and annotated in class docstring.
described_in_both: Described in both.
described_and_annotated_in_both (bool): Described and annotated in both.
"""
self.in_init = True
"""In init."""
self.annotated_in_init: bool = True
"""Annotated in init."""
self.described_in_class_docstring: bool = True
self.described_and_annotated_in_class_docstring = True
self.described_in_both: bool = True
"""Described in both."""
self.described_and_annotated_in_both: bool = True
"""Described and annotated in both."""
non_attribute: bool = True
"""Non attribute."""
if not self.both_class_and_instance_attribute: # type: ignore[has-type]
self.both_class_and_instance_attribute = True
class E:
"""
Class doctring.
Attributes:
DESCRIBED_IN_CLASS_DOCSTRING: Described in class docstring.
DESCRIBED_AND_ANNOTATED_IN_CLASS_DOCSTRING (bool): Described and annotated in class docstring.
DESCRIBED_IN_BOTH: Described in both.
DESCRIBED_AND_ANNOTATED_IN_BOTH (bool): Described and annotated in both.
described_in_class_and_init_docstring: Described in class and init docstring.
described_and_annotated_in_class_and_init_docstring (bool): Described and annotated in class and init docstring.
described_everywhere: Described everywhere.
described_and_annotated_everywhere (bool): Described and annotated everywhere.
"""
IN_CLASS = 0
"""In class."""
DESCRIBED_IN_CLASS_DOCSTRING: bool = True
DESCRIBED_AND_ANNOTATED_IN_CLASS_DOCSTRING = True
DESCRIBED_IN_BOTH: bool = True
"""Described in both."""
DESCRIBED_AND_ANNOTATED_IN_BOTH: bool = True
"""Described and annotated in both."""
both_class_and_instance_attribute: Optional[bool] = None
DEDENT = 0
"""This docstring starts immediately (no blank line).
Use `inspect.cleandoc` instead of `textwrap.dedent`."""
def __init__(self) -> None:
"""
Init doctring.
Attributes:
described_in_class_and_init_docstring: Described in class and init docstring.
described_and_annotated_in_class_and_init_docstring (bool): Described and annotated in class and init docstring.
described_everywhere: Described everywhere.
described_and_annotated_everywhere (bool): Described and annotated everywhere.
"""
self.in_init = True
"""In init."""
self.annotated_in_init: bool = True
"""Annotated in init."""
self.described_in_class_and_init_docstring: bool = True
self.described_and_annotated_in_class_and_init_docstring = True
self.described_everywhere: bool = True
"""Described everywhere."""
self.described_and_annotated_everywhere: bool = True
"""Described and annotated everywhere."""
non_attribute: bool = True
"""Non attribute."""
non_attribute2 = True
"""Non attribute 2."""
if not self.both_class_and_instance_attribute:
self.both_class_and_instance_attribute = True
d = D()
d.non_self_attribute = 0 # type: ignore[attr-defined]
"""Non self attribute."""
self.d = d
self.d.non_self_attribute2 = 0 # type: ignore[attr-defined]
"""Non self attribute 2."""
c = C()
c.non_self_attribute: int = 0 # type: ignore[attr-defined,misc]
"""Non self attribute."""
self.c = c
self.c.non_self_attribute2: int = 0 # type: ignore[attr-defined,misc]
"""Non self attribute 2."""
self.dedent = 0
"""This docstring starts immediately (no blank line).
Use `inspect.cleandoc` instead of `textwrap.dedent`."""
if True:
IN_IF: bytes = b""
"""In if."""
ANNOTATED_IN_IF: str = ""
"""Annotated in if."""
else:
IN_ELSE: list = []
"""In else."""
try:
IN_TRY: int = 1000
"""In try."""
except: # noqa
IN_EXCEPT: float = 9000.0
"""In except."""
else:
IN_TRY_ELSE: str = "-1"
"""In try else."""
finally:
IN_FINALLY: bool = bool(-9000)
"""In finally."""
class Model(BaseModel):
in_pydantic_model: int
"""In Pydantic model."""
model_field: Optional[datetime] = None
"""A model field."""
class MarshmallowSchema(Schema):
in_marshmallow_model: int
"""In Marshmallow model."""
model_field: fields.Str = fields.Str()
"""A model field."""
OK, WARNING, CRITICAL, UNKNOWN = 0, 0, 0, 0
if True:
DEDENT = 0
"""This docstring starts immediately (no blank line).
Use `inspect.cleandoc` instead of `textwrap.dedent`."""
|
