ds_provider_xledger_py_lib.serde
================================

.. py:module:: ds_provider_xledger_py_lib.serde

.. autoapi-nested-parse::

   **File:** ``__init__.py``
   **Region:** ``ds_provider_xledger_py_lib/serde``

   Description
   -----------
   Serde helpers for the Xledger provider.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_provider_xledger_py_lib/serde/deserializer/index
   /autoapi/ds_provider_xledger_py_lib/serde/serializer/index


Classes
-------

.. autoapisummary::

   ds_provider_xledger_py_lib.serde.XledgerDeserializer
   ds_provider_xledger_py_lib.serde.XledgerSerializer


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

.. py:class:: XledgerDeserializer

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.serde.deserialize.base.DataDeserializer`


   Parse GraphQL responses into dataframes using operation metadata.


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

      Deserialize a GraphQL response body.

      :param value: GraphQL response body.
      :param \*\*kwargs: Compatibility kwargs. Requires ``metadata`` and
                         ``operation_settings``.

      :returns: Parsed dataframe output.



   .. py:method:: get_next(value: Any, **kwargs: Any) -> bool

      Return ``hasNextPage`` from a read response payload.

      :param value: GraphQL response body.
      :param \*\*kwargs: Compatibility kwargs. Requires ``metadata``.

      :returns: ``True`` when there is a next page.



   .. py:method:: get_end_cursor(value: Any, **kwargs: Any) -> str | None

      Return last edge cursor from a read response payload.

      :param value: GraphQL response body.
      :param \*\*kwargs: Compatibility kwargs. Requires ``metadata``.

      :returns: Last cursor when available, otherwise ``None``.



.. py:class:: XledgerSerializer

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


   Build GraphQL payloads from dataframe input and loaded metadata.


   .. py:method:: __call__(obj: Any, **kwargs: Any) -> dict[str, Any]

      Serialize dataframe into GraphQL payload.

      :param obj: Input dataframe.
      :param \*\*kwargs: Compatibility kwargs. Requires ``operation`` and
                         ``metadata`` and ``operation_settings``.

      :returns: Payload in the form ``{"query": query, "variables": variables}``.