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

100.0

/src/python/pants/core/goals/resolves.py

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

from enum import Enum
from typing import TypeVar

from pants.engine.unions import UnionMembership, union
from pants.util.strutil import softwrap

T = TypeVar("T", bound="ExportableTool")


class ExportMode(Enum):
    """How this tool should be exported.

    resolve: in a language-based resolve
    binary: as a single binary
    """

    resolve = "resolve"
    binary = "binary"


@union
class ExportableTool:
    """Mark a subsystem as exportable.

    Using this class has 2 parts:
    - The tool class should subclass this.
      This can be done at the language-backend level, for example, `PythonToolRequirementsBase`.
      The help message can be extended with instructions specific to that tool or language backend
    - Each exportable tool should have a `UnionRule` to `ExportableTool`.
      This `UnionRule` is what ties the class into the export machinery.
    """

    options_scope: str
    export_mode: ExportMode = ExportMode.resolve

    @classmethod
    def help_for_generate_lockfile_with_default_location(cls, resolve_name: str):
        """If this tool is configured to use the default lockfile, but a user requests to regenerate
        it, this help text will be shown to the user."""

        resolve = resolve_name
        return softwrap(
            f"""
            You requested to generate a lockfile for {resolve} because
            you included it in `--generate-lockfiles-resolve`, but
            {resolve} is a tool using its default lockfile.
        """
        )

    @staticmethod
    def filter_for_subclasses(
        union_membership: UnionMembership, parent_class: type[T]
    ) -> dict[str, type[T]]:
        """Find all ExportableTools that are members of `parent_class`.

        Language backends can use this to obtain all tools they can export.
        """
        exportable_tools = union_membership.get(ExportableTool)
        relevant_tools: dict[str, type[T]] = {
            e.options_scope: e  # type: ignore # mypy isn't narrowing with `issubclass`
            for e in exportable_tools
            if issubclass(e, parent_class)
        }
        return relevant_tools

1	# Copyright 2024 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3	from __future__ import annotations	12✔
4
5	from enum import Enum	12✔
6	from typing import TypeVar	12✔
7
8	from pants.engine.unions import UnionMembership, union	12✔
9	from pants.util.strutil import softwrap	12✔
10
11	T = TypeVar("T", bound="ExportableTool")	12✔
12
13
14	class ExportMode(Enum):	12✔
15	"""How this tool should be exported.
16
17	resolve: in a language-based resolve
18	binary: as a single binary
19	"""
20
21	resolve = "resolve"	12✔
22	binary = "binary"	12✔
23
24
25	@union	12✔
26	class ExportableTool:	12✔
27	"""Mark a subsystem as exportable.
28
29	Using this class has 2 parts:
30	- The tool class should subclass this.
31	This can be done at the language-backend level, for example, `PythonToolRequirementsBase`.
32	The help message can be extended with instructions specific to that tool or language backend
33	- Each exportable tool should have a `UnionRule` to `ExportableTool`.
34	This `UnionRule` is what ties the class into the export machinery.
35	"""
36
37	options_scope: str	12✔
38	export_mode: ExportMode = ExportMode.resolve	12✔
39
40	@classmethod	12✔
41	def help_for_generate_lockfile_with_default_location(cls, resolve_name: str):	12✔
42	"""If this tool is configured to use the default lockfile, but a user requests to regenerate
43	it, this help text will be shown to the user."""
44
UNCOV 45	resolve = resolve_name	1✔
UNCOV 46	return softwrap(	1✔
47	f"""
48	You requested to generate a lockfile for {resolve} because
49	you included it in `--generate-lockfiles-resolve`, but
50	{resolve} is a tool using its default lockfile.
51	"""
52	)
53
54	@staticmethod	12✔
55	def filter_for_subclasses(	12✔
56	union_membership: UnionMembership, parent_class: type[T]
57	) -> dict[str, type[T]]:
58	"""Find all ExportableTools that are members of `parent_class`.
59
60	Language backends can use this to obtain all tools they can export.
61	"""
UNCOV 62	exportable_tools = union_membership.get(ExportableTool)	1✔
UNCOV 63	relevant_tools: dict[str, type[T]] = {	1✔
64	e.options_scope: e # type: ignore # mypy isn't narrowing with `issubclass`
65	for e in exportable_tools
66	if issubclass(e, parent_class)
67	}
UNCOV 68	return relevant_tools	1✔

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