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
|
# Copyright 2017-2020 Palantir Technologies, Inc.
# Copyright 2021- Python Language Server Contributors.
import os
import pytest
from pylsp import lsp, uris
from pylsp.plugins import pycodestyle_lint
from pylsp.workspace import Document
DOC_URI = uris.from_fs_path(__file__)
DOC = """import sys
def hello( ):
\tpass
print("hello"
,"world"
)
import json
"""
def test_pycodestyle(workspace) -> None:
doc = Document(DOC_URI, workspace, DOC)
diags = pycodestyle_lint.pylsp_lint(workspace, doc)
assert all(d["source"] == "pycodestyle" for d in diags)
# One we're expecting is:
msg = "W191 indentation contains tabs"
mod_import = [d for d in diags if d["message"] == msg][0]
assert mod_import["code"] == "W191"
assert mod_import["severity"] == lsp.DiagnosticSeverity.Warning
assert mod_import["range"]["start"] == {"line": 3, "character": 0}
assert mod_import["range"]["end"] == {"line": 3, "character": 6}
msg = "W391 blank line at end of file"
mod_import = [d for d in diags if d["message"] == msg][0]
assert mod_import["code"] == "W391"
assert mod_import["severity"] == lsp.DiagnosticSeverity.Warning
assert mod_import["range"]["start"] == {"line": 10, "character": 0}
assert mod_import["range"]["end"] == {"line": 10, "character": 1}
msg = "E201 whitespace after '('"
mod_import = [d for d in diags if d["message"] == msg][0]
assert mod_import["code"] == "E201"
assert mod_import["severity"] == lsp.DiagnosticSeverity.Warning
assert mod_import["range"]["start"] == {"line": 2, "character": 10}
assert mod_import["range"]["end"] == {"line": 2, "character": 14}
msg = "E128 continuation line under-indented for visual indent"
mod_import = [d for d in diags if d["message"] == msg][0]
assert mod_import["code"] == "E128"
assert mod_import["severity"] == lsp.DiagnosticSeverity.Warning
assert mod_import["range"]["start"] == {"line": 5, "character": 1}
assert mod_import["range"]["end"] == {"line": 5, "character": 10}
def test_pycodestyle_config(workspace) -> None:
"""Test that we load config files properly.
Config files are loaded in the following order:
tox.ini pep8.cfg setup.cfg pycodestyle.cfg
Each overriding the values in the last.
These files are first looked for in the current document's
directory and then each parent directory until any one is found
terminating at the workspace root.
If any section called 'pycodestyle' exists that will be solely used
and any config in a 'pep8' section will be ignored
"""
doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "test.py"))
workspace.put_document(doc_uri, DOC)
doc = workspace.get_document(doc_uri)
# Make sure we get a warning for 'indentation contains tabs'
diags = pycodestyle_lint.pylsp_lint(workspace, doc)
assert [d for d in diags if d["code"] == "W191"]
content = {
"setup.cfg": ("[pycodestyle]\nignore = W191, E201, E128", True),
"tox.ini": ("", False),
}
for conf_file, (content, working) in list(content.items()):
# Now we'll add config file to ignore it
with open(
os.path.join(workspace.root_path, conf_file), "w+", encoding="utf-8"
) as f:
f.write(content)
workspace._config.settings.cache_clear()
# And make sure we don't get any warnings
diags = pycodestyle_lint.pylsp_lint(workspace, doc)
assert len([d for d in diags if d["code"] == "W191"]) == (0 if working else 1)
assert len([d for d in diags if d["code"] == "E201"]) == (0 if working else 1)
assert [d for d in diags if d["code"] == "W391"]
os.unlink(os.path.join(workspace.root_path, conf_file))
# Make sure we can ignore via the PYLS config as well
workspace._config.update({"plugins": {"pycodestyle": {"ignore": ["W191", "E201"]}}})
# And make sure we only get one warning
diags = pycodestyle_lint.pylsp_lint(workspace, doc)
assert not [d for d in diags if d["code"] == "W191"]
assert not [d for d in diags if d["code"] == "E201"]
assert [d for d in diags if d["code"] == "W391"]
@pytest.mark.parametrize("newline", ["\r\n", "\r"])
def test_line_endings(workspace, newline) -> None:
"""
Check that Pycodestyle doesn't generate false positives with line endings
other than LF.
"""
# Create simple source that should give false positives
source = f"try:{newline} 1/0{newline}except Exception:{newline} pass{newline}"
# Create document
doc = Document(DOC_URI, workspace, source)
# Get diagnostics
diags = pycodestyle_lint.pylsp_lint(workspace, doc)
# Assert no diagnostics were given
assert len(diags) == 0
|
