21803785359

Committed 08 Feb 2026 07:13PM UTC coverage: 43.3% (-37.0%) from 80.277%

Build # 21803785359

Build Type

Pull #23085

github

Committed by

web-flow

Commit Message

Merge 7c1cd926d into 40389cc58

Pull Request Pull Request #23085: A helper method for indexing paths by source root

Run Details

2 of 6 new or added lines in 1 file covered. (33.33%)

17114 existing lines in 539 files now uncovered.

26075 of 60219 relevant lines covered (43.3%)

0.43 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

58.1

/src/python/pants/engine/intrinsics.py

# Copyright 2024 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

import dataclasses
import logging

from pants.engine.environment import EnvironmentName
from pants.engine.fs import (
    AddPrefix,
    CreateDigest,
    Digest,
    DigestContents,
    DigestEntries,
    DigestSubset,
    MergeDigests,
    NativeDownloadFile,
    PathGlobs,
    PathMetadataRequest,
    PathMetadataResult,
    Paths,
    RemovePrefix,
    Snapshot,
)
from pants.engine.internals import native_engine
from pants.engine.internals.docker import DockerResolveImageRequest, DockerResolveImageResult
from pants.engine.internals.native_dep_inference import (
    NativeDockerfileInfos,
    NativeJavascriptFilesDependencies,
    NativePythonFilesDependencies,
)
from pants.engine.internals.native_engine import NativeDependenciesRequest, task_side_effected
from pants.engine.internals.session import RunId, SessionValues
from pants.engine.process import (
    FallibleProcessResult,
    InteractiveProcess,
    InteractiveProcessResult,
    Process,
    ProcessExecutionEnvironment,
    ProcessResultWithRetries,
    ProcessWithRetries,
)
from pants.engine.rules import _uncacheable_rule, collect_rules, implicitly, rule
from pants.util.docutil import git_url
from pants.util.frozendict import FrozenDict


@rule
async def create_digest(
    create_digest: CreateDigest,
) -> Digest:
    return await native_engine.create_digest(create_digest)


@rule
async def path_globs_to_digest(
    path_globs: PathGlobs,
) -> Digest:
    return await native_engine.path_globs_to_digest(path_globs)


@rule
async def path_globs_to_paths(
    path_globs: PathGlobs,
) -> Paths:
    return await native_engine.path_globs_to_paths(path_globs)


@rule
async def download_file(
    native_download_file: NativeDownloadFile,
) -> Digest:
    return await native_engine.download_file(native_download_file)


@rule
async def digest_to_snapshot(digest: Digest) -> Snapshot:
    return await native_engine.digest_to_snapshot(digest)


@rule
async def get_digest_contents(digest: Digest) -> DigestContents:
    return await native_engine.get_digest_contents(digest)


@rule
async def get_digest_entries(digest: Digest) -> DigestEntries:
    return await native_engine.get_digest_entries(digest)


@rule
async def merge_digests(merge_digests: MergeDigests) -> Digest:
    return await native_engine.merge_digests(merge_digests)


@rule
async def remove_prefix(remove_prefix: RemovePrefix) -> Digest:
    return await native_engine.remove_prefix(remove_prefix)


@rule
async def add_prefix(add_prefix: AddPrefix) -> Digest:
    return await native_engine.add_prefix(add_prefix)


@rule
async def execute_process(
    process: Process, process_execution_environment: ProcessExecutionEnvironment
) -> FallibleProcessResult:
    return await native_engine.execute_process(process, process_execution_environment)


@rule
async def execute_process_with_retry(req: ProcessWithRetries) -> ProcessResultWithRetries:
    results: list[FallibleProcessResult] = []
    for attempt in range(0, req.attempts):
        proc = dataclasses.replace(req.proc, attempt=attempt)
        result = await execute_process(  # noqa: PNT30: We only know that we need to rerun the test after we run it
            proc, **implicitly()
        )
        results.append(result)
        if result.exit_code == 0:
            break
    return ProcessResultWithRetries(tuple(results))


@rule
async def digest_subset_to_digest(digest_subset: DigestSubset) -> Digest:
    return await native_engine.digest_subset_to_digest(digest_subset)


