-
Notifications
You must be signed in to change notification settings - Fork 429
docs(parser): add JSON string field extension example #1526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8b59bdb
docs(parser): add JSON string field extension example
rubenfonseca e6fbae8
fix(docs): extracted examples
rubenfonseca ec6a6f8
chore: ignore assignment error only in mypy
heitorlessa 8906200
chore: ignore assignment error only in mypy
heitorlessa 120a33e
chore: ignore assignment error only in mypy
heitorlessa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
examples/parser/src/extending_built_in_models_with_json_mypy.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
27 changes: 27 additions & 0 deletions
27
examples/parser/src/extending_built_in_models_with_json_validator.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.