ds_common_serde_py_lib
======================

.. py:module:: ds_common_serde_py_lib

.. autoapi-nested-parse::

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

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

   .. rubric:: Example

   .. code-block:: python

       from ds_common_serde_py_lib import __version__

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



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_common_serde_py_lib/_serializable_convert/index
   /autoapi/ds_common_serde_py_lib/_serializable_deserialize/index
   /autoapi/ds_common_serde_py_lib/_serializable_serialize/index
   /autoapi/ds_common_serde_py_lib/errors/index
   /autoapi/ds_common_serde_py_lib/serializable/index


Attributes
----------

.. autoapisummary::

   ds_common_serde_py_lib.__version__


Exceptions
----------

.. autoapisummary::

   ds_common_serde_py_lib.DeserializationError
   ds_common_serde_py_lib.SerializationError


Classes
-------

.. autoapisummary::

   ds_common_serde_py_lib.Serializable


Package Contents
----------------

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

   Bases: :py:obj:`SerdeError`


   Exception raised when deserialization fails.


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

   Bases: :py:obj:`SerdeError`


   Exception raised when serialization fails.


.. py:class:: Serializable

   Mixin providing ``serialize``/``deserialize`` for dataclasses.


   .. py:attribute:: __deserializers__
      :type:  ClassVar[dict[str, Any]]


   .. py:method:: 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.



   .. py:method:: deserialize(data: collections.abc.Mapping[str, Any]) -> T
      :classmethod:


      Create an instance from a mapping.

      :param data: A dictionary representing the serialized data.

      :returns: An instance of the dataclass.

      :raises DeserializationError: If `data` cannot be converted into an instance.



.. py:data:: __version__