Cr fixes

Author: aradyaron

aws_lambda_powertools/utilities/idempotency/base.py

@@ -19,7 +19,7 @@
     DataRecord,
 )
 from aws_lambda_powertools.utilities.idempotency.serialization.base import (
-    BaseDictSerializer,
+    BaseIdempotencySerializer,
 )
 from aws_lambda_powertools.utilities.idempotency.serialization.no_op import (
     NoOpSerializer,
@@ -57,7 +57,7 @@ def __init__(
         function_payload: Any,
         config: IdempotencyConfig,
         persistence_store: BasePersistenceLayer,
-        output_serializer: Optional[BaseDictSerializer] = None,
+        output_serializer: Optional[BaseIdempotencySerializer] = None,
         function_args: Optional[Tuple] = None,
         function_kwargs: Optional[Dict] = None,
     ):
@@ -72,7 +72,7 @@ def __init__(
             Idempotency Configuration
         persistence_store : BasePersistenceLayer
             Instance of persistence layer to store idempotency records
-        output_serializer: Optional[BaseDictSerializer]
+        output_serializer: Optional[BaseIdempotencySerializer]
             Serializer to transform the data to and from a dictionary.
             If not supplied, no serialization is done via the NoOpSerializer
         function_args: Optional[Tuple]

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -14,7 +14,7 @@
 from aws_lambda_powertools.utilities.idempotency.persistence.base import (
     BasePersistenceLayer,
 )
-from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseDictSerializer
+from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseIdempotencySerializer
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 logger = logging.getLogger(__name__)
@@ -86,7 +86,7 @@ def idempotent_function(
     data_keyword_argument: str,
     persistence_store: BasePersistenceLayer,
     config: Optional[IdempotencyConfig] = None,
-    output_serializer: Optional[BaseDictSerializer] = None,
+    output_serializer: Optional[BaseIdempotencySerializer] = None,
 ) -> Any:
     """
     Decorator to handle idempotency of any function
@@ -101,7 +101,7 @@ def idempotent_function(
         Instance of BasePersistenceLayer to store data
     config: IdempotencyConfig
         Configuration
-    output_serializer: Optional[BaseDictSerializer]
+    output_serializer: Optional[BaseIdempotencySerializer]
             Serializer to transform the data to and from a dictionary.
             If not supplied, no serialization is done via the NoOpSerializer
     Examples

aws_lambda_powertools/utilities/idempotency/serialization/base.py

@@ -1,17 +1,13 @@
 """
 Serialization for supporting idempotency
 """
-import logging
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
-logger = logging.getLogger(__name__)
 
-
-class BaseDictSerializer(ABC):
+class BaseIdempotencySerializer(ABC):
     """
     Abstract Base Class for Idempotency serialization layer, supporting dict operations.
-    This interface not be inherited by end user implementation.
     """
 
     @abstractmethod

aws_lambda_powertools/utilities/idempotency/serialization/custom_dict.py

@@ -1,16 +1,16 @@
 from typing import Any, Callable, Dict
 
-from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseDictSerializer
+from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseIdempotencySerializer
 
 
-class CustomDictSerializer(BaseDictSerializer):
+class CustomDictSerializer(BaseIdempotencySerializer):
     def __init__(self, to_dict: Callable[[Any], Dict], from_dict: Callable[[Dict], Any]):
         """
         Parameters
         ----------
         to_dict: Callable[[Any], Dict]
             A function capable of transforming the saved data object representation into a dictionary
-        from_dict: str
+        from_dict: Callable[[Dict], Any]
             A function capable of transforming the saved dictionary into the original data object representation
         """
         self.__to_dict: Callable[[Any], Dict] = to_dict

aws_lambda_powertools/utilities/idempotency/serialization/no_op.py

@@ -1,14 +1,14 @@
 from typing import Dict
 
-from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseDictSerializer
+from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseIdempotencySerializer
 
 
-class NoOpSerializer(BaseDictSerializer):
+class NoOpSerializer(BaseIdempotencySerializer):
     def __init__(self):
         """
         Parameters
         ----------
-        default serializer, does not transform data
+        Default serializer, does not transform data
         """
 
     def to_dict(self, data: Dict) -> Dict:

aws_lambda_powertools/utilities/idempotency/serialization/pydantic.py

@@ -2,18 +2,18 @@
 
 from pydantic import BaseModel
 
-from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseDictSerializer
+from aws_lambda_powertools.utilities.idempotency.serialization.base import BaseIdempotencySerializer
 
 Model = BaseModel
 
 
-class PydanticSerializer(BaseDictSerializer):
+class PydanticSerializer(BaseIdempotencySerializer):
     def __init__(self, model: Type[Model]):
         """
         Parameters
         ----------
         model: Model
-            A model of the type to transform
+            A Pydantic model of the type to transform
         """
         self.__model: Type[Model] = model