aws-lambda-powertools 3.4.2a1__tar.gz → 3.5.1a0__tar.gz

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/PKG-INFO

@@ -1,19 +1,17 @@
-Metadata-Version: 2.1
-Name: aws-lambda-powertools
-Version: 3.4.2a1
+Metadata-Version: 2.3
+Name: aws_lambda_powertools
+Version: 3.5.1a0
 Summary: Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.
-Home-page: https://github.com/aws-powertools/powertools-lambda-python
 License: MIT
 Keywords: aws_lambda_powertools,aws,tracing,logging,lambda,powertools,feature_flags,idempotency,middleware
 Author: Amazon Web Services
-Requires-Python: >=3.8,<4.0.0
+Requires-Python: >=3.9,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: License :: OSI Approved :: MIT No Attribution License (MIT-0)
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/event_handler/api_gateway.py

@@ -2521,7 +2521,7 @@ class Router(BaseRouter):
             frozen_responses = _FrozenDict(responses) if responses else None
             frozen_tags = frozenset(tags) if tags else None
             frozen_security = _FrozenListDict(security) if security else None
-            fronzen_openapi_extensions = _FrozenDict(openapi_extensions) if openapi_extensions else None
+            frozen_openapi_extensions = _FrozenDict(openapi_extensions) if openapi_extensions else None
 
             route_key = (
                 rule,
@@ -2537,7 +2537,7 @@ class Router(BaseRouter):
                 operation_id,
                 include_in_schema,
                 frozen_security,
-                fronzen_openapi_extensions,
+                frozen_openapi_extensions,
                 deprecated,
             )
 

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/event_handler/openapi/dependant.py

@@ -106,7 +106,7 @@ def get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:
     signature = inspect.signature(call)
 
     # Gets the global namespace for the call. This is used to resolve forward references.
