Refactoring parameter

Author: leandrodamascena

aws_lambda_powertools/utilities/idempotency/base.py

@@ -74,7 +74,7 @@ def __init__(
         config: IdempotencyConfig,
         persistence_store: BasePersistenceLayer,
         output_serializer: BaseIdempotencySerializer | None = None,
-        idempotency_key_custom_prefix: str | None = None,
+        key_prefix: str | None = None,
         function_args: tuple | None = None,
         function_kwargs: dict | None = None,
     ):
@@ -92,8 +92,8 @@ def __init__(
         output_serializer: BaseIdempotencySerializer | None
             Serializer to transform the data to and from a dictionary.
             If not supplied, no serialization is done via the NoOpSerializer
-        idempotency_key_custom_prefix: str | Optional
-            Custom prefix for idempotency key: idempotency_key_custom_prefix#hash
+        key_prefix: str | Optional
+            Custom prefix for idempotency key: key_prefix#hash
         function_args: tuple | None
             Function arguments
         function_kwargs: dict | None
@@ -105,12 +105,12 @@ def __init__(
         self.fn_args = function_args
         self.fn_kwargs = function_kwargs
         self.config = config
-        self.idempotency_key_custom_prefix = idempotency_key_custom_prefix
+        self.key_prefix = key_prefix
 
         persistence_store.configure(
             config=config,
             function_name=f"{self.function.__module__}.{self.function.__qualname__}",
-            idempotency_key_custom_prefix=self.idempotency_key_custom_prefix,
+            key_prefix=self.key_prefix,
         )
 
         self.persistence_store = persistence_store

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -40,7 +40,7 @@ def idempotent(
     context: LambdaContext,
     persistence_store: BasePersistenceLayer,
     config: IdempotencyConfig | None = None,
-    idempotency_key_custom_prefix: str | None = None,
+    key_prefix: str | None = None,
     **kwargs,
 ) -> Any:
     """
@@ -58,8 +58,8 @@ def idempotent(
         Instance of BasePersistenceLayer to store data
     config: IdempotencyConfig
         Configuration
-    idempotency_key_custom_prefix: str | Optional
-        Custom prefix for idempotency key: idempotency_key_custom_prefix#hash
+    key_prefix: str | Optional
+        Custom prefix for idempotency key: key_prefix#hash
 
     Examples
     --------
@@ -97,7 +97,7 @@ def idempotent(
         function_payload=event,
         config=config,
         persistence_store=persistence_store,
-        idempotency_key_custom_prefix=idempotency_key_custom_prefix,
+        key_prefix=key_prefix,
         function_args=args,
         function_kwargs=kwargs,
     )
@@ -112,7 +112,7 @@ def idempotent_function(
     persistence_store: BasePersistenceLayer,
     config: IdempotencyConfig | None = None,
     output_serializer: BaseIdempotencySerializer | type[BaseIdempotencyModelSerializer] | None = None,
-    idempotency_key_custom_prefix: str | None = None,
+    key_prefix: str | None = None,
     **kwargs: Any,
 ) -> Any:
     """
@@ -133,8 +133,8 @@ def idempotent_function(
             If not supplied, no serialization is done via the NoOpSerializer.
             In case a serializer of type inheriting BaseIdempotencyModelSerializer is given,
             the serializer is derived from the function return type.
-    idempotency_key_custom_prefix: str | Optional
-        Custom prefix for idempotency key: idempotency_key_custom_prefix#hash
+    key_prefix: str | Optional
+        Custom prefix for idempotency key: key_prefix#hash
 
     Examples
     --------
@@ -161,7 +161,7 @@ def process_order(customer_id: str, order: dict, **kwargs):
                 persistence_store=persistence_store,
                 config=config,
                 output_serializer=output_serializer,
-                idempotency_key_custom_prefix=idempotency_key_custom_prefix,
+                key_prefix=key_prefix,
                 **kwargs,
             ),
         )
@@ -199,7 +199,7 @@ def decorate(*args, **kwargs):
             config=config,
             persistence_store=persistence_store,
             output_serializer=output_serializer,
-            idempotency_key_custom_prefix=idempotency_key_custom_prefix,
+            key_prefix=key_prefix,
             function_args=args,
             function_kwargs=kwargs,
         )

