Merge branch 'develop' into time2

Author: ran-isenberg

CHANGELOG.md

@@ -11,15 +11,20 @@
 * **examples:** linting unnecessary whitespace
 * **homepage:** update default value for `POWERTOOLS_DEV` ([#1695](https://github.com/awslabs/aws-lambda-powertools-python/issues/1695))
 
+## Features
+
+* **apigateway:** multiple exceptions in exception_handler ([#1707](https://github.com/awslabs/aws-lambda-powertools-python/issues/1707))
+
 ## Maintenance
 
 * **ci:** revert custom hw for E2E due to lack of hw
 * **ci:** prevent dependabot updates to trigger E2E
 * **ci:** use new custom hw for E2E
 * **ci:** limit to src only to prevent dependabot failures
 * **deps:** bump dependabot/fetch-metadata from 1.3.4 to 1.3.5 ([#1689](https://github.com/awslabs/aws-lambda-powertools-python/issues/1689))
-* **deps-dev:** bump flake8-comprehensions from 3.10.0 to 3.10.1 ([#1699](https://github.com/awslabs/aws-lambda-powertools-python/issues/1699))
+* **deps-dev:** bump mypy-boto3-logs from 1.25.0 to 1.26.3 ([#1702](https://github.com/awslabs/aws-lambda-powertools-python/issues/1702))
 * **deps-dev:** bump mkdocs-material from 8.5.7 to 8.5.9 ([#1697](https://github.com/awslabs/aws-lambda-powertools-python/issues/1697))
+* **deps-dev:** bump flake8-comprehensions from 3.10.0 to 3.10.1 ([#1699](https://github.com/awslabs/aws-lambda-powertools-python/issues/1699))
 * **deps-dev:** bump types-requests from 2.28.11.2 to 2.28.11.3 ([#1698](https://github.com/awslabs/aws-lambda-powertools-python/issues/1698))
 * **deps-dev:** bump pytest-benchmark from 3.4.1 to 4.0.0 ([#1659](https://github.com/awslabs/aws-lambda-powertools-python/issues/1659))
 * **deps-dev:** bump mypy-boto3-secretsmanager from 1.25.0 to 1.26.0.post1 ([#1691](https://github.com/awslabs/aws-lambda-powertools-python/issues/1691))

aws_lambda_powertools/event_handler/api_gateway.py

@@ -689,9 +689,14 @@ def not_found(self, func: Optional[Callable] = None):
             return self.exception_handler(NotFoundError)
         return self.exception_handler(NotFoundError)(func)
 
-    def exception_handler(self, exc_class: Type[Exception]):
+    def exception_handler(self, exc_class: Union[Type[Exception], List[Type[Exception]]]):
         def register_exception_handler(func: Callable):
-            self._exception_handlers[exc_class] = func
+            if isinstance(exc_class, list):
+                for exp in exc_class:
+                    self._exception_handlers[exp] = func
+            else:
+                self._exception_handlers[exc_class] = func
+            return func
 
         return register_exception_handler
 

aws_lambda_powertools/logging/logger.py

@@ -18,12 +18,14 @@
     Optional,
     TypeVar,
     Union,
+    overload,
 )
 
 import jmespath
 
 from ..shared import constants
 from ..shared.functions import resolve_env_var_choice, resolve_truthy_env_var_choice
+from ..shared.types import AnyCallableT
 from .exceptions import InvalidLoggerSamplingRateError
 from .filters import SuppressFilter
 from .formatter import (
@@ -314,13 +316,33 @@ def _configure_sampling(self):
                 f"Please review POWERTOOLS_LOGGER_SAMPLE_RATE environment variable."
             )
 
+    @overload
     def inject_lambda_context(
         self,
-        lambda_handler: Optional[Callable[[Dict, Any], Any]] = None,
+        lambda_handler: AnyCallableT,
         log_event: Optional[bool] = None,
         correlation_id_path: Optional[str] = None,
         clear_state: Optional[bool] = False,
-    ):
+    ) -> AnyCallableT:
+        ...
+
+    @overload
+    def inject_lambda_context(
+        self,
+        lambda_handler: None = None,
+        log_event: Optional[bool] = None,
+        correlation_id_path: Optional[str] = None,
+        clear_state: Optional[bool] = False,
+    ) -> Callable[[AnyCallableT], AnyCallableT]:
+        ...
+
+    def inject_lambda_context(
+        self,
+        lambda_handler: Optional[AnyCallableT] = None,
+        log_event: Optional[bool] = None,
+        correlation_id_path: Optional[str] = None,
+        clear_state: Optional[bool] = False,
+    ) -> Any:
         """Decorator to capture Lambda contextual info and inject into logger
 
         Parameters

docs/core/event_handler/api_gateway.md

@@ -226,6 +226,9 @@ You can use **`exception_handler`** decorator with any Python exception. This al
 --8<-- "examples/event_handler_rest/src/exception_handling.py"
 ```
 
+???+ info
+    The `exception_handler` also supports passing a list of exception types you wish to handle with one handler.
+
 ### Raising HTTP errors
 
 You can easily raise any HTTP Error back to the client using `ServiceError` exception. This ensures your Lambda function doesn't fail but return the correct HTTP response signalling the error.

poetry.lock

@@ -76,5 +76,5 @@
   "pathParameters": null,
   "stageVariables": null,
   "body": "Hello from Lambda!",
-  "isBase64Encoded": true
-}
+  "isBase64Encoded": false
+}

tests/events/apiGatewayProxyEvent.json

@@ -1388,6 +1388,65 @@ def get_lambda() -> Response:
     assert result["body"] == json_dump(expected)
 
 
+def test_exception_handler_supports_list(json_dump):
+    # GIVEN a resolver with an exception handler defined for a multiple exceptions in a list
+    app = ApiGatewayResolver()
+    event = deepcopy(LOAD_GW_EVENT)
+
+    @app.exception_handler([ValueError, NotFoundError])
+    def multiple_error(ex: Exception):
+        raise BadRequestError("Bad request")
+
+    @app.get("/path/a")
+    def path_a() -> Response:
+        raise ValueError("foo")
+
+    @app.get("/path/b")
+    def path_b() -> Response:
+        raise NotFoundError
+
+    # WHEN calling the app generating each exception
+    for route in ["/path/a", "/path/b"]:
+        event["path"] = route
+        result = app(event, {})
+
+        # THEN call the exception handler in the same way for both exceptions
+        assert result["statusCode"] == 400
+        assert result["multiValueHeaders"]["Content-Type"] == [content_types.APPLICATION_JSON]
+        expected = {"statusCode": 400, "message": "Bad request"}
+        assert result["body"] == json_dump(expected)
+
+
+def test_exception_handler_supports_multiple_decorators(json_dump):
+    # GIVEN a resolver with an exception handler defined with multiple decorators
+    app = ApiGatewayResolver()
+    event = deepcopy(LOAD_GW_EVENT)
+
+    @app.exception_handler(ValueError)
+    @app.exception_handler(NotFoundError)
+    def multiple_error(ex: Exception):
+        raise BadRequestError("Bad request")
+
+    @app.get("/path/a")
+    def path_a() -> Response:
+        raise ValueError("foo")
+
+    @app.get("/path/b")
+    def path_b() -> Response:
+        raise NotFoundError
+
+    # WHEN calling the app generating each exception
+    for route in ["/path/a", "/path/b"]:
+        event["path"] = route
+        result = app(event, {})
+
+        # THEN call the exception handler in the same way for both exceptions
+        assert result["statusCode"] == 400
+        assert result["multiValueHeaders"]["Content-Type"] == [content_types.APPLICATION_JSON]
+        expected = {"statusCode": 400, "message": "Bad request"}
+        assert result["body"] == json_dump(expected)
+
+
 def test_event_source_compatibility():
     # GIVEN
     app = APIGatewayHttpResolver()