22740642519

Committed 05 Mar 2026 11:00PM UTC coverage: 52.677% (-40.3%) from 92.931%

Build # 22740642519

Build Type

Pull #23157

github

Committed by

web-flow

Commit Message

Merge 2aa18e6d4 into f0030f5e7

Pull Request Pull Request #23157: [pants ng] Partition source files by config.

Run Details

31678 of 60136 relevant lines covered (52.68%)

0.53 hits per line

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

0.0

/src/python/pants/backend/awslambda/python/target_types.py

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

from __future__ import annotations

import re
from dataclasses import dataclass
from enum import Enum
from re import Match
from typing import ClassVar, cast

from pants.backend.python.target_types import PexCompletePlatformsField, PythonResolveField
from pants.backend.python.util_rules.faas import (
    FaaSArchitecture,
    PythonFaaSCompletePlatforms,
    PythonFaaSDependencies,
    PythonFaaSHandlerField,
    PythonFaaSKnownRuntime,
    PythonFaaSLayoutField,
    PythonFaaSPex3VenvCreateExtraArgsField,
    PythonFaaSPexBuildExtraArgs,
    PythonFaaSRuntimeField,
)
from pants.backend.python.util_rules.faas import rules as faas_rules
from pants.core.environments.target_types import EnvironmentField
from pants.core.goals.package import OutputPathField
from pants.engine.addresses import Address
from pants.engine.rules import collect_rules
from pants.engine.target import (
    COMMON_TARGET_FIELDS,
    BoolField,
    Field,
    InvalidFieldException,
    StringField,
    Target,
)
from pants.util.docutil import doc_url
from pants.util.strutil import help_text, softwrap


class PythonAwsLambdaHandlerField(PythonFaaSHandlerField):
    # This doesn't matter (just needs to be fixed), but is the default name used by the AWS
    # console when creating a Python lambda, so is as good as any
    # https://docs.aws.amazon.com/lambda/latest/dg/python-handler.html
    reexported_handler_module = "lambda_function"

    help = help_text(
        f"""
        Entry point to the AWS Lambda handler.

        {PythonFaaSHandlerField.help}

        This is re-exported at `{reexported_handler_module}.handler` in the resulting package to be
        used as the configured handler of the Lambda in AWS. It can also be accessed under its
        source-root-relative module path, for example: `path.to.module.handler_func`.
        """
    )


@dataclass(frozen=True)
class ResolvedPythonAwsHandler:
    val: str
    file_name_used: bool


@dataclass(frozen=True)
class ResolvePythonAwsHandlerRequest:
    field: PythonAwsLambdaHandlerField


class PythonAwsLambdaIncludeRequirements(BoolField):
    alias = "include_requirements"
    default = True
    help = help_text(
        """
        Whether to resolve requirements and include them in the AWS Lambda artifact. This is most useful with Lambda
        Layers to make code uploads smaller when third-party requirements are in layers.
        https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
        """
    )


class PythonAwsLambdaIncludeSources(BoolField):
    alias = "include_sources"
    default = True
    help = help_text(
        """
        Whether to resolve first party sources and include them in the AWS Lambda artifact. This is
        most useful to allow creating a Lambda Layer with only third-party requirements.
        https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
        """
    )


PYTHON_RUNTIME_REGEX = r"python(?P<major>\d)\.(?P<minor>\d+)"


class PythonAwsLambdaFunctionRuntimes(Enum):
    PYTHON_36 = "python3.6"
    PYTHON_37 = "python3.7"
    PYTHON_38 = "python3.8"
    PYTHON_39 = "python3.9"
    PYTHON_310 = "python3.10"
    PYTHON_311 = "python3.11"
    PYTHON_312 = "python3.12"
    PYTHON_313 = "python3.13"
    PYTHON_314 = "python3.14"

    def to_interpreter_version(self) -> tuple[int, int]:
        """Returns the Python version implied by the runtime, as (major, minor)."""
        mo = cast(Match, re.match(PYTHON_RUNTIME_REGEX, self.value))
        return int(mo.group("major")), int(mo.group("minor"))


LAMBDA_DOCKER_REPO = "public.ecr.aws/lambda/python"


