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
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/pylint-dev/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/pylint-dev/pylint/blob/main/CONTRIBUTORS.txt
"""Unit tests for the imports checker."""
import os
import astroid
from pytest import CaptureFixture
from pylint.checkers import imports
from pylint.interfaces import UNDEFINED
from pylint.testutils import CheckerTestCase, MessageTest
from pylint.testutils._run import _Run as Run
REGR_DATA = os.path.join(os.path.dirname(__file__), "..", "regrtest_data", "")
class TestImportsChecker(CheckerTestCase):
CHECKER_CLASS = imports.ImportsChecker
def test_relative_beyond_top_level(self) -> None:
module = astroid.MANAGER.ast_from_module_name("beyond_top", REGR_DATA)
import_from = module.body[0]
msg = MessageTest(
msg_id="relative-beyond-top-level",
node=import_from,
line=1,
col_offset=0,
end_line=1,
end_col_offset=25,
)
with self.assertAddsMessages(msg):
self.checker.visit_importfrom(import_from)
with self.assertNoMessages():
self.checker.visit_importfrom(module.body[1])
with self.assertNoMessages():
self.checker.visit_importfrom(module.body[2].body[0])
@staticmethod
def test_relative_beyond_top_level_two(capsys: CaptureFixture[str]) -> None:
Run(
[
f"{os.path.join(REGR_DATA, 'beyond_top_two')}",
"-d all",
"-e relative-beyond-top-level",
],
exit=False,
)
output, errors = capsys.readouterr()
top_level_function = os.path.join(
REGR_DATA, "beyond_top_two/namespace_package/top_level_function.py"
)
Run(
[top_level_function, "-d all", "-e relative-beyond-top-level"],
exit=False,
)
output2, errors2 = capsys.readouterr()
assert len(output.split("\n")) == 5
assert len(output2.split("\n")) == 5
assert errors == errors2
@staticmethod
def test_relative_beyond_top_level_three(capsys: CaptureFixture[str]) -> None:
Run(
[
f"{os.path.join(REGR_DATA, 'beyond_top_three/a.py')}",
"-d all",
"-e relative-beyond-top-level",
],
exit=False,
)
output, errors = capsys.readouterr()
assert len(output.split("\n")) == 5
assert errors == ""
@staticmethod
def test_relative_beyond_top_level_four(capsys: CaptureFixture[str]) -> None:
Run(
[
f"{os.path.join(REGR_DATA, 'beyond_top_four/module')}",
"-d missing-docstring,unused-import",
],
exit=False,
)
output, errors = capsys.readouterr()
assert len(output.split("\n")) == 5
assert errors == ""
def test_wildcard_import_init(self) -> None:
module = astroid.MANAGER.ast_from_module_name("init_wildcard", REGR_DATA)
import_from = module.body[0]
with self.assertNoMessages():
self.checker.visit_importfrom(import_from)
def test_wildcard_import_non_init(self) -> None:
module = astroid.MANAGER.ast_from_module_name("wildcard", REGR_DATA)
import_from = module.body[0]
msg = MessageTest(
msg_id="wildcard-import",
node=import_from,
args="empty",
confidence=UNDEFINED,
line=1,
col_offset=0,
end_line=1,
end_col_offset=19,
)
with self.assertAddsMessages(msg):
self.checker.visit_importfrom(import_from)
@staticmethod
def test_preferred_module(capsys: CaptureFixture[str]) -> None:
"""
Tests preferred-module configuration option
"""
# test preferred-modules case with base module import
Run(
[
f"{os.path.join(REGR_DATA, 'preferred_module/unpreferred_module.py')}",
"-d all",
"-e preferred-module",
# prefer sys instead of os (for triggering test)
"--preferred-modules=os:sys",
],
exit=False,
)
output, errors = capsys.readouterr()
# assert that we saw preferred-modules triggered
assert "Prefer importing 'sys' instead of 'os'" in output
# assert there were no errors
assert len(errors) == 0
# test preferred-modules trigger case with submodules
Run(
[
f"{os.path.join(REGR_DATA, 'preferred_module/unpreferred_submodule.py')}",
"-d all",
"-e preferred-module",
# prefer os.path instead of pathlib (for triggering test)
"--preferred-modules=os.path:pathlib",
],
exit=False,
)
output, errors = capsys.readouterr()
# assert that we saw preferred-modules triggered
assert "Prefer importing 'pathlib' instead of 'os.path'" in output
# assert there were no errors
assert len(errors) == 0
# test preferred-modules ignore case with submodules
Run(
[
f"{os.path.join(REGR_DATA, 'preferred_module/unpreferred_submodule.py')}",
"-d all",
"-e preferred-module",
# prefer pathlib instead of os.stat (for untriggered test)
"--preferred-modules=os.stat:pathlib",
],
exit=False,
)
output, errors = capsys.readouterr()
# assert that we didn't see preferred-modules triggered
assert "Your code has been rated at 10.00/10" in output
# assert there were no errors
assert len(errors) == 0
# test preferred-modules base module for implemented submodule (from ... import)
Run(
[
f"{os.path.join(REGR_DATA, 'preferred_module/unpreferred_submodule.py')}",
"-d all",
"-e preferred-module",
# prefer pathlib instead of os (for triggering test)
"--preferred-modules=os:pathlib",
],
exit=False,
)
output, errors = capsys.readouterr()
# assert that we saw preferred-modules triggered with base module
assert "Prefer importing 'pathlib' instead of 'os'" in output
# assert there were no errors
assert len(errors) == 0
# Test for challenges with preferred modules indefinite matches
Run(
[
f"{os.path.join(REGR_DATA, 'preferred_module/unpreferred_submodule.py')}",
"-d all",
"-e preferred-module",
# prefer pathlib instead of random (testing to avoid regression)
# pathlib shouldn't match with path, which is in the test file
"--preferred-modules=random:pathlib",
],
exit=False,
)
_, errors = capsys.readouterr()
# Assert there were no errors
assert len(errors) == 0
@staticmethod
def test_allow_reexport_package(capsys: CaptureFixture[str]) -> None:
"""Test --allow-reexport-from-package option."""
# Option disabled - useless-import-alias should always be emitted
Run(
[
f"{os.path.join(REGR_DATA, 'allow_reexport')}",
"--allow-reexport-from-package=no",
"-sn",
],
exit=False,
)
output, errors = capsys.readouterr()
assert len(output.split("\n")) == 7, f"Expected 7 line breaks in:{output}"
assert (
"__init__.py:1:0: C0414: Import alias does not rename original package (useless-import-alias)"
in output
)
assert (
"file.py:2:0: C0414: Import alias does not rename original package (useless-import-alias)"
in output
)
assert len(errors) == 0
# Option enabled - useless-import-alias should only be emitted for 'file.py'
Run(
[
f"{os.path.join(REGR_DATA, 'allow_reexport')}",
"--allow-reexport-from-package=yes",
"--disable=missing-module-docstring",
"-sn",
],
exit=False,
)
output, errors = capsys.readouterr()
assert len(output.split("\n")) == 3
assert "__init__.py" not in output
assert (
"file.py:2:0: C0414: Import alias does not rename original package (useless-import-alias)"
in output
)
assert len(errors) == 0
|
