21552830208

Committed 31 Jan 2026 11:40PM UTC coverage: 80.277% (-0.05%) from 80.324%

Build # 21552830208

Build Type

Pull #23062

github

Committed by

web-flow

Commit Message

Merge 808a9786c into 2c4dcf9cf

Pull Request Pull Request #23062: Remove support for Get

Run Details

18 of 25 new or added lines in 4 files covered. (72.0%)

17119 existing lines in 541 files now uncovered.

78278 of 97510 relevant lines covered (80.28%)

3.36 hits per line

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

69.31

/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 (
    NativeParsedDockerfileInfo,
    NativeParsedJavascriptDependencies,
    NativeParsedPythonDependencies,
)
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


@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,
) -> NativeParsedDockerfileInfo:
    return await native_engine.parse_dockerfile_info(deps_request)


@rule
async def parse_python_deps(
    deps_request: NativeDependenciesRequest,
) -> NativeParsedPythonDependencies:
    return await native_engine.parse_python_deps(deps_request)


@rule
async def parse_javascript_deps(
    deps_request: NativeDependenciesRequest,
) -> NativeParsedJavascriptDependencies:
    return await native_engine.parse_javascript_deps(deps_request)


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

pantsbuild / pants / 21552830208

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