18727944183

Committed 22 Oct 2025 07:44PM UTC coverage: 80.273% (-0.003%) from 80.276%

Build # 18727944183

Build Type

Pull #22783

github

Committed by

web-flow

Commit Message

Merge 05742def6 into 725b949b8

Pull Request Pull Request #22783: only set pex --override during lockfile generation

Run Details

77856 of 96989 relevant lines covered (80.27%)

2.82 hits per line

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

52.0

/src/python/pants/backend/python/goals/lockfile.py

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

from __future__ import annotations

import itertools
import os.path
from collections import defaultdict
from dataclasses import dataclass
from operator import itemgetter

from pants.backend.python.subsystems.python_tool_base import PythonToolBase
from pants.backend.python.subsystems.setup import PythonSetup
from pants.backend.python.target_types import (
    PythonRequirementFindLinksField,
    PythonRequirementResolveField,
    PythonRequirementsField,
)
from pants.backend.python.util_rules.interpreter_constraints import InterpreterConstraints
from pants.backend.python.util_rules.lockfile_diff import _generate_python_lockfile_diff
from pants.backend.python.util_rules.lockfile_metadata import PythonLockfileMetadata
from pants.backend.python.util_rules.pex import find_interpreter
from pants.backend.python.util_rules.pex_cli import PexCliProcess, maybe_log_pex_stderr
from pants.backend.python.util_rules.pex_environment import PexSubsystem
from pants.backend.python.util_rules.pex_requirements import (
    PexRequirements,
    ResolvePexConfig,
    ResolvePexConfigRequest,
    determine_resolve_pex_config,
)
from pants.core.goals.generate_lockfiles import (
    DEFAULT_TOOL_LOCKFILE,
    GenerateLockfile,
    GenerateLockfileResult,
    GenerateLockfilesSubsystem,
    KnownUserResolveNames,
    KnownUserResolveNamesRequest,
    RequestedUserResolveNames,
    UserGenerateLockfiles,
    WrappedGenerateLockfile,
)
from pants.core.goals.resolves import ExportableTool
from pants.core.util_rules.lockfile_metadata import calculate_invalidation_digest
from pants.engine.fs import CreateDigest, Digest, FileContent, MergeDigests
from pants.engine.internals.synthetic_targets import SyntheticAddressMaps, SyntheticTargetsRequest
from pants.engine.internals.target_adaptor import TargetAdaptor
from pants.engine.intrinsics import create_digest, get_digest_contents, merge_digests
from pants.engine.process import ProcessCacheScope, fallible_to_exec_result_or_raise
from pants.engine.rules import collect_rules, implicitly, rule
from pants.engine.target import AllTargets
from pants.engine.unions import UnionMembership, UnionRule
from pants.option.subsystem import _construct_subsystem
from pants.util.docutil import bin_name
from pants.util.logging import LogLevel
from pants.util.ordered_set import FrozenOrderedSet
from pants.util.pip_requirement import PipRequirement


@dataclass(frozen=True)
class GeneratePythonLockfile(GenerateLockfile):
    requirements: FrozenOrderedSet[str]
    find_links: FrozenOrderedSet[str]
    interpreter_constraints: InterpreterConstraints

    @property
    def requirements_hex_digest(self) -> str:
        """Produces a hex digest of the requirements input for this lockfile."""
        return calculate_invalidation_digest(self.requirements)


@rule
async def wrap_python_lockfile_request(request: GeneratePythonLockfile) -> WrappedGenerateLockfile:
    return WrappedGenerateLockfile(request)


@dataclass(frozen=True)
class _PipArgsAndConstraintsSetup:
    resolve_config: ResolvePexConfig
    args: tuple[str, ...]
    digest: Digest


async def _setup_pip_args_and_constraints_file(resolve_name: str) -> _PipArgsAndConstraintsSetup:
    resolve_config = await determine_resolve_pex_config(
        ResolvePexConfigRequest(resolve_name), **implicitly()
    )

    args = list(resolve_config.pex_args())
    digests: list[Digest] = []

    if resolve_config.constraints_file:
        args.append(f"--constraints={resolve_config.constraints_file.path}")
        digests.append(resolve_config.constraints_file.digest)

    input_digest = await merge_digests(MergeDigests(digests))
    return _PipArgsAndConstraintsSetup(resolve_config, tuple(args), input_digest)


