docs: new parser utility

aws_lambda_powertools/utilities/parser/__init__.py

@@ -3,14 +3,16 @@
 from . import envelopes
 from .envelopes import BaseEnvelope
 from .exceptions import ModelValidationError
-from .parser import event_parser
-from .pydantic import BaseModel, root_validator, validator
+from .parser import event_parser, parse
+from .pydantic import BaseModel, Field, root_validator, validator
 
 __all__ = [
     "event_parser",
+    "parse",
     "envelopes",
     "BaseEnvelope",
     "BaseModel",
+    "Field",
     "validator",
     "root_validator",
     "ModelValidationError",

aws_lambda_powertools/utilities/parser/envelopes/__init__.py

@@ -1,6 +1,6 @@
 from .base import BaseEnvelope
-from .dynamodb import DynamoDBEnvelope
+from .dynamodb import DynamoDBStreamEnvelope
 from .event_bridge import EventBridgeEnvelope
 from .sqs import SqsEnvelope
 
-__all__ = ["DynamoDBEnvelope", "EventBridgeEnvelope", "SqsEnvelope", "BaseEnvelope"]
+__all__ = ["DynamoDBStreamEnvelope", "EventBridgeEnvelope", "SqsEnvelope", "BaseEnvelope"]

aws_lambda_powertools/utilities/parser/envelopes/dynamodb.py

@@ -10,7 +10,7 @@
 logger = logging.getLogger(__name__)
 
 
-class DynamoDBEnvelope(BaseEnvelope):
+class DynamoDBStreamEnvelope(BaseEnvelope):
     """ DynamoDB Stream Envelope to extract data within NewImage/OldImage
 
     Note: Values are the parsed models. Images' values can also be None, and
@@ -31,6 +31,8 @@ def parse(self, data: Dict[str, Any], model: BaseModel) -> List[Dict[Literal["Ne
         -------
         List
             List of records parsed with model provided
+
+
         """
         parsed_envelope = DynamoDBStreamModel(**data)
         output = []

aws_lambda_powertools/utilities/parser/envelopes/sqs.py

@@ -19,7 +19,7 @@ class SqsEnvelope(BaseEnvelope):
     all items in the list will be parsed as str and npt as JSON (and vice versa)
     """
 
-    def parse(self, data: Dict[str, Any], model: Union[BaseModel, str]) -> List[Union[BaseModel, str]]:
+    def parse(self, data: Dict[str, Any], model: Union[BaseModel, str]) -> List[BaseModel]:
         """Parses records found with model provided
 
         Parameters

aws_lambda_powertools/utilities/parser/parser.py

@@ -149,6 +149,9 @@ def handler(event: Order, context: LambdaContext):
 
     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