@rule
async def session_values() -> SessionValues:
    return await native_engine.session_values()


@rule
async def run_id() -> RunId:
    return await native_engine.run_id()


__SQUELCH_WARNING = "__squelch_warning"


# NB: Call one of the helpers below, instead of calling this rule directly,
#  to ensure correct application of restartable logic.
@_uncacheable_rule
async def _interactive_process(
    process: InteractiveProcess, process_execution_environment: ProcessExecutionEnvironment
) -> InteractiveProcessResult:
    # This is a crafty way for a caller to signal into this function without a dedicated arg
    # (which would confound the solver).  Note that we go via __dict__ instead of using
    # setattr/delattr, because those error for frozen dataclasses.
    if __SQUELCH_WARNING in process.__dict__:
        del process.__dict__[__SQUELCH_WARNING]
    else:
        logging.warning(
            "A plugin is calling `await _interactive_process(...)` directly. This will cause "
            "restarting logic not to be applied. Use `await run_interactive_process(process)` "
            "or `await run_interactive_process_in_environment(process, environment_name)` instead. "
            f"See {git_url('src/python/pants/engine/intrinsics.py')} for more details."
        )
    return await native_engine.interactive_process(process, process_execution_environment)


async def run_interactive_process(process: InteractiveProcess) -> InteractiveProcessResult:
    # NB: We must call task_side_effected() in this helper, rather than in a nested @rule call,
    #  so that the Task for the @rule that calls this helper is the one marked as non-restartable.
    if not process.restartable:
        task_side_effected()

    process.__dict__[__SQUELCH_WARNING] = True
    ret: InteractiveProcessResult = await _interactive_process(process, **implicitly())
    return ret


async def run_interactive_process_in_environment(
    process: InteractiveProcess, environment_name: EnvironmentName
) -> InteractiveProcessResult:
    # NB: We must call task_side_effected() in this helper, rather than in a nested @rule call,
    #  so that the Task for the @rule that calls this helper is the one marked as non-restartable.
    if not process.restartable:
        task_side_effected()

    process.__dict__[__SQUELCH_WARNING] = True
    ret: InteractiveProcessResult = await _interactive_process(
        process, **implicitly({environment_name: EnvironmentName})
    )
    return ret


@rule
async def docker_resolve_image(request: DockerResolveImageRequest) -> DockerResolveImageResult:
    return await native_engine.docker_resolve_image(request)


@rule
async def parse_dockerfile_info(
    deps_request: NativeDependenciesRequest,
) -> NativeDockerfileInfos:
    path_infos_pairs = await native_engine.parse_dockerfile_info(deps_request)
    return NativeDockerfileInfos(FrozenDict(path_infos_pairs))


@rule
async def parse_python_deps(
    deps_request: NativeDependenciesRequest,
) -> NativePythonFilesDependencies:
    path_deps_pairs = await native_engine.parse_python_deps(deps_request)
    return NativePythonFilesDependencies(FrozenDict(path_deps_pairs))


@rule
async def parse_javascript_deps(
    deps_request: NativeDependenciesRequest,
) -> NativeJavascriptFilesDependencies:
    path_deps_pairs = await native_engine.parse_javascript_deps(deps_request)
    return NativeJavascriptFilesDependencies(FrozenDict(path_deps_pairs))


@rule
async def path_metadata_request(request: PathMetadataRequest) -> PathMetadataResult:
    return await native_engine.path_metadata_request(request)


def rules():
    return [
        *collect_rules(),
    ]

