ds_common_serde_py_lib

File: __init__.py Region: ds-common-serde-py-lib

Description

A Python package from the ds-common-serde-py-lib library.

Example

from ds_common_serde_py_lib import __version__

print(f"Package version: {__version__}")

Submodules

• ds_common_serde_py_lib._serializable_convert
• ds_common_serde_py_lib._serializable_deserialize
• ds_common_serde_py_lib._serializable_serialize
• ds_common_serde_py_lib.errors
• ds_common_serde_py_lib.serializable

Attributes

__version__

Exceptions

DeserializationError	Exception raised when deserialization fails.
SerializationError	Exception raised when serialization fails.

Classes

Serializable

Mixin providing serialize/deserialize for dataclasses.

Package Contents

exception ds_common_serde_py_lib.DeserializationError(message: str = 'Deserialization failed', code: str = 'DS_DESERIALIZATION_ERROR', status_code: int = 500, details: dict[str, Any] | None = None)

Bases: SerdeError

Exception raised when deserialization fails.

exception ds_common_serde_py_lib.SerializationError(message: str = 'Serialization failed', code: str = 'DS_SERIALIZATION_ERROR', status_code: int = 500, details: dict[str, Any] | None = None)

Bases: SerdeError

Exception raised when serialization fails.

class ds_common_serde_py_lib.Serializable

Mixin providing serialize/deserialize for dataclasses.

__deserializers__: ClassVar[dict[str, Any]]

serialize() → dict[str, Any]

Return a JSON-serializable representation of the dataclass.

Returns:

A dictionary representing the serialized data.

Raises:

SerializationError – If serialization fails or does not produce a mapping.

classmethod deserialize(data: collections.abc.Mapping[str, Any]) → T

Create an instance from a mapping.

Parameters:

data – A dictionary representing the serialized data.

Returns:

An instance of the dataclass.

Raises:

DeserializationError – If data cannot be converted into an instance.

ds_common_serde_py_lib.__version__