@rule(desc="Generate Python lockfile", level=LogLevel.DEBUG)
async def generate_lockfile(
    req: GeneratePythonLockfile,
    generate_lockfiles_subsystem: GenerateLockfilesSubsystem,
    python_setup: PythonSetup,
    pex_subsystem: PexSubsystem,
) -> GenerateLockfileResult:
    if not req.requirements:
        raise ValueError(
            f"Cannot generate lockfile with no requirements. Please add some requirements to {req.resolve_name}."
        )

    pip_args_setup = await _setup_pip_args_and_constraints_file(req.resolve_name)
    header_delimiter = "//"

    python = await find_interpreter(req.interpreter_constraints, **implicitly())

    result = await fallible_to_exec_result_or_raise(
        **implicitly(
            PexCliProcess(
                subcommand=("lock", "create"),
                extra_args=(
                    f"--output={req.lockfile_dest}",
                    # See https://github.com/pantsbuild/pants/issues/12458. For now, we always
                    # generate universal locks because they have the best compatibility. We may
                    # want to let users change this, as `style=strict` is safer.
                    "--style=universal",
                    "--pip-version",
                    python_setup.pip_version,
                    "--resolver-version",
                    "pip-2020-resolver",
                    "--preserve-pip-download-log",
                    "pex-pip-download.log",
                    # PEX files currently only run on Linux and Mac machines; so we hard code this
                    # limit on lock universality to avoid issues locking due to irrelevant
                    # Windows-only dependency issues. See this Pex issue that originated from a
                    # Pants user issue presented in Slack:
                    #   https://github.com/pex-tool/pex/issues/1821
                    #
                    # At some point it will probably make sense to expose `--target-system` for
                    # configuration.
                    "--target-system",
                    "linux",
                    "--target-system",
                    "mac",
                    # This makes diffs more readable when lockfiles change.
                    "--indent=2",
                    f"--python-path={python.path}",
                    *(f"--find-links={link}" for link in req.find_links),
                    *pip_args_setup.args,
                    *req.interpreter_constraints.generate_pex_arg_list(),
                    *(f"--override={override}" for override in pip_args_setup.resolve_config.overrides),
                    *req.requirements,
                ),
                additional_input_digest=pip_args_setup.digest,
                output_files=(req.lockfile_dest,),
                description=f"Generate lockfile for {req.resolve_name}",
                # Instead of caching lockfile generation with LMDB, we instead use the invalidation
                # scheme from `lockfile_metadata.py` to check for stale/invalid lockfiles. This is
                # necessary so that our invalidation is resilient to deleting LMDB or running on a
                # new machine.
                #
                # We disable caching with LMDB so that when you generate a lockfile, you always get
                # the most up-to-date snapshot of the world. This is generally desirable and also
                # necessary to avoid an awkward edge case where different developers generate
                # different lockfiles even when generating at the same time. See
                # https://github.com/pantsbuild/pants/issues/12591.
                cache_scope=ProcessCacheScope.PER_SESSION,
            )
        )
    )
    maybe_log_pex_stderr(result.stderr, pex_subsystem.verbosity)

    metadata = PythonLockfileMetadata.new(
        valid_for_interpreter_constraints=req.interpreter_constraints,
        requirements={
            PipRequirement.parse(
                i,
                description_of_origin=f"the lockfile {req.lockfile_dest} for the resolve {req.resolve_name}",
            )
            for i in req.requirements
        },
        manylinux=pip_args_setup.resolve_config.manylinux,
        requirement_constraints=(
            set(pip_args_setup.resolve_config.constraints_file.constraints)
            if pip_args_setup.resolve_config.constraints_file
            else set()
        ),
        only_binary=set(pip_args_setup.resolve_config.only_binary),
        no_binary=set(pip_args_setup.resolve_config.no_binary),
        excludes=set(pip_args_setup.resolve_config.excludes),
        overrides=set(pip_args_setup.resolve_config.overrides),
        sources=set(pip_args_setup.resolve_config.sources),
    )
    regenerate_command = (
        generate_lockfiles_subsystem.custom_command
        or f"{bin_name()} generate-lockfiles --resolve={req.resolve_name}"
    )
    if python_setup.separate_lockfile_metadata_file:
        descr = f"This lockfile was generated by Pants. To regenerate, run: {regenerate_command}"
        metadata_digest = await create_digest(
            CreateDigest(
                [
                    FileContent(
                        PythonLockfileMetadata.metadata_location_for_lockfile(req.lockfile_dest),
                        metadata.to_json(with_description=descr).encode(),
                    ),
                ]
            )
        )
        final_lockfile_digest = await merge_digests(
            MergeDigests([metadata_digest, result.output_digest])
        )
    else:
        initial_lockfile_digest_contents = await get_digest_contents(result.output_digest)
        lockfile_with_header = metadata.add_header_to_lockfile(
            initial_lockfile_digest_contents[0].content,
            regenerate_command=regenerate_command,
            delimeter=header_delimiter,
        )
        final_lockfile_digest = await create_digest(
            CreateDigest(
                [
                    FileContent(req.lockfile_dest, lockfile_with_header),
                ]
            )
        )

    if req.diff:
        diff = await _generate_python_lockfile_diff(
            final_lockfile_digest, req.resolve_name, req.lockfile_dest
        )
    else:
        diff = None

    return GenerateLockfileResult(final_lockfile_digest, req.resolve_name, req.lockfile_dest, diff)