aws_lambda_powertools/utilities/idempotency/persistence/base.py

@@ -58,7 +58,7 @@ def configure(
         self,
         config: IdempotencyConfig,
         function_name: str | None = None,
-        idempotency_key_custom_prefix: str | None = None,
+        key_prefix: str | None = None,
     ) -> None:
         """
         Initialize the base persistence layer from the configuration settings
@@ -69,12 +69,11 @@ def configure(
             Idempotency configuration settings
         function_name: str, Optional
             The name of the function being decorated
-        idempotency_key_custom_prefix: str | Optional
-            Custom prefix for idempotency key: idempotency_key_custom_prefix#hash
+        key_prefix: str | Optional
+            Custom prefix for idempotency key: key_prefix#hash
         """
         self.function_name = (
-            idempotency_key_custom_prefix
-            or f"{os.getenv(constants.LAMBDA_FUNCTION_NAME_ENV, 'test-func')}.{function_name or ''}"
+            key_prefix or f"{os.getenv(constants.LAMBDA_FUNCTION_NAME_ENV, 'test-func')}.{function_name or ''}"
         )
 
         if self.configured:

docs/utilities/idempotency.md

@@ -362,7 +362,7 @@ You can change this expiration window with the **`expires_after_seconds`** param
 
 !!! warning "Warning: Changing the idempotency key generation will invalidate existing idempotency records"
 
-Use **`idempotency_key_custom_prefix`** parameter in the `@idempotent` or `@idempotent_function` decorators to define a custom prefix for your Idempotency Key. This allows you to decouple idempotency key name from function names. It can be useful during application refactoring, for example.
+Use **`key_prefix`** parameter in the `@idempotent` or `@idempotent_function` decorators to define a custom prefix for your Idempotency Key. This allows you to decouple idempotency key name from function names. It can be useful during application refactoring, for example.
 
 === "Using a custom prefix in Lambda Handler"
 

examples/idempotency/src/working_with_custom_idempotency_key_prefix.py

@@ -22,7 +22,7 @@ class Payment:
 class PaymentError(Exception): ...
 
 
-@idempotent(persistence_store=persistence_layer, idempotency_key_custom_prefix="my_custom_prefix") # (1)!
+@idempotent(persistence_store=persistence_layer, key_prefix="my_custom_prefix") # (1)!
 def lambda_handler(event: dict, context: LambdaContext):
     try:
         payment: Payment = create_subscription_payment(event)

examples/idempotency/src/working_with_custom_idempotency_key_prefix_standalone.py

@@ -29,7 +29,7 @@ class Order:
     data_keyword_argument="order",
     config=config,
     persistence_store=dynamodb,
-    idempotency_key_custom_prefix="my_custom_prefix", # (1)!
+    key_prefix="my_custom_prefix", # (1)!
 )
 def process_order(order: Order): 
     return f"processed order {order.order_id}"

tests/functional/idempotency/_boto3/test_idempotency.py

@@ -2062,7 +2062,7 @@ def test_idempotent_function_with_custom_prefix_standalone_function():
     @idempotent_function(
         persistence_store=persistence_layer,
         data_keyword_argument="record",
-        idempotency_key_custom_prefix="my-custom-prefix",
+        key_prefix="my-custom-prefix",
     )
     def record_handler(record):
         return expected_result
@@ -2080,7 +2080,7 @@ def test_idempotent_function_with_custom_prefix_lambda_handler(lambda_context):
     persistence_layer = MockPersistenceLayer(expected_idempotency_key=idempotency_key)
     expected_result = {"message": "Foo"}
 
-    @idempotent(persistence_store=persistence_layer, idempotency_key_custom_prefix="my-custom-prefix")
+    @idempotent(persistence_store=persistence_layer, key_prefix="my-custom-prefix")
     def lambda_handler(record, context):
         return expected_result