20632486505

Committed 01 Jan 2026 04:21AM UTC coverage: 43.231% (-37.1%) from 80.281%

Build # 20632486505

Build Type

Pull #22962

github

Committed by

web-flow

Commit Message

Merge 08d5c63b0 into f52ab6675

Pull Request Pull Request #22962: Bump the gha-deps group across 1 directory with 6 updates

Run Details

26122 of 60424 relevant lines covered (43.23%)

0.86 hits per line

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

68.63

/src/python/pants/build_graph/build_file_aliases.py

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

from __future__ import annotations

from collections.abc import Callable, Mapping
from dataclasses import dataclass
from typing import Any

from pants.base.parse_context import ParseContext
from pants.util.frozendict import FrozenDict

ContextAwareObjectFactory = Callable[[ParseContext], Callable[..., None]]


@dataclass(frozen=True)
class BuildFileAliases:
    """A structure containing sets of symbols to be exposed in BUILD files.

    There are three types of symbols that can be directly exposed:

    :API: public

    - targets: These are Target subclasses or TargetMacro.Factory instances.
    - objects: These are any python object, from constants to types.
    - context_aware_object_factories: These are object factories that are passed a ParseContext and
      produce one or more objects that use data from the context to enable some feature or utility;
      you might call them a BUILD file "macro" since they expand parameters to some final, "real"
      BUILD file object.  Common uses include creating objects that must be aware of the current
      BUILD file path or functions that need to be able to create targets or objects from within the
      BUILD file parse.
    """

    _objects: FrozenDict[str, Any]
    _context_aware_object_factories: FrozenDict[str, ContextAwareObjectFactory]

    @classmethod
    def _validate_alias(cls, category: str, alias: str, obj: Any) -> None:
        if not isinstance(alias, str):
            raise TypeError(
                f"Aliases must be strings, given {category} entry {alias!r} of type {type(alias).__name__} as "
                f"the alias of {obj}"
            )

    @classmethod
    def _validate_objects(cls, objects: dict[str, Any] | None) -> FrozenDict[str, Any]:
        if not objects:
            return FrozenDict()

        for alias, obj in objects.items():
            cls._validate_alias("objects", alias, obj)
        return FrozenDict(objects)

    @classmethod
    def _validate_context_aware_object_factories(
        cls, context_aware_object_factories: dict[str, ContextAwareObjectFactory] | None
    ) -> FrozenDict[str, ContextAwareObjectFactory]:
        if not context_aware_object_factories:
            return FrozenDict()

        for alias, obj in context_aware_object_factories.items():
            cls._validate_alias("context_aware_object_factories", alias, obj)
            if not callable(obj):
                raise TypeError(
                    f"The given context aware object factory {alias!r} must be a callable."
                )

        return FrozenDict(context_aware_object_factories)

    def __init__(
        self,
        objects: dict[str, Any] | None = None,
        context_aware_object_factories: dict[str, ContextAwareObjectFactory] | None = None,
    ) -> None:
        """
        :API: public
        """
        object.__setattr__(self, "_objects", self._validate_objects(objects))
        object.__setattr__(
            self,
            "_context_aware_object_factories",
            self._validate_context_aware_object_factories(context_aware_object_factories),
        )

    @property
    def objects(self) -> FrozenDict[str, Any]:
        """
        :API: public
        """
        return self._objects

    @property
    def context_aware_object_factories(self) -> FrozenDict[str, ContextAwareObjectFactory]:
        """
        :API: public
        """
        return self._context_aware_object_factories

    def merge(self, other: BuildFileAliases) -> BuildFileAliases:
        """Merges a set of build file aliases and returns a new set of aliases containing both.

        Any duplicate aliases from `other` will trump.

        :API: public
        """
        if not isinstance(other, BuildFileAliases):
            raise TypeError(f"Can only merge other BuildFileAliases, given {other}")

        def _merge(item1: Mapping[str, Any], item2: Mapping[str, Any]) -> dict[str, Any]:
            merged: dict[str, Any] = {}
            merged.update(item1)
            merged.update(item2)
            return merged

        objects = _merge(self.objects, other.objects)
        context_aware_object_factories = _merge(
            self.context_aware_object_factories, other.context_aware_object_factories
        )
        return BuildFileAliases(
            objects=objects,
            context_aware_object_factories=context_aware_object_factories,
        )