class RequestedPythonUserResolveNames(RequestedUserResolveNames):
    pass


class KnownPythonUserResolveNamesRequest(KnownUserResolveNamesRequest):
    pass


@rule
async def determine_python_user_resolves(
    _: KnownPythonUserResolveNamesRequest,
    python_setup: PythonSetup,
    union_membership: UnionMembership,
) -> KnownUserResolveNames:
    """Find all know Python resolves, from both user-created resolves and internal tools."""
    python_tool_resolves = ExportableTool.filter_for_subclasses(union_membership, PythonToolBase)

    tools_using_default_resolve = [
        resolve_name
        for resolve_name, subsystem_cls in python_tool_resolves.items()
        if (await _construct_subsystem(subsystem_cls)).install_from_resolve is None
    ]

    return KnownUserResolveNames(
        names=(
            *python_setup.resolves.keys(),
            *tools_using_default_resolve,
        ),  # the order of the keys doesn't matter since shadowing is done in `setup_user_lockfile_requests`
        option_name="[python].resolves",
        requested_resolve_names_cls=RequestedPythonUserResolveNames,
    )


@rule
async def setup_user_lockfile_requests(
    requested: RequestedPythonUserResolveNames,
    all_targets: AllTargets,
    python_setup: PythonSetup,
    union_membership: UnionMembership,
) -> UserGenerateLockfiles:
    """Transform the names of resolves requested into the `GeneratePythonLockfile` request object.

    Shadowing is done here by only checking internal resolves if the resolve is not a user-created
    resolve.
    """
    if not (python_setup.enable_resolves and python_setup.resolves_generate_lockfiles):
        return UserGenerateLockfiles()

    resolve_to_requirements_fields = defaultdict(set)
    find_links: set[str] = set()
    for tgt in all_targets:
        if not tgt.has_fields((PythonRequirementResolveField, PythonRequirementsField)):
            continue
        resolve = tgt[PythonRequirementResolveField].normalized_value(python_setup)
        resolve_to_requirements_fields[resolve].add(tgt[PythonRequirementsField])
        find_links.update(tgt[PythonRequirementFindLinksField].value or ())

    tools = ExportableTool.filter_for_subclasses(union_membership, PythonToolBase)

    out = set()
    for resolve in requested:
        if resolve in python_setup.resolves:
            out.add(
                GeneratePythonLockfile(
                    requirements=PexRequirements.req_strings_from_requirement_fields(
                        resolve_to_requirements_fields[resolve]
                    ),
                    find_links=FrozenOrderedSet(find_links),
                    interpreter_constraints=InterpreterConstraints(
                        python_setup.resolves_to_interpreter_constraints.get(
                            resolve, python_setup.interpreter_constraints
                        )
                    ),
                    resolve_name=resolve,
                    lockfile_dest=python_setup.resolves[resolve],
                    diff=False,
                )
            )
        else:
            tool_cls: type[PythonToolBase] = tools[resolve]
            tool = await _construct_subsystem(tool_cls)

            # TODO: we shouldn't be managing default ICs in lockfile identification.
            #   We should find a better place to do this or a better way to default
            if tool.register_interpreter_constraints:
                ic = tool.interpreter_constraints
            else:
                ic = InterpreterConstraints(tool.default_interpreter_constraints)

            out.add(
                GeneratePythonLockfile(
                    requirements=FrozenOrderedSet(sorted(tool.requirements)),
                    find_links=FrozenOrderedSet(find_links),
                    interpreter_constraints=ic,
                    resolve_name=resolve,
                    lockfile_dest=DEFAULT_TOOL_LOCKFILE,
                    diff=False,
                )
            )

    return UserGenerateLockfiles(out)


