pantsbuild / pants / 21378504907

coverage: 43.218% (-37.1%) from 80.269%
21378504907

Pull #23038

github

web-flow 
Merge a9ec5051e into 09b8ecaa1
Pull Request #23038: remote cache logger - new plugin to help debug the remote cache

0 of 45 new or added lines in 1 file covered. (0.0%)

17212 existing lines in 540 files now uncovered.

26144 of 60493 relevant lines covered (43.22%)

0.86 hits per line

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

0.0
/src/python/pants/backend/python/macros/common_fields.py
1 
# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
2 
# Licensed under the Apache License, Version 2.0 (see LICENSE).
3 










UNCOV

4



from __future__ import annotations




×







5













UNCOV

6



from collections.abc import Iterable




×








UNCOV

7



from typing import ClassVar




×







8













UNCOV

9



from pants.backend.python.target_types import (




×







10



    PythonRequirementModulesField,










11



    PythonRequirementTarget,










12



    PythonRequirementTypeStubModulesField,










13



    normalize_module_mapping,










14



)











UNCOV

15



from pants.engine.addresses import Address




×








UNCOV

16



from pants.engine.target import DictStringToStringSequenceField, OverridesField




×








UNCOV

17



from pants.util.frozendict import FrozenDict




×








UNCOV

18



from pants.util.strutil import help_text




×







19












20













UNCOV

21



class ModuleMappingField(DictStringToStringSequenceField):




×








UNCOV

22



    alias = "module_mapping"




×








UNCOV

23



    help = help_text(




×







24



        f"""










25



        A mapping of requirement names to a list of the modules they provide.










26














27



        For example, `{{"ansicolors": ["colors"]}}`.










28














29



        Any unspecified requirements will use a default. See the










30



        `{PythonRequirementModulesField.alias}` field from the `{PythonRequirementTarget.alias}`










31



        target for more information.










32



        """










33



    )











UNCOV

34



    value: FrozenDict[str, tuple[str, ...]]




×








UNCOV

35



    default: ClassVar[FrozenDict[str, tuple[str, ...]]] = FrozenDict()




×







36













UNCOV

37



    @classmethod




×








UNCOV

38



    def compute_value(  # type: ignore[override]




×







39



        cls, raw_value: dict[str, Iterable[str]], address: Address










40



    ) -> FrozenDict[str, tuple[str, ...]]:










41



        value_or_default = super().compute_value(raw_value, address)




×







42



        return normalize_module_mapping(value_or_default)




×







43












44













UNCOV

45



class TypeStubsModuleMappingField(DictStringToStringSequenceField):




×








UNCOV

46



    alias = "type_stubs_module_mapping"




×








UNCOV

47



    help = help_text(




×







48



        f"""










49



        A mapping of type-stub requirement names to a list of the modules they provide.










50














51



        For example, `{{"types-requests": ["requests"]}}`.










52














53



        If the requirement is not specified _and_ its name looks like a type stub, Pants will










54



        use a default. See the `{PythonRequirementTypeStubModulesField.alias}` field from the










55



        `{PythonRequirementTarget.alias}` target for more information.










56



        """










57



    )











UNCOV

58



    value: FrozenDict[str, tuple[str, ...]]




×








UNCOV

59



    default: ClassVar[FrozenDict[str, tuple[str, ...]]] = FrozenDict()




×







60













UNCOV

61



    @classmethod




×








UNCOV

62



    def compute_value(  # type: ignore[override]




×







63



        cls, raw_value: dict[str, Iterable[str]], address: Address










64



    ) -> FrozenDict[str, tuple[str, ...]]:










65



        value_or_default = super().compute_value(raw_value, address)




×







66



        return normalize_module_mapping(value_or_default)




×







67












68













UNCOV

69



class RequirementsOverrideField(OverridesField):




×








UNCOV

70



    help = help_text(




×







71



        """










72



        Override the field values for generated `python_requirement` targets.










73














74



        Expects a dictionary of requirements to a dictionary for the










75



        overrides. You may either use a string for a single requirement,










76



        or a string tuple for multiple requirements. Each override is a dictionary of










77



        field names to the overridden value.










78














79



        For example:










80














81



            overrides={










82



                "django": {"dependencies": ["#setuptools"]},










83



                "ansicolors": {"description": "pretty colors"]},










84



                ("ansicolors, "django"): {"tags": ["overridden"]},










85



            }










86














87



        Every overridden requirement is validated to be generated by this target.










88














89



        You can specify the same requirement in multiple keys, so long as you don't










90



        override the same field more than one time for the requirement.










91



        """










92



    )
























    

  • 

    •