Merge branch 'develop' into dependabot/docker/docs/squidfunk/mkdocs-material-sha25695f2ff42251979c043d6cb5b1c82e6ae8189e57e02105813dd1ce124021a418b

Author: leandrodamascena

.github/workflows/quality_check.yml

@@ -63,6 +63,8 @@ jobs:
         run: make dev-quality-code
       - name: Checking third-party library licenses
         run: make check-licenses
+      - name: Checking and enforcing format
+        run: make format-check
       - name: Formatting and Linting
         run: make lint
       - name: Static type checking

.pre-commit-config.yaml

@@ -12,13 +12,13 @@ repos:
       - id: check-toml
   - repo: local
     hooks:
-      - id: black
-        name: formatting::black
-        entry: poetry run black
+      - id: ruff
+        name: formatting::ruff
+        entry: poetry run ruff format
         language: system
         types: [python]
       - id: ruff
-        name: linting-format::ruff
+        name: linting::ruff
         entry: poetry run ruff check
         language: system
         types: [python]

Makefile

@@ -25,8 +25,11 @@ dev-gitpod:
 check-licenses:
 	poetry run licensecheck -u poetry:dev
 
+format-check:
+	poetry run ruff format aws_lambda_powertools tests examples --check
+
 format:
-	poetry run black aws_lambda_powertools tests examples
+	poetry run ruff format aws_lambda_powertools tests examples
 
 lint: format
 	poetry run ruff check aws_lambda_powertools tests examples

aws_lambda_powertools/event_handler/api_gateway.py

@@ -1604,7 +1604,6 @@ def _validate_response_validation_error_http_code(
         response_validation_error_http_code: HTTPStatus | int | None,
         enable_validation: bool,
     ) -> HTTPStatus:
-
         if response_validation_error_http_code and not enable_validation:
             msg = "'response_validation_error_http_code' cannot be set when enable_validation is False."
             raise ValueError(msg)
@@ -1613,7 +1612,6 @@ def _validate_response_validation_error_http_code(
             not isinstance(response_validation_error_http_code, HTTPStatus)
             and response_validation_error_http_code is not None
         ):
-
             try:
                 response_validation_error_http_code = HTTPStatus(response_validation_error_http_code)
             except ValueError:

aws_lambda_powertools/event_handler/bedrock_agent.py

