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
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from pathlib import Path
from mozlint import result
from mozlint.pathutils import expand_exclusions
mach_site_file = Path(__file__).parents[3] / "python" / "sites" / "mach.txt"
skip_prefixes = ("#", "requires-python:")
def lint(paths, config, fix=None, **lintargs):
results = []
fixed = 0
files = sorted(Path(p) for p in expand_exclusions(paths, config, lintargs["root"]))
log = lintargs["log"]
mach_dependencies = set()
for raw_line in mach_site_file.read_text().splitlines():
line = raw_line.strip()
if not line or line.startswith(skip_prefixes):
continue
mach_dependencies.add(line)
for path in files:
try:
if path.name != "mach.txt":
redundant_spec_results, redundant_spec_fixed = (
command_site_redundant_specifications(
path, mach_dependencies, fix, config
)
)
results += redundant_spec_results
fixed += redundant_spec_fixed
order_results, order_fixed = site_ordering(path, fix, config)
results += order_results
fixed += order_fixed
except Exception as ex:
log.debug(f"Error: {ex}, in file: {path}")
return {"results": results, "fixed": fixed}
def command_site_redundant_specifications(
path: Path, mach_dependencies: set, fix: bool, config
):
lines = path.read_text().splitlines(keepends=True)
new_lines = []
fixed = 0
results = []
for line_number, raw_line in enumerate(lines):
stripped = raw_line.strip()
if not stripped or stripped.startswith(skip_prefixes):
new_lines.append(raw_line)
continue
if stripped in mach_dependencies:
if fix:
fixed += 1
continue
output = {
"path": str(path),
"message": f"Specification of '{stripped}' is redundant; already in {mach_site_file}.",
"level": "error",
"lineno": line_number + 1,
}
results.append(result.from_config(config, **output))
else:
new_lines.append(raw_line)
if fixed:
path.write_text("".join(new_lines), newline="\n")
return results, fixed
def site_ordering(path: Path, fix: bool, config):
lines = path.read_text().splitlines(keepends=True)
first_line = lines[0]
results = []
fixed = 0
start_index = 1
if not first_line.strip().startswith("requires-python:"):
start_index = 0
results.append(
result.from_config(
config,
path=str(path),
message="First line must start with 'requires-python:'.",
level="error",
lineno=1,
)
)
blocks = []
comment_block = []
for raw_line in lines[start_index:]:
stripped = raw_line.strip()
if not stripped:
continue
# Group any comment lines with the following specification line before sorting.
if stripped.startswith("#"):
comment_block.append(raw_line)
else:
blocks.append((comment_block.copy(), raw_line))
comment_block.clear()
sorted_blocks = sorted(blocks, key=lambda pair: pair[1].strip())
if blocks != sorted_blocks:
if fix:
new_lines = [first_line]
for comments, spec in sorted_blocks:
new_lines.extend(comments)
if not spec.endswith("\n"):
spec += "\n"
new_lines.append(spec)
path.write_text("".join(new_lines), newline="\n")
fixed = 1
else:
results.append(
result.from_config(
config,
path=str(path),
message="After 'requires-python:', entries must be in alphabetical order.",
hint="Re-run with --fix to resolve this automatically.",
level="error",
lineno=start_index + 1,
)
)
return results, fixed
|
