Skip to content

MessagePack

cachetory.serializers.MsgPackSerializer

Uses MessagePack serialization.

Warning

This serializer requires ormsgpack extra.

Source code in cachetory/serializers/msgpack.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class MsgPackSerializer(Serializer[ValueT, bytes], Generic[ValueT]):
    """
    Uses [MessagePack](https://msgpack.org/) serialization.

    Warning:
        This serializer requires [`ormsgpack`](https://github.com/aviramha/ormsgpack) extra.
    """

    @classmethod
    def from_url(cls, url: str) -> MsgPackSerializer[ValueT]:
        """
        Construct serializer from the URL.

        # Supported schema's

        - `msgpack://`
        """
        return MsgPackSerializer[ValueT]()

    def serialize(self, value: ValueT) -> bytes:
        return ormsgpack.packb(value)  # type: ignore[no-any-return, unused-ignore]

    def deserialize(self, data: bytes) -> ValueT:
        return ormsgpack.unpackb(data)  # type: ignore[no-any-return]

from_url classmethod 

from_url(url: str) -> MsgPackSerializer[ValueT]

Construct serializer from the URL.

Supported schema's

  • msgpack://
Source code in cachetory/serializers/msgpack.py 
18
19
20
21
22
23
24
25
26
27
@classmethod
def from_url(cls, url: str) -> MsgPackSerializer[ValueT]:
    """
    Construct serializer from the URL.

    # Supported schema's

    - `msgpack://`
    """
    return MsgPackSerializer[ValueT]()