Skip to content

serializer

The internal component that encodes requests and decodes responses into models. Owned by the Client; you should not need to use it directly.

This module contains the Serializer that is used to parse incoming network data into Python classes.

Serializer

Serializes wom.py model classes to and from raw bytes.

Source code in wom/serializer.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class Serializer:
    """Serializes wom.py model classes to and from raw bytes."""

    __slots__ = ("_decoders", "_encoder")

    def __init__(self) -> None:
        self._decoders: DecodersT = {}
        self._encoder = Encoder()

    def encode(self, obj: t.Any) -> bytes:
        """Encodes the object into JSON bytes.

        Parameters
        ----------
        obj : Any
            The object to encode.

        Returns
        -------
        bytes
            The encoded JSON payload.
        """
        return self._encoder.encode(obj)

    def decode(self, data: bytes, model_type: t.Type[T]) -> T:
        """Decodes the data into the given model type.

        Parameters
        ----------
        data : bytes
            The JSON payload as bytes.
        model_type : Type[T]
            The type of model to decode into.

        Returns
        -------
        T
            The requested model.
        """
        return self.get_decoder(model_type).decode(data)

    def get_decoder(self, model_type: t.Type[T]) -> Decoder[T]:
        """Lazily initializes decoders as they are requested and caches them.

        Parameters
        ----------
        model_type : Type[T]
            The model type this decoder will target.

        Returns
        -------
        Decoder[T]
            The requested decoder.
        """
        if not (decoder := self._decoders.get(model_type)):
            decoder = self._decoders[model_type] = Decoder(  # pyright: ignore[reportArgumentType]
                model_type
            )

        return decoder  # type: ignore[return-value]

decode 

decode(data: bytes, model_type: t.Type[T]) -> T

Decodes the data into the given model type.

Parameters:

Name Type Description Default
data bytes

The JSON payload as bytes.

 required
model_type Type[T]

The type of model to decode into.

 required

Returns:

Type Description
T

The requested model.
Source code in wom/serializer.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def decode(self, data: bytes, model_type: t.Type[T]) -> T:
    """Decodes the data into the given model type.

    Parameters
    ----------
    data : bytes
        The JSON payload as bytes.
    model_type : Type[T]
        The type of model to decode into.

    Returns
    -------
    T
        The requested model.
    """
    return self.get_decoder(model_type).decode(data)

encode 

encode(obj: t.Any) -> bytes

Encodes the object into JSON bytes.

Parameters:

Name Type Description Default
obj Any

The object to encode.

 required

Returns:

Type Description
bytes

The encoded JSON payload.
Source code in wom/serializer.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def encode(self, obj: t.Any) -> bytes:
    """Encodes the object into JSON bytes.

    Parameters
    ----------
    obj : Any
        The object to encode.

    Returns
    -------
    bytes
        The encoded JSON payload.
    """
    return self._encoder.encode(obj)

get_decoder 

get_decoder(model_type: t.Type[T]) -> Decoder[T]

Lazily initializes decoders as they are requested and caches them.

Parameters:

Name Type Description Default
model_type Type[T]

The model type this decoder will target.

 required

Returns:

Type Description
Decoder[T]

The requested decoder.
Source code in wom/serializer.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def get_decoder(self, model_type: t.Type[T]) -> Decoder[T]:
    """Lazily initializes decoders as they are requested and caches them.

    Parameters
    ----------
    model_type : Type[T]
        The model type this decoder will target.

    Returns
    -------
    Decoder[T]
        The requested decoder.
    """
    if not (decoder := self._decoders.get(model_type)):
        decoder = self._decoders[model_type] = Decoder(  # pyright: ignore[reportArgumentType]
            model_type
        )

    return decoder  # type: ignore[return-value]