@dataclass(frozen=True)
class PythonSyntheticLockfileTargetsRequest(SyntheticTargetsRequest):
    """Register the type used to create synthetic targets for Python lockfiles.

    As the paths for all lockfiles are known up-front, we set the `path` field to
    `SyntheticTargetsRequest.SINGLE_REQUEST_FOR_ALL_TARGETS` so that we get a single request for all
    our synthetic targets rather than one request per directory.
    """

    path: str = SyntheticTargetsRequest.SINGLE_REQUEST_FOR_ALL_TARGETS


def synthetic_lockfile_target_name(resolve: str) -> str:
    return f"_{resolve}_lockfile"


@rule
async def python_lockfile_synthetic_targets(
    request: PythonSyntheticLockfileTargetsRequest,
    python_setup: PythonSetup,
) -> SyntheticAddressMaps:
    if not python_setup.enable_synthetic_lockfiles:
        return SyntheticAddressMaps()

    resolves = [
        (os.path.dirname(lockfile), os.path.basename(lockfile), name)
        for name, lockfile in python_setup.resolves.items()
    ]

    return SyntheticAddressMaps.for_targets_request(
        request,
        [
            (
                os.path.join(spec_path, "BUILD.python-lockfiles"),
                tuple(
                    TargetAdaptor(
                        "_lockfiles",
                        name=synthetic_lockfile_target_name(name),
                        sources=(lockfile,),
                        __description_of_origin__=f"the [python].resolves option {name!r}",
                    )
                    for _, lockfile, name in lockfiles
                ),
            )
            for spec_path, lockfiles in itertools.groupby(sorted(resolves), key=itemgetter(0))
        ],
    )


def rules():
    return (
        *collect_rules(),
        UnionRule(GenerateLockfile, GeneratePythonLockfile),
        UnionRule(KnownUserResolveNamesRequest, KnownPythonUserResolveNamesRequest),
        UnionRule(RequestedUserResolveNames, RequestedPythonUserResolveNames),
        UnionRule(SyntheticTargetsRequest, PythonSyntheticLockfileTargetsRequest),
    )

