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
|
"""Example module
This is a description
"""
import collections
from dataclasses import dataclass
from functools import cached_property
import typing
A_TUPLE = ("a", "b")
"""A tuple to be rendered as a tuple."""
A_LIST = ["c", "d"]
"""A list to be rendered as a list."""
class Foo:
"""Can we parse arguments from the class docstring?
:param attr: Set an attribute.
:type attr: str
"""
class_var = 42 #: Class var docstring
another_class_var = 42
"""Another class var docstring"""
class Meta:
"""A nested class just to test things out"""
@classmethod
def foo():
"""The foo class method"""
return True
def __init__(self, attr):
"""Constructor docstring"""
self.attr = attr
self.attr2 = attr
"""This is the docstring of an instance attribute.
:type: str
"""
@property
def attr(self):
return 5
@attr.setter
def attr(self, value):
pass
@property
def property_simple(self) -> int:
"""This property should parse okay."""
return 42
@cached_property
def my_cached_property(self) -> int:
"""This cached property should be a property."""
return 42
def method_okay(self, foo=None, bar=None):
"""This method should parse okay"""
return True
def method_multiline(self, foo=None, bar=None, baz=None):
"""This is on multiple lines, but should parse okay too
pydocstyle gives us lines of source. Test if this means that multiline
definitions are covered in the way we're anticipating here
"""
return True
def method_tricky(self, foo=None, bar=dict(foo=1, bar=2)):
"""This will likely fail our argument testing
We parse naively on commas, so the nested dictionary will throw this off
"""
return True
def method_sphinx_docs(self, foo, bar=0):
"""This method is documented with sphinx style docstrings.
:param foo: The first argument.
:type foo: int
:param int bar: The second argument.
:returns: The sum of foo and bar.
:rtype: int
"""
return foo + bar
def method_google_docs(self, foo, bar=0):
"""This method is documented with google style docstrings.
Args:
foo (int): The first argument.
bar (int): The second argument.
Returns:
int: The sum of foo and bar.
"""
return foo + bar
def method_sphinx_unicode(self):
"""This docstring uses unicodé.
:returns: A string.
:rtype: str
"""
return "sphinx"
def method_google_unicode(self):
"""This docstring uses unicodé.
Returns:
str: A string.
"""
return "google"
Foo.bar = "dinglebop"
def decorator_okay(func):
"""This decorator should parse okay."""
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
class Bar(Foo):
def method_okay(self, foo=None, bar=None):
pass
class ClassWithNoInit:
pass
class One:
"""One."""
def __init__(self):
"""One __init__."""
super().__init__()
class MultilineOne(One):
"""This is a naughty summary line
that exists on two lines."""
class Two(One):
"""Two."""
class Three:
__init__ = Two.__init__
def fn_with_long_sig(
this,
*,
function=None,
has=True,
quite=True,
a,
long,
signature,
many,
keyword,
arguments,
):
"""A function with a long signature."""
TYPED_DATA: int = 1
"""This is TYPED_DATA."""
@dataclass
class TypedAttrs:
one: str
"""This is TypedAttrs.one."""
two: int = 1
"""This is TypedAttrs.two."""
class TypedClassInit:
"""This is TypedClassInit."""
def __init__(self, one: int = 1) -> None:
self._one = one
def typed_method(self, two: int) -> int:
"""This is TypedClassInit.typed_method."""
return self._one + two
UniqueValue = collections.namedtuple("UniqueValue", ("value", "count"))
TypedUniqueValue = typing.NamedTuple(
"TypedUniqueValue", [("value", str), ("count", int)]
)
|
