Module aws_lambda_powertools.utilities.idempotency.serialization.dataclass

Expand source code 
from dataclasses import asdict, is_dataclass
from typing import Any, Dict, Type

from aws_lambda_powertools.utilities.idempotency.exceptions import (
    IdempotencyModelTypeError,
    IdempotencyNoSerializationModelError,
)
from aws_lambda_powertools.utilities.idempotency.serialization.base import (
    BaseIdempotencyModelSerializer,
    BaseIdempotencySerializer,
)

DataClass = Any


class DataclassSerializer(BaseIdempotencyModelSerializer):
    """
    A serializer class for transforming data between dataclass objects and dictionaries.
    """

    def __init__(self, model: Type[DataClass]):
        """
        Parameters
        ----------
        model: Type[DataClass]
            A dataclass type to be used for serialization and deserialization
        """
        self.__model: Type[DataClass] = model

    def to_dict(self, data: DataClass) -> Dict:
        return asdict(data)

    def from_dict(self, data: Dict) -> DataClass:
        return self.__model(**data)

    @classmethod
    def instantiate(cls, model_type: Any) -> BaseIdempotencySerializer:
        if model_type is None:
            raise IdempotencyNoSerializationModelError("No serialization model was supplied")

        if not is_dataclass(model_type):
            raise IdempotencyModelTypeError("Model type is not inherited of dataclass type")
        return cls(model=model_type)

Classes

class DataclassSerializer (model: Type[Any])

A serializer class for transforming data between dataclass objects and dictionaries.

Parameters

model : Type[DataClass]
A dataclass type to be used for serialization and deserialization
Expand source code 
class DataclassSerializer(BaseIdempotencyModelSerializer):
    """
    A serializer class for transforming data between dataclass objects and dictionaries.
    """

    def __init__(self, model: Type[DataClass]):
        """
        Parameters
        ----------
        model: Type[DataClass]
            A dataclass type to be used for serialization and deserialization
        """
        self.__model: Type[DataClass] = model

    def to_dict(self, data: DataClass) -> Dict:
        return asdict(data)

    def from_dict(self, data: Dict) -> DataClass:
        return self.__model(**data)

    @classmethod
    def instantiate(cls, model_type: Any) -> BaseIdempotencySerializer:
        if model_type is None:
            raise IdempotencyNoSerializationModelError("No serialization model was supplied")

        if not is_dataclass(model_type):
            raise IdempotencyModelTypeError("Model type is not inherited of dataclass type")
        return cls(model=model_type)

Ancestors

Methods

def from_dict(self, data: Dict) ‑> Any
Expand source code 
def from_dict(self, data: Dict) -> DataClass:
    return self.__model(**data)
def to_dict(self, data: Any) ‑> Dict
Expand source code 
def to_dict(self, data: DataClass) -> Dict:
    return asdict(data)

Inherited members