core.custom.custom_msgpack

Attributes

_T
_TypeT
default_serializers
PACK_OPTIONS

Classes

Serializer	Provides a way to encode all objects of a given class or its
BytesSerializer	Serializes objects to a byte string.
StringSerializer	Serializes objects to a string.
DictionarySerializer	Serializes objects that can be built with keyword arguments.
Serializers	Organises the different serializer implementations under a unifiying
Serializable	Classes inheriting from this base are serialised using the

Functions

load_keyed_tuple(...)
make_serializable(→ collections.abc.Callable[[_TypeT], ...)
packb(→ bytes)
unpackb(→ Any)

Module Contents

core.custom.custom_msgpack._T

core.custom.custom_msgpack._TypeT

class core.custom.custom_msgpack.Serializer(tag: int, target: type[_T])

Bases: Generic[_T]

Provides a way to encode all objects of a given class or its subclasses to and from MessagePack using extension types.

tag

target

abstractmethod encode(obj: _T) → bytes

abstractmethod decode(value: bytes) → _T

class core.custom.custom_msgpack.BytesSerializer(tag: int, target: type[_T], encode: collections.abc.Callable[[_T], bytes], decode: collections.abc.Callable[[bytes], _T])

Bases: Serializer[_T]

Serializes objects to a byte string.

_encode

_decode

encode(obj: _T) → bytes

decode(value: bytes) → _T

class core.custom.custom_msgpack.StringSerializer(tag: int, target: type[_T], encode: collections.abc.Callable[[_T], str], decode: collections.abc.Callable[[str], _T])

Bases: Serializer[_T]

Serializes objects to a string.

_encode

_decode

encode(obj: _T) → bytes

decode(value: bytes) → _T

class core.custom.custom_msgpack.DictionarySerializer(tag: int, target: type[_T], keys: collections.abc.Iterable[str])

Bases: Serializer[_T]

Serializes objects that can be built with keyword arguments.

For example:

class Point:

    def __init__(self, x, y):
        self.x = x
        self.y = y

Can be serialised using:

DictionarySerializer(Point, ('x', 'y'))

Which results in something like this in JSON:

{'x': 1, 'y': 2}

As the internal __dict__ represenation is of no concern, __slots__ may be used:

class Point:

__slots__ = (‘x’, ‘y’)

def __init__(self, x, y):

self.x = x self.y = y

constructor

encode(obj: _T) → bytes

decode(value: bytes) → _T

class core.custom.custom_msgpack.Serializers

Organises the different serializer implementations under a unifiying interface. This allows the actual encoder/decoder to call a single class without having to worry how the various serializers need to be looked up and called.

by_tag: dict[int, Serializer[Any]]

by_type: dict[type[object], tuple[int, Serializer[Any]]]

register(serializer: Serializer[Any]) → None

encode(value: object) → object

decode(tag: int, value: bytes) → Any

core.custom.custom_msgpack.default_serializers

core.custom.custom_msgpack.load_keyed_tuple(b: bytes) → sqlalchemy.util._collections.AbstractKeyedTuple[Any]

class core.custom.custom_msgpack.Serializable

Classes inheriting from this base are serialised using the DictionarySerializer class.

The keys that should be used need to be specified as follows:

class Point(Serializable, keys=('x', 'y')):

    def __init__(self, x, y):
        self.x = x
        self.y = y

serialized_keys: ClassVar[collections.abc.Collection[str]]

classmethod serializers() → Serializers

classmethod __init_subclass__(tag: int, keys: collections.abc.Collection[str], **kwargs: Any)

core.custom.custom_msgpack.make_serializable(*, tag: int, serializers: Serializers = default_serializers) → collections.abc.Callable[[_TypeT], _TypeT]

core.custom.custom_msgpack.PACK_OPTIONS

core.custom.custom_msgpack.packb(obj: Any) → bytes

core.custom.custom_msgpack.unpackb(value: bytes) → Any