From fe7c4436bf8f2ef78806dd6a0fe74209659c21bd Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Mon, 3 Feb 2025 15:44:47 +0000 Subject: [PATCH 1/2] Mkdocstrings - Parser module --- docs/api_doc/parser.md | 2 ++ mkdocs.yml | 1 + 2 files changed, 3 insertions(+) create mode 100644 docs/api_doc/parser.md diff --git a/docs/api_doc/parser.md b/docs/api_doc/parser.md new file mode 100644 index 00000000000..be52cde0b7d --- /dev/null +++ b/docs/api_doc/parser.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.parser.parser diff --git a/mkdocs.yml b/mkdocs.yml index e16ffe33008..a83aad098a6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,6 +63,7 @@ nav: # - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md # - Customer to advocate: contributing/tracks/customer_advocate.md - API Documentation: + - Parser: api_doc/parser.md - Streaming: api_doc/streaming.md - Typing: api_doc/typing.md - Validation: api_doc/validation.md From 5366e72a72e0fe3dc696e1b8e38e53a65071b1de Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Mon, 3 Feb 2025 15:50:00 +0000 Subject: [PATCH 2/2] Mkdocstrings - Parser module --- aws_lambda_powertools/utilities/parser/parser.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/aws_lambda_powertools/utilities/parser/parser.py b/aws_lambda_powertools/utilities/parser/parser.py index 4f6115255a8..446209880fd 100644 --- a/aws_lambda_powertools/utilities/parser/parser.py +++ b/aws_lambda_powertools/utilities/parser/parser.py @@ -1,3 +1,10 @@ +""" +The Parser utility simplifies data parsing and validation using Pydantic. It allows you to define data models +in pure Python classes, parse and validate incoming events, and extract only the data you need. +!!! abstract "Usage Documentation" + [`Parser`](../utilities/parser.md) +""" + from __future__ import annotations import logging