class PythonAwsLambdaRuntime(PythonFaaSRuntimeField):
    # https://gallery.ecr.aws/lambda/python
    RUNTIME_TAG_MAPPING = {
        (PythonAwsLambdaFunctionRuntimes.PYTHON_36, FaaSArchitecture.X86_64): "3.6",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_37, FaaSArchitecture.X86_64): "3.7",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_38, FaaSArchitecture.X86_64): "3.8-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_38, FaaSArchitecture.ARM64): "3.8-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_39, FaaSArchitecture.X86_64): "3.9-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_39, FaaSArchitecture.ARM64): "3.9-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_310, FaaSArchitecture.X86_64): "3.10-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_310, FaaSArchitecture.ARM64): "3.10-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_311, FaaSArchitecture.X86_64): "3.11-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_311, FaaSArchitecture.ARM64): "3.11-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_312, FaaSArchitecture.X86_64): "3.12-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_312, FaaSArchitecture.ARM64): "3.12-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_313, FaaSArchitecture.X86_64): "3.13-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_313, FaaSArchitecture.ARM64): "3.13-arm64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_314, FaaSArchitecture.X86_64): "3.14-x86_64",
        (PythonAwsLambdaFunctionRuntimes.PYTHON_314, FaaSArchitecture.ARM64): "3.14-arm64",
    }

    help = help_text(
        """
        The identifier of the AWS Lambda runtime to target (pythonX.Y).
        See https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html.

        N.B.: only one of this and `complete_platforms` can be set. If `runtime` is set, a default complete
        platform is chosen, if one is known for that runtime. If you have issues either
        packaging the AWS Lambda PEX or running it as a deployed AWS Lambda function, you should try
        using an explicit `complete_platforms` instead.
        """
    )

    valid_choices = PythonAwsLambdaFunctionRuntimes
    known_runtimes = tuple(
        PythonFaaSKnownRuntime(
            runtime.value, *runtime.to_interpreter_version(), LAMBDA_DOCKER_REPO, tag, architecture
        )
        for (runtime, architecture), tag in RUNTIME_TAG_MAPPING.items()
    )

    @classmethod
    def compute_value(cls, raw_value: str | None, address: Address) -> str | None:
        value = super().compute_value(raw_value, address)
        if value is None:
            return None
        if not re.match(PYTHON_RUNTIME_REGEX, value):
            raise InvalidFieldException(
                softwrap(
                    f"""
                    The `{cls.alias}` field in target at {address} must be of the form pythonX.Y,
                    but was {value}.
                    """
                )
            )
        return value

    def to_interpreter_version(self) -> tuple[int, int] | None:
        """Returns the Python version implied by the runtime, as (major, minor)."""
        if self.value is None:
            return None
        mo = cast(Match, re.match(PYTHON_RUNTIME_REGEX, self.value))
        return int(mo.group("major")), int(mo.group("minor"))

    @classmethod
    def from_interpreter_version(cls, py_major: int, py_minor: int) -> str:
        return f"python{py_major}.{py_minor}"


class AWSLambdaArchitectureField(StringField):
    alias = "architecture"
    valid_choices = FaaSArchitecture
    expected_type = str
    default = FaaSArchitecture.X86_64.value
    help = help_text(
        """
        The architecture of the AWS Lambda runtime to target (x86_64 or arm64).
        See https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html.
        """
    )


class PythonAwsLambdaLayerDependenciesField(PythonFaaSDependencies):
    required = True


class _AWSLambdaBaseTarget(Target):
    core_fields: ClassVar[tuple[type[Field], ...]] = (
        *COMMON_TARGET_FIELDS,
        OutputPathField,
        PythonAwsLambdaIncludeRequirements,
        PythonAwsLambdaRuntime,
        PythonFaaSCompletePlatforms,
        PythonFaaSPex3VenvCreateExtraArgsField,
        PythonFaaSPexBuildExtraArgs,
        PythonFaaSLayoutField,
        PythonResolveField,
        EnvironmentField,
    )

    def validate(self) -> None:
        has_runtime = self[PythonAwsLambdaRuntime].value is not None
        has_complete_platforms = self[PexCompletePlatformsField].value is not None

        runtime_alias = self[PythonAwsLambdaRuntime].alias
        complete_platforms_alias = self[PexCompletePlatformsField].alias

        if has_runtime and has_complete_platforms:
            raise ValueError(
                softwrap(
                    f"""
                    The `{complete_platforms_alias}` takes precedence over the `{runtime_alias}` field, if
                    it is set. Remove the `{runtime_alias}` field to only use the `{complete_platforms_alias}`
                    value, or remove the `{complete_platforms_alias}` field to use the default platform
                    implied by `{runtime_alias}`.
                    """
                )
            )


