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
|
"""Unit tests for the pylint checkers in :mod:`pylint.extensions.check_docs`,
in particular the Sphinx parameter documentation checker `SphinxDocChecker`
"""
from __future__ import division, print_function, absolute_import
import unittest
from astroid import test_utils
from pylint.testutils import CheckerTestCase, Message
from pylint.extensions.check_docs import SphinxDocChecker
class SpinxDocCheckerTest(CheckerTestCase):
"""Tests for pylint_plugin.SphinxDocChecker"""
CHECKER_CLASS = SphinxDocChecker
def test_missing_func_params_in_docstring(self):
"""Example of a function with missing parameter documentation in the
docstring
"""
node = test_utils.extract_node("""
def function_foo(x, y):
'''docstring ...
missing parameter documentation'''
pass
""")
with self.assertAddsMessages(
Message(
msg_id='missing-sphinx-param',
node=node,
args=('x, y',)),
Message(
msg_id='missing-sphinx-type',
node=node,
args=('x, y',))
):
self.checker.visit_function(node)
def test_missing_method_params_in_docstring(self):
"""Example of a class method with missing parameter documentation in
the docstring
"""
node = test_utils.extract_node("""
class Foo(object):
def method_foo(self, x, y):
'''docstring ...
missing parameter documentation'''
pass
""")
method_node = node.body[0]
with self.assertAddsMessages(
Message(
msg_id='missing-sphinx-param',
node=method_node,
args=('x, y',)),
Message(
msg_id='missing-sphinx-type',
node=method_node,
args=('x, y',))
):
self.checker.visit_class(node)
def test_existing_func_params_in_docstring(self):
"""Example of a function with correctly documented parameters and
return values
"""
node = test_utils.extract_node("""
def function_foo(xarg, yarg, zarg):
'''function foo ...
:param xarg: bla xarg
:type xarg: int
:param yarg: bla yarg
:type yarg: float
:param int zarg: bla zarg
:return: sum
:rtype: float
'''
return xarg + yarg
""")
with self.assertNoMessages():
self.checker.visit_function(node)
def test_wrong_name_of_func_params_in_docstring(self):
"""Example of functions with inconsistent parameter names in the
signature and in the documentation
"""
node = test_utils.extract_node("""
def function_foo(xarg, yarg, zarg):
'''function foo ...
:param xarg1: bla xarg
:type xarg: int
:param yarg: bla yarg
:type yarg1: float
:param str zarg1: bla zarg
'''
return xarg + yarg
""")
with self.assertAddsMessages(
Message(
msg_id='missing-sphinx-param',
node=node,
args=('xarg, xarg1, zarg, zarg1',)),
Message(
msg_id='missing-sphinx-type',
node=node,
args=('yarg, yarg1, zarg',)),
):
self.checker.visit_function(node)
node = test_utils.extract_node("""
def function_foo(xarg, yarg):
'''function foo ...
:param yarg1: bla yarg
:type yarg1: float
For the other parameters, see bla.
'''
return xarg + yarg
""")
with self.assertAddsMessages(
Message(
msg_id='missing-sphinx-param',
node=node,
args=('yarg1',)),
Message(
msg_id='missing-sphinx-type',
node=node,
args=('yarg1',))
):
self.checker.visit_function(node)
def test_see_sentence_for_func_params_in_docstring(self):
"""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
"""
node = test_utils.extract_node("""
def function_foo(xarg, yarg):
'''function foo ...
:param yarg: bla yarg
:type yarg: float
For the other parameters, see :func:`bla`
'''
return xarg + yarg
""")
with self.assertNoMessages():
self.checker.visit_function(node)
def test_constr_params_in_class(self):
"""Example of a class with missing constructor parameter documentation
Everything is completely analogous to functions.
"""
node = test_utils.extract_node("""
class ClassFoo(object):
'''docstring foo
missing constructor parameter documentation'''
def __init__(self, x, y):
pass
""")
with self.assertAddsMessages(
Message(
msg_id='missing-sphinx-param',
node=node,
args=('x, y',)),
Message(
msg_id='missing-sphinx-type',
node=node,
args=('x, y',))
):
self.checker.visit_class(node)
if __name__ == '__main__':
unittest.main()
|
