Skip to content

Commit 5bfb60f

Browse files
leandrodamascenaleandrodamascena
authored
refactor(data_masking): move Data Masking utility to a private folder (#3202)
Moving DataMasking to a private folder
1 parent 4be04cb commit 5bfb60f

File tree

18 files changed

+47
-37
lines changed

18 files changed

+47
-37
lines changed

‎aws_lambda_powertools/utilities/_data_masking/__init__.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
"""
2+
Note: This utility is currently in a Non-General Availability (Non-GA) phase and may have limitations.
3+
Please DON'T USE THIS utility in production environments.
4+
Keep in mind that when we transition to General Availability (GA), there might be breaking changes introduced.
5+
"""
6+
7+
from aws_lambda_powertools.utilities._data_masking.base import DataMasking
8+
9+
__all__ = [
10+
"DataMasking",
11+
]

‎aws_lambda_powertools/utilities/data_masking/base.py renamed to ‎aws_lambda_powertools/utilities/_data_masking/base.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
import json
22
from typing import Optional, Union
33

4-
from aws_lambda_powertools.utilities.data_masking.provider import BaseProvider
4+
from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
55

66

77
class DataMasking:
88
"""
9+
Note: This utility is currently in a Non-General Availability (Non-GA) phase and may have limitations.
10+
Please DON'T USE THIS utility in production environments.
11+
Keep in mind that when we transition to General Availability (GA), there might be breaking changes introduced.
12+
913
A utility class for masking sensitive data within various data types.
1014
1115
This class provides methods for masking sensitive information, such as personal

‎aws_lambda_powertools/utilities/data_masking/constants.py renamed to ‎aws_lambda_powertools/utilities/_data_masking/constants.py

File renamed without changes.

‎aws_lambda_powertools/utilities/_data_masking/provider/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from aws_lambda_powertools.utilities._data_masking.provider.base import BaseProvider
2+
3+
__all__ = [
4+
"BaseProvider",
5+
]

‎aws_lambda_powertools/utilities/data_masking/provider/base.py renamed to ‎aws_lambda_powertools/utilities/_data_masking/provider/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import json
22
from typing import Any
33

4-
from aws_lambda_powertools.utilities.data_masking.constants import DATA_MASKING_STRING
4+
from aws_lambda_powertools.utilities._data_masking.constants import DATA_MASKING_STRING
55

66

77
class BaseProvider:

‎aws_lambda_powertools/utilities/_data_masking/provider/kms/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
2+
3+
__all__ = [
4+
"AwsEncryptionSdkProvider",
5+
]

‎aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py renamed to ‎aws_lambda_powertools/utilities/_data_masking/provider/kms/aws_encryption_sdk.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
)
1313

1414
from aws_lambda_powertools.shared.user_agent import register_feature_to_botocore_session
15-
from aws_lambda_powertools.utilities.data_masking.constants import (
15+
from aws_lambda_powertools.utilities._data_masking.constants import (
1616
CACHE_CAPACITY,
1717
MAX_CACHE_AGE_SECONDS,
1818
MAX_MESSAGES_ENCRYPTED,
1919
)
20-
from aws_lambda_powertools.utilities.data_masking.provider import BaseProvider
20+
from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
2121

2222

2323
class ContextMismatchError(Exception):

‎aws_lambda_powertools/utilities/data_masking/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎aws_lambda_powertools/utilities/data_masking/provider/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎aws_lambda_powertools/utilities/data_masking/provider/kms/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎tests/e2e/data_masking/handlers/basic_handler.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from aws_lambda_powertools import Logger
2-
from aws_lambda_powertools.utilities.data_masking import DataMasking
3-
from aws_lambda_powertools.utilities.data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
2+
from aws_lambda_powertools.utilities._data_masking import DataMasking
3+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
44

55
logger = Logger()
66

‎tests/e2e/data_masking/test_e2e_data_masking.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
import pytest
55
from aws_encryption_sdk.exceptions import DecryptKeyError
66

7-
from aws_lambda_powertools.utilities.data_masking import DataMasking
8-
from aws_lambda_powertools.utilities.data_masking.provider.kms.aws_encryption_sdk import (
7+
from aws_lambda_powertools.utilities._data_masking import DataMasking
8+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import (
99
AwsEncryptionSdkProvider,
1010
ContextMismatchError,
1111
)

‎tests/functional/data_masking/test_aws_encryption_sdk.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
import pytest
88

9-
from aws_lambda_powertools.utilities.data_masking import DataMasking
10-
from aws_lambda_powertools.utilities.data_masking.constants import DATA_MASKING_STRING
11-
from aws_lambda_powertools.utilities.data_masking.provider import BaseProvider
12-
from aws_lambda_powertools.utilities.data_masking.provider.kms import (
9+
from aws_lambda_powertools.utilities._data_masking import DataMasking
10+
from aws_lambda_powertools.utilities._data_masking.constants import DATA_MASKING_STRING
11+
from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
12+
from aws_lambda_powertools.utilities._data_masking.provider.kms import (
1313
AwsEncryptionSdkProvider,
1414
)
1515

‎tests/performance/data_masking/load_test_data_masking/pt-load-test-stack/function_1024/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
from aws_lambda_powertools import Logger, Tracer
44
from aws_lambda_powertools.event_handler import APIGatewayRestResolver
55
from aws_lambda_powertools.logging import correlation_paths
6-
from aws_lambda_powertools.utilities.data_masking import DataMasking
7-
from aws_lambda_powertools.utilities.data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
6+
from aws_lambda_powertools.utilities._data_masking import DataMasking
7+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
88
from aws_lambda_powertools.utilities.typing import LambdaContext
99

1010
KMS_KEY_ARN = os.environ["KMS_KEY_ARN"]

‎tests/performance/data_masking/load_test_data_masking/pt-load-test-stack/function_128/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
from aws_lambda_powertools import Logger, Tracer
44
from aws_lambda_powertools.event_handler import APIGatewayRestResolver
55
from aws_lambda_powertools.logging import correlation_paths
6-
from aws_lambda_powertools.utilities.data_masking import DataMasking
7-
from aws_lambda_powertools.utilities.data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
6+
from aws_lambda_powertools.utilities._data_masking import DataMasking
7+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
88
from aws_lambda_powertools.utilities.typing import LambdaContext
99

1010
KMS_KEY_ARN = os.environ["KMS_KEY_ARN"]

‎tests/performance/data_masking/load_test_data_masking/pt-load-test-stack/function_1769/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
from aws_lambda_powertools import Logger, Tracer
44
from aws_lambda_powertools.event_handler import APIGatewayRestResolver
55
from aws_lambda_powertools.logging import correlation_paths
6-
from aws_lambda_powertools.utilities.data_masking import DataMasking
7-
from aws_lambda_powertools.utilities.data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
6+
from aws_lambda_powertools.utilities._data_masking import DataMasking
7+
from aws_lambda_powertools.utilities._data_masking.provider.kms.aws_encryption_sdk import AwsEncryptionSdkProvider
88
from aws_lambda_powertools.utilities.typing import LambdaContext
99

1010
KMS_KEY_ARN = os.environ["KMS_KEY_ARN"]

‎tests/performance/data_masking/test_perf_data_masking.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
import pytest
55

6-
from aws_lambda_powertools.utilities.data_masking.base import DataMasking
6+
from aws_lambda_powertools.utilities._data_masking.base import DataMasking
77

8-
DATA_MASKING_PACKAGE = "aws_lambda_powertools.utilities.data_masking"
8+
DATA_MASKING_PACKAGE = "aws_lambda_powertools.utilities._data_masking"
99
DATA_MASKING_INIT_SLA: float = 0.002
1010
DATA_MASKING_NESTED_ENCRYPT_SLA: float = 0.001
1111

‎tests/unit/data_masking/test_unit_data_masking.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
import pytest
44

5-
from aws_lambda_powertools.utilities.data_masking.base import DataMasking
6-
from aws_lambda_powertools.utilities.data_masking.constants import DATA_MASKING_STRING
5+
from aws_lambda_powertools.utilities._data_masking.base import DataMasking
6+
from aws_lambda_powertools.utilities._data_masking.constants import DATA_MASKING_STRING
77

88

99
@pytest.fixture

0 commit comments

Comments
 (0)