19015773527

Committed 02 Nov 2025 05:33PM UTC coverage: 17.872% (-62.4%) from 80.3%

Build # 19015773527

Build Type

Pull #22816

github

Committed by

web-flow

Commit Message

Merge a12d75757 into 6c024e162

Pull Request Pull Request #22816: Update Pants internal Python to 3.14

Run Details

4 of 5 new or added lines in 3 files covered. (80.0%)

28452 existing lines in 683 files now uncovered.

9831 of 55007 relevant lines covered (17.87%)

0.18 hits per line

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

0.0

/src/python/pants/backend/codegen/protobuf/python/rules.py

1	# Copyright 2020 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
UNCOV 3	import logging	×
UNCOV 4	import os	×
UNCOV 5	from pathlib import PurePath	×
6
UNCOV 7	from pants.backend.codegen.protobuf import protoc	×
UNCOV 8	from pants.backend.codegen.protobuf.protoc import Protoc	×
UNCOV 9	from pants.backend.codegen.protobuf.python.additional_fields import PythonSourceRootField	×
UNCOV 10	from pants.backend.codegen.protobuf.python.grpc_python_plugin import GrpcPythonPlugin	×
UNCOV 11	from pants.backend.codegen.protobuf.python.python_protobuf_subsystem import (	×
12	PythonProtobufGrpclibPlugin,
13	PythonProtobufMypyPlugin,
14	PythonProtobufSubsystem,
15	)
UNCOV 16	from pants.backend.codegen.protobuf.target_types import ProtobufGrpcToggleField, ProtobufSourceField	×
UNCOV 17	from pants.backend.python.target_types import PythonSourceField	×
UNCOV 18	from pants.backend.python.util_rules import pex	×
UNCOV 19	from pants.backend.python.util_rules.pex import (	×
20	VenvPexRequest,
21	create_venv_pex,
22	determine_venv_pex_resolve_info,
23	)
UNCOV 24	from pants.backend.python.util_rules.pex_environment import PexEnvironment	×
UNCOV 25	from pants.core.goals.resolves import ExportableTool	×
UNCOV 26	from pants.core.util_rules.external_tool import download_external_tool	×
UNCOV 27	from pants.core.util_rules.source_files import SourceFilesRequest	×
UNCOV 28	from pants.core.util_rules.stripped_source_files import strip_source_roots	×
UNCOV 29	from pants.engine.fs import AddPrefix, CreateDigest, Directory, MergeDigests, RemovePrefix	×
UNCOV 30	from pants.engine.internals.graph import transitive_targets as transitive_targets_get	×
UNCOV 31	from pants.engine.intrinsics import create_digest, digest_to_snapshot, merge_digests, remove_prefix	×
UNCOV 32	from pants.engine.platform import Platform	×
UNCOV 33	from pants.engine.process import Process, execute_process_or_raise	×
UNCOV 34	from pants.engine.rules import collect_rules, concurrently, implicitly, rule	×
UNCOV 35	from pants.engine.target import GeneratedSources, GenerateSourcesRequest, TransitiveTargetsRequest	×
UNCOV 36	from pants.engine.unions import UnionRule	×
UNCOV 37	from pants.source.source_root import SourceRootRequest, get_source_root	×
UNCOV 38	from pants.util.logging import LogLevel	×
39
UNCOV 40	logger = logging.getLogger(__name__)	×
41
42
UNCOV 43	class GeneratePythonFromProtobufRequest(GenerateSourcesRequest):	×
UNCOV 44	input = ProtobufSourceField	×
UNCOV 45	output = PythonSourceField	×
46
47
UNCOV 48	@rule(desc="Generate Python from Protobuf", level=LogLevel.DEBUG)	×
UNCOV 49	async def generate_python_from_protobuf(	×
50	request: GeneratePythonFromProtobufRequest,
51	protoc: Protoc,
52	grpc_python_plugin: GrpcPythonPlugin,
53	python_protobuf_subsystem: PythonProtobufSubsystem,
54	python_protobuf_mypy_plugin: PythonProtobufMypyPlugin,
55	python_protobuf_grpclib_plugin: PythonProtobufGrpclibPlugin,
56	pex_environment: PexEnvironment,
57	platform: Platform,
58	) -> GeneratedSources:
59	download_protoc_request = download_external_tool(protoc.get_request(platform))	×
60
61	output_dir = "_generated_files"	×
62	create_output_dir_request = create_digest(CreateDigest([Directory(output_dir)]))	×
63
64	# Protoc needs all transitive dependencies on `protobuf_libraries` to work properly. It won't
65	# actually generate those dependencies; it only needs to look at their .proto files to work
66	# with imports.
67	transitive_targets = await transitive_targets_get(	×
68	TransitiveTargetsRequest([request.protocol_target.address]), **implicitly()
69	)
70
71	# NB: By stripping the source roots, we avoid having to set the value `--proto_path`
72	# for Protobuf imports to be discoverable.
73	all_stripped_sources_request = strip_source_roots(	×
74	**implicitly(
75	SourceFilesRequest(
76	tgt[ProtobufSourceField]
77	for tgt in transitive_targets.closure
78	if tgt.has_field(ProtobufSourceField)
79	)
80	)
81	)
82	target_stripped_sources_request = strip_source_roots(	×
83	**implicitly(SourceFilesRequest([request.protocol_target[ProtobufSourceField]]))
84	)
85
86	(	×
87	downloaded_protoc_binary,
88	empty_output_dir,
89	all_sources_stripped,
90	target_sources_stripped,
91	) = await concurrently(
92	download_protoc_request,
93	create_output_dir_request,
94	all_stripped_sources_request,
95	target_stripped_sources_request,
96	)
97
98	grpc_enabled = request.protocol_target.get(ProtobufGrpcToggleField).value	×
99	protoc_relpath = "__protoc"	×
100	unmerged_digests = [	×
101	all_sources_stripped.snapshot.digest,
102	empty_output_dir,
103	]
104
105	pyi_gen_option = "pyi_out:" if python_protobuf_subsystem.generate_type_stubs else ""	×
106	protoc_argv = [	×
107	os.path.join(protoc_relpath, downloaded_protoc_binary.exe),
108	f"--python_out={pyi_gen_option}{output_dir}",
109	]
110
111	complete_pex_env = pex_environment.in_sandbox(working_directory=None)	×
112
113	if python_protobuf_subsystem.mypy_plugin:	×
114	protoc_gen_mypy_script = "protoc-gen-mypy"	×
115	protoc_gen_mypy_grpc_script = "protoc-gen-mypy_grpc"	×
116	mypy_request = python_protobuf_mypy_plugin.to_pex_request()	×
117	mypy_pex = await create_venv_pex(	×
118	VenvPexRequest(
119	pex_request=mypy_request,
120	complete_pex_env=complete_pex_env,
121	bin_names=[protoc_gen_mypy_script],
122	),
123	**implicitly(),
124	)
125	protoc_argv.extend(	×
126	[
127	f"--plugin=protoc-gen-mypy={mypy_pex.bin[protoc_gen_mypy_script].argv0}",
128	"--mypy_out",
129	output_dir,
130	]
131	)
132
133	if grpc_enabled and python_protobuf_subsystem.grpcio_plugin:	×
134	mypy_pex_info = await determine_venv_pex_resolve_info(mypy_pex)	×
135
136	# In order to generate stubs for gRPC code, we need mypy-protobuf 2.0 or above.
137	mypy_protobuf_info = mypy_pex_info.find("mypy-protobuf")	×
138	if mypy_protobuf_info and mypy_protobuf_info.version.major >= 2:	×
139	# TODO: Use `pex_path` once VenvPex stores a Pex field.
140	mypy_pex = await create_venv_pex(	×
141	VenvPexRequest(
142	pex_request=mypy_request,
143	complete_pex_env=complete_pex_env,
144	bin_names=[protoc_gen_mypy_script, protoc_gen_mypy_grpc_script],
145	),
146	**implicitly(),
147	)
148	protoc_argv.extend(	×
149	[
150	f"--plugin=protoc-gen-mypy_grpc={mypy_pex.bin[protoc_gen_mypy_grpc_script].argv0}",
151	"--mypy_grpc_out",
152	output_dir,
153	]
154	)
155	unmerged_digests.append(mypy_pex.digest)	×
156
157	if grpc_enabled:	×
158	if not (	×
159	python_protobuf_subsystem.grpcio_plugin or python_protobuf_subsystem.grpclib_plugin
160	):
161	logger.warning(	×
162	"""
163	No Python grpc plugins have been enabled. Make sure to enable at least one of the
164	following under the [python-protobuf] configuration: grpcio_plugin, grpclib_plugin.
165	"""
166	)
167
168	if python_protobuf_subsystem.grpcio_plugin:	×
169	downloaded_grpc_plugin = await download_external_tool(	×
170	grpc_python_plugin.get_request(platform)
171	)
172	unmerged_digests.append(downloaded_grpc_plugin.digest)	×
173	protoc_argv.extend(	×
174	[f"--plugin=protoc-gen-grpc={downloaded_grpc_plugin.exe}", "--grpc_out", output_dir]
175	)
176
177	if python_protobuf_subsystem.grpclib_plugin:	×
178	protoc_gen_grpclib_script = "protoc-gen-grpclib_python"	×
179	grpclib_request = python_protobuf_grpclib_plugin.to_pex_request()	×
180	grpclib_pex = await create_venv_pex(	×
181	VenvPexRequest(
182	pex_request=grpclib_request,
183	complete_pex_env=complete_pex_env,
184	bin_names=[protoc_gen_grpclib_script],
185	),
186	**implicitly(),
187	)
188	unmerged_digests.append(grpclib_pex.digest)	×
189	protoc_argv.extend(	×
190	[
191	f"--plugin=protoc-gen-grpclib_python={grpclib_pex.bin[protoc_gen_grpclib_script].argv0}",
192	"--grpclib_python_out",
193	output_dir,
194	]
195	)
196
197	input_digest = await merge_digests(MergeDigests(unmerged_digests))	×
198	protoc_argv.extend(target_sources_stripped.snapshot.files)	×
199	result = await execute_process_or_raise(	×
200	**implicitly(
201	Process(
202	protoc_argv,
203	input_digest=input_digest,
204	immutable_input_digests={
205	protoc_relpath: downloaded_protoc_binary.digest,
206	},
207	description=f"Generating Python sources from {request.protocol_target.address}.",
208	level=LogLevel.DEBUG,
209	output_directories=(output_dir,),
210	append_only_caches=complete_pex_env.append_only_caches,
211	)
212	),
213	)
214
215	# We must do some path manipulation on the output digest for it to look like normal sources,
216	# including adding back a source root.
217	py_source_root = request.protocol_target.get(PythonSourceRootField).value	×
218	if py_source_root:	×
219	# Verify that the python source root specified by the target is in fact a source root.
220	source_root_request = SourceRootRequest(PurePath(py_source_root))	×
221	else:
222	# The target didn't specify a python source root, so use the protobuf_source's source root.
223	source_root_request = SourceRootRequest.for_target(request.protocol_target)	×
224
225	normalized_digest, source_root = await concurrently(	×
226	remove_prefix(RemovePrefix(result.output_digest, output_dir)),
227	get_source_root(source_root_request),
228	)
229
230	source_root_restored = (	×
231	await digest_to_snapshot(**implicitly(AddPrefix(normalized_digest, source_root.path)))
232	if source_root.path != "."
233	else await digest_to_snapshot(normalized_digest)
234	)
235	return GeneratedSources(source_root_restored)	×
236
237
UNCOV 238	def rules():	×
UNCOV 239	return [	×
240	*collect_rules(),
241	*pex.rules(),
242	UnionRule(GenerateSourcesRequest, GeneratePythonFromProtobufRequest),
243	*protoc.rules(),
244	UnionRule(ExportableTool, GrpcPythonPlugin),
245	]

pantsbuild / pants / 19015773527

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