1	# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	10✔
5
6	import itertools	10✔
7	import os.path	10✔
8	from collections import defaultdict	10✔
9	from dataclasses import dataclass	10✔
10	from operator import itemgetter	10✔
11
12	from pants.backend.python.subsystems.python_tool_base import PythonToolBase	10✔
13	from pants.backend.python.subsystems.setup import PythonSetup	10✔
14	from pants.backend.python.target_types import (	10✔
15	PythonRequirementFindLinksField,
16	PythonRequirementResolveField,
17	PythonRequirementsField,
18	)
19	from pants.backend.python.util_rules.interpreter_constraints import InterpreterConstraints	10✔
20	from pants.backend.python.util_rules.lockfile_diff import _generate_python_lockfile_diff	10✔
21	from pants.backend.python.util_rules.lockfile_metadata import PythonLockfileMetadata	10✔
22	from pants.backend.python.util_rules.pex import find_interpreter	10✔
23	from pants.backend.python.util_rules.pex_cli import PexCliProcess, maybe_log_pex_stderr	10✔
24	from pants.backend.python.util_rules.pex_environment import PexSubsystem	10✔
25	from pants.backend.python.util_rules.pex_requirements import (	10✔
26	PexRequirements,
27	ResolvePexConfig,
28	ResolvePexConfigRequest,
29	determine_resolve_pex_config,
30	)
31	from pants.core.goals.generate_lockfiles import (	10✔
32	DEFAULT_TOOL_LOCKFILE,
33	GenerateLockfile,
34	GenerateLockfileResult,
35	GenerateLockfilesSubsystem,
36	KnownUserResolveNames,
37	KnownUserResolveNamesRequest,
38	RequestedUserResolveNames,
39	UserGenerateLockfiles,
40	WrappedGenerateLockfile,
41	)
42	from pants.core.goals.resolves import ExportableTool	10✔
43	from pants.core.util_rules.lockfile_metadata import calculate_invalidation_digest	10✔
44	from pants.engine.fs import CreateDigest, Digest, FileContent, MergeDigests	10✔
45	from pants.engine.internals.synthetic_targets import SyntheticAddressMaps, SyntheticTargetsRequest	10✔
46	from pants.engine.internals.target_adaptor import TargetAdaptor	10✔
47	from pants.engine.intrinsics import create_digest, get_digest_contents, merge_digests	10✔
48	from pants.engine.process import ProcessCacheScope, fallible_to_exec_result_or_raise	10✔
49	from pants.engine.rules import collect_rules, implicitly, rule	10✔
50	from pants.engine.target import AllTargets	10✔
51	from pants.engine.unions import UnionMembership, UnionRule	10✔
52	from pants.option.subsystem import _construct_subsystem	10✔
53	from pants.util.docutil import bin_name	10✔
54	from pants.util.logging import LogLevel	10✔
55	from pants.util.ordered_set import FrozenOrderedSet	10✔
56	from pants.util.pip_requirement import PipRequirement	10✔
57
58
59	@dataclass(frozen=True)	10✔
60	class GeneratePythonLockfile(GenerateLockfile):	10✔
61	requirements: FrozenOrderedSet[str]	10✔
62	find_links: FrozenOrderedSet[str]	10✔
63	interpreter_constraints: InterpreterConstraints	10✔
64
65	@property	10✔
66	def requirements_hex_digest(self) -> str:	10✔
67	"""Produces a hex digest of the requirements input for this lockfile."""
68	return calculate_invalidation_digest(self.requirements)	×
69
70
71	@rule	10✔
72	async def wrap_python_lockfile_request(request: GeneratePythonLockfile) -> WrappedGenerateLockfile:	10✔
73	return WrappedGenerateLockfile(request)	×
74
75
76	@dataclass(frozen=True)	10✔
77	class _PipArgsAndConstraintsSetup:	10✔
78	resolve_config: ResolvePexConfig	10✔
79	args: tuple[str, ...]	10✔
80	digest: Digest	10✔
81
82
83	async def _setup_pip_args_and_constraints_file(resolve_name: str) -> _PipArgsAndConstraintsSetup:	10✔
84	resolve_config = await determine_resolve_pex_config(	×
85	ResolvePexConfigRequest(resolve_name), **implicitly()
86	)
87
88	args = list(resolve_config.pex_args())	×
89	digests: list[Digest] = []	×
90
91	if resolve_config.constraints_file:	×
92	args.append(f"--constraints={resolve_config.constraints_file.path}")	×
93	digests.append(resolve_config.constraints_file.digest)	×
94
95	input_digest = await merge_digests(MergeDigests(digests))	×
96	return _PipArgsAndConstraintsSetup(resolve_config, tuple(args), input_digest)	×
97
98
99	@rule(desc="Generate Python lockfile", level=LogLevel.DEBUG)	10✔
100	async def generate_lockfile(	10✔
101	req: GeneratePythonLockfile,
102	generate_lockfiles_subsystem: GenerateLockfilesSubsystem,
103	python_setup: PythonSetup,
104	pex_subsystem: PexSubsystem,
105	) -> GenerateLockfileResult:
106	if not req.requirements:	×
107	raise ValueError(	×
108	f"Cannot generate lockfile with no requirements. Please add some requirements to {req.resolve_name}."
109	)
110
111	pip_args_setup = await _setup_pip_args_and_constraints_file(req.resolve_name)	×
112	header_delimiter = "//"	×
113
114	python = await find_interpreter(req.interpreter_constraints, **implicitly())	×
115
116	result = await fallible_to_exec_result_or_raise(	×
117	**implicitly(
118	PexCliProcess(
119	subcommand=("lock", "create"),
120	extra_args=(
121	f"--output={req.lockfile_dest}",
122	# See https://github.com/pantsbuild/pants/issues/12458. For now, we always
123	# generate universal locks because they have the best compatibility. We may
124	# want to let users change this, as `style=strict` is safer.
125	"--style=universal",
126	"--pip-version",
127	python_setup.pip_version,
128	"--resolver-version",
129	"pip-2020-resolver",
130	"--preserve-pip-download-log",
131	"pex-pip-download.log",
132	# PEX files currently only run on Linux and Mac machines; so we hard code this
133	# limit on lock universality to avoid issues locking due to irrelevant
134	# Windows-only dependency issues. See this Pex issue that originated from a
135	# Pants user issue presented in Slack:
136	# https://github.com/pex-tool/pex/issues/1821
137	#
138	# At some point it will probably make sense to expose `--target-system` for
139	# configuration.
140	"--target-system",
141	"linux",
142	"--target-system",
143	"mac",
144	# This makes diffs more readable when lockfiles change.
145	"--indent=2",
146	f"--python-path={python.path}",
147	*(f"--find-links={link}" for link in req.find_links),
148	*pip_args_setup.args,
149	*req.interpreter_constraints.generate_pex_arg_list(),
150	*(f"--override={override}" for override in pip_args_setup.resolve_config.overrides),
151	*req.requirements,
152	),
153	additional_input_digest=pip_args_setup.digest,
154	output_files=(req.lockfile_dest,),
155	description=f"Generate lockfile for {req.resolve_name}",
156	# Instead of caching lockfile generation with LMDB, we instead use the invalidation
157	# scheme from `lockfile_metadata.py` to check for stale/invalid lockfiles. This is
158	# necessary so that our invalidation is resilient to deleting LMDB or running on a
159	# new machine.
160	#
161	# We disable caching with LMDB so that when you generate a lockfile, you always get
162	# the most up-to-date snapshot of the world. This is generally desirable and also
163	# necessary to avoid an awkward edge case where different developers generate
164	# different lockfiles even when generating at the same time. See
165	# https://github.com/pantsbuild/pants/issues/12591.
166	cache_scope=ProcessCacheScope.PER_SESSION,
167	)
168	)
169	)
170	maybe_log_pex_stderr(result.stderr, pex_subsystem.verbosity)	×
171
172	metadata = PythonLockfileMetadata.new(	×
173	valid_for_interpreter_constraints=req.interpreter_constraints,
174	requirements={
175	PipRequirement.parse(
176	i,
177	description_of_origin=f"the lockfile {req.lockfile_dest} for the resolve {req.resolve_name}",
178	)
179	for i in req.requirements
180	},
181	manylinux=pip_args_setup.resolve_config.manylinux,
182	requirement_constraints=(
183	set(pip_args_setup.resolve_config.constraints_file.constraints)
184	if pip_args_setup.resolve_config.constraints_file
185	else set()
186	),
187	only_binary=set(pip_args_setup.resolve_config.only_binary),
188	no_binary=set(pip_args_setup.resolve_config.no_binary),
189	excludes=set(pip_args_setup.resolve_config.excludes),
190	overrides=set(pip_args_setup.resolve_config.overrides),
191	sources=set(pip_args_setup.resolve_config.sources),
192	)
193	regenerate_command = (	×
194	generate_lockfiles_subsystem.custom_command
195	or f"{bin_name()} generate-lockfiles --resolve={req.resolve_name}"
196	)
197	if python_setup.separate_lockfile_metadata_file:	×
198	descr = f"This lockfile was generated by Pants. To regenerate, run: {regenerate_command}"	×
199	metadata_digest = await create_digest(	×
200	CreateDigest(
201	[
202	FileContent(
203	PythonLockfileMetadata.metadata_location_for_lockfile(req.lockfile_dest),
204	metadata.to_json(with_description=descr).encode(),
205	),
206	]
207	)
208	)
209	final_lockfile_digest = await merge_digests(	×
210	MergeDigests([metadata_digest, result.output_digest])
211	)
212	else:
213	initial_lockfile_digest_contents = await get_digest_contents(result.output_digest)	×
214	lockfile_with_header = metadata.add_header_to_lockfile(	×
215	initial_lockfile_digest_contents[0].content,
216	regenerate_command=regenerate_command,
217	delimeter=header_delimiter,
218	)
219	final_lockfile_digest = await create_digest(	×
220	CreateDigest(
221	[
222	FileContent(req.lockfile_dest, lockfile_with_header),
223	]
224	)
225	)
226
227	if req.diff:	×
228	diff = await _generate_python_lockfile_diff(	×
229	final_lockfile_digest, req.resolve_name, req.lockfile_dest
230	)
231	else:
232	diff = None	×
233
234	return GenerateLockfileResult(final_lockfile_digest, req.resolve_name, req.lockfile_dest, diff)	×
235
236
237	class RequestedPythonUserResolveNames(RequestedUserResolveNames):	10✔
238	pass	10✔
239
240
241	class KnownPythonUserResolveNamesRequest(KnownUserResolveNamesRequest):	10✔
242	pass	10✔
243
244
245	@rule	10✔
246	async def determine_python_user_resolves(	10✔
247	_: KnownPythonUserResolveNamesRequest,
248	python_setup: PythonSetup,
249	union_membership: UnionMembership,
250	) -> KnownUserResolveNames:
251	"""Find all know Python resolves, from both user-created resolves and internal tools."""
252	python_tool_resolves = ExportableTool.filter_for_subclasses(union_membership, PythonToolBase)	×
253
254	tools_using_default_resolve = [	×
255	resolve_name
256	for resolve_name, subsystem_cls in python_tool_resolves.items()
257	if (await _construct_subsystem(subsystem_cls)).install_from_resolve is None
258	]
259
260	return KnownUserResolveNames(	×
261	names=(
262	*python_setup.resolves.keys(),
263	*tools_using_default_resolve,
264	), # the order of the keys doesn't matter since shadowing is done in `setup_user_lockfile_requests`
265	option_name="[python].resolves",
266	requested_resolve_names_cls=RequestedPythonUserResolveNames,
267	)
268
269
270	@rule	10✔
271	async def setup_user_lockfile_requests(	10✔
272	requested: RequestedPythonUserResolveNames,
273	all_targets: AllTargets,
274	python_setup: PythonSetup,
275	union_membership: UnionMembership,
276	) -> UserGenerateLockfiles:
277	"""Transform the names of resolves requested into the `GeneratePythonLockfile` request object.
278
279	Shadowing is done here by only checking internal resolves if the resolve is not a user-created
280	resolve.
281	"""
282	if not (python_setup.enable_resolves and python_setup.resolves_generate_lockfiles):	×
283	return UserGenerateLockfiles()	×
284
285	resolve_to_requirements_fields = defaultdict(set)	×
286	find_links: set[str] = set()	×
287	for tgt in all_targets:	×
288	if not tgt.has_fields((PythonRequirementResolveField, PythonRequirementsField)):	×
289	continue	×
290	resolve = tgt[PythonRequirementResolveField].normalized_value(python_setup)	×
291	resolve_to_requirements_fields[resolve].add(tgt[PythonRequirementsField])	×
292	find_links.update(tgt[PythonRequirementFindLinksField].value or ())	×
293
294	tools = ExportableTool.filter_for_subclasses(union_membership, PythonToolBase)	×
295
296	out = set()	×
297	for resolve in requested:	×
298	if resolve in python_setup.resolves:	×
299	out.add(	×
300	GeneratePythonLockfile(
301	requirements=PexRequirements.req_strings_from_requirement_fields(
302	resolve_to_requirements_fields[resolve]
303	),
304	find_links=FrozenOrderedSet(find_links),
305	interpreter_constraints=InterpreterConstraints(
306	python_setup.resolves_to_interpreter_constraints.get(
307	resolve, python_setup.interpreter_constraints
308	)
309	),
310	resolve_name=resolve,
311	lockfile_dest=python_setup.resolves[resolve],
312	diff=False,
313	)
314	)
315	else:
316	tool_cls: type[PythonToolBase] = tools[resolve]	×
317	tool = await _construct_subsystem(tool_cls)	×
318
319	# TODO: we shouldn't be managing default ICs in lockfile identification.
320	# We should find a better place to do this or a better way to default
321	if tool.register_interpreter_constraints:	×
322	ic = tool.interpreter_constraints	×
323	else:
324	ic = InterpreterConstraints(tool.default_interpreter_constraints)	×
325
326	out.add(	×
327	GeneratePythonLockfile(
328	requirements=FrozenOrderedSet(sorted(tool.requirements)),
329	find_links=FrozenOrderedSet(find_links),
330	interpreter_constraints=ic,
331	resolve_name=resolve,
332	lockfile_dest=DEFAULT_TOOL_LOCKFILE,
333	diff=False,
334	)
335	)
336
337	return UserGenerateLockfiles(out)	×
338
339
340	@dataclass(frozen=True)	10✔
341	class PythonSyntheticLockfileTargetsRequest(SyntheticTargetsRequest):	10✔
342	"""Register the type used to create synthetic targets for Python lockfiles.
343
344	As the paths for all lockfiles are known up-front, we set the `path` field to
345	`SyntheticTargetsRequest.SINGLE_REQUEST_FOR_ALL_TARGETS` so that we get a single request for all
346	our synthetic targets rather than one request per directory.
347	"""
348
349	path: str = SyntheticTargetsRequest.SINGLE_REQUEST_FOR_ALL_TARGETS	10✔
350
351
352	def synthetic_lockfile_target_name(resolve: str) -> str:	10✔
353	return f"_{resolve}_lockfile"	×
354
355
356	@rule	10✔
357	async def python_lockfile_synthetic_targets(	10✔
358	request: PythonSyntheticLockfileTargetsRequest,
359	python_setup: PythonSetup,
360	) -> SyntheticAddressMaps:
361	if not python_setup.enable_synthetic_lockfiles:	×
362	return SyntheticAddressMaps()	×
363
364	resolves = [	×
365	(os.path.dirname(lockfile), os.path.basename(lockfile), name)
366	for name, lockfile in python_setup.resolves.items()
367	]
368
369	return SyntheticAddressMaps.for_targets_request(	×
370	request,
371	[
372	(
373	os.path.join(spec_path, "BUILD.python-lockfiles"),
374	tuple(
375	TargetAdaptor(
376	"_lockfiles",
377	name=synthetic_lockfile_target_name(name),
378	sources=(lockfile,),
379	__description_of_origin__=f"the [python].resolves option {name!r}",
380	)
381	for _, lockfile, name in lockfiles
382	),
383	)
384	for spec_path, lockfiles in itertools.groupby(sorted(resolves), key=itemgetter(0))
385	],
386	)
387
388
389	def rules():	10✔
390	return (	9✔
391	*collect_rules(),
392	UnionRule(GenerateLockfile, GeneratePythonLockfile),
393	UnionRule(KnownUserResolveNamesRequest, KnownPythonUserResolveNamesRequest),
394	UnionRule(RequestedUserResolveNames, RequestedPythonUserResolveNames),
395	UnionRule(SyntheticTargetsRequest, PythonSyntheticLockfileTargetsRequest),
396	)

pantsbuild / pants / 18727944183

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