From 0e8cb716cc22f03e4fca42820f7ec6ed32fc4ddc Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Mon, 3 Feb 2025 21:50:53 +0000 Subject: [PATCH] Mkdocstrings - Data Classes module --- aws_lambda_powertools/utilities/data_classes/common.py | 6 ++++++ aws_lambda_powertools/utilities/feature_flags/appconfig.py | 1 + aws_lambda_powertools/utilities/jmespath_utils/__init__.py | 1 + docs/api_doc/data_classes.md | 2 ++ mkdocs.yml | 1 + 5 files changed, 11 insertions(+) create mode 100644 docs/api_doc/data_classes.md diff --git a/aws_lambda_powertools/utilities/data_classes/common.py b/aws_lambda_powertools/utilities/data_classes/common.py index ec4335b9ee8..8374bf5ee08 100644 --- a/aws_lambda_powertools/utilities/data_classes/common.py +++ b/aws_lambda_powertools/utilities/data_classes/common.py @@ -1,3 +1,9 @@ +""" +Base class for Event Source Data Classes +!!! abstract "Usage Documentation" + [`Data classes`](../utilities/data_classes.md) +""" + from __future__ import annotations import base64 diff --git a/aws_lambda_powertools/utilities/feature_flags/appconfig.py b/aws_lambda_powertools/utilities/feature_flags/appconfig.py index 4f0ad3e4418..2becf16d0fd 100644 --- a/aws_lambda_powertools/utilities/feature_flags/appconfig.py +++ b/aws_lambda_powertools/utilities/feature_flags/appconfig.py @@ -2,6 +2,7 @@ !!! abstract "Usage Documentation" [`Feature Flags`](../../utilities/feature_flags.md) """ + from __future__ import annotations import logging diff --git a/aws_lambda_powertools/utilities/jmespath_utils/__init__.py b/aws_lambda_powertools/utilities/jmespath_utils/__init__.py index 231fb732c83..c35f9b610cf 100644 --- a/aws_lambda_powertools/utilities/jmespath_utils/__init__.py +++ b/aws_lambda_powertools/utilities/jmespath_utils/__init__.py @@ -3,6 +3,7 @@ !!! abstract "Usage Documentation" [`JMESPath Functions`](../utilities/jmespath_functions.md) """ + from __future__ import annotations import base64 diff --git a/docs/api_doc/data_classes.md b/docs/api_doc/data_classes.md new file mode 100644 index 00000000000..47090024306 --- /dev/null +++ b/docs/api_doc/data_classes.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.data_classes.common diff --git a/mkdocs.yml b/mkdocs.yml index e32d5536cb2..815fcb45b7e 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: + - Event Source Data Classes: api_doc/data_classes.md - Data Masking: - Base: api_doc/data_masking/base.md - Exception: api_doc/data_masking/exceptions.md