26380816428

Committed 25 May 2026 02:57AM UTC coverage: 52.312% (-40.6%) from 92.89%

Build # 26380816428

Build Type

Pull #23368

github

Committed by

web-flow

Commit Message

Merge 7410b48e1 into 7b1060c81

Pull Request Pull Request #23368: Run Linux ARM CI on Depot runners (Cherry-pick of #23363)

Coverage Stats

31807 of 60802 relevant lines covered (52.31%)

1.05 hits per line

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

0.0

/src/python/pants/backend/python/subsystems/twine.py

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

from __future__ import annotations

from pants.backend.python.subsystems.python_tool_base import PythonToolBase
from pants.backend.python.target_types import ConsoleScript
from pants.core.goals.resolves import ExportableTool
from pants.core.util_rules.config_files import ConfigFilesRequest
from pants.engine.fs import CreateDigest
from pants.engine.rules import collect_rules
from pants.engine.unions import UnionRule
from pants.option.global_options import ca_certs_path_to_file_content
from pants.option.option_types import ArgsListOption, BoolOption, FileOption, SkipOption, StrOption
from pants.util.docutil import doc_url
from pants.util.strutil import softwrap

# pants: infer-dep(twine.lock*)


class TwineSubsystem(PythonToolBase):
    options_scope = "twine"
    name = "Twine"
    help_short = (
        "The utility for publishing Python distributions to PyPI and other Python repositories."
    )

    default_version = "twine>=4,<5"
    default_main = ConsoleScript("twine")

    default_requirements = [
        "twine>=3.7.1,<5",
        # This explicit dependency resolves a weird behavior in poetry, where it would include a
        # sys platform constraint on "Windows" when this was included transitively from the twine
        # requirements.
        # See: https://github.com/pantsbuild/pants/pull/13594#issuecomment-968154931
        "colorama>=0.4.3",
        # Remove this constraint once on twine > 5. See:
        # https://github.com/pypa/twine/issues/977
        # https://github.com/pypa/twine/issues/1125
        "importlib-metadata<8",
    ]

    register_interpreter_constraints = True

    default_lockfile_resource = ("pants.backend.python.subsystems", "twine.lock")

    skip = SkipOption("publish")
    args = ArgsListOption(example="--skip-existing")
    config = FileOption(
        default=None,
        advanced=True,
        help=lambda cls: softwrap(
            f"""
            Path to a .pypirc config file to use.
            (https://packaging.python.org/specifications/pypirc/)

            Setting this option will disable `[{cls.options_scope}].config_discovery`. Use
            this option if the config is located in a non-standard location.
            """
        ),
    )
    config_discovery = BoolOption(
        default=True,
        advanced=True,
        help=lambda cls: softwrap(
            f"""
            If true, Pants will include all relevant config files during runs (`.pypirc`).

            Use `[{cls.options_scope}].config` instead if your config is in a non-standard location.
            """
        ),
    )

    ca_certs_path = StrOption(
        advanced=True,
        default="<inherit>",
        help=softwrap(
            f"""
            Path to a file containing PEM-format CA certificates used for verifying secure
            connections when publishing python distributions.

            Uses the value from `[GLOBAL].ca_certs_path` by default. Set to `"<none>"` to
            not use any certificates.

            Even when using the `docker_environment` and `remote_environment` targets, this path
            will be read from the local host, and those certs will be used in the environment.

            This option cannot be overridden via environment targets, so if you need a different
            value than what the rest of your organization is using, override the value via an
            environment variable, CLI argument, or `.pants.rc` file. See {doc_url("docs/using-pants/key-concepts/options")}.
            """
        ),
    )

    def config_request(self) -> ConfigFilesRequest:
        # Refer to https://twine.readthedocs.io/en/latest/#configuration for how config files are
        # discovered.
        return ConfigFilesRequest(
            specified=self.config,
            specified_option_name=f"[{self.options_scope}].config",
            discovery=self.config_discovery,
            check_existence=[".pypirc"],
        )

    def ca_certs_digest_request(self, default_ca_certs_path: str | None) -> CreateDigest | None:
        path = default_ca_certs_path if self.ca_certs_path == "<inherit>" else self.ca_certs_path
        if not path or path == "<none>":
            return None
        return CreateDigest((ca_certs_path_to_file_content(path),))


