improv: export Pydantic ValidationError instead of our own

Author: heitorlessa

aws_lambda_powertools/utilities/parser/__init__.py

@@ -2,9 +2,8 @@
 """
 from . import envelopes
 from .envelopes import BaseEnvelope
-from .exceptions import ModelValidationError
 from .parser import event_parser, parse
-from .pydantic import BaseModel, Field, root_validator, validator
+from .pydantic import BaseModel, Field, ValidationError, root_validator, validator
 
 __all__ = [
     "event_parser",
@@ -15,5 +14,5 @@
     "Field",
     "validator",
     "root_validator",
-    "ModelValidationError",
+    "ValidationError",
 ]

aws_lambda_powertools/utilities/parser/exceptions.py

@@ -2,9 +2,5 @@ class InvalidEnvelopeError(Exception):
     """Input envelope is not callable and instance of BaseEnvelope"""
 
 
-class ModelValidationError(Exception):
-    """Input data does not conform with model"""
-
-
 class InvalidModelTypeError(Exception):
     """Input data model does not implement BaseModel"""

aws_lambda_powertools/utilities/parser/parser.py

@@ -1,12 +1,12 @@
 import logging
 from typing import Any, Callable, Dict, Optional
 
-from pydantic import BaseModel, ValidationError
+from pydantic import BaseModel
 
 from ...middleware_factory import lambda_handler_decorator
 from ..typing import LambdaContext
 from .envelopes.base import BaseEnvelope
-from .exceptions import InvalidEnvelopeError, InvalidModelTypeError, ModelValidationError
+from .exceptions import InvalidEnvelopeError, InvalidModelTypeError
 
 logger = logging.getLogger(__name__)
 
@@ -72,7 +72,7 @@ def handler(event: Order, context: LambdaContext):
 
     Raises
     ------
-    ModelValidationError
+    ValidationError
         When input event does not conform with model provided
     InvalidModelTypeError
         When model given does not implement BaseModel
@@ -94,7 +94,7 @@ def parse(event: Dict[str, Any], model: BaseModel, envelope: Optional[BaseEnvelo
 
     **Lambda handler decorator to parse & validate event**
 
-        from aws_lambda_powertools.utilities.parser.exceptions import ModelValidationError
+        from aws_lambda_powertools.utilities.parser import ValidationError
 
         class Order(BaseModel):
             id: int
@@ -104,7 +104,7 @@ class Order(BaseModel):
         def handler(event: Order, context: LambdaContext):
             try:
                 parse(model=Order)
-            except ModelValidationError:
+            except ValidationError:
                 ...
 
     **Lambda handler decorator to parse & validate event - using built-in envelope**
@@ -117,7 +117,7 @@ class Order(BaseModel):
         def handler(event: Order, context: LambdaContext):
             try:
                 parse(model=Order, envelope=envelopes.EVENTBRIDGE)
-            except ModelValidationError:
+            except ValidationError:
                 ...
 
     Parameters
@@ -131,7 +131,7 @@ def handler(event: Order, context: LambdaContext):
 
     Raises
     ------
-    ModelValidationError
+    ValidationError
         When input event does not conform with model provided
     InvalidModelTypeError
         When model given does not implement BaseModel
@@ -144,16 +144,12 @@ def handler(event: Order, context: LambdaContext):
             return envelope().parse(data=event, model=model)
         except AttributeError:
             raise InvalidEnvelopeError(f"Envelope must implement BaseEnvelope, envelope={envelope}")
-        except (ValidationError, TypeError) as e:
-            raise ModelValidationError(f"Input event does not conform with model, envelope={envelope}") from e
 
     try:
         logger.debug("Parsing and validating event model; no envelope used")
         if isinstance(event, str):
             return model.parse_raw(event)
 
         return model.parse_obj(event)
-    except (ValidationError, TypeError) as e:
-        raise ModelValidationError("Input event does not conform with model") from e
     except AttributeError:
         raise InvalidModelTypeError("Input model must implement BaseModel")

docs/content/utilities/parser.mdx

@@ -139,10 +139,10 @@ You can parse inbound events using **event_parser** decorator, or the standalone
 
 Use the decorator for fail fast scenarios where you want your Lambda function to raise an exception in the event of a malformed payload.
 
-`event_parser` decorator will throw a `ModelValidationError` if your event cannot be parsed according to the model.
+`event_parser` decorator will throw a `ValidationError` if your event cannot be parsed according to the model.
 
 ```python=:title=event_parser_decorator.py
-from aws_lambda_powertools.utilities.parser import event_parser, BaseModel, ModelValidationError
+from aws_lambda_powertools.utilities.parser import event_parser, BaseModel, ValidationError
 from aws_lambda_powertools.utilities.typing import LambdaContext
 import json
 
@@ -187,7 +187,7 @@ handler(event=json.dumps(payload), context=LambdaContext()) # also works if even
 Use this standalone function when you want more control over the data validation process, for example returning a 400 error for malformed payloads.
 
 ```python:title=parse_standalone_example.py
-from aws_lambda_powertools.utilities.parser import parse, BaseModel, ModelValidationError
+from aws_lambda_powertools.utilities.parser import parse, BaseModel, ValidationError
 
 class OrderItem(BaseModel):
     id: int
@@ -219,7 +219,7 @@ def my_function():
         parsed_payload: Order = parse(event=payload, model=Order) # highlight-line
         # payload dict is now parsed into our model
         return parsed_payload.items
-    except ModelValidationError:
+    except ValidationError:
         return {
             "status_code": 400,
             "message": "Invalid order"

tests/functional/parser/conftest.py

@@ -1,9 +1,9 @@
 from typing import Any, Dict
 
 import pytest
-from pydantic import BaseModel, ValidationError
+from pydantic import BaseModel
 
-from aws_lambda_powertools.utilities.parser import BaseEnvelope, ModelValidationError
+from aws_lambda_powertools.utilities.parser import BaseEnvelope
 
 
 @pytest.fixture
@@ -37,10 +37,7 @@ class MyDummyEnvelope(BaseEnvelope):
         """Unwrap dummy event within payload key"""
 
         def parse(self, data: Dict[str, Any], model: BaseModel):
-            try:
-                parsed_enveloped = dummy_envelope_schema(**data)
-            except (ValidationError, TypeError) as e:
-                raise ModelValidationError("Dummy input does not conform with schema") from e
+            parsed_enveloped = dummy_envelope_schema(**data)
             return self._parse(data=parsed_enveloped.payload, model=model)
 
     return MyDummyEnvelope

tests/functional/parser/test_dynamodb.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
+from aws_lambda_powertools.utilities.parser import ValidationError, envelopes, event_parser
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedDynamoBusiness, MyDynamoBusiness
 from tests.functional.parser.utils import load_event
@@ -59,11 +59,11 @@ def test_dynamo_db_stream_trigger_event_no_envelope():
 
 def test_validate_event_does_not_conform_with_model_no_envelope():
     event_dict: Any = {"hello": "s"}
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_dynamodb_no_envelope(event_dict, LambdaContext())
 
 
 def test_validate_event_does_not_conform_with_model():
     event_dict: Any = {"hello": "s"}
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_dynamodb(event_dict, LambdaContext())

tests/functional/parser/test_eventbridge.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
+from aws_lambda_powertools.utilities.parser import ValidationError, envelopes, event_parser
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedEventbridgeBusiness, MyEventbridgeBusiness
 from tests.functional.parser.utils import load_event
@@ -46,7 +46,7 @@ def test_validate_event_does_not_conform_with_user_dict_model():
         "resources": ["arn:aws:ec2:us-west-1:123456789012:instance/i-1234567890abcdef0"],
         "detail": {},
     }
-    with pytest.raises(exceptions.ModelValidationError) as e:
+    with pytest.raises(ValidationError) as e:
         handle_eventbridge(event_dict, LambdaContext())
     print(e.exconly())
 
@@ -57,5 +57,5 @@ def test_handle_eventbridge_trigger_event_no_envelope():
 
 
 def test_handle_invalid_event_with_eventbridge_envelope():
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_eventbridge(event={}, context=LambdaContext())

tests/functional/parser/test_parser.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import event_parser, exceptions
+from aws_lambda_powertools.utilities.parser import ValidationError, event_parser, exceptions
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 
@@ -13,7 +13,7 @@ def test_parser_unsupported_event(dummy_schema, invalid_value):
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_no_envelope(event=invalid_value, context=LambdaContext())
 
 

tests/functional/parser/test_sqs.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
+from aws_lambda_powertools.utilities.parser import ValidationError, envelopes, event_parser
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedSqsBusiness, MySqsBusiness
 from tests.functional.parser.utils import load_event
@@ -23,7 +23,7 @@ def test_handle_sqs_trigger_event_json_body(sqs_event):  # noqa: F811
 def test_validate_event_does_not_conform_with_model():
     event: Any = {"invalid": "event"}
 
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_sqs_json_body(event, LambdaContext())
 
 
@@ -51,7 +51,7 @@ def test_validate_event_does_not_conform_user_json_string_with_model():
         ]
     }
 
-    with pytest.raises(exceptions.ModelValidationError):
+    with pytest.raises(ValidationError):
         handle_sqs_json_body(event, LambdaContext())