estruttura.serializers module

Serializers.

class estruttura.serializers.Serializer(*args, **kwds)

Bases: ImmutableBasicData, Generic[T]

Abstract serializer.

abstract serialize(relationship, value)

Serialize value.

Parameters

• relationship – Relationship.

• value – Value.

Returns

Serialized value.

Raises

SerializationError – Error while serializing.

abstract deserialize(relationship, serialized)

Deserialize value.

Parameters

• relationship – Relationship.

• serialized – Serialized value.

Returns

Value.

Raises

SerializationError – Error while deserializing.

to_items(usecase=None)

Convert to items.

Parameters

usecase – Usecase.

Returns

Items.

update(*args, **kwargs)

Make a new serializer with updates.

Same parameters as dict.update(). :return: Updated serializer.

class estruttura.serializers.TypedSerializer(*args, **kwds)

Bases: Serializer[T]

Serializer that utilizes relationship types to best guess serialization formatting.

serialize(relationship, value)

Serialize value.

Parameters

• relationship – Relationship.

• value – Value.

Returns

Serialized value.

Raises

SerializationError – Error while serializing.

deserialize(relationship, serialized)

Deserialize value.

Parameters

• relationship – Relationship.

• serialized – Serialized value.

Returns

Value.

Raises

SerializationError – Error while deserializing.

class estruttura.serializers.EnumSerializer(by_name=False, fallback=None)

Bases: Serializer

Serializer for enum types.

serialize(relationship, value)

Serialize value.

Parameters

• relationship – Relationship.

• value – Value.

Returns

Serialized value.

Raises

SerializationError – Error while serializing.

deserialize(relationship, serialized)

Deserialize value.

Parameters

• relationship – Relationship.

• serialized – Serialized value.

Returns

Value.

Raises

SerializationError – Error while deserializing.

property by_name

Whether to serialize by name instead of value.

property fallback

Fallback serializer (in case value is not an enum).