change flags name to more intuitive

Author: anafalcao

aws_lambda_powertools/utilities/data_masking/base.py

@@ -100,8 +100,8 @@ def erase(
         self,
         data: dict,
         fields: list[str],
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
     ) -> dict: ...
@@ -110,8 +110,8 @@ def erase(
         self,
         data: Sequence | Mapping,
         fields: list[str] | None = None,
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
         masking_rules: dict | None = None,
@@ -125,8 +125,8 @@ def erase(
                 data=data,
                 fields=fields,
                 action=self.provider.erase,
+                dynamic_mask=dynamic_mask,
                 custom_mask=custom_mask,
-                mask_pattern=mask_pattern,
                 regex_pattern=regex_pattern,
                 mask_format=mask_format,
             )
@@ -137,8 +137,8 @@ def _apply_action(
         fields: list[str] | None,
         action: Callable,
         provider_options: dict | None = None,
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
         **encryption_context: str,
@@ -174,8 +174,8 @@ def _apply_action(
                 fields=fields,
                 action=action,
                 provider_options=provider_options,
+                dynamic_mask=dynamic_mask,
                 custom_mask=custom_mask,
-                mask_pattern=mask_pattern,
                 regex_pattern=regex_pattern,
                 mask_format=mask_format,
                 **encryption_context,
@@ -185,8 +185,8 @@ def _apply_action(
             return action(
                 data=data,
                 provider_options=provider_options,
+                dynamic_mask=dynamic_mask,
                 custom_mask=custom_mask,
-                mask_pattern=mask_pattern,
                 regex_pattern=regex_pattern,
                 mask_format=mask_format,
                 **encryption_context,
@@ -198,8 +198,8 @@ def _apply_action_to_fields(
         fields: list,
         action: Callable,
         provider_options: dict | None = None,
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
         **encryption_context: str,
@@ -260,8 +260,8 @@ def _apply_action_to_fields(
             self._call_action,
             action=action,
             provider_options=provider_options,
+            dynamic_mask=dynamic_mask,
             custom_mask=custom_mask,
-            mask_pattern=mask_pattern,
             regex_pattern=regex_pattern,
             mask_format=mask_format,
             **encryption_context,  # type: ignore[arg-type]
@@ -343,8 +343,8 @@ def _call_action(
         field_name: str,
         action: Callable,
         provider_options: dict[str, Any] | None = None,
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
         **encryption_context,
@@ -367,8 +367,8 @@ def _call_action(
         fields[field_name] = action(
             field_value,
             provider_options=provider_options,
+            dynamic_mask=dynamic_mask,
             custom_mask=custom_mask,
-            mask_pattern=mask_pattern,
             regex_pattern=regex_pattern,
             mask_format=mask_format,
             **encryption_context,

aws_lambda_powertools/utilities/data_masking/provider/base.py

@@ -70,8 +70,8 @@ def decrypt(self, data, provider_options: dict | None = None, **encryption_conte
     def erase(
         self,
         data,
-        custom_mask: bool | None = None,
-        mask_pattern: str | None = None,
+        dynamic_mask: bool | None = None,
+        custom_mask: str | None = None,
         regex_pattern: str | None = None,
         mask_format: str | None = None,
         masking_rules: dict | None = None,
@@ -91,22 +91,21 @@ def erase(
 
         if data:
             if isinstance(data, str):
+                if dynamic_mask:
+                    result = self._custom_erase(data, **kwargs)
                 if custom_mask:
-                    if mask_pattern:
-                        result = self._pattern_mask(data, mask_pattern)
-                    elif regex_pattern and mask_format:
-                        result = self._regex_mask(data, regex_pattern, mask_format)
-                    else:
-                        result = self._custom_erase(data, **kwargs)
+                    result = self._pattern_mask(data, custom_mask)
+                if regex_pattern and mask_format:
+                    result = self._regex_mask(data, regex_pattern, mask_format)
             elif isinstance(data, dict):
                 if masking_rules:
                     result = self._apply_masking_rules(data, masking_rules)
             elif isinstance(data, (list, tuple, set)):
                 result = type(data)(
                     self.erase(
                         item,
+                        dynamic_mask=dynamic_mask,
                         custom_mask=custom_mask,
-                        mask_pattern=mask_pattern,
                         regex_pattern=regex_pattern,
                         mask_format=mask_format,
                         masking_rules=masking_rules,