class PythonAWSLambda(_AWSLambdaBaseTarget):
    alias = "python_aws_lambda_function"

    core_fields = (
        *_AWSLambdaBaseTarget.core_fields,
        PythonFaaSDependencies,
        PythonAwsLambdaHandlerField,
        AWSLambdaArchitectureField,
    )
    help = help_text(
        f"""
        A self-contained Python function suitable for uploading to AWS Lambda.

        See {doc_url("docs/python/integrations/aws-lambda")}.
        """
    )


class PythonAWSLambdaLayer(_AWSLambdaBaseTarget):
    alias = "python_aws_lambda_layer"
    core_fields = (
        *_AWSLambdaBaseTarget.core_fields,
        PythonAwsLambdaIncludeSources,
        PythonAwsLambdaLayerDependenciesField,
        AWSLambdaArchitectureField,
    )
    help = help_text(
        f"""
        A Python layer suitable for uploading to AWS Lambda.

        See {doc_url("docs/python/integrations/aws-lambda")}.
        """
    )


def rules():
    return (
        *collect_rules(),
        *faas_rules(),
    )

1	# Copyright 2020 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	import re	×
7	from dataclasses import dataclass	×
8	from enum import Enum	×
9	from re import Match	×
10	from typing import ClassVar, cast	×
11
12	from pants.backend.python.target_types import PexCompletePlatformsField, PythonResolveField	×
13	from pants.backend.python.util_rules.faas import (	×
14	FaaSArchitecture,
15	PythonFaaSCompletePlatforms,
16	PythonFaaSDependencies,
17	PythonFaaSHandlerField,
18	PythonFaaSKnownRuntime,
19	PythonFaaSLayoutField,
20	PythonFaaSPex3VenvCreateExtraArgsField,
21	PythonFaaSPexBuildExtraArgs,
22	PythonFaaSRuntimeField,
23	)
24	from pants.backend.python.util_rules.faas import rules as faas_rules	×
25	from pants.core.environments.target_types import EnvironmentField	×
26	from pants.core.goals.package import OutputPathField	×
27	from pants.engine.addresses import Address	×
28	from pants.engine.rules import collect_rules	×
29	from pants.engine.target import (	×
30	COMMON_TARGET_FIELDS,
31	BoolField,
32	Field,
33	InvalidFieldException,
34	StringField,
35	Target,
36	)
37	from pants.util.docutil import doc_url	×
38	from pants.util.strutil import help_text, softwrap	×
39
40
41	class PythonAwsLambdaHandlerField(PythonFaaSHandlerField):	×
42	# This doesn't matter (just needs to be fixed), but is the default name used by the AWS
43	# console when creating a Python lambda, so is as good as any
44	# https://docs.aws.amazon.com/lambda/latest/dg/python-handler.html
45	reexported_handler_module = "lambda_function"	×
46
47	help = help_text(	×
48	f"""
49	Entry point to the AWS Lambda handler.
50
51	{PythonFaaSHandlerField.help}
52
53	This is re-exported at `{reexported_handler_module}.handler` in the resulting package to be
54	used as the configured handler of the Lambda in AWS. It can also be accessed under its
55	source-root-relative module path, for example: `path.to.module.handler_func`.
56	"""
57	)
58
59
60	@dataclass(frozen=True)	×
61	class ResolvedPythonAwsHandler:	×
62	val: str	×
63	file_name_used: bool	×
64
65
66	@dataclass(frozen=True)	×
67	class ResolvePythonAwsHandlerRequest:	×
68	field: PythonAwsLambdaHandlerField	×
69
70
71	class PythonAwsLambdaIncludeRequirements(BoolField):	×
72	alias = "include_requirements"	×
73	default = True	×
74	help = help_text(	×
75	"""
76	Whether to resolve requirements and include them in the AWS Lambda artifact. This is most useful with Lambda
77	Layers to make code uploads smaller when third-party requirements are in layers.
78	https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
79	"""
80	)
81
82
83	class PythonAwsLambdaIncludeSources(BoolField):	×
84	alias = "include_sources"	×
85	default = True	×
86	help = help_text(	×
87	"""
88	Whether to resolve first party sources and include them in the AWS Lambda artifact. This is
89	most useful to allow creating a Lambda Layer with only third-party requirements.
90	https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
91	"""
92	)
93
94
95	PYTHON_RUNTIME_REGEX = r"python(?P<major>\d)\.(?P<minor>\d+)"	×
96
97
98	class PythonAwsLambdaFunctionRuntimes(Enum):	×
99	PYTHON_36 = "python3.6"	×
100	PYTHON_37 = "python3.7"	×
101	PYTHON_38 = "python3.8"	×
102	PYTHON_39 = "python3.9"	×
103	PYTHON_310 = "python3.10"	×
104	PYTHON_311 = "python3.11"	×
105	PYTHON_312 = "python3.12"	×
106	PYTHON_313 = "python3.13"	×
107	PYTHON_314 = "python3.14"	×
108
109	def to_interpreter_version(self) -> tuple[int, int]:	×
110	"""Returns the Python version implied by the runtime, as (major, minor)."""
111	mo = cast(Match, re.match(PYTHON_RUNTIME_REGEX, self.value))	×
112	return int(mo.group("major")), int(mo.group("minor"))	×
113
114
115	LAMBDA_DOCKER_REPO = "public.ecr.aws/lambda/python"	×
116
117
118	class PythonAwsLambdaRuntime(PythonFaaSRuntimeField):	×
119	# https://gallery.ecr.aws/lambda/python
120	RUNTIME_TAG_MAPPING = {	×
121	(PythonAwsLambdaFunctionRuntimes.PYTHON_36, FaaSArchitecture.X86_64): "3.6",
122	(PythonAwsLambdaFunctionRuntimes.PYTHON_37, FaaSArchitecture.X86_64): "3.7",
123	(PythonAwsLambdaFunctionRuntimes.PYTHON_38, FaaSArchitecture.X86_64): "3.8-x86_64",
124	(PythonAwsLambdaFunctionRuntimes.PYTHON_38, FaaSArchitecture.ARM64): "3.8-arm64",
125	(PythonAwsLambdaFunctionRuntimes.PYTHON_39, FaaSArchitecture.X86_64): "3.9-x86_64",
126	(PythonAwsLambdaFunctionRuntimes.PYTHON_39, FaaSArchitecture.ARM64): "3.9-arm64",
127	(PythonAwsLambdaFunctionRuntimes.PYTHON_310, FaaSArchitecture.X86_64): "3.10-x86_64",
128	(PythonAwsLambdaFunctionRuntimes.PYTHON_310, FaaSArchitecture.ARM64): "3.10-arm64",
129	(PythonAwsLambdaFunctionRuntimes.PYTHON_311, FaaSArchitecture.X86_64): "3.11-x86_64",
130	(PythonAwsLambdaFunctionRuntimes.PYTHON_311, FaaSArchitecture.ARM64): "3.11-arm64",
131	(PythonAwsLambdaFunctionRuntimes.PYTHON_312, FaaSArchitecture.X86_64): "3.12-x86_64",
132	(PythonAwsLambdaFunctionRuntimes.PYTHON_312, FaaSArchitecture.ARM64): "3.12-arm64",
133	(PythonAwsLambdaFunctionRuntimes.PYTHON_313, FaaSArchitecture.X86_64): "3.13-x86_64",
134	(PythonAwsLambdaFunctionRuntimes.PYTHON_313, FaaSArchitecture.ARM64): "3.13-arm64",
135	(PythonAwsLambdaFunctionRuntimes.PYTHON_314, FaaSArchitecture.X86_64): "3.14-x86_64",
136	(PythonAwsLambdaFunctionRuntimes.PYTHON_314, FaaSArchitecture.ARM64): "3.14-arm64",
137	}
138
139	help = help_text(	×
140	"""
141	The identifier of the AWS Lambda runtime to target (pythonX.Y).
142	See https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html.
143
144	N.B.: only one of this and `complete_platforms` can be set. If `runtime` is set, a default complete
145	platform is chosen, if one is known for that runtime. If you have issues either
146	packaging the AWS Lambda PEX or running it as a deployed AWS Lambda function, you should try
147	using an explicit `complete_platforms` instead.
148	"""
149	)
150
151	valid_choices = PythonAwsLambdaFunctionRuntimes	×
152	known_runtimes = tuple(	×
153	PythonFaaSKnownRuntime(
154	runtime.value, *runtime.to_interpreter_version(), LAMBDA_DOCKER_REPO, tag, architecture
155	)
156	for (runtime, architecture), tag in RUNTIME_TAG_MAPPING.items()
157	)
158
159	@classmethod	×
160	def compute_value(cls, raw_value: str \| None, address: Address) -> str \| None:	×
161	value = super().compute_value(raw_value, address)	×
162	if value is None:	×
163	return None	×
164	if not re.match(PYTHON_RUNTIME_REGEX, value):	×
165	raise InvalidFieldException(	×
166	softwrap(
167	f"""
168	The `{cls.alias}` field in target at {address} must be of the form pythonX.Y,
169	but was {value}.
170	"""
171	)
172	)
173	return value	×
174
175	def to_interpreter_version(self) -> tuple[int, int] \| None:	×
176	"""Returns the Python version implied by the runtime, as (major, minor)."""
177	if self.value is None:	×
178	return None	×
179	mo = cast(Match, re.match(PYTHON_RUNTIME_REGEX, self.value))	×
180	return int(mo.group("major")), int(mo.group("minor"))	×
181
182	@classmethod	×
183	def from_interpreter_version(cls, py_major: int, py_minor: int) -> str:	×
184	return f"python{py_major}.{py_minor}"	×
185
186
187	class AWSLambdaArchitectureField(StringField):	×
188	alias = "architecture"	×
189	valid_choices = FaaSArchitecture	×
190	expected_type = str	×
191	default = FaaSArchitecture.X86_64.value	×
192	help = help_text(	×
193	"""
194	The architecture of the AWS Lambda runtime to target (x86_64 or arm64).
195	See https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html.
196	"""
197	)
198
199
200	class PythonAwsLambdaLayerDependenciesField(PythonFaaSDependencies):	×
201	required = True	×
202
203
204	class _AWSLambdaBaseTarget(Target):	×
205	core_fields: ClassVar[tuple[type[Field], ...]] = (	×
206	*COMMON_TARGET_FIELDS,
207	OutputPathField,
208	PythonAwsLambdaIncludeRequirements,
209	PythonAwsLambdaRuntime,
210	PythonFaaSCompletePlatforms,
211	PythonFaaSPex3VenvCreateExtraArgsField,
212	PythonFaaSPexBuildExtraArgs,
213	PythonFaaSLayoutField,
214	PythonResolveField,
215	EnvironmentField,
216	)
217
218	def validate(self) -> None:	×
219	has_runtime = self[PythonAwsLambdaRuntime].value is not None	×
220	has_complete_platforms = self[PexCompletePlatformsField].value is not None	×
221
222	runtime_alias = self[PythonAwsLambdaRuntime].alias	×
223	complete_platforms_alias = self[PexCompletePlatformsField].alias	×
224
225	if has_runtime and has_complete_platforms:	×
226	raise ValueError(	×
227	softwrap(
228	f"""
229	The `{complete_platforms_alias}` takes precedence over the `{runtime_alias}` field, if
230	it is set. Remove the `{runtime_alias}` field to only use the `{complete_platforms_alias}`
231	value, or remove the `{complete_platforms_alias}` field to use the default platform
232	implied by `{runtime_alias}`.
233	"""
234	)
235	)
236
237
238	class PythonAWSLambda(_AWSLambdaBaseTarget):	×
239	alias = "python_aws_lambda_function"	×
240
241	core_fields = (	×
242	*_AWSLambdaBaseTarget.core_fields,
243	PythonFaaSDependencies,
244	PythonAwsLambdaHandlerField,
245	AWSLambdaArchitectureField,
246	)
247	help = help_text(	×
248	f"""
249	A self-contained Python function suitable for uploading to AWS Lambda.
250
251	See {doc_url("docs/python/integrations/aws-lambda")}.
252	"""
253	)
254
255
256	class PythonAWSLambdaLayer(_AWSLambdaBaseTarget):	×
257	alias = "python_aws_lambda_layer"	×
258	core_fields = (	×
259	*_AWSLambdaBaseTarget.core_fields,
260	PythonAwsLambdaIncludeSources,
261	PythonAwsLambdaLayerDependenciesField,
262	AWSLambdaArchitectureField,
263	)
264	help = help_text(	×
265	f"""
266	A Python layer suitable for uploading to AWS Lambda.
267
268	See {doc_url("docs/python/integrations/aws-lambda")}.
269	"""
270	)
271
272
273	def rules():	×
274	return (	×
275	*collect_rules(),
276	*faas_rules(),
277	)

pantsbuild / pants / 22740642519

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