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
|
"""Tests for generic docstring routines."""
import pytest
from docstring_parser.common import DocstringStyle, ParseError
from docstring_parser.parser import parse
def test_rest() -> None:
"""Test ReST-style parser autodetection."""
docstring = parse(
"""
Short description
Long description
Causing people to indent:
A lot sometimes
:param spam: spam desc
:param int bla: bla desc
:param str yay:
:raises ValueError: exc desc
:returns tuple: ret desc
"""
)
assert docstring.style == DocstringStyle.REST
assert docstring.short_description == "Short description"
assert docstring.long_description == (
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert docstring.description == (
"Short description\n\n"
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert len(docstring.params) == 3
assert docstring.params[0].arg_name == "spam"
assert docstring.params[0].type_name is None
assert docstring.params[0].description == "spam desc"
assert docstring.params[1].arg_name == "bla"
assert docstring.params[1].type_name == "int"
assert docstring.params[1].description == "bla desc"
assert docstring.params[2].arg_name == "yay"
assert docstring.params[2].type_name == "str"
assert docstring.params[2].description == ""
assert len(docstring.raises) == 1
assert docstring.raises[0].type_name == "ValueError"
assert docstring.raises[0].description == "exc desc"
assert docstring.returns is not None
assert docstring.returns.type_name == "tuple"
assert docstring.returns.description == "ret desc"
assert docstring.many_returns is not None
assert len(docstring.many_returns) == 1
assert docstring.many_returns[0] == docstring.returns
def test_google() -> None:
"""Test Google-style parser autodetection."""
docstring = parse(
"""Short description
Long description
Causing people to indent:
A lot sometimes
Args:
spam: spam desc
bla (int): bla desc
yay (str):
Raises:
ValueError: exc desc
Returns:
tuple: ret desc
"""
)
assert docstring.style == DocstringStyle.GOOGLE
assert docstring.short_description == "Short description"
assert docstring.long_description == (
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert docstring.description == (
"Short description\n\n"
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert len(docstring.params) == 3
assert docstring.params[0].arg_name == "spam"
assert docstring.params[0].type_name is None
assert docstring.params[0].description == "spam desc"
assert docstring.params[1].arg_name == "bla"
assert docstring.params[1].type_name == "int"
assert docstring.params[1].description == "bla desc"
assert docstring.params[2].arg_name == "yay"
assert docstring.params[2].type_name == "str"
assert docstring.params[2].description == ""
assert len(docstring.raises) == 1
assert docstring.raises[0].type_name == "ValueError"
assert docstring.raises[0].description == "exc desc"
assert docstring.returns is not None
assert docstring.returns.type_name == "tuple"
assert docstring.returns.description == "ret desc"
assert docstring.many_returns is not None
assert len(docstring.many_returns) == 1
assert docstring.many_returns[0] == docstring.returns
def test_numpydoc() -> None:
"""Test numpydoc-style parser autodetection."""
docstring = parse(
"""Short description
Long description
Causing people to indent:
A lot sometimes
Parameters
----------
spam
spam desc
bla : int
bla desc
yay : str
Raises
------
ValueError
exc desc
Other Parameters
----------------
this_guy : int, optional
you know him
Returns
-------
tuple
ret desc
See Also
--------
multiple lines...
something else?
Warnings
--------
multiple lines...
none of this is real!
"""
)
assert docstring.style == DocstringStyle.NUMPYDOC
assert docstring.short_description == "Short description"
assert docstring.long_description == (
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert docstring.description == (
"Short description\n\n"
"Long description\n\n"
"Causing people to indent:\n\n"
" A lot sometimes"
)
assert len(docstring.params) == 4
assert docstring.params[0].arg_name == "spam"
assert docstring.params[0].type_name is None
assert docstring.params[0].description == "spam desc"
assert docstring.params[1].arg_name == "bla"
assert docstring.params[1].type_name == "int"
assert docstring.params[1].description == "bla desc"
assert docstring.params[2].arg_name == "yay"
assert docstring.params[2].type_name == "str"
assert docstring.params[2].description is None
assert docstring.params[3].arg_name == "this_guy"
assert docstring.params[3].type_name == "int"
assert docstring.params[3].is_optional
assert docstring.params[3].description == "you know him"
assert len(docstring.raises) == 1
assert docstring.raises[0].type_name == "ValueError"
assert docstring.raises[0].description == "exc desc"
assert docstring.returns is not None
assert docstring.returns.type_name == "tuple"
assert docstring.returns.description == "ret desc"
assert docstring.many_returns is not None
assert len(docstring.many_returns) == 1
assert docstring.many_returns[0] == docstring.returns
def test_autodetection_error_detection() -> None:
"""Test autodection for the case where one of the parsers throws an error
and another one succeeds.
"""
source = """
Does something useless
:param 3 + 3 a: a param
"""
with pytest.raises(ParseError):
# assert that one of the parsers does raise
parse(source, DocstringStyle.REST)
# assert that autodetection still works
docstring = parse(source)
assert docstring
assert docstring.style == DocstringStyle.GOOGLE
|
