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
|
"""Unittest for the base checker."""
import re
import sys
import unittest
from astroid import test_utils
from pylint.checkers import base
from pylint.testutils import CheckerTestCase, Message, set_config
class DocstringTest(CheckerTestCase):
CHECKER_CLASS = base.DocStringChecker
def test_missing_docstring_module(self):
module = test_utils.build_module("something")
with self.assertAddsMessages(Message('missing-docstring', node=module, args=('module',))):
self.checker.visit_module(module)
def test_missing_docstring_emtpy_module(self):
module = test_utils.build_module("")
with self.assertNoMessages():
self.checker.visit_module(module)
def test_empty_docstring_module(self):
module = test_utils.build_module("''''''")
with self.assertAddsMessages(Message('empty-docstring', node=module, args=('module',))):
self.checker.visit_module(module)
def test_empty_docstring_function(self):
func = test_utils.extract_node("""
def func(tion):
pass""")
with self.assertAddsMessages(Message('missing-docstring', node=func, args=('function',))):
self.checker.visit_function(func)
@set_config(docstring_min_length=2)
def test_short_function_no_docstring(self):
func = test_utils.extract_node("""
def func(tion):
pass""")
with self.assertNoMessages():
self.checker.visit_function(func)
@set_config(docstring_min_length=2)
def test_function_no_docstring_by_name(self):
func = test_utils.extract_node("""
def __fun__(tion):
pass""")
with self.assertNoMessages():
self.checker.visit_function(func)
def test_class_no_docstring(self):
klass = test_utils.extract_node("""
class Klass(object):
pass""")
with self.assertAddsMessages(Message('missing-docstring', node=klass, args=('class',))):
self.checker.visit_class(klass)
class NameCheckerTest(CheckerTestCase):
CHECKER_CLASS = base.NameChecker
CONFIG = {
'bad_names': set(),
}
@set_config(include_naming_hint=True)
def test_naming_hint(self):
const = test_utils.extract_node("""
const = "CONSTANT" #@
""")
with self.assertAddsMessages(
Message('invalid-name', node=const.targets[0],
args=('constant', 'const', ' (hint: (([A-Z_][A-Z0-9_]*)|(__.*__))$)'))):
self.checker.visit_assname(const.targets[0])
@set_config(include_naming_hint=True,
const_name_hint='CONSTANT')
def test_naming_hint_configured_hint(self):
const = test_utils.extract_node("""
const = "CONSTANT" #@
""")
with self.assertAddsMessages(
Message('invalid-name', node=const.targets[0],
args=('constant', 'const', ' (hint: CONSTANT)'))):
self.checker.visit_assname(const.targets[0])
@set_config(attr_rgx=re.compile('[A-Z]+'))
def test_property_names(self):
# If a method is annotated with @property, it's name should
# match the attr regex. Since by default the attribute regex is the same
# as the method regex, we override it here.
methods = test_utils.extract_node("""
import abc
class FooClass(object):
@property
def FOO(self): #@
pass
@property
def bar(self): #@
pass
@abc.abstractproperty
def BAZ(self): #@
pass
""")
with self.assertNoMessages():
self.checker.visit_function(methods[0])
self.checker.visit_function(methods[2])
with self.assertAddsMessages(Message('invalid-name', node=methods[1],
args=('attribute', 'bar', ''))):
self.checker.visit_function(methods[1])
@set_config(attr_rgx=re.compile('[A-Z]+'))
def test_property_setters(self):
method = test_utils.extract_node("""
class FooClass(object):
@property
def foo(self): pass
@foo.setter
def FOOSETTER(self): #@
pass
""")
with self.assertNoMessages():
self.checker.visit_function(method)
def test_module_level_names(self):
assign = test_utils.extract_node("""
import collections
Class = collections.namedtuple("a", ("b", "c")) #@
""")
with self.assertNoMessages():
self.checker.visit_assname(assign.targets[0])
assign = test_utils.extract_node("""
class ClassA(object):
pass
ClassB = ClassA
""")
with self.assertNoMessages():
self.checker.visit_assname(assign.targets[0])
module = test_utils.build_module("""
def A():
return 1, 2, 3
CONSTA, CONSTB, CONSTC = A()
CONSTD = A()""")
with self.assertNoMessages():
self.checker.visit_assname(module.body[1].targets[0].elts[0])
self.checker.visit_assname(module.body[2].targets[0])
assign = test_utils.extract_node("""
CONST = "12 34 ".rstrip().split()""")
with self.assertNoMessages():
self.checker.visit_assname(assign.targets[0])
class MultiNamingStyleTest(CheckerTestCase):
CHECKER_CLASS = base.NameChecker
MULTI_STYLE_RE = re.compile('(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$')
@set_config(class_rgx=MULTI_STYLE_RE)
def test_multi_name_detection_majority(self):
classes = test_utils.extract_node("""
class classb(object): #@
pass
class CLASSA(object): #@
pass
class CLASSC(object): #@
pass
""")
with self.assertAddsMessages(Message('invalid-name', node=classes[0], args=('class', 'classb', ''))):
for cls in classes:
self.checker.visit_class(cls)
self.checker.leave_module(cls.root)
@set_config(class_rgx=MULTI_STYLE_RE)
def test_multi_name_detection_first_invalid(self):
classes = test_utils.extract_node("""
class class_a(object): #@
pass
class classb(object): #@
pass
class CLASSC(object): #@
pass
""")
with self.assertAddsMessages(Message('invalid-name', node=classes[0], args=('class', 'class_a', '')),
Message('invalid-name', node=classes[2], args=('class', 'CLASSC', ''))):
for cls in classes:
self.checker.visit_class(cls)
self.checker.leave_module(cls.root)
@set_config(method_rgx=MULTI_STYLE_RE,
function_rgx=MULTI_STYLE_RE,
name_group=('function:method',))
def test_multi_name_detection_group(self):
function_defs = test_utils.extract_node("""
class First(object):
def func(self): #@
pass
def FUNC(): #@
pass
""", module_name='test')
with self.assertAddsMessages(Message('invalid-name', node=function_defs[1], args=('function', 'FUNC', ''))):
for func in function_defs:
self.checker.visit_function(func)
self.checker.leave_module(func.root)
@set_config(function_rgx=re.compile('(?:(?P<ignore>FOO)|(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$'))
def test_multi_name_detection_exempt(self):
function_defs = test_utils.extract_node("""
def FOO(): #@
pass
def lower(): #@
pass
def FOO(): #@
pass
def UPPER(): #@
pass
""")
with self.assertAddsMessages(Message('invalid-name', node=function_defs[3], args=('function', 'UPPER', ''))):
for func in function_defs:
self.checker.visit_function(func)
self.checker.leave_module(func.root)
if __name__ == '__main__':
unittest.main()
|