1	# Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	2✔
5
6	from collections.abc import Callable, Mapping	2✔
7	from dataclasses import dataclass	2✔
8	from typing import Any	2✔
9
10	from pants.base.parse_context import ParseContext	2✔
11	from pants.util.frozendict import FrozenDict	2✔
12
13	ContextAwareObjectFactory = Callable[[ParseContext], Callable[..., None]]	2✔
14
15
16	@dataclass(frozen=True)	2✔
17	class BuildFileAliases:	2✔
18	"""A structure containing sets of symbols to be exposed in BUILD files.
19
20	There are three types of symbols that can be directly exposed:
21
22	:API: public
23
24	- targets: These are Target subclasses or TargetMacro.Factory instances.
25	- objects: These are any python object, from constants to types.
26	- context_aware_object_factories: These are object factories that are passed a ParseContext and
27	produce one or more objects that use data from the context to enable some feature or utility;
28	you might call them a BUILD file "macro" since they expand parameters to some final, "real"
29	BUILD file object. Common uses include creating objects that must be aware of the current
30	BUILD file path or functions that need to be able to create targets or objects from within the
31	BUILD file parse.
32	"""
33
34	_objects: FrozenDict[str, Any]	2✔
35	_context_aware_object_factories: FrozenDict[str, ContextAwareObjectFactory]	2✔
36
37	@classmethod	2✔
38	def _validate_alias(cls, category: str, alias: str, obj: Any) -> None:	2✔
39	if not isinstance(alias, str):	2✔
40	raise TypeError(	×
41	f"Aliases must be strings, given {category} entry {alias!r} of type {type(alias).__name__} as "
42	f"the alias of {obj}"
43	)
44
45	@classmethod	2✔
46	def _validate_objects(cls, objects: dict[str, Any] \| None) -> FrozenDict[str, Any]:	2✔
47	if not objects:	2✔
48	return FrozenDict()	2✔
49
50	for alias, obj in objects.items():	2✔
51	cls._validate_alias("objects", alias, obj)	2✔
52	return FrozenDict(objects)	2✔
53
54	@classmethod	2✔
55	def _validate_context_aware_object_factories(	2✔
56	cls, context_aware_object_factories: dict[str, ContextAwareObjectFactory] \| None
57	) -> FrozenDict[str, ContextAwareObjectFactory]:
58	if not context_aware_object_factories:	2✔
59	return FrozenDict()	2✔
60
61	for alias, obj in context_aware_object_factories.items():	×
62	cls._validate_alias("context_aware_object_factories", alias, obj)	×
63	if not callable(obj):	×
64	raise TypeError(	×
65	f"The given context aware object factory {alias!r} must be a callable."
66	)
67
68	return FrozenDict(context_aware_object_factories)	×
69
70	def __init__(	2✔
71	self,
72	objects: dict[str, Any] \| None = None,
73	context_aware_object_factories: dict[str, ContextAwareObjectFactory] \| None = None,
74	) -> None:
75	"""
76	:API: public
77	"""
78	object.__setattr__(self, "_objects", self._validate_objects(objects))	2✔
79	object.__setattr__(	2✔
80	self,
81	"_context_aware_object_factories",
82	self._validate_context_aware_object_factories(context_aware_object_factories),
83	)
84
85	@property	2✔
86	def objects(self) -> FrozenDict[str, Any]:	2✔
87	"""
88	:API: public
89	"""
90	return self._objects	2✔
91
92	@property	2✔
93	def context_aware_object_factories(self) -> FrozenDict[str, ContextAwareObjectFactory]:	2✔
94	"""
95	:API: public
96	"""
97	return self._context_aware_object_factories	2✔
98
99	def merge(self, other: BuildFileAliases) -> BuildFileAliases:	2✔
100	"""Merges a set of build file aliases and returns a new set of aliases containing both.
101
102	Any duplicate aliases from `other` will trump.
103
104	:API: public
105	"""
106	if not isinstance(other, BuildFileAliases):	×
107	raise TypeError(f"Can only merge other BuildFileAliases, given {other}")	×
108
109	def _merge(item1: Mapping[str, Any], item2: Mapping[str, Any]) -> dict[str, Any]:	×
110	merged: dict[str, Any] = {}	×
111	merged.update(item1)	×
112	merged.update(item2)	×
113	return merged	×
114
115	objects = _merge(self.objects, other.objects)	×
116	context_aware_object_factories = _merge(	×
117	self.context_aware_object_factories, other.context_aware_object_factories
118	)
119	return BuildFileAliases(	×
120	objects=objects,
121	context_aware_object_factories=context_aware_object_factories,
122	)

pantsbuild / pants / 20632486505

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