-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
unittest_typecheck.py
339 lines (302 loc) · 10.6 KB
/
unittest_typecheck.py
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# Copyright (c) 2014 Google, Inc.
# Copyright (c) 2014 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2014 Holger Peters <email@holger-peters.de>
# Copyright (c) 2015-2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2015 Dmitry Pribysh <dmand@yandex.ru>
# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
# Copyright (c) 2016 Derek Gustafson <degustaf@gmail.com>
# Copyright (c) 2016 Filipe Brandenburger <filbranden@google.com>
# Copyright (c) 2017 Łukasz Rogalski <rogalski.91@gmail.com>
# Copyright (c) 2018 Bryce Guinta <bryce.paul.guinta@gmail.com>
# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
# Copyright (c) 2019 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2019 Martin Vielsmaier <martin.vielsmaier@gmail.com>
# Copyright (c) 2019 Federico Bond <federicobond@gmail.com>
# Copyright (c) 2020 Julien Palard <julien@palard.fr>
# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2020 Damien Baty <damien.baty@polyconseil.fr>
# Copyright (c) 2020 Anthony Sottile <asottile@umich.edu>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 David Liu <david@cs.toronto.edu>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Copyright (c) 2021 David Gilman <davidgilman1@gmail.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
import astroid
import pytest
from pylint.checkers import typecheck
from pylint.interfaces import INFERENCE, UNDEFINED
from pylint.testutils import CheckerTestCase, MessageTest, set_config
try:
from coverage import tracer as _ # pylint: disable=unused-import
C_EXTENTIONS_AVAILABLE = True
except ImportError:
_ = None
C_EXTENTIONS_AVAILABLE = False
needs_c_extension = pytest.mark.skipif(
not C_EXTENTIONS_AVAILABLE, reason="Requires coverage (source of C-extension)"
)
class TestTypeChecker(CheckerTestCase):
"Tests for pylint.checkers.typecheck"
CHECKER_CLASS = typecheck.TypeChecker
def test_no_member_in_getattr(self) -> None:
"""Make sure that a module attribute access is checked by pylint."""
node = astroid.extract_node(
"""
import optparse
optparse.THIS_does_not_EXIST
"""
)
with self.assertAddsMessages(
MessageTest(
"no-member",
node=node,
args=("Module", "optparse", "THIS_does_not_EXIST", ""),
confidence=INFERENCE,
)
):
self.checker.visit_attribute(node)
@set_config(ignored_modules=("argparse",))
def test_no_member_in_getattr_ignored(self) -> None:
"""Make sure that a module attribute access check is omitted with a
module that is configured to be ignored.
"""
node = astroid.extract_node(
"""
import argparse
argparse.THIS_does_not_EXIST
"""
)
with self.assertNoMessages():
self.checker.visit_attribute(node)
@set_config(ignored_modules=("xml.etree.",))
def test_ignored_modules_invalid_pattern(self) -> None:
node = astroid.extract_node(
"""
import xml
xml.etree.Lala
"""
)
message = MessageTest(
"no-member",
node=node,
args=("Module", "xml.etree", "Lala", ""),
confidence=INFERENCE,
)
with self.assertAddsMessages(message):
self.checker.visit_attribute(node)
@set_config(ignored_modules=("xml",))
def test_ignored_modules_root_one_applies_as_well(self) -> None:
# Check that when a root module is completely ignored, submodules are skipped.
node = astroid.extract_node(
"""
import xml
xml.etree.Lala
"""
)
with self.assertNoMessages():
self.checker.visit_attribute(node)
@set_config(ignored_modules=("xml.etree*",))
def test_ignored_modules_patterns(self) -> None:
node = astroid.extract_node(
"""
import xml
xml.etree.portocola #@
"""
)
with self.assertNoMessages():
self.checker.visit_attribute(node)
@set_config(ignored_classes=("xml.*",))
def test_ignored_classes_no_recursive_pattern(self) -> None:
node = astroid.extract_node(
"""
import xml
xml.etree.ElementTree.Test
"""
)
message = MessageTest(
"no-member",
node=node,
args=("Module", "xml.etree.ElementTree", "Test", ""),
confidence=INFERENCE,
)
with self.assertAddsMessages(message):
self.checker.visit_attribute(node)
@set_config(ignored_classes=("optparse.Values",))
def test_ignored_classes_qualified_name(self) -> None:
"""Test that ignored-classes supports qualified name for ignoring."""
node = astroid.extract_node(
"""
import optparse
optparse.Values.lala
"""
)
with self.assertNoMessages():
self.checker.visit_attribute(node)
@set_config(ignored_classes=("Values",))
def test_ignored_classes_only_name(self) -> None:
"""Test that ignored_classes works with the name only."""
node = astroid.extract_node(
"""
import optparse
optparse.Values.lala
"""
)
with self.assertNoMessages():
self.checker.visit_attribute(node)
@set_config(suggestion_mode=False)
@needs_c_extension
def test_nomember_on_c_extension_error_msg(self) -> None:
node = astroid.extract_node(
"""
from coverage import tracer
tracer.CTracer #@
"""
)
message = MessageTest(
"no-member",
node=node,
args=("Module", "coverage.tracer", "CTracer", ""),
confidence=INFERENCE,
)
with self.assertAddsMessages(message):
self.checker.visit_attribute(node)
@set_config(suggestion_mode=True)
@needs_c_extension
def test_nomember_on_c_extension_info_msg(self) -> None:
node = astroid.extract_node(
"""
from coverage import tracer
tracer.CTracer #@
"""
)
message = MessageTest(
"c-extension-no-member",
node=node,
args=("Module", "coverage.tracer", "CTracer", ""),
confidence=INFERENCE,
)
with self.assertAddsMessages(message):
self.checker.visit_attribute(node)
class TestTypeCheckerOnDecorators(CheckerTestCase):
"Tests for pylint.checkers.typecheck on decorated functions."
CHECKER_CLASS = typecheck.TypeChecker
def test_issue3882_class_decorators(self) -> None:
decorators = """
class Unsubscriptable:
def __init__(self, f):
self.f = f
class Subscriptable:
def __init__(self, f):
self.f = f
def __getitem__(self, item):
return item
"""
for generic in "Optional", "List", "ClassVar", "Final", "Literal":
self.typing_objects_are_subscriptable(generic)
self.getitem_on_modules()
self.decorated_by_a_subscriptable_class(decorators)
self.decorated_by_an_unsubscriptable_class(decorators)
self.decorated_by_subscriptable_then_unsubscriptable_class(decorators)
self.decorated_by_unsubscriptable_then_subscriptable_class(decorators)
def getitem_on_modules(self) -> None:
"""Mainly validate the code won't crash if we're not having a function."""
module = astroid.parse(
"""
import collections
test = collections[int]
"""
)
subscript = module.body[-1].value
with self.assertAddsMessages(
MessageTest(
"unsubscriptable-object",
node=subscript.value,
args="collections",
confidence=UNDEFINED,
)
):
self.checker.visit_subscript(subscript)
def typing_objects_are_subscriptable(self, generic: str) -> None:
module = astroid.parse(
f"""
import typing
test = typing.{generic}[int]
"""
)
subscript = module.body[-1].value
with self.assertNoMessages():
self.checker.visit_subscript(subscript)
def decorated_by_a_subscriptable_class(self, decorators: str) -> None:
module = astroid.parse(
decorators
+ """
@Subscriptable
def decorated():
...
test = decorated[None]
"""
)
subscript = module.body[-1].value
with self.assertNoMessages():
self.checker.visit_subscript(subscript)
def decorated_by_subscriptable_then_unsubscriptable_class(
self, decorators: str
) -> None:
module = astroid.parse(
decorators
+ """
@Unsubscriptable
@Subscriptable
def decorated():
...
test = decorated[None]
"""
)
subscript = module.body[-1].value
with self.assertAddsMessages(
MessageTest(
"unsubscriptable-object",
node=subscript.value,
args="decorated",
confidence=UNDEFINED,
)
):
self.checker.visit_subscript(subscript)
def decorated_by_unsubscriptable_then_subscriptable_class(
self, decorators: str
) -> None:
module = astroid.parse(
decorators
+ """
@Subscriptable
@Unsubscriptable
def decorated():
...
test = decorated[None]
"""
)
subscript = module.body[-1].value
with self.assertNoMessages():
self.checker.visit_subscript(subscript)
def decorated_by_an_unsubscriptable_class(self, decorators: str) -> None:
module = astroid.parse(
decorators
+ """
@Unsubscriptable
def decorated():
...
test = decorated[None]
"""
)
subscript = module.body[-1].value
with self.assertAddsMessages(
MessageTest(
"unsubscriptable-object",
node=subscript.value,
args="decorated",
confidence=UNDEFINED,
)
):
self.checker.visit_subscript(subscript)