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
|
# -*- coding: utf-8 -*-
# Copyright (c) 2009-2011, 2014 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2012 FELD Boris <lothiraldan@gmail.com>
# Copyright (c) 2013-2014 Google, Inc.
# Copyright (c) 2014-2016 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2014 Arun Persaud <arun@nubati.net>
# Copyright (c) 2014 buck <buck.2019@gmail.com>
# Copyright (c) 2015 Harut <yes@harutune.name>
# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING
"""Check format checker helper functions"""
from __future__ import unicode_literals
import astroid
from astroid import test_utils
from pylint.checkers.format import *
from pylint.testutils import (
CheckerTestCase, Message, set_config, tokenize_str,
)
class MultiStatementLineTest(CheckerTestCase):
CHECKER_CLASS = FormatChecker
def testSingleLineIfStmts(self):
stmt = test_utils.extract_node("""
if True: pass #@
""")
with self.assertAddsMessages(Message('multiple-statements', node=stmt.body[0])):
self.checker.process_tokens([])
self.checker.visit_default(stmt.body[0])
self.checker.config.single_line_if_stmt = True
with self.assertNoMessages():
self.checker.process_tokens([])
self.checker.visit_default(stmt.body[0])
stmt = test_utils.extract_node("""
if True: pass #@
else:
pass
""")
with self.assertAddsMessages(Message('multiple-statements', node=stmt.body[0])):
self.checker.process_tokens([])
self.checker.visit_default(stmt.body[0])
def testTryExceptFinallyNoMultipleStatement(self):
tree = test_utils.extract_node("""
try: #@
pass
except:
pass
finally:
pass""")
with self.assertNoMessages():
self.checker.process_tokens([])
self.checker.visit_default(tree.body[0])
class SuperfluousParenthesesTest(CheckerTestCase):
CHECKER_CLASS = FormatChecker
def testCheckKeywordParensHandlesValidCases(self):
self.checker._keywords_with_parens = set()
cases = [
'if foo:',
'if foo():',
'if (x and y) or z:',
'assert foo()',
'assert ()',
'if (1, 2) in (3, 4):',
'if (a or b) in c:',
'return (x for x in x)',
'if (x for x in x):',
'for x in (x for x in x):',
'not (foo or bar)',
'not (foo or bar) and baz',
]
with self.assertNoMessages():
for code in cases:
self.checker._check_keyword_parentheses(tokenize_str(code), 0)
def testCheckKeywordParensHandlesUnnecessaryParens(self):
self.checker._keywords_with_parens = set()
cases = [
(Message('superfluous-parens', line=1, args='if'),
'if (foo):', 0),
(Message('superfluous-parens', line=1, args='if'),
'if ((foo, bar)):', 0),
(Message('superfluous-parens', line=1, args='if'),
'if (foo(bar)):', 0),
(Message('superfluous-parens', line=1, args='return'),
'return ((x for x in x))', 0),
(Message('superfluous-parens', line=1, args='not'),
'not (foo)', 0),
(Message('superfluous-parens', line=1, args='not'),
'if not (foo):', 1),
(Message('superfluous-parens', line=1, args='if'),
'if (not (foo)):', 0),
(Message('superfluous-parens', line=1, args='not'),
'if (not (foo)):', 2),
]
for msg, code, offset in cases:
with self.assertAddsMessages(msg):
self.checker._check_keyword_parentheses(tokenize_str(code), offset)
def testFuturePrintStatementWithoutParensWarning(self):
code = """from __future__ import print_function
print('Hello world!')
"""
tree = astroid.parse(code)
with self.assertNoMessages():
self.checker.process_module(tree)
self.checker.process_tokens(tokenize_str(code))
class CheckSpaceTest(CheckerTestCase):
CHECKER_CLASS = FormatChecker
def testParenthesesGood(self):
good_cases = [
'(a)\n',
'(a * (b + c))\n',
'(#\n a)\n',
]
with self.assertNoMessages():
for code in good_cases:
self.checker.process_tokens(tokenize_str(code))
def testParenthesesBad(self):
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'after', 'bracket', '( a)\n^'))):
self.checker.process_tokens(tokenize_str('( a)\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'bracket', '(a )\n ^'))):
self.checker.process_tokens(tokenize_str('(a )\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'bracket', 'foo (a)\n ^'))):
self.checker.process_tokens(tokenize_str('foo (a)\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'bracket', '{1: 2} [1]\n ^'))):
self.checker.process_tokens(tokenize_str('{1: 2} [1]\n'))
def testTrailingCommaGood(self):
with self.assertNoMessages():
self.checker.process_tokens(tokenize_str('(a, )\n'))
self.checker.process_tokens(tokenize_str('(a,)\n'))
self.checker.config.no_space_check = []
with self.assertNoMessages():
self.checker.process_tokens(tokenize_str('(a,)\n'))
@set_config(no_space_check=[])
def testTrailingCommaBad(self):
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'bracket', '(a, )\n ^'))):
self.checker.process_tokens(tokenize_str('(a, )\n'))
def testComma(self):
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'comma', '(a , b)\n ^'))):
self.checker.process_tokens(tokenize_str('(a , b)\n'))
def testSpacesAllowedInsideSlices(self):
good_cases = [
'[a:b]\n',
'[a : b]\n',
'[a : ]\n',
'[:a]\n',
'[:]\n',
'[::]\n',
]
with self.assertNoMessages():
for code in good_cases:
self.checker.process_tokens(tokenize_str(code))
def testKeywordSpacingGood(self):
with self.assertNoMessages():
self.checker.process_tokens(tokenize_str('foo(foo=bar)\n'))
self.checker.process_tokens(tokenize_str('lambda x=1: x\n'))
def testKeywordSpacingBad(self):
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'before', 'keyword argument assignment',
'(foo =bar)\n ^'))):
self.checker.process_tokens(tokenize_str('(foo =bar)\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'after', 'keyword argument assignment',
'(foo= bar)\n ^'))):
self.checker.process_tokens(tokenize_str('(foo= bar)\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('No', 'allowed', 'around', 'keyword argument assignment',
'(foo = bar)\n ^'))):
self.checker.process_tokens(tokenize_str('(foo = bar)\n'))
def testOperatorSpacingGood(self):
good_cases = [
'a = b\n'
'a < b\n'
'a\n< b\n',
]
with self.assertNoMessages():
for code in good_cases:
self.checker.process_tokens(tokenize_str(code))
def testOperatorSpacingBad(self):
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('Exactly one', 'required', 'before', 'comparison', 'a< b\n ^'))):
self.checker.process_tokens(tokenize_str('a< b\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('Exactly one', 'required', 'after', 'comparison', 'a <b\n ^'))):
self.checker.process_tokens(tokenize_str('a <b\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('Exactly one', 'required', 'around', 'comparison', 'a<b\n ^'))):
self.checker.process_tokens(tokenize_str('a<b\n'))
with self.assertAddsMessages(
Message('bad-whitespace', line=1,
args=('Exactly one', 'required', 'around', 'comparison', 'a< b\n ^'))):
self.checker.process_tokens(tokenize_str('a< b\n'))
def testEmptyLines(self):
self.checker.config.no_space_check = []
with self.assertAddsMessages(
Message('trailing-whitespace', line=2)):
self.checker.process_tokens(tokenize_str('a = 1\n \nb = 2\n'))
self.checker.config.no_space_check = ['empty-line']
with self.assertNoMessages():
self.checker.process_tokens(tokenize_str('a = 1\n \nb = 2\n'))
if __name__ == '__main__':
import unittest
unittest.main()
|