-    globalns = getattr(call, "__global__", {})
+    globalns = getattr(call, "__globals__", {})
 
     typed_params = [
         inspect.Parameter(

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/logging/formatter.py

@@ -7,10 +7,11 @@ import os
 import time
 import traceback
 from abc import ABCMeta, abstractmethod
+from contextlib import contextmanager
 from contextvars import ContextVar
 from datetime import datetime, timezone
 from functools import partial
-from typing import TYPE_CHECKING, Any, Callable, Iterable
+from typing import TYPE_CHECKING, Any, Callable, Generator, Iterable
 
 from aws_lambda_powertools.shared import constants
 from aws_lambda_powertools.shared.functions import powertools_dev_is_set
@@ -62,6 +63,10 @@ class BasePowertoolsFormatter(logging.Formatter, metaclass=ABCMeta):
         """Removes any previously added logging keys"""
         raise NotImplementedError()
 
+    @contextmanager
+    def append_context_keys(self, **additional_keys: Any) -> Generator[None, None, None]:
+        yield
+
     # These specific thread-safe methods are necessary to manage shared context in concurrent environments.
     # They prevent race conditions and ensure data consistency across multiple threads.
     def thread_safe_append_keys(self, **additional_keys) -> None:
@@ -263,6 +268,31 @@ class LambdaPowertoolsFormatter(BasePowertoolsFormatter):
         self.log_format = dict.fromkeys(self.log_record_order)
         self.log_format.update(**self.keys_combined)
 
+    @contextmanager
+    def append_context_keys(self, **additional_keys: Any) -> Generator[None, None, None]:
+        """
+        Context manager to temporarily add logging keys.
+
+        Parameters:
+        -----------
+        **keys: Any
+            Key-value pairs to include in the log context during the lifespan of the context manager.
+
+        Example:
+        --------
+        >>> logger = Logger(service="example_service")
+        >>> with logger.append_context_keys(user_id="123", operation="process"):
+        >>>     logger.info("Log with context")
+        >>> logger.info("Log without context")
+        """
+        # Add keys to the context
+        self.append_keys(**additional_keys)
+        try:
+            yield
+        finally:
+            # Remove the keys after exiting the context
+            self.remove_keys(additional_keys.keys())
+
     # These specific thread-safe methods are necessary to manage shared context in concurrent environments.
     # They prevent race conditions and ensure data consistency across multiple threads.
     def thread_safe_append_keys(self, **additional_keys) -> None:

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/logging/logger.py

@@ -7,16 +7,8 @@ import os
 import random
 import sys
 import warnings
-from typing import (
-    IO,
-    TYPE_CHECKING,
-    Any,
-    Callable,
-    Iterable,
-    Mapping,
-    TypeVar,
-    overload,
-)
+from contextlib import contextmanager
+from typing import IO, TYPE_CHECKING, Any, Callable, Generator, Iterable, Mapping, TypeVar, overload
 
 from aws_lambda_powertools.logging.constants import (
     LOGGER_ATTRIBUTE_PRECONFIGURED,
@@ -589,6 +581,26 @@ class Logger:
     def remove_keys(self, keys: Iterable[str]) -> None:
         self.registered_formatter.remove_keys(keys)
 
+    @contextmanager
+    def append_context_keys(self, **additional_keys: Any) -> Generator[None, None, None]:
+        """
+        Context manager to temporarily add logging keys.
+
+        Parameters:
+        -----------
+        **keys: Any
+            Key-value pairs to include in the log context during the lifespan of the context manager.
+
+        Example:
+        --------
+        >>> logger = Logger(service="example_service")
+        >>> with logger.append_context_keys(user_id="123", operation="process"):
+        >>>     logger.info("Log with context")
+        >>> logger.info("Log without context")
+        """
+        with self.registered_formatter.append_context_keys(**additional_keys):
+            yield
+
     # These specific thread-safe methods are necessary to manage shared context in concurrent environments.
     # They prevent race conditions and ensure data consistency across multiple threads.
     def thread_safe_append_keys(self, **additional_keys: object) -> None:

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/shared/version.py

@@ -1,3 +1,3 @@
 """Exposes version constant to avoid circular dependencies."""
 
-VERSION = "3.4.2a1"
+VERSION = "3.5.1a0"

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/data_classes/__init__.py

@@ -45,6 +45,7 @@ from .secrets_manager_event import SecretsManagerEvent
 from .ses_event import SESEvent
 from .sns_event import SNSEvent
 from .sqs_event import SQSEvent
+from .transfer_family_event import TransferFamilyAuthorizer, TransferFamilyAuthorizerResponse
 from .vpc_lattice import VPCLatticeEvent, VPCLatticeEventV2
 
 __all__ = [
@@ -87,4 +88,6 @@ __all__ = [
     "VPCLatticeEvent",
     "VPCLatticeEventV2",
     "CloudFormationCustomResourceEvent",
+    "TransferFamilyAuthorizerResponse",
+    "TransferFamilyAuthorizer",
 ]

aws_lambda_powertools-3.5.1a0/aws_lambda_powertools/utilities/data_classes/transfer_family_event.py

@@ -0,0 +1,190 @@
+from __future__ import annotations
+
+from typing import Any, Literal
+
+from aws_lambda_powertools.utilities.data_classes.common import (
+    DictWrapper,
+)
+
+
+class TransferFamilyAuthorizer(DictWrapper):
+    @property
+    def username(self) -> str:
+        """The username used for authentication"""
+        return self["username"]
+
+    @property
+    def password(self) -> str | None:
+        """
+        The password used for authentication.
+        None in case customer authenticating with certificates
+        """
+        return self["password"]
+
+    @property
+    def protocol(self) -> str:
+        """The protocol can be SFTP, FTP or FTPS"""
+        return self["protocol"]
+
+    @property
+    def server_id(self) -> str:
+        """The AWS Transfer Family ServerID"""
+        return self["serverId"]
+
+    @property
+    def source_ip(self) -> str:
+        """The customer IP used for connection"""
+        return self["sourceIp"]
+
+
+class TransferFamilyAuthorizerResponse:
+
+    def _build_authentication_response(
+        self,
+        role_arn: str,
+        policy: str | None = None,
+        home_directory: str | None = None,
+        home_directory_details: dict | None = None,
+        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
+        user_gid: int | None = None,
+        user_uid: int | None = None,
+        public_keys: str | None = None,
+    ) -> dict[str, Any]:
+
+        response: dict[str, Any] = {}
+
+        if home_directory_type == "PATH":
+            if not home_directory:
+                raise ValueError("home_directory must be set when home_directory_type is PATH")
+
+            response["HomeDirectory"] = home_directory
+        elif home_directory_type == "LOGICAL":
+            if not home_directory_details:
+                raise ValueError("home_directory_details must be set when home_directory_type is LOGICAL")
+
+            response["HomeDirectoryDetails"] = [home_directory_details]
+
+        else:
+            raise ValueError(f"Invalid home_directory_type: {home_directory_type}")
+
+        if user_uid is not None:
+            response["PosixProfile"] = {"Gid": user_gid, "Uid": user_gid}
+
+        if policy:
+            response["Policy"] = policy
+
+        if public_keys:
+            response["PublicKeys"] = public_keys
+
+        response["Role"] = role_arn
+        response["HomeDirectoryType"] = home_directory_type
+
+        return response
+
+    def build_authentication_response_efs(
+        self,
+        role_arn: str,
+        user_gid: int,
+        user_uid: int,
+        policy: str | None = None,
+        home_directory: str | None = None,
+        home_directory_details: dict | None = None,
+        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
+        public_keys: str | None = None,
+    ) -> dict[str, Any]:
+        """
+        Build an authentication response for AWS Transfer Family using EFS (Elastic File System).
+
+        Parameters:
+        -----------
+        role_arn : str
+            The Amazon Resource Name (ARN) of the IAM role.
+        user_gid : int
+            The group ID of the user.
+        user_uid : int
+            The user ID.
+        policy : str | None, optional
+            The IAM policy document. Defaults to None.
+        home_directory : str | None, optional
+            The home directory path. Required if home_directory_type is "PATH". Defaults to None.
+        home_directory_details : dict | None, optional
+            Details of the home directory. Required if home_directory_type is "LOGICAL". Defaults to None.
+        home_directory_type : Literal["LOGICAL", "PATH"], optional
+            The type of home directory. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
+        public_keys : str | None, optional
+            The public keys associated with the user. Defaults to None.
+
+        Returns:
+        --------
+        dict[str, Any]
+            A dictionary containing the authentication response with various details such as
+            role ARN, policy, home directory information, and user details.
+
+        Raises:
+        -------
+        ValueError
+            If an invalid home_directory_type is provided or if required parameters are missing
+            for the specified home_directory_type.
+        """
+
+        return self._build_authentication_response(
+            role_arn=role_arn,
+            policy=policy,
+            home_directory=home_directory,
+            home_directory_details=home_directory_details,
+            home_directory_type=home_directory_type,
+            public_keys=public_keys,
+            user_gid=user_gid,
+            user_uid=user_uid,
+        )
+
+    def build_authentication_response_s3(
+        self,
+        role_arn: str,
+        policy: str | None = None,
+        home_directory: str | None = None,
+        home_directory_details: dict | None = None,
+        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
+        public_keys: str | None = None,
+    ) -> dict[str, Any]:
+        """
+        Build an authentication response for Amazon S3.
+
+        This method constructs an authentication response tailored for S3 access,
+        likely by calling an internal method with the provided parameters.
+
+        Parameters:
+        -----------
+        role_arn : str
+            The Amazon Resource Name (ARN) of the IAM role for S3 access.
+        policy : str | None, optional
+            The IAM policy document for S3 access. Defaults to None.
+        home_directory : str | None, optional
+            The home directory path in S3. Required if home_directory_type is "PATH". Defaults to None.
+        home_directory_details : dict | None, optional
+            Details of the home directory in S3. Required if home_directory_type is "LOGICAL". Defaults to None.
+        home_directory_type : Literal["LOGICAL", "PATH"], optional
+            The type of home directory in S3. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
+        public_keys : str | None, optional
+            The public keys associated with the user for S3 access. Defaults to None.
+
+        Returns:
+        --------
+        dict[str, Any]
+            A dictionary containing the authentication response with various details such as
+            role ARN, policy, home directory information, and potentially other S3-specific attributes.
+
+        Raises:
+        -------
+        ValueError
+            If an invalid home_directory_type is provided or if required parameters are missing
+            for the specified home_directory_type.
+        """
+        return self._build_authentication_response(
+            role_arn=role_arn,
+            policy=policy,
+            home_directory=home_directory,
+            home_directory_details=home_directory_details,
+            home_directory_type=home_directory_type,
+            public_keys=public_keys,
+        )

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/idempotency/base.py

@@ -74,6 +74,7 @@ class IdempotencyHandler:
         config: IdempotencyConfig,
         persistence_store: BasePersistenceLayer,
         output_serializer: BaseIdempotencySerializer | None = None,
+        key_prefix: str | None = None,
         function_args: tuple | None = None,
         function_kwargs: dict | None = None,
     ):
@@ -91,6 +92,8 @@ class IdempotencyHandler:
         output_serializer: BaseIdempotencySerializer | None
             Serializer to transform the data to and from a dictionary.
             If not supplied, no serialization is done via the NoOpSerializer
+        key_prefix: str | Optional
+            Custom prefix for idempotency key: key_prefix#hash
         function_args: tuple | None
             Function arguments
         function_kwargs: dict | None
@@ -102,8 +105,14 @@ class IdempotencyHandler:
         self.fn_args = function_args
         self.fn_kwargs = function_kwargs
         self.config = config
+        self.key_prefix = key_prefix
+
+        persistence_store.configure(
+            config=config,
+            function_name=f"{self.function.__module__}.{self.function.__qualname__}",
+            key_prefix=self.key_prefix,
+        )
 
-        persistence_store.configure(config, f"{self.function.__module__}.{self.function.__qualname__}")
         self.persistence_store = persistence_store
 
     def handle(self) -> Any:

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -40,6 +40,7 @@ def idempotent(
     context: LambdaContext,
     persistence_store: BasePersistenceLayer,
     config: IdempotencyConfig | None = None,
+    key_prefix: str | None = None,
     **kwargs,
 ) -> Any:
     """
@@ -57,6 +58,8 @@ def idempotent(
         Instance of BasePersistenceLayer to store data
     config: IdempotencyConfig
         Configuration
+    key_prefix: str | Optional
+        Custom prefix for idempotency key: key_prefix#hash
 
     Examples
     --------
@@ -94,6 +97,7 @@ def idempotent(
         function_payload=event,
         config=config,
         persistence_store=persistence_store,
+        key_prefix=key_prefix,
         function_args=args,
         function_kwargs=kwargs,
     )
@@ -108,6 +112,7 @@ def idempotent_function(
     persistence_store: BasePersistenceLayer,
     config: IdempotencyConfig | None = None,
     output_serializer: BaseIdempotencySerializer | type[BaseIdempotencyModelSerializer] | None = None,
+    key_prefix: str | None = None,
     **kwargs: Any,
 ) -> Any:
     """
@@ -128,6 +133,8 @@ def idempotent_function(
             If not supplied, no serialization is done via the NoOpSerializer.
             In case a serializer of type inheriting BaseIdempotencyModelSerializer is given,
             the serializer is derived from the function return type.
+    key_prefix: str | Optional
+        Custom prefix for idempotency key: key_prefix#hash
 
     Examples
     --------
@@ -154,6 +161,7 @@ def idempotent_function(
                 persistence_store=persistence_store,
                 config=config,
                 output_serializer=output_serializer,
+                key_prefix=key_prefix,
                 **kwargs,
             ),
         )
@@ -191,6 +199,7 @@ def idempotent_function(
             config=config,
             persistence_store=persistence_store,
             output_serializer=output_serializer,
+            key_prefix=key_prefix,
             function_args=args,
             function_kwargs=kwargs,
         )

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/idempotency/persistence/base.py

@@ -54,7 +54,12 @@ class BasePersistenceLayer(ABC):
         self.use_local_cache = False
         self.hash_function = hashlib.md5
 
-    def configure(self, config: IdempotencyConfig, function_name: str | None = None) -> None:
+    def configure(
+        self,
+        config: IdempotencyConfig,
+        function_name: str | None = None,
+        key_prefix: str | None = None,
+    ) -> None:
         """
         Initialize the base persistence layer from the configuration settings
 
@@ -64,8 +69,12 @@ class BasePersistenceLayer(ABC):
             Idempotency configuration settings
         function_name: str, Optional
             The name of the function being decorated
+        key_prefix: str | Optional
+            Custom prefix for idempotency key: key_prefix#hash
         """
-        self.function_name = f"{os.getenv(constants.LAMBDA_FUNCTION_NAME_ENV, 'test-func')}.{function_name or ''}"
+        self.function_name = (
+            key_prefix or f"{os.getenv(constants.LAMBDA_FUNCTION_NAME_ENV, 'test-func')}.{function_name or ''}"
+        )
 
         if self.configured:
             # Prevent being reconfigured multiple times
@@ -75,9 +84,7 @@ class BasePersistenceLayer(ABC):
         self.event_key_jmespath = config.event_key_jmespath
         if config.event_key_jmespath:
             self.event_key_compiled_jmespath = jmespath.compile(config.event_key_jmespath)
-        self.jmespath_options = config.jmespath_options
-        if not self.jmespath_options:
-            self.jmespath_options = {"custom_functions": PowertoolsFunctions()}
+        self.jmespath_options = config.jmespath_options or {"custom_functions": PowertoolsFunctions()}
         if config.payload_validation_jmespath:
             self.validation_key_jmespath = jmespath.compile(config.payload_validation_jmespath)
             self.payload_validation_enabled = True

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/idempotency/serialization/functions.py

@@ -5,7 +5,7 @@ from typing import Any, Optional, Union, get_args, get_origin
 if sys.version_info >= (3, 10):
     from types import UnionType  # Available in Python 3.10+
 else:
-    UnionType = Union  # Fallback for Python 3.8 and 3.9
+    UnionType = Union  # Fallback for Python 3.9
 
 from aws_lambda_powertools.utilities.idempotency.exceptions import (
     IdempotencyModelTypeError,

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/parser/models/__init__.py

@@ -109,6 +109,7 @@ from .ses import (
 )
 from .sns import SnsModel, SnsNotificationModel, SnsRecordModel
 from .sqs import SqsAttributesModel, SqsModel, SqsMsgAttributeModel, SqsRecordModel
+from .transfer_family import TransferFamilyAuthorizer
 from .vpc_lattice import VpcLatticeModel
 from .vpc_latticev2 import VpcLatticeV2Model
 
@@ -179,6 +180,7 @@ __all__ = [
     "SqsAttributesModel",
     "S3SqsEventNotificationModel",
     "S3SqsEventNotificationRecordModel",
+    "TransferFamilyAuthorizer",
     "APIGatewayProxyEventModel",
     "APIGatewayEventRequestContext",
     "APIGatewayEventAuthorizer",

{aws_lambda_powertools-3.4.2a1 → aws_lambda_powertools-3.5.1a0}/aws_lambda_powertools/utilities/parser/models/apigwv2.py

@@ -72,4 +72,4 @@ class APIGatewayProxyEventV2Model(BaseModel):
 class ApiGatewayAuthorizerRequestV2(APIGatewayProxyEventV2Model):
     type: Literal["REQUEST"]
     routeArn: str
-    identitySource: List[str]
+    identitySource: Optional[List[str]] = None

aws_lambda_powertools-3.5.1a0/aws_lambda_powertools/utilities/parser/models/transfer_family.py

@@ -0,0 +1,12 @@
+from typing import Literal, Optional
+
+from pydantic import BaseModel, Field
+from pydantic.networks import IPvAnyAddress
+
+
+class TransferFamilyAuthorizer(BaseModel):
+    username: str
+    password: Optional[str] = None
+    protocol: Literal["SFTP", "FTP", "FTPS"]
+    server_id: str = Field(..., alias="serverId")
+    source_ip: IPvAnyAddress = Field(..., alias="sourceIp")