ds_resource_plugin_py_lib.common.serde.serialize
================================================

.. py:module:: ds_resource_plugin_py_lib.common.serde.serialize

.. autoapi-nested-parse::

   **File:** ``__init__.py``
   **Region:** ``ds_resource_plugin_py_lib/common/serde/serialize``

   Description
   -----------
   Serializer implementations for dataset content.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_resource_plugin_py_lib/common/serde/serialize/awswrangler/index
   /autoapi/ds_resource_plugin_py_lib/common/serde/serialize/base/index
   /autoapi/ds_resource_plugin_py_lib/common/serde/serialize/pandas/index


Classes
-------

.. autoapisummary::

   ds_resource_plugin_py_lib.common.serde.serialize.AwsWranglerSerializer
   ds_resource_plugin_py_lib.common.serde.serialize.DataSerializer
   ds_resource_plugin_py_lib.common.serde.serialize.PandasSerializer


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

.. py:class:: AwsWranglerSerializer

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.serde.serialize.base.DataSerializer`


   Extensible class to serialize dataset content.

   Convert obj to bytes.

   Not supposed to be used directly, but to be subclassed.


   .. py:attribute:: format
      :type:  ds_resource_plugin_py_lib.common.resource.dataset.storage_format.DatasetStorageFormatType


   .. py:attribute:: kwargs
      :type:  dict[str, Any]


   .. py:method:: __call__(obj: pandas.DataFrame, **kwargs: Any) -> Any

      Serialize a pandas DataFrame into a value.
      :param obj: The pandas DataFrame to serialize.
      :param \*\*kwargs: Additional keyword arguments.

      :returns: A value.



.. py:class:: DataSerializer

   Bases: :py:obj:`ds_common_serde_py_lib.Serializable`


   Extensible class to serialize dataset content.

   Convert obj to bytes.

   Not supposed to be used directly, but to be subclassed.


   .. py:method:: __call__(obj: Any, **kwargs: Any) -> Any
      :abstractmethod:



.. py:class:: PandasSerializer

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.serde.serialize.base.DataSerializer`


   Extensible class to serialize dataset content.

   Convert obj to bytes.

   Not supposed to be used directly, but to be subclassed.


   .. py:attribute:: format
      :type:  ds_resource_plugin_py_lib.common.resource.dataset.storage_format.DatasetStorageFormatType


   .. py:attribute:: kwargs
      :type:  dict[str, Any]


   .. py:method:: __call__(obj: Any, **_kwargs: Any) -> Any

      Serialize a pandas DataFrame into a value.
      :param obj: The pandas DataFrame to serialize.
      :param \*\*kwargs: Additional keyword arguments.

      :returns: A value.