21803785359

Committed 08 Feb 2026 07:13PM UTC coverage: 43.3% (-37.0%) from 80.277%

Build # 21803785359

Build Type

Pull #23085

github

Committed by

web-flow

Commit Message

Merge 7c1cd926d into 40389cc58

Pull Request Pull Request #23085: A helper method for indexing paths by source root

Run Details

2 of 6 new or added lines in 1 file covered. (33.33%)

17114 existing lines in 539 files now uncovered.

26075 of 60219 relevant lines covered (43.3%)

0.43 hits per line

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

95.12

/src/python/pants/option/scope.py

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

from dataclasses import dataclass
from typing import Any, cast

from pants.option.option_value_container import OptionValueContainer

GLOBAL_SCOPE = ""
GLOBAL_SCOPE_CONFIG_SECTION = "GLOBAL"


def normalize_scope(scope: str):
    return scope.lower().replace("-", "_")


@dataclass(frozen=True)
class Scope:
    """An options scope."""

    scope: str


@dataclass(frozen=True, order=True)
class ScopeInfo:
    """Information about a scope."""

    scope: str
    subsystem_cls: type[Any] | None = None
    # A ScopeInfo may have a deprecated_scope (from its associated subsystem_cls), which represents
    # a previous/deprecated name for a current/non-deprecated ScopeInfo. It may also be directly
    # deprecated via this `removal_version`, which allows for the deprecation of an entire scope.
    removal_version: str | None = None
    removal_hint: str | None = None

    # Command line goal scope flag.
    is_goal: bool = False

    # Builtin goals, such as `help` and `version` etc.
    is_builtin: bool = False

    # Auxiliary goals, such as the `experimental-bsp` goal.
    is_auxiliary: bool = False

    @property
    def description(self) -> str:
        return cast(str, self._subsystem_cls_attr("help"))

    @property
    def deprecated_scope(self) -> str | None:
        return cast(str | None, self._subsystem_cls_attr("deprecated_options_scope"))

    @property
    def deprecated_scope_removal_version(self) -> str | None:
        return cast(
            str | None,
            self._subsystem_cls_attr("deprecated_options_scope_removal_version"),
        )

    @property
    def scope_aliases(self) -> tuple[str, ...]:
        """BuiltinGoal subsystems may define aliases."""
        return cast(tuple[str, ...], self._subsystem_cls_attr("aliases", ()))

    def _subsystem_cls_attr(self, name: str, default=None):
        return getattr(self.subsystem_cls, name, default) if self.subsystem_cls else default


@dataclass(frozen=True)
class OptionsParsingSettings:
    """Information derived from options bootstrapping used to parse full options."""

    known_scope_infos: tuple[ScopeInfo, ...]
    allow_unknown_options: bool


@dataclass(frozen=True)
class ScopedOptions:
    """A wrapper around options selected for a particular Scope."""

    scope: Scope
    options: OptionValueContainer

1	# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from dataclasses import dataclass	1✔
5	from typing import Any, cast	1✔
6
7	from pants.option.option_value_container import OptionValueContainer	1✔
8
9	GLOBAL_SCOPE = ""	1✔
10	GLOBAL_SCOPE_CONFIG_SECTION = "GLOBAL"	1✔
11
12
13	def normalize_scope(scope: str):	1✔
14	return scope.lower().replace("-", "_")	1✔
15
16
17	@dataclass(frozen=True)	1✔
18	class Scope:	1✔
19	"""An options scope."""
20
21	scope: str	1✔
22
23
24	@dataclass(frozen=True, order=True)	1✔
25	class ScopeInfo:	1✔
26	"""Information about a scope."""
27
28	scope: str	1✔
29	subsystem_cls: type[Any] \| None = None	1✔
30	# A ScopeInfo may have a deprecated_scope (from its associated subsystem_cls), which represents
31	# a previous/deprecated name for a current/non-deprecated ScopeInfo. It may also be directly
32	# deprecated via this `removal_version`, which allows for the deprecation of an entire scope.
33	removal_version: str \| None = None	1✔
34	removal_hint: str \| None = None	1✔
35
36	# Command line goal scope flag.
37	is_goal: bool = False	1✔
38
39	# Builtin goals, such as `help` and `version` etc.
40	is_builtin: bool = False	1✔
41
42	# Auxiliary goals, such as the `experimental-bsp` goal.
43	is_auxiliary: bool = False	1✔
44
45	@property	1✔
46	def description(self) -> str:	1✔
UNCOV 47	return cast(str, self._subsystem_cls_attr("help"))	×
48
49	@property	1✔
50	def deprecated_scope(self) -> str \| None:	1✔
51	return cast(str \| None, self._subsystem_cls_attr("deprecated_options_scope"))	1✔
52
53	@property	1✔
54	def deprecated_scope_removal_version(self) -> str \| None:	1✔
UNCOV 55	return cast(	×
56	str \| None,
57	self._subsystem_cls_attr("deprecated_options_scope_removal_version"),
58	)
59
60	@property	1✔
61	def scope_aliases(self) -> tuple[str, ...]:	1✔
62	"""BuiltinGoal subsystems may define aliases."""
63	return cast(tuple[str, ...], self._subsystem_cls_attr("aliases", ()))	1✔
64
65	def _subsystem_cls_attr(self, name: str, default=None):	1✔
66	return getattr(self.subsystem_cls, name, default) if self.subsystem_cls else default	1✔
67
68
69	@dataclass(frozen=True)	1✔
70	class OptionsParsingSettings:	1✔
71	"""Information derived from options bootstrapping used to parse full options."""
72
73	known_scope_infos: tuple[ScopeInfo, ...]	1✔
74	allow_unknown_options: bool	1✔
75
76
77	@dataclass(frozen=True)	1✔
78	class ScopedOptions:	1✔
79	"""A wrapper around options selected for a particular Scope."""
80
81	scope: Scope	1✔
82	options: OptionValueContainer	1✔

pantsbuild / pants / 21803785359

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