forked from pantsbuild/pants
-
Notifications
You must be signed in to change notification settings - Fork 1
/
rules.py
200 lines (173 loc) · 6.94 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
191
192
193
194
195
196
197
198
199
200
# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
import re
from dataclasses import dataclass
from pathlib import PurePath
from typing import Optional, Tuple
from pants.backend.python.lint.black.subsystem import Black
from pants.backend.python.lint.python_fmt import PythonFmtRequest
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 PythonSources
from pants.core.goals.fmt import FmtResult
from pants.core.goals.lint import LintRequest, LintResult, 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 EMPTY_SNAPSHOT, Digest, GlobMatchErrorBehavior, MergeDigests, PathGlobs
from pants.engine.process import FallibleProcessResult, Process, ProcessResult
from pants.engine.rules import collect_rules, rule
from pants.engine.selectors import Get, MultiGet
from pants.engine.target import FieldSetWithOrigin
from pants.engine.unions import UnionRule
from pants.python.python_setup import PythonSetup
from pants.util.strutil import pluralize
@dataclass(frozen=True)
class BlackFieldSet(FieldSetWithOrigin):
required_fields = (PythonSources,)
sources: PythonSources
class BlackRequest(PythonFmtRequest, LintRequest):
field_set_type = BlackFieldSet
@dataclass(frozen=True)
class SetupRequest:
request: BlackRequest
check_only: bool
@dataclass(frozen=True)
class Setup:
process: Process
original_digest: Digest
def generate_args(
*, specified_source_files: SourceFiles, black: Black, check_only: bool,
) -> Tuple[str, ...]:
args = []
if check_only:
args.append("--check")
if black.options.config is not None:
args.extend(["--config", black.options.config])
args.extend(black.options.args)
# NB: For some reason, Black's --exclude option only works on recursive invocations, meaning
# calling Black on a directory(s) and letting it auto-discover files. However, we don't want
# Black to run over everything recursively under the directory of our target, as Black should
# only touch files directly specified. We can use `--include` to ensure that Black only
# operates on the files we actually care about.
args.extend(["--include", "|".join(re.escape(f) for f in specified_source_files.files)])
args.extend(PurePath(f).parent.as_posix() for f in specified_source_files.files)
return tuple(args)
@rule
async def setup(
setup_request: SetupRequest,
black: Black,
python_setup: PythonSetup,
subprocess_encoding_environment: SubprocessEncodingEnvironment,
) -> Setup:
requirements_pex_request = Get(
Pex,
PexRequest(
output_filename="black.pex",
requirements=PexRequirements(black.get_requirement_specs()),
interpreter_constraints=PexInterpreterConstraints(
black.default_interpreter_constraints
),
entry_point=black.get_entry_point(),
),
)
config_path: Optional[str] = black.options.config
config_digest_request = Get(
Digest,
PathGlobs(
globs=[config_path] if config_path else [],
glob_match_error_behavior=GlobMatchErrorBehavior.error,
description_of_origin="the option `--black-config`",
),
)
all_source_files_request = Get(
SourceFiles,
AllSourceFilesRequest(field_set.sources for field_set in setup_request.request.field_sets),
)
specified_source_files_request = Get(
SourceFiles,
SpecifiedSourceFilesRequest(
(field_set.sources, field_set.origin) for field_set in setup_request.request.field_sets
),
)
requests = requirements_pex_request, config_digest_request, specified_source_files_request
all_source_files, requirements_pex, config_digest, specified_source_files = (
await MultiGet(all_source_files_request, *requests)
if setup_request.request.prior_formatter_result is None
else (SourceFiles(EMPTY_SNAPSHOT), *await MultiGet(*requests))
)
all_source_files_snapshot = (
all_source_files.snapshot
if setup_request.request.prior_formatter_result is None
else setup_request.request.prior_formatter_result
)
input_digest = await Get(
Digest,
MergeDigests((all_source_files_snapshot.digest, requirements_pex.digest, config_digest)),
)
address_references = ", ".join(
sorted(field_set.address.reference() for field_set in setup_request.request.field_sets)
)
process = requirements_pex.create_process(
python_setup=python_setup,
subprocess_encoding_environment=subprocess_encoding_environment,
pex_path="./black.pex",
pex_args=generate_args(
specified_source_files=specified_source_files,
black=black,
check_only=setup_request.check_only,
),
input_digest=input_digest,
output_files=all_source_files_snapshot.files,
description=(
f"Run Black on {pluralize(len(setup_request.request.field_sets), 'target')}: {address_references}."
),
)
return Setup(process, original_digest=all_source_files_snapshot.digest)
@rule(desc="Format using Black")
async def black_fmt(field_sets: BlackRequest, black: Black) -> FmtResult:
if black.options.skip:
return FmtResult.noop()
setup = await Get(Setup, SetupRequest(field_sets, check_only=False))
result = await Get(ProcessResult, Process, setup.process)
return FmtResult.from_process_result(
result,
original_digest=setup.original_digest,
formatter_name="Black",
strip_chroot_path=True,
)
@rule(desc="Lint using Black")
async def black_lint(field_sets: BlackRequest, black: Black) -> LintResults:
if black.options.skip:
return LintResults()
setup = await Get(Setup, SetupRequest(field_sets, check_only=True))
result = await Get(FallibleProcessResult, Process, setup.process)
return LintResults(
[
LintResult.from_fallible_process_result(
result, linter_name="Black", strip_chroot_path=True
)
]
)
def rules():
return [
*collect_rules(),
UnionRule(PythonFmtRequest, BlackRequest),
UnionRule(LintRequest, BlackRequest),
*download_pex_bin.rules(),
*determine_source_files.rules(),
*pex.rules(),
*python_native_code.rules(),
*strip_source_roots.rules(),
*subprocess_environment.rules(),
]