From bf03d98bf69d96ed3d6319df15422bee26df5792 Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Mon, 3 Feb 2025 21:16:51 +0000 Subject: [PATCH] Mkdocstrings - DataMasking module --- aws_lambda_powertools/utilities/data_masking/base.py | 11 +++++++++-- .../utilities/data_masking/provider/base.py | 4 ++-- .../data_masking/provider/kms/aws_encryption_sdk.py | 4 ++-- docs/api_doc/data_masking/base.md | 2 ++ docs/api_doc/data_masking/exceptions.md | 2 ++ docs/api_doc/data_masking/provider.md | 2 ++ mkdocs.yml | 8 ++++++-- 7 files changed, 25 insertions(+), 8 deletions(-) create mode 100644 docs/api_doc/data_masking/base.md create mode 100644 docs/api_doc/data_masking/exceptions.md create mode 100644 docs/api_doc/data_masking/provider.md diff --git a/aws_lambda_powertools/utilities/data_masking/base.py b/aws_lambda_powertools/utilities/data_masking/base.py index 9b80e50bd58..c5f49cfade8 100644 --- a/aws_lambda_powertools/utilities/data_masking/base.py +++ b/aws_lambda_powertools/utilities/data_masking/base.py @@ -1,3 +1,9 @@ +""" +Base class for Data Masking +!!! abstract "Usage Documentation" + [`Data masking`](../../utilities/data_masking.md) +""" + from __future__ import annotations import functools @@ -24,8 +30,9 @@ class DataMasking: The DataMasking class orchestrates erasing, encrypting, and decrypting for the base provider. - Example: - ``` + Example + ------- + ```python from aws_lambda_powertools.utilities.data_masking.base import DataMasking def lambda_handler(event, context): diff --git a/aws_lambda_powertools/utilities/data_masking/provider/base.py b/aws_lambda_powertools/utilities/data_masking/provider/base.py index 28bc8384f8d..8751becfb2c 100644 --- a/aws_lambda_powertools/utilities/data_masking/provider/base.py +++ b/aws_lambda_powertools/utilities/data_masking/provider/base.py @@ -11,9 +11,9 @@ class BaseProvider: """ The BaseProvider class serves as an abstract base class for data masking providers. - Examples + Example -------- - ``` + ```python from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider from aws_lambda_powertools.utilities.data_masking import DataMasking diff --git a/aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py b/aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py index 497b67c6edd..62c4d19e045 100644 --- a/aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py +++ b/aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py @@ -48,9 +48,9 @@ class AWSEncryptionSDKProvider(BaseProvider): """ The AWSEncryptionSDKProvider is used as a provider for the DataMasking class. - Usage + Example ------- - ``` + ```python from aws_lambda_powertools.utilities.data_masking import DataMasking from aws_lambda_powertools.utilities.data_masking.providers.kms.aws_encryption_sdk import ( AWSEncryptionSDKProvider, diff --git a/docs/api_doc/data_masking/base.md b/docs/api_doc/data_masking/base.md new file mode 100644 index 00000000000..f53f55f4c39 --- /dev/null +++ b/docs/api_doc/data_masking/base.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.data_masking.base diff --git a/docs/api_doc/data_masking/exceptions.md b/docs/api_doc/data_masking/exceptions.md new file mode 100644 index 00000000000..7c640463e64 --- /dev/null +++ b/docs/api_doc/data_masking/exceptions.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.data_masking.exceptions diff --git a/docs/api_doc/data_masking/provider.md b/docs/api_doc/data_masking/provider.md new file mode 100644 index 00000000000..406c360c495 --- /dev/null +++ b/docs/api_doc/data_masking/provider.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.data_masking.provider diff --git a/mkdocs.yml b/mkdocs.yml index 1238a20fe3d..e32d5536cb2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,14 +63,18 @@ nav: # - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md # - Customer to advocate: contributing/tracks/customer_advocate.md - API Documentation: - - Feature Flags: + - Data Masking: + - Base: api_doc/data_masking/base.md + - Exception: api_doc/data_masking/exceptions.md + - Provider: api_doc/data_masking/provider.md + - Feature Flags: - AppConfig: api_doc/feature_flags/appconfig.md - Base: api_doc/feature_flags/base.md - Comparators: api_doc/feature_flags/comparators.md - Exceptions: api_doc/feature_flags/exceptions.md - Feature flags: api_doc/feature_flags/feature_flags.md - Schema: api_doc/feature_flags/schema.md - - Idempotency: + - Idempotency: - Base: api_doc/idempotency/base.md - Config: api_doc/idempotency/config.md - Exceptions: api_doc/idempotency/exceptions.md