forked from pantsbuild/pants
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rules.py
190 lines (165 loc) · 6.69 KB
/
rules.py
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
# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
from dataclasses import dataclass
from typing import Optional, Tuple
from pants.backend.python.lint.flake8.subsystem import Flake8
from pants.backend.python.rules import download_pex_bin, pex
from pants.backend.python.rules.pex import (
Pex,
PexInterpreterConstraints,
PexRequest,
PexRequirements,
)
from pants.backend.python.subsystems import python_native_code, subprocess_environment
from pants.backend.python.subsystems.subprocess_environment import SubprocessEncodingEnvironment
from pants.backend.python.target_types import PythonInterpreterCompatibility, PythonSources
from pants.core.goals.lint import LintRequest, LintResult, LintResultFile, LintResults
from pants.core.util_rules import determine_source_files, strip_source_roots
from pants.core.util_rules.determine_source_files import (
AllSourceFilesRequest,
SourceFiles,
SpecifiedSourceFilesRequest,
)
from pants.engine.fs import Digest, MergeDigests, PathGlobs, Snapshot, SnapshotSubset
from pants.engine.process import FallibleProcessResult, Process
from pants.engine.rules import SubsystemRule, rule
from pants.engine.selectors import Get, MultiGet
from pants.engine.target import FieldSetWithOrigin
from pants.engine.unions import UnionRule
from pants.option.global_options import GlobMatchErrorBehavior
from pants.python.python_setup import PythonSetup
from pants.util.strutil import pluralize
@dataclass(frozen=True)
class Flake8FieldSet(FieldSetWithOrigin):
required_fields = (PythonSources,)
sources: PythonSources
compatibility: PythonInterpreterCompatibility
class Flake8Request(LintRequest):
field_set_type = Flake8FieldSet
@dataclass(frozen=True)
class Flake8Partition:
field_sets: Tuple[Flake8FieldSet, ...]
interpreter_constraints: PexInterpreterConstraints
def generate_args(
*, specified_source_files: SourceFiles, flake8: Flake8, output_file: Optional[str]
) -> Tuple[str, ...]:
args = []
if flake8.options.config is not None:
args.append(f"--config={flake8.options.config}")
if output_file:
args.append(f"--output-file={output_file}")
args.extend(flake8.options.args)
args.extend(specified_source_files.files)
return tuple(args)
@rule
async def flake8_lint_partition(
partition: Flake8Partition,
flake8: Flake8,
python_setup: PythonSetup,
subprocess_encoding_environment: SubprocessEncodingEnvironment,
) -> LintResult:
requirements_pex_request = Get(
Pex,
PexRequest(
output_filename="flake8.pex",
requirements=PexRequirements(flake8.get_requirement_specs()),
interpreter_constraints=(
partition.interpreter_constraints
or PexInterpreterConstraints(flake8.default_interpreter_constraints)
),
entry_point=flake8.get_entry_point(),
),
)
config_path: Optional[str] = flake8.options.config
config_snapshot_request = Get(
Snapshot,
PathGlobs(
globs=[config_path] if config_path else [],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin="the option `--flake8-config`",
),
)
all_source_files_request = Get(
SourceFiles, AllSourceFilesRequest(field_set.sources for field_set in partition.field_sets)
)
specified_source_files_request = Get(
SourceFiles,
SpecifiedSourceFilesRequest(
(field_set.sources, field_set.origin) for field_set in partition.field_sets
),
)
requirements_pex, config_snapshot, all_source_files, specified_source_files = await MultiGet(
requirements_pex_request,
config_snapshot_request,
all_source_files_request,
specified_source_files_request,
)
input_digest = await Get(
Digest,
MergeDigests(
(all_source_files.snapshot.digest, requirements_pex.digest, config_snapshot.digest)
),
)
address_references = ", ".join(
sorted(field_set.address.reference() for field_set in partition.field_sets)
)
output_path = flake8.output_file_path
flake8_args = generate_args(
specified_source_files=specified_source_files,
flake8=flake8,
output_file=output_path.name if output_path else None,
)
process = requirements_pex.create_process(
python_setup=python_setup,
subprocess_encoding_environment=subprocess_encoding_environment,
pex_path="./flake8.pex",
pex_args=flake8_args,
output_files=(output_path.name,) if output_path else None,
input_digest=input_digest,
description=(
f"Run Flake8 on {pluralize(len(partition.field_sets), 'target')}: {address_references}."
),
)
result = await Get(FallibleProcessResult, Process, process)
results_file = None
if output_path:
report_file_snapshot = await Get(
Snapshot, SnapshotSubset(result.output_digest, PathGlobs([output_path.name]))
)
if report_file_snapshot.is_empty or len(report_file_snapshot.files) != 1:
raise Exception(f"Unexpected report file snapshot: {report_file_snapshot}")
results_file = LintResultFile(output_path=output_path, digest=report_file_snapshot.digest)
return LintResult.from_fallible_process_result(
result, linter_name="Flake8", results_file=results_file
)
@rule(desc="Lint using Flake8")
async def flake8_lint(
request: Flake8Request, flake8: Flake8, python_setup: PythonSetup
) -> LintResults:
if flake8.options.skip:
return LintResults()
# NB: Flake8 output depends upon which Python interpreter version it's run with
# (http://flake8.pycqa.org/en/latest/user/invocation.html). We batch targets by their
# constraints to ensure, for example, that all Python 2 targets run together and all Python 3
# targets run together.
constraints_to_field_sets = PexInterpreterConstraints.group_field_sets_by_constraints(
request.field_sets, python_setup
)
partitioned_results = await MultiGet(
Get(LintResult, Flake8Partition(partition_field_sets, partition_compatibility))
for partition_compatibility, partition_field_sets in constraints_to_field_sets.items()
)
return LintResults(partitioned_results)
def rules():
return [
flake8_lint,
flake8_lint_partition,
SubsystemRule(Flake8),
UnionRule(LintRequest, Flake8Request),
*download_pex_bin.rules(),
*determine_source_files.rules(),
*pex.rules(),
*python_native_code.rules(),
*strip_source_roots.rules(),
*subprocess_environment.rules(),
]