forked from pantsbuild/pants
-
Notifications
You must be signed in to change notification settings - Fork 0
/
strip_source_roots.py
183 lines (154 loc) · 6.71 KB
/
strip_source_roots.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
# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
import itertools
from dataclasses import dataclass
from pathlib import PurePath
from typing import Iterable, Optional, Tuple, Type, cast
from pants.core.target_types import FilesSources
from pants.engine.addresses import Address
from pants.engine.fs import (
EMPTY_SNAPSHOT,
Digest,
DirectoriesToMerge,
DirectoryWithPrefixToStrip,
PathGlobs,
Snapshot,
SnapshotSubset,
)
from pants.engine.rules import RootRule, rule, subsystem_rule
from pants.engine.selectors import Get, MultiGet
from pants.engine.target import HydratedSources, HydrateSourcesRequest
from pants.engine.target import Sources as SourcesField
from pants.engine.target import rules as target_rules
from pants.source.source_root import NoSourceRootError, SourceRootConfig
from pants.util.meta import frozen_after_init
@dataclass(frozen=True)
class SourceRootStrippedSources:
"""Wrapper for a snapshot of files whose source roots have been stripped."""
snapshot: Snapshot
@dataclass(frozen=True)
class StripSnapshotRequest:
"""A request to strip source roots for every file in the snapshot.
The call site may optionally give the field `representative_path` if it is confident that all
the files in the snapshot will only have one source root. Using `representative_path` results in
better performance because we only need to call `SourceRoots.find_by_path()` on one single file
rather than every file.
"""
snapshot: Snapshot
representative_path: Optional[str] = None
@frozen_after_init
@dataclass(unsafe_hash=True)
class StripSourcesFieldRequest:
"""A request to strip source roots for every file in a `Sources` field.
The call site may optionally give a snapshot to `specified_files_snapshot` to only strip a
subset of the target's `sources`, rather than every `sources` file. This is useful when working
with precise file arguments.
"""
sources_field: SourcesField
for_sources_types: Tuple[Type[SourcesField], ...]
enable_codegen: bool
specified_files_snapshot: Optional[Snapshot]
def __init__(
self,
sources_field: SourcesField,
*,
for_sources_types: Iterable[Type[SourcesField]] = (SourcesField,),
enable_codegen: bool = False,
specified_files_snapshot: Optional[Snapshot] = None,
) -> None:
self.sources_field = sources_field
self.for_sources_types = tuple(for_sources_types)
self.enable_codegen = enable_codegen
self.specified_files_snapshot = specified_files_snapshot
@rule
async def strip_source_roots_from_snapshot(
request: StripSnapshotRequest, source_root_config: SourceRootConfig,
) -> SourceRootStrippedSources:
"""Removes source roots from a snapshot, e.g. `src/python/pants/util/strutil.py` ->
`pants/util/strutil.py`."""
source_roots_object = source_root_config.get_source_roots()
def determine_source_root(path: str) -> str:
source_root = source_roots_object.safe_find_by_path(path)
if source_root is not None:
return cast(str, source_root.path)
if source_root_config.options.unmatched == "fail":
raise NoSourceRootError(f"Could not find a source root for `{path}`.")
# Otherwise, create a source root by using the parent directory.
return PurePath(path).parent.as_posix()
if request.representative_path is not None:
resulting_digest = await Get[Digest](
DirectoryWithPrefixToStrip(
directory_digest=request.snapshot.directory_digest,
prefix=determine_source_root(request.representative_path),
)
)
resulting_snapshot = await Get[Snapshot](Digest, resulting_digest)
return SourceRootStrippedSources(snapshot=resulting_snapshot)
files_grouped_by_source_root = {
source_root: tuple(files)
for source_root, files in itertools.groupby(
request.snapshot.files, key=determine_source_root
)
}
snapshot_subsets = await MultiGet(
Get[Snapshot](
SnapshotSubset(
directory_digest=request.snapshot.directory_digest, globs=PathGlobs(files),
)
)
for files in files_grouped_by_source_root.values()
)
resulting_digests = await MultiGet(
Get[Digest](
DirectoryWithPrefixToStrip(
directory_digest=snapshot.directory_digest, prefix=source_root
)
)
for snapshot, source_root in zip(snapshot_subsets, files_grouped_by_source_root.keys())
)
merged_result = await Get[Digest](DirectoriesToMerge(resulting_digests))
resulting_snapshot = await Get[Snapshot](Digest, merged_result)
return SourceRootStrippedSources(resulting_snapshot)
def representative_path_from_address(address: Address) -> str:
"""Generate a representative path as a performance hack so that we don't need to call
SourceRoots.find_by_path() on every single file belonging to a target."""
return PurePath(address.spec_path, "BUILD").as_posix()
@rule
async def strip_source_roots_from_sources_field(
request: StripSourcesFieldRequest,
) -> SourceRootStrippedSources:
"""Remove source roots from a target, e.g. `src/python/pants/util/strutil.py` ->
`pants/util/strutil.py`."""
if request.specified_files_snapshot is not None:
sources_snapshot = request.specified_files_snapshot
else:
hydrated_sources = await Get[HydratedSources](
HydrateSourcesRequest(
request.sources_field,
for_sources_types=request.for_sources_types,
enable_codegen=request.enable_codegen,
)
)
sources_snapshot = hydrated_sources.snapshot
if not sources_snapshot.files:
return SourceRootStrippedSources(EMPTY_SNAPSHOT)
# Unlike all other `Sources` subclasses, `FilesSources` (and its subclasses) do not remove
# their source root. This is so that filesystem APIs (e.g. Python's `open()`) may still access
# the files as they normally would, with the full path relative to the build root.
if isinstance(request.sources_field, FilesSources):
return SourceRootStrippedSources(sources_snapshot)
return await Get[SourceRootStrippedSources](
StripSnapshotRequest(
sources_snapshot,
representative_path=representative_path_from_address(request.sources_field.address),
)
)
def rules():
return [
strip_source_roots_from_snapshot,
strip_source_roots_from_sources_field,
subsystem_rule(SourceRootConfig),
RootRule(StripSnapshotRequest),
RootRule(StripSourcesFieldRequest),
*target_rules(),
]