1	# Copyright 2024 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	1✔
5
6	import dataclasses	1✔
7	import logging	1✔
8
9	from pants.engine.environment import EnvironmentName	1✔
10	from pants.engine.fs import (	1✔
11	AddPrefix,
12	CreateDigest,
13	Digest,
14	DigestContents,
15	DigestEntries,
16	DigestSubset,
17	MergeDigests,
18	NativeDownloadFile,
19	PathGlobs,
20	PathMetadataRequest,
21	PathMetadataResult,
22	Paths,
23	RemovePrefix,
24	Snapshot,
25	)
26	from pants.engine.internals import native_engine	1✔
27	from pants.engine.internals.docker import DockerResolveImageRequest, DockerResolveImageResult	1✔
28	from pants.engine.internals.native_dep_inference import (	1✔
29	NativeDockerfileInfos,
30	NativeJavascriptFilesDependencies,
31	NativePythonFilesDependencies,
32	)
33	from pants.engine.internals.native_engine import NativeDependenciesRequest, task_side_effected	1✔
34	from pants.engine.internals.session import RunId, SessionValues	1✔
35	from pants.engine.process import (	1✔
36	FallibleProcessResult,
37	InteractiveProcess,
38	InteractiveProcessResult,
39	Process,
40	ProcessExecutionEnvironment,
41	ProcessResultWithRetries,
42	ProcessWithRetries,
43	)
44	from pants.engine.rules import _uncacheable_rule, collect_rules, implicitly, rule	1✔
45	from pants.util.docutil import git_url	1✔
46	from pants.util.frozendict import FrozenDict	1✔
47
48
49	@rule	1✔
50	async def create_digest(	1✔
51	create_digest: CreateDigest,
52	) -> Digest:
53	return await native_engine.create_digest(create_digest)	×
54
55
56	@rule	1✔
57	async def path_globs_to_digest(	1✔
58	path_globs: PathGlobs,
59	) -> Digest:
60	return await native_engine.path_globs_to_digest(path_globs)	×
61
62
63	@rule	1✔
64	async def path_globs_to_paths(	1✔
65	path_globs: PathGlobs,
66	) -> Paths:
67	return await native_engine.path_globs_to_paths(path_globs)	×
68
69
70	@rule	1✔
71	async def download_file(	1✔
72	native_download_file: NativeDownloadFile,
73	) -> Digest:
74	return await native_engine.download_file(native_download_file)	×
75
76
77	@rule	1✔
78	async def digest_to_snapshot(digest: Digest) -> Snapshot:	1✔
79	return await native_engine.digest_to_snapshot(digest)	×
80
81
82	@rule	1✔
83	async def get_digest_contents(digest: Digest) -> DigestContents:	1✔
84	return await native_engine.get_digest_contents(digest)	×
85
86
87	@rule	1✔
88	async def get_digest_entries(digest: Digest) -> DigestEntries:	1✔
89	return await native_engine.get_digest_entries(digest)	×
90
91
92	@rule	1✔
93	async def merge_digests(merge_digests: MergeDigests) -> Digest:	1✔
94	return await native_engine.merge_digests(merge_digests)	×
95
96
97	@rule	1✔
98	async def remove_prefix(remove_prefix: RemovePrefix) -> Digest:	1✔
99	return await native_engine.remove_prefix(remove_prefix)	×
100
101
102	@rule	1✔
103	async def add_prefix(add_prefix: AddPrefix) -> Digest:	1✔
104	return await native_engine.add_prefix(add_prefix)	×
105
106
107	@rule	1✔
108	async def execute_process(	1✔
109	process: Process, process_execution_environment: ProcessExecutionEnvironment
110	) -> FallibleProcessResult:
111	return await native_engine.execute_process(process, process_execution_environment)	×
112
113
114	@rule	1✔
115	async def execute_process_with_retry(req: ProcessWithRetries) -> ProcessResultWithRetries:	1✔
116	results: list[FallibleProcessResult] = []	×
117	for attempt in range(0, req.attempts):	×
118	proc = dataclasses.replace(req.proc, attempt=attempt)	×
119	result = await execute_process( # noqa: PNT30: We only know that we need to rerun the test after we run it	×
120	proc, **implicitly()
121	)
122	results.append(result)	×
123	if result.exit_code == 0:	×
124	break	×
125	return ProcessResultWithRetries(tuple(results))	×
126
127
128	@rule	1✔
129	async def digest_subset_to_digest(digest_subset: DigestSubset) -> Digest:	1✔
130	return await native_engine.digest_subset_to_digest(digest_subset)	×
131
132
133	@rule	1✔
134	async def session_values() -> SessionValues:	1✔
135	return await native_engine.session_values()	×
136
137
138	@rule	1✔
139	async def run_id() -> RunId:	1✔
140	return await native_engine.run_id()	×
141
142
143	__SQUELCH_WARNING = "__squelch_warning"	1✔
144
145
146	# NB: Call one of the helpers below, instead of calling this rule directly,
147	# to ensure correct application of restartable logic.
148	@_uncacheable_rule	1✔
149	async def _interactive_process(	1✔
150	process: InteractiveProcess, process_execution_environment: ProcessExecutionEnvironment
151	) -> InteractiveProcessResult:
152	# This is a crafty way for a caller to signal into this function without a dedicated arg
153	# (which would confound the solver). Note that we go via __dict__ instead of using
154	# setattr/delattr, because those error for frozen dataclasses.
155	if __SQUELCH_WARNING in process.__dict__:	×
156	del process.__dict__[__SQUELCH_WARNING]	×
157	else:
158	logging.warning(	×
159	"A plugin is calling `await _interactive_process(...)` directly. This will cause "
160	"restarting logic not to be applied. Use `await run_interactive_process(process)` "
161	"or `await run_interactive_process_in_environment(process, environment_name)` instead. "
162	f"See {git_url('src/python/pants/engine/intrinsics.py')} for more details."
163	)
164	return await native_engine.interactive_process(process, process_execution_environment)	×
165
166
167	async def run_interactive_process(process: InteractiveProcess) -> InteractiveProcessResult:	1✔
168	# NB: We must call task_side_effected() in this helper, rather than in a nested @rule call,
169	# so that the Task for the @rule that calls this helper is the one marked as non-restartable.
UNCOV 170	if not process.restartable:	×
UNCOV 171	task_side_effected()	×
172
UNCOV 173	process.__dict__[__SQUELCH_WARNING] = True	×
UNCOV 174	ret: InteractiveProcessResult = await _interactive_process(process, **implicitly())	×
UNCOV 175	return ret	×
176
177
178	async def run_interactive_process_in_environment(	1✔
179	process: InteractiveProcess, environment_name: EnvironmentName
180	) -> InteractiveProcessResult:
181	# NB: We must call task_side_effected() in this helper, rather than in a nested @rule call,
182	# so that the Task for the @rule that calls this helper is the one marked as non-restartable.
UNCOV 183	if not process.restartable:	×
UNCOV 184	task_side_effected()	×
185
UNCOV 186	process.__dict__[__SQUELCH_WARNING] = True	×
UNCOV 187	ret: InteractiveProcessResult = await _interactive_process(	×
188	process, **implicitly({environment_name: EnvironmentName})
189	)
UNCOV 190	return ret	×
191
192
193	@rule	1✔
194	async def docker_resolve_image(request: DockerResolveImageRequest) -> DockerResolveImageResult:	1✔
195	return await native_engine.docker_resolve_image(request)	×
196
197
198	@rule	1✔
199	async def parse_dockerfile_info(	1✔
200	deps_request: NativeDependenciesRequest,
201	) -> NativeDockerfileInfos:
202	path_infos_pairs = await native_engine.parse_dockerfile_info(deps_request)	×
203	return NativeDockerfileInfos(FrozenDict(path_infos_pairs))	×
204
205
206	@rule	1✔
207	async def parse_python_deps(	1✔
208	deps_request: NativeDependenciesRequest,
209	) -> NativePythonFilesDependencies:
210	path_deps_pairs = await native_engine.parse_python_deps(deps_request)	×
211	return NativePythonFilesDependencies(FrozenDict(path_deps_pairs))	×
212
213
214	@rule	1✔
215	async def parse_javascript_deps(	1✔
216	deps_request: NativeDependenciesRequest,
217	) -> NativeJavascriptFilesDependencies:
218	path_deps_pairs = await native_engine.parse_javascript_deps(deps_request)	×
219	return NativeJavascriptFilesDependencies(FrozenDict(path_deps_pairs))	×
220
221
222	@rule	1✔
223	async def path_metadata_request(request: PathMetadataRequest) -> PathMetadataResult:	1✔
224	return await native_engine.path_metadata_request(request)	×
225
226
227	def rules():	1✔
228	return [	1✔
229	*collect_rules(),
230	]

pantsbuild / pants / 21803785359

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous