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
|
# Copyright 2017-2020 Palantir Technologies, Inc.
# Copyright 2021- Python Language Server Contributors.
import os
import tempfile
from textwrap import dedent
from unittest.mock import patch
from pylsp import lsp, uris
from pylsp.plugins import flake8_lint
from pylsp.workspace import Document
DOC_URI = uris.from_fs_path(__file__)
DOC = """import pylsp
t = "TEST"
def using_const():
\ta = 8 + 9
\treturn t
"""
def temp_document(doc_text, workspace):
with tempfile.NamedTemporaryFile(mode="w", delete=False) as temp_file:
name = temp_file.name
temp_file.write(doc_text)
doc = Document(uris.from_fs_path(name), workspace)
return name, doc
def test_flake8_unsaved(workspace) -> None:
doc = Document("", workspace, DOC)
diags = flake8_lint.pylsp_lint(workspace, doc)
msg = "F841 local variable 'a' is assigned to but never used"
unused_var = [d for d in diags if d["message"] == msg][0]
assert unused_var["source"] == "flake8"
assert unused_var["code"] == "F841"
assert unused_var["range"]["start"] == {"line": 5, "character": 1}
assert unused_var["range"]["end"] == {"line": 5, "character": 11}
assert unused_var["severity"] == lsp.DiagnosticSeverity.Warning
assert unused_var["tags"] == [lsp.DiagnosticTag.Unnecessary]
def test_flake8_lint(workspace) -> None:
name, doc = temp_document(DOC, workspace)
try:
diags = flake8_lint.pylsp_lint(workspace, doc)
msg = "F841 local variable 'a' is assigned to but never used"
unused_var = [d for d in diags if d["message"] == msg][0]
assert unused_var["source"] == "flake8"
assert unused_var["code"] == "F841"
assert unused_var["range"]["start"] == {"line": 5, "character": 1}
assert unused_var["range"]["end"] == {"line": 5, "character": 11}
assert unused_var["severity"] == lsp.DiagnosticSeverity.Warning
finally:
os.remove(name)
def test_flake8_respecting_configuration(workspace) -> None:
docs = [
("src/__init__.py", ""),
("src/a.py", DOC),
("src/b.py", "import os"),
(
"setup.cfg",
dedent(
"""
[flake8]
ignore = E302,W191
per-file-ignores =
src/a.py:F401
src/b.py:W292
"""
),
),
]
made = {}
for rel, contents in docs:
location = os.path.join(workspace.root_path, rel)
made[rel] = {"uri": uris.from_fs_path(location)}
os.makedirs(os.path.dirname(location), exist_ok=True)
with open(location, "w", encoding="utf-8") as fle:
fle.write(contents)
workspace.put_document(made[rel]["uri"], contents)
made[rel]["document"] = workspace._docs[made[rel]["uri"]]
diags = flake8_lint.pylsp_lint(workspace, made["src/a.py"]["document"])
assert diags == [
{
"source": "flake8",
"code": "F841",
"range": {
"start": {"line": 5, "character": 1},
"end": {"line": 5, "character": 11},
},
"message": "F841 local variable 'a' is assigned to but never used",
"severity": 2,
"tags": [1],
},
]
diags = flake8_lint.pylsp_lint(workspace, made["src/b.py"]["document"])
assert diags == [
{
"source": "flake8",
"code": "F401",
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": 0, "character": 9},
},
"message": "F401 'os' imported but unused",
"severity": 2,
"tags": [1],
}
]
def test_flake8_config_param(workspace) -> None:
with patch("pylsp.plugins.flake8_lint.Popen") as popen_mock:
mock_instance = popen_mock.return_value
mock_instance.communicate.return_value = [bytes(), bytes()]
flake8_conf = "/tmp/some.cfg"
workspace._config.update({"plugins": {"flake8": {"config": flake8_conf}}})
_name, doc = temp_document(DOC, workspace)
flake8_lint.pylsp_lint(workspace, doc)
(call_args,) = popen_mock.call_args[0]
assert "flake8" in call_args
assert "--config={}".format(flake8_conf) in call_args
def test_flake8_executable_param(workspace) -> None:
with patch("pylsp.plugins.flake8_lint.Popen") as popen_mock:
mock_instance = popen_mock.return_value
mock_instance.communicate.return_value = [bytes(), bytes()]
flake8_executable = "/tmp/flake8"
workspace._config.update(
{"plugins": {"flake8": {"executable": flake8_executable}}}
)
_name, doc = temp_document(DOC, workspace)
flake8_lint.pylsp_lint(workspace, doc)
(call_args,) = popen_mock.call_args[0]
assert flake8_executable in call_args
def get_flake8_cfg_settings(workspace, config_str):
"""Write a ``setup.cfg``, load it in the workspace, and return the flake8 settings.
This function creates a ``setup.cfg``; you'll have to delete it yourself.
"""
with open(
os.path.join(workspace.root_path, "setup.cfg"), "w+", encoding="utf-8"
) as f:
f.write(config_str)
workspace.update_config({"pylsp": {"configurationSources": ["flake8"]}})
return workspace._config.plugin_settings("flake8")
def test_flake8_multiline(workspace) -> None:
config_str = r"""[flake8]
exclude =
blah/,
file_2.py
"""
doc_str = "print('hi')\nimport os\n"
doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
workspace.put_document(doc_uri, doc_str)
flake8_settings = get_flake8_cfg_settings(workspace, config_str)
assert "exclude" in flake8_settings
assert len(flake8_settings["exclude"]) == 2
with patch("pylsp.plugins.flake8_lint.Popen") as popen_mock:
mock_instance = popen_mock.return_value
mock_instance.communicate.return_value = [bytes(), bytes()]
doc = workspace.get_document(doc_uri)
flake8_lint.pylsp_lint(workspace, doc)
call_args = popen_mock.call_args[0][0]
init_file = os.path.join("blah", "__init__.py")
assert call_args == [
"flake8",
"-",
"--exclude=blah/,file_2.py",
"--stdin-display-name",
init_file,
]
os.unlink(os.path.join(workspace.root_path, "setup.cfg"))
def test_flake8_per_file_ignores(workspace) -> None:
config_str = r"""[flake8]
ignores = F403
per-file-ignores =
**/__init__.py:F401,E402
test_something.py:E402,
exclude =
file_1.py
file_2.py
"""
doc_str = "print('hi')\nimport os\n"
doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
workspace.put_document(doc_uri, doc_str)
flake8_settings = get_flake8_cfg_settings(workspace, config_str)
assert "perFileIgnores" in flake8_settings
assert len(flake8_settings["perFileIgnores"]) == 2
assert "exclude" in flake8_settings
assert len(flake8_settings["exclude"]) == 2
doc = workspace.get_document(doc_uri)
res = flake8_lint.pylsp_lint(workspace, doc)
assert not res
os.unlink(os.path.join(workspace.root_path, "setup.cfg"))
def test_per_file_ignores_alternative_syntax(workspace) -> None:
config_str = r"""[flake8]
per-file-ignores = **/__init__.py:F401,E402
"""
doc_str = "print('hi')\nimport os\n"
doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
workspace.put_document(doc_uri, doc_str)
flake8_settings = get_flake8_cfg_settings(workspace, config_str)
assert "perFileIgnores" in flake8_settings
assert len(flake8_settings["perFileIgnores"]) == 2
doc = workspace.get_document(doc_uri)
res = flake8_lint.pylsp_lint(workspace, doc)
assert not res
os.unlink(os.path.join(workspace.root_path, "setup.cfg"))
|
