improv: rename to event_parser as per Tom's review

Author: heitorlessa

aws_lambda_powertools/utilities/parser/__init__.py

@@ -1,9 +1,17 @@
-"""Advanced parser utility
+"""Advanced event_parser utility
 """
 from . import envelopes
 from .envelopes import BaseEnvelope
 from .exceptions import SchemaValidationError
-from .parser import parser
+from .parser import event_parser
 from .pydantic import BaseModel, root_validator, validator
 
-__all__ = ["parser", "envelopes", "BaseEnvelope", "BaseModel", "validator", "root_validator", "SchemaValidationError"]
+__all__ = [
+    "event_parser",
+    "envelopes",
+    "BaseEnvelope",
+    "BaseModel",
+    "validator",
+    "root_validator",
+    "SchemaValidationError",
+]

aws_lambda_powertools/utilities/parser/parser.py

@@ -12,7 +12,7 @@
 
 
 @lambda_handler_decorator
-def parser(
+def event_parser(
     handler: Callable[[Dict, Any], Any],
     event: Dict[str, Any],
     context: LambdaContext,
@@ -42,7 +42,7 @@ class Order(BaseModel):
             description: str
             ...
 
-        @parser(schema=Order)
+        @event_parser(schema=Order)
         def handler(event: Order, context: LambdaContext):
             ...
 
@@ -53,7 +53,7 @@ class Order(BaseModel):
             description: str
             ...
 
-        @parser(schema=Order, envelope=envelopes.EVENTBRIDGE)
+        @event_parser(schema=Order, envelope=envelopes.EVENTBRIDGE)
         def handler(event: Order, context: LambdaContext):
             ...
 
@@ -87,7 +87,7 @@ def handler(event: Order, context: LambdaContext):
 def parse(event: Dict[str, Any], schema: BaseModel, envelope: Optional[BaseEnvelope] = None) -> Any:
     """Standalone function to parse & validate events using Pydantic models
 
-    Typically used when you need fine-grained control over error handling compared to parser decorator.
+    Typically used when you need fine-grained control over error handling compared to event_parser decorator.
 
     Example
     -------

tests/functional/parser/test_dynamodb.py

@@ -2,13 +2,13 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, exceptions, parser
+from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedDynamoBusiness, MyDynamoBusiness
 from tests.functional.parser.utils import load_event
 
 
-@parser(schema=MyDynamoBusiness, envelope=envelopes.DynamoDBEnvelope)
+@event_parser(schema=MyDynamoBusiness, envelope=envelopes.DynamoDBEnvelope)
 def handle_dynamodb(event: List[Dict[str, MyDynamoBusiness]], _: LambdaContext):
     assert len(event) == 2
     assert event[0]["OldImage"] is None
@@ -20,7 +20,7 @@ def handle_dynamodb(event: List[Dict[str, MyDynamoBusiness]], _: LambdaContext):
     assert event[1]["NewImage"].Id["N"] == 101
 
 
-@parser(schema=MyAdvancedDynamoBusiness)
+@event_parser(schema=MyAdvancedDynamoBusiness)
 def handle_dynamodb_no_envelope(event: MyAdvancedDynamoBusiness, _: LambdaContext):
     records = event.Records
     record = records[0]

tests/functional/parser/test_eventbridge.py

@@ -2,19 +2,19 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, exceptions, parser
+from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedEventbridgeBusiness, MyEventbridgeBusiness
 from tests.functional.parser.utils import load_event
 
 
-@parser(schema=MyEventbridgeBusiness, envelope=envelopes.EventBridgeEnvelope)
+@event_parser(schema=MyEventbridgeBusiness, envelope=envelopes.EventBridgeEnvelope)
 def handle_eventbridge(event: MyEventbridgeBusiness, _: LambdaContext):
     assert event.instance_id == "i-1234567890abcdef0"
     assert event.state == "terminated"
 
 
-@parser(schema=MyAdvancedEventbridgeBusiness)
+@event_parser(schema=MyAdvancedEventbridgeBusiness)
 def handle_eventbridge_no_envelope(event: MyAdvancedEventbridgeBusiness, _: LambdaContext):
     assert event.detail.instance_id == "i-1234567890abcdef0"
     assert event.detail.state == "terminated"

tests/functional/parser/test_parser.py

@@ -2,13 +2,13 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import exceptions, parser
+from aws_lambda_powertools.utilities.parser import event_parser, exceptions
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 
 @pytest.mark.parametrize("invalid_value", [None, bool(), [], (), object])
 def test_parser_unsupported_event(dummy_schema, invalid_value):
-    @parser(schema=dummy_schema)
+    @event_parser(schema=dummy_schema)
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 
@@ -20,7 +20,7 @@ def handle_no_envelope(event: Dict, _: LambdaContext):
     "invalid_envelope,expected", [(True, ""), (["dummy"], ""), (object, exceptions.InvalidEnvelopeError)]
 )
 def test_parser_invalid_envelope_type(dummy_event, dummy_schema, invalid_envelope, expected):
-    @parser(schema=dummy_schema, envelope=invalid_envelope)
+    @event_parser(schema=dummy_schema, envelope=invalid_envelope)
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 
@@ -32,15 +32,15 @@ def handle_no_envelope(event: Dict, _: LambdaContext):
 
 
 def test_parser_schema_with_envelope(dummy_event, dummy_schema, dummy_envelope):
-    @parser(schema=dummy_schema, envelope=dummy_envelope)
+    @event_parser(schema=dummy_schema, envelope=dummy_envelope)
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 
     handle_no_envelope(dummy_event, LambdaContext())
 
 
 def test_parser_schema_no_envelope(dummy_event, dummy_schema):
-    @parser(schema=dummy_schema)
+    @event_parser(schema=dummy_schema)
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 
@@ -49,7 +49,7 @@ def handle_no_envelope(event: Dict, _: LambdaContext):
 
 @pytest.mark.parametrize("invalid_schema", [None, str, bool(), [], (), object])
 def test_parser_with_invalid_schema_type(dummy_event, invalid_schema):
-    @parser(schema=invalid_schema)
+    @event_parser(schema=invalid_schema)
     def handle_no_envelope(event: Dict, _: LambdaContext):
         return event
 

tests/functional/parser/test_sqs.py

@@ -2,14 +2,14 @@
 
 import pytest
 
-from aws_lambda_powertools.utilities.parser import envelopes, exceptions, parser
+from aws_lambda_powertools.utilities.parser import envelopes, event_parser, exceptions
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyAdvancedSqsBusiness, MySqsBusiness
 from tests.functional.parser.utils import load_event
 from tests.functional.validator.conftest import sqs_event  # noqa: F401
 
 
-@parser(schema=MySqsBusiness, envelope=envelopes.SqsEnvelope)
+@event_parser(schema=MySqsBusiness, envelope=envelopes.SqsEnvelope)
 def handle_sqs_json_body(event: List[MySqsBusiness], _: LambdaContext):
     assert len(event) == 1
     assert event[0].message == "hello world"
@@ -55,7 +55,7 @@ def test_validate_event_does_not_conform_user_json_string_with_schema():
         handle_sqs_json_body(event, LambdaContext())
 
 
-@parser(schema=MyAdvancedSqsBusiness)
+@event_parser(schema=MyAdvancedSqsBusiness)
 def handle_sqs_no_envelope(event: MyAdvancedSqsBusiness, _: LambdaContext):
     records = event.Records
     record = records[0]