@@ -110,11 +110,11 @@ def get(  # type: ignore[override]
         tags: list[str] | None = None,
         operation_id: str | None = None,
         include_in_schema: bool = True,
+        openapi_extensions: dict[str, Any] | None = None,
         deprecated: bool = False,
         custom_response_validation_http_code: int | HTTPStatus | None = None,
         middlewares: list[Callable[..., Any]] | None = None,
     ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
-        openapi_extensions = None
         security = None
 
         return super().get(
@@ -151,11 +151,11 @@ def post(  # type: ignore[override]
         tags: list[str] | None = None,
         operation_id: str | None = None,
         include_in_schema: bool = True,
+        openapi_extensions: dict[str, Any] | None = None,
         deprecated: bool = False,
         custom_response_validation_http_code: int | HTTPStatus | None = None,
         middlewares: list[Callable[..., Any]] | None = None,
     ):
-        openapi_extensions = None
         security = None
 
         return super().post(
@@ -192,11 +192,11 @@ def put(  # type: ignore[override]
         tags: list[str] | None = None,
         operation_id: str | None = None,
         include_in_schema: bool = True,
+        openapi_extensions: dict[str, Any] | None = None,
         deprecated: bool = False,
         custom_response_validation_http_code: int | HTTPStatus | None = None,
         middlewares: list[Callable[..., Any]] | None = None,
     ):
-        openapi_extensions = None
         security = None
 
         return super().put(
@@ -233,11 +233,11 @@ def patch(  # type: ignore[override]
         tags: list[str] | None = None,
         operation_id: str | None = None,
         include_in_schema: bool = True,
+        openapi_extensions: dict[str, Any] | None = None,
         deprecated: bool = False,
         custom_response_validation_http_code: int | HTTPStatus | None = None,
         middlewares: list[Callable] | None = None,
     ):
-        openapi_extensions = None
         security = None
 
         return super().patch(
@@ -274,11 +274,11 @@ def delete(  # type: ignore[override]
         tags: list[str] | None = None,
         operation_id: str | None = None,
         include_in_schema: bool = True,
+        openapi_extensions: dict[str, Any] | None = None,
         deprecated: bool = False,
         custom_response_validation_http_code: int | HTTPStatus | None = None,
         middlewares: list[Callable[..., Any]] | None = None,
     ):
-        openapi_extensions = None
         security = None
 
         return super().delete(
@@ -325,6 +325,7 @@ def get_openapi_json_schema(  # type: ignore[override]
         license_info: License | None = None,
         security_schemes: dict[str, SecurityScheme] | None = None,
         security: list[dict[str, list[str]]] | None = None,
+        openapi_extensions: dict[str, Any] | None = None,
     ) -> str:
         """
         Returns the OpenAPI schema as a JSON serializable dict.
@@ -365,8 +366,6 @@ def get_openapi_json_schema(  # type: ignore[override]
         """
         from aws_lambda_powertools.event_handler.openapi.compat import model_json
 
-        openapi_extensions = None
-
         schema = super().get_openapi_schema(
             title=title,
             version=version,

aws_lambda_powertools/event_handler/openapi/models.py

@@ -36,7 +36,6 @@ class OpenAPIExtensions(BaseModel):
     @model_validator(mode="before")
     def serialize_openapi_extension_v2(self):
         if isinstance(self, dict) and self.get("openapi_extensions"):
-
             openapi_extension_value = self.get("openapi_extensions")
 
             for extension_key in openapi_extension_value:

aws_lambda_powertools/logging/logger.py

@@ -1205,15 +1205,15 @@ def flush_buffer(self) -> None:
         buffer = self._buffer_cache.get(tracer_id)
         if not buffer:
             return
-        
+
         if not self._buffer_config:
             return
-        
+
         # Check ALC level against buffer level
         lambda_log_level = self._get_aws_lambda_log_level()
         if lambda_log_level:
             # Check if buffer level is less verbose than ALC
-            if (logging.getLevelName(lambda_log_level) > logging.getLevelName(self._buffer_config.buffer_at_verbosity)):
+            if logging.getLevelName(lambda_log_level) > logging.getLevelName(self._buffer_config.buffer_at_verbosity):
                 warnings.warn(
                     "Advanced Logging Controls (ALC) Log Level is less verbose than Log Buffering Log Level. "
                     "Some logs might be missing",

aws_lambda_powertools/utilities/batch/base.py

@@ -296,8 +296,7 @@ def _clean(self):
 
         if self._entire_batch_failed() and self.raise_on_entire_batch_failure:
             raise BatchProcessingError(
-                msg=f"All records failed processing. {len(self.exceptions)} individual errors logged "
-                f"separately below.",
+                msg=f"All records failed processing. {len(self.exceptions)} individual errors logged separately below.",
                 child_exceptions=self.exceptions,
             )
 

aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py

@@ -314,7 +314,6 @@ def put_artifact(self, artifact_name: str, body: Any, content_type: str) -> None
         # So we are using if/else instead.
 
         if self.data.encryption_key:
-
             encryption_key_id = self.data.encryption_key.get_id
             encryption_key_type = self.data.encryption_key.get_type
             if encryption_key_type == "KMS":

aws_lambda_powertools/utilities/data_classes/transfer_family_event.py

@@ -39,7 +39,6 @@ def source_ip(self) -> str:
 
 
 class TransferFamilyAuthorizerResponse:
-
     def _build_authentication_response(
         self,
         role_arn: str,
@@ -51,7 +50,6 @@ def _build_authentication_response(
         user_uid: int | None = None,
         public_keys: str | None = None,
     ) -> dict[str, Any]:
-
         response: dict[str, Any] = {}
 
         if home_directory_type == "PATH":

aws_lambda_powertools/utilities/data_masking/provider/base.py

@@ -82,7 +82,6 @@ def erase(
         masking_rules: dict | None = None,
         **kwargs,
     ) -> Any:
-
         result: Any = DATA_MASKING_STRING
 
         if not any([dynamic_mask, custom_mask, regex_pattern, mask_format, masking_rules]):

aws_lambda_powertools/utilities/idempotency/serialization/dataclass.py

@@ -38,7 +38,6 @@ def from_dict(self, data: dict) -> DataClass:
 
     @classmethod
     def instantiate(cls, model_type: Any) -> BaseIdempotencySerializer:
-
         model_type = get_actual_type(model_type=model_type)
 
         if model_type is None:

aws_lambda_powertools/utilities/idempotency/serialization/pydantic.py

@@ -35,7 +35,6 @@ def from_dict(self, data: dict) -> BaseModel:
 
     @classmethod
     def instantiate(cls, model_type: Any) -> BaseIdempotencySerializer:
-
         model_type = get_actual_type(model_type=model_type)
 
         if model_type is None:

docs/core/event_handler/bedrock_agents.md

@@ -313,6 +313,16 @@ To implement these customizations, include extra parameters when defining your r
 --8<-- "examples/event_handler_bedrock_agents/src/customizing_bedrock_api_operations.py"
 ```
 
+#### Enabling user confirmation
+
+You can enable user confirmation with Bedrock Agents to have your application ask for explicit user approval before invoking an action.
+
+```python hl_lines="14" title="enabling_user_confirmation.py" title="Enabling user confirmation"
+--8<-- "examples/event_handler_bedrock_agents/src/enabling_user_confirmation.py"
+```
+
+1. Add an openapi extension
+
 ## Testing your code
 
 Test your routes by passing an [Agent for Amazon Bedrock proxy event](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html#agents-lambda-input) request:

examples/batch_processing/src/getting_started_error_handling.py

@@ -12,8 +12,7 @@
 logger = Logger()
 
 
-class InvalidPayload(Exception):
-    ...
+class InvalidPayload(Exception): ...
 
 
 @tracer.capture_method

examples/data_masking/src/aws_encryption_provider_example.py

@@ -16,7 +16,8 @@
     local_cache_capacity=200,
     max_cache_age_seconds=400,
     max_messages_encrypted=200,
-    max_bytes_encrypted=2000)
+    max_bytes_encrypted=2000,
+)
 
 data_masker = DataMasking(provider=encryption_provider)
 

examples/event_handler_bedrock_agents/cdk/bedrock_agent_stack.py

@@ -8,7 +8,6 @@
 
 
 class AgentsCdkStack(Stack):
-
     def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         super().__init__(scope, construct_id, **kwargs)
 

examples/event_handler_bedrock_agents/src/enabling_user_confirmation.py

@@ -0,0 +1,26 @@
+from time import time
+
+from aws_lambda_powertools import Logger
+from aws_lambda_powertools.event_handler import BedrockAgentResolver
+from aws_lambda_powertools.utilities.typing import LambdaContext
+
+logger = Logger()
+app = BedrockAgentResolver()
+
+
+@app.get(
+    "/current_time",
+    description="Gets the current time in seconds",
+    openapi_extensions={"x-requireConfirmation": "ENABLED"},  # (1)!
+)
+def current_time() -> int:
+    return int(time())
+
+
+@logger.inject_lambda_context
+def lambda_handler(event: dict, context: LambdaContext):
+    return app.resolve(event, context)
+
+
+if __name__ == "__main__":
+    print(app.get_openapi_json_schema())

examples/event_handler_graphql/src/enable_exceptions_batch_resolver.py

@@ -14,8 +14,7 @@
 }
 
 
-class PostRelatedNotFound(Exception):
-    ...
+class PostRelatedNotFound(Exception): ...
 
 
 @app.batch_resolver(type_name="Query", field_name="relatedPosts", raise_on_error=True)  # (1)!

examples/event_handler_rest/src/raising_http_errors.py

@@ -66,6 +66,7 @@ def service_error():
 def service_unavailable_error():
     raise ServiceUnavailableError("Service is temporarily unavailable")  # HTTP 503
 
+
 @app.get("/todos")
 @tracer.capture_method
 def get_todos():

examples/event_sources/src/cloudWatchDashboard.py

@@ -26,6 +26,6 @@ def lambda_handler(event: CloudWatchDashboardCustomWidgetEvent, context):
         "markdown": f"""
         Dashboard: {event.widget_context.dashboard_name}
         Time Range: {time_range.start} to {time_range.end}
-        Theme: {event.widget_context.theme or 'default'}
+        Theme: {event.widget_context.theme or "default"}
         """,
     }

examples/event_sources/src/s3_batch_operation.py

@@ -33,5 +33,4 @@ def lambda_handler(event: S3BatchOperationEvent, context: LambdaContext):
     return response.asdict()
 
 
-def do_some_work(s3_client, src_bucket: str, src_key: str):
-    ...
+def do_some_work(s3_client, src_bucket: str, src_key: str): ...

examples/homepage/install/arm64/cdk_arm64.py

@@ -3,7 +3,6 @@
 
 
 class SampleApp(Stack):
-
     def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         super().__init__(scope, construct_id, **kwargs)
 

examples/homepage/install/sar/cdk_sar.py

@@ -10,7 +10,6 @@
 
 
 class SampleApp(Stack):
-
     def __init__(self, scope: Construct, id_: str) -> None:
         super().__init__(scope, id_)
 

examples/homepage/install/x86_64/cdk_x86.py

@@ -3,7 +3,6 @@
 
 
 class SampleApp(Stack):
-
     def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         super().__init__(scope, construct_id, **kwargs)
 

examples/idempotency/src/working_with_custom_idempotency_key_prefix.py

@@ -22,7 +22,7 @@ class Payment:
 class PaymentError(Exception): ...
 
 
-@idempotent(persistence_store=persistence_layer, key_prefix="my_custom_prefix") # (1)!
+@idempotent(persistence_store=persistence_layer, key_prefix="my_custom_prefix")  # (1)!
 def lambda_handler(event: dict, context: LambdaContext):
     try:
         payment: Payment = create_subscription_payment(event)

examples/idempotency/src/working_with_custom_idempotency_key_prefix_standalone.py

@@ -29,15 +29,15 @@ class Order:
     data_keyword_argument="order",
     config=config,
     persistence_store=dynamodb,
-    key_prefix="my_custom_prefix", # (1)!
+    key_prefix="my_custom_prefix",  # (1)!
 )
-def process_order(order: Order): 
+def process_order(order: Order):
     return f"processed order {order.order_id}"
 
 
 def lambda_handler(event: dict, context: LambdaContext):
     # see Lambda timeouts section
-    config.register_lambda_context(context) 
+    config.register_lambda_context(context)
 
     order_item = OrderItem(sku="fake", description="sample")
     order = Order(item=order_item, order_id=1)

examples/jmespath_functions/src/powertools_json_idempotency_jmespath.py

@@ -16,8 +16,7 @@
 config = IdempotencyConfig(event_key_jmespath="powertools_json(body)")
 
 
-class PaymentError(Exception):
-    ...
+class PaymentError(Exception): ...
 
 
 @idempotent(config=config, persistence_store=persistence_layer)

examples/logger/src/append_keys_vs_extra.py

@@ -8,8 +8,7 @@
 logger = Logger(service="payment")
 
 
-class PaymentError(Exception):
-    ...
+class PaymentError(Exception): ...
 
 
 def lambda_handler(event, context):