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
|
# 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
from __future__ import annotations
import re
from pathlib import Path
import pytest
from pylint.checkers import BaseChecker
from pylint.lint.expand_modules import _is_in_ignore_list_re, expand_modules
from pylint.testutils import CheckerTestCase, set_config
from pylint.typing import MessageDefinitionTuple, ModuleDescriptionDict
def test__is_in_ignore_list_re_match() -> None:
patterns = [
re.compile(".*enchilada.*"),
re.compile("unittest_.*"),
re.compile(".*tests/.*"),
]
assert _is_in_ignore_list_re("unittest_utils.py", patterns)
assert _is_in_ignore_list_re("cheese_enchiladas.xml", patterns)
assert _is_in_ignore_list_re("src/tests/whatever.xml", patterns)
TEST_DIRECTORY = Path(__file__).parent.parent
INIT_PATH = str(TEST_DIRECTORY / "lint/__init__.py")
EXPAND_MODULES = str(TEST_DIRECTORY / "lint/unittest_expand_modules.py")
this_file = {
"basename": "lint.unittest_expand_modules",
"basepath": EXPAND_MODULES,
"isarg": True,
"name": "lint.unittest_expand_modules",
"path": EXPAND_MODULES,
}
this_file_from_init = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.unittest_expand_modules",
"path": EXPAND_MODULES,
}
this_file_from_init_deduplicated = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": True,
"name": "lint.unittest_expand_modules",
"path": EXPAND_MODULES,
}
unittest_lint = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.unittest_lint",
"path": str(TEST_DIRECTORY / "lint/unittest_lint.py"),
}
test_utils = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.test_utils",
"path": str(TEST_DIRECTORY / "lint/test_utils.py"),
}
test_run_pylint = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.test_run_pylint",
"path": str(TEST_DIRECTORY / "lint/test_run_pylint.py"),
}
test_pylinter = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.test_pylinter",
"path": str(TEST_DIRECTORY / "lint/test_pylinter.py"),
}
test_caching = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": False,
"name": "lint.test_caching",
"path": str(TEST_DIRECTORY / "lint/test_caching.py"),
}
init_of_package = {
"basename": "lint",
"basepath": INIT_PATH,
"isarg": True,
"name": "lint",
"path": INIT_PATH,
}
def _list_expected_package_modules(
deduplicating: bool = False,
) -> tuple[dict[str, object], ...]:
"""Generates reusable list of modules for our package."""
return (
init_of_package,
test_caching,
test_pylinter,
test_run_pylint,
test_utils,
this_file_from_init_deduplicated if deduplicating else this_file_from_init,
unittest_lint,
)
class TestExpandModules(CheckerTestCase):
"""Test the expand_modules function while allowing options to be set."""
class Checker(BaseChecker):
"""This dummy checker is needed to allow options to be set."""
name = "checker"
msgs: dict[str, MessageDefinitionTuple] = {}
options = (("test-opt", {"action": "store_true", "help": "help message"}),)
CHECKER_CLASS: type = Checker
@pytest.mark.parametrize(
"files_or_modules,expected",
[
([__file__], {this_file["path"]: this_file}),
(
[str(Path(__file__).parent)],
{
module["path"]: module # pylint: disable=unsubscriptable-object
for module in _list_expected_package_modules()
},
),
],
)
@set_config(ignore_paths="")
def test_expand_modules(
self, files_or_modules: list[str], expected: dict[str, ModuleDescriptionDict]
) -> None:
"""Test expand_modules with the default value of ignore-paths."""
ignore_list: list[str] = []
ignore_list_re: list[re.Pattern[str]] = []
modules, errors = expand_modules(
files_or_modules,
[],
ignore_list,
ignore_list_re,
self.linter.config.ignore_paths,
)
assert modules == expected
assert not errors
@pytest.mark.parametrize(
"files_or_modules,expected",
[
([__file__, __file__], {this_file["path"]: this_file}),
(
[EXPAND_MODULES, str(Path(__file__).parent), EXPAND_MODULES],
{
module["path"]: module # pylint: disable=unsubscriptable-object
for module in _list_expected_package_modules(deduplicating=True)
},
),
],
)
@set_config(ignore_paths="")
def test_expand_modules_deduplication(
self, files_or_modules: list[str], expected: dict[str, ModuleDescriptionDict]
) -> None:
"""Test expand_modules deduplication."""
ignore_list: list[str] = []
ignore_list_re: list[re.Pattern[str]] = []
modules, errors = expand_modules(
files_or_modules,
[],
ignore_list,
ignore_list_re,
self.linter.config.ignore_paths,
)
assert modules == expected
assert not errors
@pytest.mark.parametrize(
"files_or_modules,expected",
[
([__file__], {}),
(
[str(Path(__file__).parent)],
{
module["path"]: module # pylint: disable=unsubscriptable-object
for module in (init_of_package,)
},
),
],
)
@set_config(ignore_paths=".*/lint/.*")
def test_expand_modules_with_ignore(
self, files_or_modules: list[str], expected: dict[str, ModuleDescriptionDict]
) -> None:
"""Test expand_modules with a non-default value of ignore-paths."""
ignore_list: list[str] = []
ignore_list_re: list[re.Pattern[str]] = []
modules, errors = expand_modules(
files_or_modules,
[],
ignore_list,
ignore_list_re,
self.linter.config.ignore_paths,
)
assert modules == expected
assert not errors
|