def rules():
    return [
        *collect_rules(),
        UnionRule(ExportableTool, TwineSubsystem),
    ]

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	×
5
6	from pants.backend.python.subsystems.python_tool_base import PythonToolBase	×
7	from pants.backend.python.target_types import ConsoleScript	×
8	from pants.core.goals.resolves import ExportableTool	×
9	from pants.core.util_rules.config_files import ConfigFilesRequest	×
10	from pants.engine.fs import CreateDigest	×
11	from pants.engine.rules import collect_rules	×
12	from pants.engine.unions import UnionRule	×
13	from pants.option.global_options import ca_certs_path_to_file_content	×
14	from pants.option.option_types import ArgsListOption, BoolOption, FileOption, SkipOption, StrOption	×
15	from pants.util.docutil import doc_url	×
16	from pants.util.strutil import softwrap	×
17
18	# pants: infer-dep(twine.lock*)
19
20
21	class TwineSubsystem(PythonToolBase):	×
22	options_scope = "twine"	×
23	name = "Twine"	×
24	help_short = (	×
25	"The utility for publishing Python distributions to PyPI and other Python repositories."
26	)
27
28	default_version = "twine>=4,<5"	×
29	default_main = ConsoleScript("twine")	×
30
31	default_requirements = [	×
32	"twine>=3.7.1,<5",
33	# This explicit dependency resolves a weird behavior in poetry, where it would include a
34	# sys platform constraint on "Windows" when this was included transitively from the twine
35	# requirements.
36	# See: https://github.com/pantsbuild/pants/pull/13594#issuecomment-968154931
37	"colorama>=0.4.3",
38	# Remove this constraint once on twine > 5. See:
39	# https://github.com/pypa/twine/issues/977
40	# https://github.com/pypa/twine/issues/1125
41	"importlib-metadata<8",
42	]
43
44	register_interpreter_constraints = True	×
45
46	default_lockfile_resource = ("pants.backend.python.subsystems", "twine.lock")	×
47
48	skip = SkipOption("publish")	×
49	args = ArgsListOption(example="--skip-existing")	×
50	config = FileOption(	×
51	default=None,
52	advanced=True,
53	help=lambda cls: softwrap(
54	f"""
55	Path to a .pypirc config file to use.
56	(https://packaging.python.org/specifications/pypirc/)
57
58	Setting this option will disable `[{cls.options_scope}].config_discovery`. Use
59	this option if the config is located in a non-standard location.
60	"""
61	),
62	)
63	config_discovery = BoolOption(	×
64	default=True,
65	advanced=True,
66	help=lambda cls: softwrap(
67	f"""
68	If true, Pants will include all relevant config files during runs (`.pypirc`).
69
70	Use `[{cls.options_scope}].config` instead if your config is in a non-standard location.
71	"""
72	),
73	)
74
75	ca_certs_path = StrOption(	×
76	advanced=True,
77	default="<inherit>",
78	help=softwrap(
79	f"""
80	Path to a file containing PEM-format CA certificates used for verifying secure
81	connections when publishing python distributions.
82
83	Uses the value from `[GLOBAL].ca_certs_path` by default. Set to `"<none>"` to
84	not use any certificates.
85
86	Even when using the `docker_environment` and `remote_environment` targets, this path
87	will be read from the local host, and those certs will be used in the environment.
88
89	This option cannot be overridden via environment targets, so if you need a different
90	value than what the rest of your organization is using, override the value via an
91	environment variable, CLI argument, or `.pants.rc` file. See {doc_url("docs/using-pants/key-concepts/options")}.
92	"""
93	),
94	)
95
96	def config_request(self) -> ConfigFilesRequest:	×
97	# Refer to https://twine.readthedocs.io/en/latest/#configuration for how config files are
98	# discovered.
99	return ConfigFilesRequest(	×
100	specified=self.config,
101	specified_option_name=f"[{self.options_scope}].config",
102	discovery=self.config_discovery,
103	check_existence=[".pypirc"],
104	)
105
106	def ca_certs_digest_request(self, default_ca_certs_path: str \| None) -> CreateDigest \| None:	×
107	path = default_ca_certs_path if self.ca_certs_path == "<inherit>" else self.ca_certs_path	×
108	if not path or path == "<none>":	×
109	return None	×
110	return CreateDigest((ca_certs_path_to_file_content(path),))	×
111
112
113	def rules():	×
114	return [	×
115	*collect_rules(),
116	UnionRule(ExportableTool, TwineSubsystem),
117	]

pantsbuild / pants / 26380816428

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