Merge branch 'develop' into ryandeivert-firehose-event

Author: ryandeivert

CHANGELOG.md

@@ -8,14 +8,20 @@
 
 * **typing:** level arg in copy_config_to_registered_loggers ([#1534](https://github.com/awslabs/aws-lambda-powertools-python/issues/1534))
 
+## Documentation
+
+* **parser:** add JSON string field extension example ([#1526](https://github.com/awslabs/aws-lambda-powertools-python/issues/1526))
+
 ## Maintenance
 
-* **deps:** bump email-validator from 1.2.1 to 1.3.0 ([#1533](https://github.com/awslabs/aws-lambda-powertools-python/issues/1533))
-* **deps:** bump fastjsonschema from 2.16.1 to 2.16.2 ([#1530](https://github.com/awslabs/aws-lambda-powertools-python/issues/1530))
 * **deps:** bump codecov/codecov-action from 3.1.0 to 3.1.1 ([#1529](https://github.com/awslabs/aws-lambda-powertools-python/issues/1529))
 * **deps:** bump actions/setup-python from 3 to 4 ([#1528](https://github.com/awslabs/aws-lambda-powertools-python/issues/1528))
+* **deps:** bump email-validator from 1.2.1 to 1.3.0 ([#1533](https://github.com/awslabs/aws-lambda-powertools-python/issues/1533))
+* **deps:** bump fastjsonschema from 2.16.1 to 2.16.2 ([#1530](https://github.com/awslabs/aws-lambda-powertools-python/issues/1530))
 * **deps-dev:** bump mypy-boto3-s3 from 1.24.36.post1 to 1.24.76 ([#1531](https://github.com/awslabs/aws-lambda-powertools-python/issues/1531))
 * **deps-dev:** bump mkdocs-material from 8.5.1 to 8.5.3 ([#1532](https://github.com/awslabs/aws-lambda-powertools-python/issues/1532))
+* **deps-dev:** bump mako from 1.2.2 to 1.2.3 ([#1537](https://github.com/awslabs/aws-lambda-powertools-python/issues/1537))
+* **deps-dev:** bump types-requests from 2.28.10 to 2.28.11 ([#1538](https://github.com/awslabs/aws-lambda-powertools-python/issues/1538))
 * **docs:** bump layer version to 36 (1.29.2)
 
 

docs/utilities/parser.md

@@ -171,7 +171,7 @@ Parser comes with the following built-in models:
 | **KafkaSelfManagedEventModel**  | Lambda Event Source payload for self managed Kafka payload         |
 | **KafkaMskEventModel**          | Lambda Event Source payload for AWS MSK payload                    |
 
-### extending built-in models
+### Extending built-in models
 
 You can extend them to include your own models, and yet have all other known fields parsed along the way.
 
@@ -236,6 +236,20 @@ for order_item in ret.detail.items:
 3. Defined how part of our EventBridge event should look like by overriding `detail` key within our `OrderEventModel`
 4. Parser parsed the original event against `OrderEventModel`
 
+???+ tip
+    When extending a `string` field containing JSON, you need to wrap the field
+    with [Pydantic's Json Type](https://pydantic-docs.helpmanual.io/usage/types/#json-type):
+
+    ```python hl_lines="14 18-19"
+    --8<-- "examples/parser/src/extending_built_in_models_with_json_mypy.py"
+    ```
+
+    Alternatively, you could use a [Pydantic validator](https://pydantic-docs.helpmanual.io/usage/validators/) to transform the JSON string into a dict before the mapping:
+
+    ```python hl_lines="18-20 24-25"
+    --8<-- "examples/parser/src/extending_built_in_models_with_json_validator.py"
+    ```
+
 ## Envelopes
 
 When trying to parse your payloads wrapped in a known structure, you might encounter the following situations:

examples/parser/src/extending_built_in_models_with_json_mypy.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel, Json
+
+from aws_lambda_powertools.utilities.parser import event_parser
+from aws_lambda_powertools.utilities.parser.models import APIGatewayProxyEventV2Model
+from aws_lambda_powertools.utilities.typing import LambdaContext
+
+
+class CancelOrder(BaseModel):
+    order_id: int
+    reason: str
+
+
+class CancelOrderModel(APIGatewayProxyEventV2Model):
+    body: Json[CancelOrder]  # type: ignore[assignment]
+
+
+@event_parser(model=CancelOrderModel)
+def handler(event: CancelOrderModel, context: LambdaContext):
+    cancel_order: CancelOrder = event.body  # type: ignore[assignment]
+
+    assert cancel_order.order_id is not None

examples/parser/src/extending_built_in_models_with_json_validator.py

@@ -0,0 +1,27 @@
+import json
+
+from pydantic import BaseModel, validator
+
+from aws_lambda_powertools.utilities.parser import event_parser
+from aws_lambda_powertools.utilities.parser.models import APIGatewayProxyEventV2Model
+from aws_lambda_powertools.utilities.typing import LambdaContext
+
+
+class CancelOrder(BaseModel):
+    order_id: int
+    reason: str
+
+
+class CancelOrderModel(APIGatewayProxyEventV2Model):
+    body: CancelOrder  # type: ignore[assignment]
+
+    @validator("body", pre=True)
+    def transform_body_to_dict(cls, value: str):
+        return json.loads(value)
+
+
+@event_parser(model=CancelOrderModel)
+def handler(event: CancelOrderModel, context: LambdaContext):
+    cancel_order: CancelOrder = event.body
+
+    assert cancel_order.order_id is not None

poetry.lock

@@ -63,16 +63,16 @@ mypy-boto3-dynamodb = { version = "^1.24.74", python = ">=3.7" }
 mypy-boto3-lambda = { version = "^1.24.0", python = ">=3.7" }
 mypy-boto3-logs = { version = "^1.24.0", python = ">=3.7" }
 mypy-boto3-secretsmanager = { version = "^1.24.11", python = ">=3.7" }
-mypy-boto3-ssm = { version = "^1.24.0", python = ">=3.7" }
+mypy-boto3-ssm = { version = "^1.24.80", python = ">=3.7" }
 mypy-boto3-s3 = { version = "^1.24.76", python = ">=3.7" }
 mypy-boto3-xray = { version = "^1.24.0", python = ">=3.7" }
-types-requests = "^2.28.8"
+types-requests = "^2.28.11"
 typing-extensions = { version = "^4.3.0", python = ">=3.7" }
 python-snappy = "^0.6.1"
 mkdocs-material = { version = "^8.5.3", python = ">=3.7" }
 filelock = { version = "^3.8.0", python = ">=3.7" }
 # Maintenance: 2022-09-19 pinned mako to fix vulnerability as a pdoc3 dependency. Remove once we drop python 3.6.
-Mako = {version = "1.2.2", python = ">=3.7"}
+Mako = {version = "1.2.3", python = ">=3.7"}
 
 [tool.poetry.extras]
 pydantic = ["pydantic", "email-validator"]