Serialization Module

Serialization module.

class pepperpy.serialization.BaseSerializable(*args, **kwargs)

Bases: Protocol

Base serializable protocol.

serialize()

Serialize object.

Return type:

Dict[str, Any]

Returns:

Serialized object

deserialize(data)

Deserialize object.

Parameters:

data (Dict[str, Any]) – Serialized object

Return type:

None

class pepperpy.serialization.SerializationConfig(name='serialization_manager', metadata=<factory>)

Bases: ModuleConfig

Serialization configuration.

Parameters:

• name (str)

• metadata (Dict[str, Any])

name: str = 'serialization_manager'

metadata: Dict[str, Any]

exception pepperpy.serialization.SerializationError(message, details=None, cause=None)

Bases: PepperpyError

Serialization error.

Parameters:

• message (str)

• details (Dict[str, Any] | None)

• cause (Exception | None)

Return type:

None

class pepperpy.serialization.SerializationManager(config=None)

Bases: BaseModule[SerializationConfig]

Serialization manager.

Parameters:

config (SerializationConfig | None)

__init__(config=None)

Initialize serialization manager.

Parameters:

config (Optional[SerializationConfig]) – Serialization configuration

Return type:

None

serialize(obj)

Serialize object.

Parameters:

obj (BaseSerializable) – Object to serialize

Return type:

Dict[str, Any]

Returns:

Serialized object

Raises:

SerializationError – If object cannot be serialized

deserialize(obj, data)

Deserialize object.

Parameters:

• obj (BaseSerializable) – Object to deserialize

• data (Dict[str, Any]) – Serialized object

Raises:

SerializationError – If object cannot be deserialized

Return type:

None