aws-lambda-powertools 3.5.1a3__tar.gz → 3.5.1a5__tar.gz

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: aws_lambda_powertools
-Version: 3.5.1a3
+Version: 3.5.1a5
 Summary: Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.
 License: MIT
 Keywords: aws_lambda_powertools,aws,tracing,logging,lambda,powertools,feature_flags,idempotency,middleware

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/api_gateway.py

@@ -313,10 +313,10 @@ class Route:
         middlewares: list[Callable[..., Response]] | None = None,
     ):
         """
+        Internally used Route Configuration
 
         Parameters
         ----------
-
         method: str
             The HTTP method, example "GET"
         path: str
@@ -908,6 +908,8 @@ class ResponseBuilder(Generic[ResponseEventT]):
 
 
 class BaseRouter(ABC):
+    """Base class for Routing"""
+
     current_event: BaseProxyEvent
     lambda_context: LambdaContext
     context: dict
@@ -1459,7 +1461,7 @@ def _registered_api_adapter(app: ApiGatewayResolver, next_middleware: Callable[.
 
 
 class ApiGatewayResolver(BaseRouter):
-    """API Gateway and ALB proxy resolver
+    """API Gateway, VPC Laticce, Bedrock and ALB proxy resolver
 
     Examples
     --------
@@ -2570,6 +2572,8 @@ class Router(BaseRouter):
 
 
 class APIGatewayRestResolver(ApiGatewayResolver):
+    """Amazon API Gateway REST and HTTP API v1 payload resolver"""
+
     current_event: APIGatewayProxyEvent
 
     def __init__(
@@ -2650,6 +2654,8 @@ class APIGatewayRestResolver(ApiGatewayResolver):
 
 
 class APIGatewayHttpResolver(ApiGatewayResolver):
+    """Amazon API Gateway HTTP API v2 payload resolver"""
+
     current_event: APIGatewayProxyEventV2
 
     def __init__(
@@ -2685,6 +2691,8 @@ class APIGatewayHttpResolver(ApiGatewayResolver):
 
 
 class ALBResolver(ApiGatewayResolver):
+    """Amazon Application Load Balancer (ALB) resolver"""
+
     current_event: ALBEvent
 
     def __init__(

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/middlewares/base.py

@@ -26,7 +26,7 @@ class BaseMiddlewareHandler(Generic[EventHandlerInstance], ABC):
     This is the middleware handler function where middleware logic is implemented.
     The next middleware handler is represented by `next_middleware`, returning a Response object.
 
-    Examples
+    Example
     --------
 
     **Correlation ID Middleware**

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/middlewares/openapi_validation.py

@@ -37,7 +37,7 @@ class OpenAPIValidationMiddleware(BaseMiddlewareHandler):
     Lambda handler. It also validates the response against the OpenAPI schema defined by the Lambda handler. It
     should not be used directly, but rather through the `enable_validation` parameter of the `ApiGatewayResolver`.
 
-    Examples
+    Example
     --------
 
     ```python

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/middlewares/schema_validation.py

@@ -18,7 +18,7 @@ logger = logging.getLogger(__name__)
 class SchemaValidationMiddleware(BaseMiddlewareHandler):
     """Middleware to validate API request and response against JSON Schema using the [Validation utility](https://docs.powertools.aws.dev/lambda/python/latest/utilities/validation/).
 
-    Examples
+    Example
     --------
     **Validating incoming event**
 

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/openapi/params.py

@@ -879,8 +879,6 @@ def get_flat_dependant(
     ----------
     dependant: Dependant
         The dependant model to flatten
-    skip_repeats: bool
-        If True, child Dependents already visited will be skipped to avoid duplicates
     visited: list[CacheKey], optional
         Keeps track of visited Dependents to avoid infinite recursion. Defaults to empty list.
 
@@ -932,7 +930,12 @@ def analyze_param(
     ModelField | None
         The type annotation and the Pydantic field representing the parameter
     """
-    field_info, type_annotation = get_field_info_and_type_annotation(annotation, value, is_path_param)
+    field_info, type_annotation = get_field_info_and_type_annotation(
+        annotation,
+        value,
+        is_path_param,
+        is_response_param,
+    )
 
     # If the value is a FieldInfo, we use it as the FieldInfo for the parameter
     if isinstance(value, FieldInfo):
@@ -962,7 +965,12 @@ def analyze_param(
     return field
 
 
-def get_field_info_and_type_annotation(annotation, value, is_path_param: bool) -> tuple[FieldInfo | None, Any]:
+def get_field_info_and_type_annotation(
+    annotation,
+    value,
+    is_path_param: bool,
+    is_response_param: bool,
+) -> tuple[FieldInfo | None, Any]:
     """
     Get the FieldInfo and type annotation from an annotation and value.
     """
@@ -976,6 +984,10 @@ def get_field_info_and_type_annotation(annotation, value, is_path_param: bool) -
         # If the annotation is a Response type, we recursively call this function with the inner type
         elif get_origin(annotation) is Response:
             field_info, type_annotation = get_field_info_response_type(annotation, value)
+        # If the response param is a tuple with two elements, we use the first element as the type annotation,
+        # just like we did in the APIGateway._to_response
+        elif is_response_param and get_origin(annotation) is tuple and len(get_args(annotation)) == 2:
+            field_info, type_annotation = get_field_info_tuple_type(annotation, value)
         # If the annotation is not an Annotated type, we use it as the type annotation
         else:
             type_annotation = annotation
@@ -983,12 +995,22 @@ def get_field_info_and_type_annotation(annotation, value, is_path_param: bool) -
     return field_info, type_annotation
 
 
+def get_field_info_tuple_type(annotation, value) -> tuple[FieldInfo | None, Any]:
+    (inner_type, _) = get_args(annotation)
+
+    # If the inner type is an Annotated type, we need to extract the type annotation and the FieldInfo
+    if get_origin(inner_type) is Annotated:
+        return get_field_info_annotated_type(inner_type, value, False)
+
+    return None, inner_type
+
+
 def get_field_info_response_type(annotation, value) -> tuple[FieldInfo | None, Any]:
     # Example: get_args(Response[inner_type]) == (inner_type,)  # noqa: ERA001
     (inner_type,) = get_args(annotation)
 
     # Recursively resolve the inner type
-    return get_field_info_and_type_annotation(inner_type, value, False)
+    return get_field_info_and_type_annotation(inner_type, value, False, True)
 
 
 def get_field_info_annotated_type(annotation, value, is_path_param: bool) -> tuple[FieldInfo | None, Any]:

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/event_handler/openapi/swagger_ui/html.py

@@ -22,7 +22,7 @@ def generate_swagger_html(
     spec: str
         The OpenAPI spec
     swagger_js: str
-       Swagger UI JavaScript source code or URL
+        Swagger UI JavaScript source code or URL
     swagger_css: str
         Swagger UI CSS source code or URL
     swagger_base_url: str

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/logging/__init__.py

@@ -1,5 +1,4 @@
-"""Logging utility
-"""
+"""Logging utility"""
 
 from .logger import Logger
 

aws_lambda_powertools-3.5.1a5/aws_lambda_powertools/logging/exceptions.py

@@ -0,0 +1,6 @@
+class InvalidLoggerSamplingRateError(Exception):
+    """
+    Logger configured with Invalid Sampling value
+    """
+
+    pass

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/logging/formatter.py

@@ -273,17 +273,17 @@ class LambdaPowertoolsFormatter(BasePowertoolsFormatter):
         """
         Context manager to temporarily add logging keys.
 
-        Parameters:
+        Parameters
         -----------
-        **keys: Any
+        **additional_keys: Any
             Key-value pairs to include in the log context during the lifespan of the context manager.
 
-        Example:
+        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")
+            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)

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/logging/logger.py

@@ -1,3 +1,9 @@
+"""
+Logger utility
+!!! abstract "Usage Documentation"
+    [`Logger`](../../core/logger.md)
+"""
+
 from __future__ import annotations
 
 import functools
@@ -82,7 +88,7 @@ class Logger:
         by default "INFO"
     child: bool, optional
         create a child Logger named <service>.<caller_file_name>, False by default
-    sample_rate: float, optional
+    sampling_rate: float, optional
         sample rate for debug calls within execution context defaults to 0.0
     stream: sys.stdout, optional
         valid output for a logging stream, by default sys.stdout
@@ -103,7 +109,6 @@ class Logger:
     use_datetime_directive: bool, optional
         Interpret `datefmt` as a format string for `datetime.datetime.strftime`, rather than
         `time.strftime`.
-
         See https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior . This
         also supports a custom %F directive for milliseconds.
     use_rfc3339: bool, optional
@@ -116,7 +121,6 @@ class Logger:
         by default json.loads
     json_default : Callable, optional
         function to coerce unserializable values, by default `str()`
-
         Only used when no custom formatter is set
     utc : bool, optional
         set logging timestamp to UTC, by default False to continue to use local time as per stdlib
@@ -590,17 +594,19 @@ class Logger:
         """
         Context manager to temporarily add logging keys.
 
-        Parameters:
+        Parameters
         -----------
-        **keys: Any
+        **additional_keys: Any
             Key-value pairs to include in the log context during the lifespan of the context manager.
 
-        Example:
+        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")
+        **Logging with contextual keys**
+
+            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

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/metrics/__init__.py

@@ -1,5 +1,4 @@
-"""CloudWatch Embedded Metric Format utility
-"""
+"""CloudWatch Embedded Metric Format utility"""
 
 from aws_lambda_powertools.metrics.base import MetricResolution, MetricUnit, single_metric
 from aws_lambda_powertools.metrics.exceptions import (

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/metrics/base.py

@@ -1,3 +1,9 @@
+"""
+Metrics utility
+!!! abstract "Usage Documentation"
+    [`Metrics`](../../core/metrics.md)
+"""
+
 from __future__ import annotations
 
 import datetime

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/metrics/metrics.py

@@ -1,7 +1,7 @@
 # NOTE: keeps for compatibility
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Callable
 
 from aws_lambda_powertools.metrics.provider.cloudwatch_emf.cloudwatch import AmazonCloudWatchEMFProvider
 
@@ -149,8 +149,8 @@ class Metrics:
         capture_cold_start_metric: bool = False,
         raise_on_empty_metrics: bool = False,
         default_dimensions: dict[str, str] | None = None,
-        **kwargs,
-    ):
+        **kwargs: dict[str, Any],
+    ) -> Callable[..., Any]:
         return self.provider.log_metrics(
             lambda_handler=lambda_handler,
             capture_cold_start_metric=capture_cold_start_metric,

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/metrics/provider/cloudwatch_emf/cloudwatch.py

@@ -330,7 +330,7 @@ class AmazonCloudWatchEMFProvider(BaseProvider):
         """
         Set the timestamp for the metric.
 
-        Parameters:
+        Parameters
         -----------
         timestamp: int | datetime.datetime
             The timestamp to create the metric.

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/metrics/provider/datadog/datadog.py

@@ -87,10 +87,6 @@ class DatadogProvider(BaseProvider):
             Timestamp in int for the metrics, default = time.time()
         tags: list[str]
             In format like ["tag:value", "tag2:value2"]
-        args: Any
-            extra args will be dropped for compatibility
-        kwargs: Any
-            extra kwargs will be converted into tags, e.g., add_metrics(sales=sam) -> tags=['sales:sam']
 
         Examples
         --------

aws_lambda_powertools-3.5.1a5/aws_lambda_powertools/middleware_factory/__init__.py

@@ -0,0 +1,8 @@
+"""Utilities to enhance middleware
+!!! abstract "Usage Documentation"
+    [`Middleware Factory`](../utilities/middleware_factory.md)
+"""
+
+from .factory import lambda_handler_decorator
+
+__all__ = ["lambda_handler_decorator"]

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/shared/version.py

@@ -1,3 +1,3 @@
 """Exposes version constant to avoid circular dependencies."""
 
-VERSION = "3.5.1a3"
+VERSION = "3.5.1a5"

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/tracing/__init__.py

@@ -1,5 +1,4 @@
-"""Tracing utility
-"""
+"""Tracing utility"""
 
 from .extensions import aiohttp_trace_config
 from .tracer import Tracer

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/tracing/base.py

@@ -1,3 +1,9 @@
+"""
+Tracing utility
+!!! abstract "Usage Documentation"
+    [`Tracer`](../../core/tracer.md)
+"""
+
 from __future__ import annotations
 
 import abc

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/batch/base.py

@@ -1,5 +1,7 @@
 """
 Batch processing utilities
+!!! abstract "Usage Documentation"
+    [`Batch processing`](../../utilities/batch.md)
 """
 
 from __future__ import annotations

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/batch/decorators.py

@@ -51,9 +51,8 @@ def async_batch_processor(
     processor: AsyncBatchProcessor
         Batch Processor to handle partial failure cases
 
-    Examples
+    Example
     --------
-    **Processes Lambda's event with a BasePartialProcessor**
         >>> from aws_lambda_powertools.utilities.batch import async_batch_processor, AsyncBatchProcessor
         >>> from aws_lambda_powertools.utilities.data_classes.sqs_event import SQSRecord
         >>>
@@ -119,7 +118,7 @@ def batch_processor(
     processor: BatchProcessor
         Batch Processor to handle partial failure cases
 
-    Examples
+    Example
     --------
     **Processes Lambda's event with a BatchProcessor**
 
@@ -180,7 +179,7 @@ def process_partial_response(
     result: PartialItemFailureResponse
         Lambda Partial Batch Response
 
-    Examples
+    Example
     --------
     **Processes Lambda's SQS event**
 
@@ -244,7 +243,7 @@ def async_process_partial_response(
     result: PartialItemFailureResponse
         Lambda Partial Batch Response
 
-    Examples
+    Example
     --------
     **Processes Lambda's SQS event**
 

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/batch/sqs_fifo_partial_processor.py

@@ -21,7 +21,7 @@ class SqsFifoPartialProcessor(BatchProcessor):
     Stops processing records when the first record fails. The remaining records are reported as failed items.
 
     Example
-    _______
+    -------
 
     ## Process batch triggered by a FIFO SQS
 

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/data_classes/common.py

@@ -1,3 +1,9 @@
+"""
+Base class for Event Source Data Classes
+!!! abstract "Usage Documentation"
+    [`Data classes`](../utilities/data_classes.md)
+"""
+
 from __future__ import annotations
 
 import base64

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/data_masking/base.py

@@ -1,3 +1,9 @@
+"""
+Base class for Data Masking
+!!! abstract "Usage Documentation"
+    [`Data masking`](../../utilities/data_masking.md)
+"""
+
 from __future__ import annotations
 
 import functools
@@ -24,8 +30,9 @@ class DataMasking:
     The DataMasking class orchestrates erasing, encrypting, and decrypting
     for the base provider.
 
-    Example:
-    ```
+    Example
+    -------
+    ```python
     from aws_lambda_powertools.utilities.data_masking.base import DataMasking
 
     def lambda_handler(event, context):

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/data_masking/provider/base.py

@@ -11,9 +11,9 @@ class BaseProvider:
     """
     The BaseProvider class serves as an abstract base class for data masking providers.
 
-    Examples
+    Example
     --------
-    ```
+    ```python
     from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
     from aws_lambda_powertools.utilities.data_masking import DataMasking
 

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py

@@ -48,9 +48,9 @@ class AWSEncryptionSDKProvider(BaseProvider):
     """
     The AWSEncryptionSDKProvider is used as a provider for the DataMasking class.
 
-    Usage
+    Example
     -------
-    ```
+    ```python
     from aws_lambda_powertools.utilities.data_masking import DataMasking
     from aws_lambda_powertools.utilities.data_masking.providers.kms.aws_encryption_sdk import (
         AWSEncryptionSDKProvider,
@@ -142,17 +142,17 @@ class KMSKeyProvider:
 
         Parameters
         -------
-            data : Any
-                The data to be encrypted.
-            provider_options : dict
-                Additional options for the aws_encryption_sdk.EncryptionSDKClient
-            **encryption_context : str
-                Additional keyword arguments collected into a dictionary.
+        data: Any
+            The data to be encrypted.
+        provider_options: dict
+            Additional options for the aws_encryption_sdk.EncryptionSDKClient
+        **encryption_context: str
+            Additional keyword arguments collected into a dictionary.
 
         Returns
         -------
-            ciphertext : str
-                The encrypted data, as a base64-encoded string.
+        ciphertext: str
+            The encrypted data, as a base64-encoded string.
         """
         provider_options = provider_options or {}
         self._validate_encryption_context(encryption_context)
@@ -179,15 +179,15 @@ class KMSKeyProvider:
 
         Parameters
         -------
-            data : str
-                The encrypted data, as a base64-encoded string
-            provider_options
-                Additional options for the aws_encryption_sdk.EncryptionSDKClient
+        data: str
+            The encrypted data, as a base64-encoded string
+        provider_options
+            Additional options for the aws_encryption_sdk.EncryptionSDKClient
 
         Returns
         -------
-            ciphertext : bytes
-                The decrypted data in bytes
+        ciphertext: bytes
+            The decrypted data in bytes
         """
         provider_options = provider_options or {}
         self._validate_encryption_context(encryption_context)

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/feature_flags/appconfig.py

@@ -1,3 +1,8 @@
+"""Advanced feature flags utility
+!!! abstract "Usage Documentation"
+    [`Feature Flags`](../../utilities/feature_flags.md)
+"""
+
 from __future__ import annotations
 
 import logging

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/feature_flags/base.py

@@ -28,7 +28,8 @@ class StoreProvider(ABC):
         dict[str, Any]
             parsed JSON dictionary
 
-            **Example**
+        Example
+        -------
 
         ```python
         {

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/feature_flags/comparators.py

@@ -56,6 +56,8 @@ def compare_time_range(context_value: Any, condition_value: dict) -> bool:
     end_time = current_time.replace(hour=int(end_hour), minute=int(end_min))
 
     if int(end_hour) < int(start_hour):
+        # In normal circumstances, we need to assert **both** conditions
+        """
         # When the end hour is smaller than start hour, it means we are crossing a day's boundary.
         # In this case we need to assert that current_time is **either** on one side or the other side of the boundary
         #
@@ -69,10 +71,9 @@ def compare_time_range(context_value: Any, condition_value: dict) -> bool:
         #                                             │ │                                        │
         #    └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─  │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
         #                                               │
-
+        """
         return (start_time <= current_time) or (current_time <= end_time)
     else:
-        # In normal circumstances, we need to assert **both** conditions
         return start_time <= current_time <= end_time
 
 

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/feature_flags/feature_flags.py

@@ -179,7 +179,8 @@ class FeatureFlags:
         dict[str, dict]
             parsed JSON dictionary
 
-            **Example**
+        Example
+        -------
 
         ```python
         {
@@ -251,7 +252,7 @@ class FeatureFlags:
             Can be boolean or any JSON values for non-boolean features.
 
 
-        Examples
+        Example
         --------
 
         ```python
@@ -343,7 +344,8 @@ class FeatureFlags:
         list[str]
             list of all feature names that either matches context or have True as default
 
-            **Example**
+        Example
+        -------
 
         ```python
         ["premium_features", "my_feature_two", "always_true_feature"]
@@ -400,8 +402,8 @@ class FeatureFlags:
         exc_class : Exception | list[Exception]
             One or more exceptions to catch
 
-        Examples
-        --------
+        Example
+        -------
 
         ```python
         feature_flags = FeatureFlags(store=app_config)

{aws_lambda_powertools-3.5.1a3 → aws_lambda_powertools-3.5.1a5}/aws_lambda_powertools/utilities/idempotency/base.py

@@ -1,3 +1,9 @@
+"""
+Base for Idempotency utility
+!!! abstract "Usage Documentation"
+    [`Idempotency`](../../utilities/idempotency.md)
+"""
+
 from __future__ import annotations
 
 import datetime