ds_resource_plugin_py_lib.common.serde.binary
=============================================

.. py:module:: ds_resource_plugin_py_lib.common.serde.binary

.. autoapi-nested-parse::

   **File:** ``binary.py``
   **Region:** ``ds_resource_plugin_py_lib/common/serde``

   Description
   -----------
   Helpers for serializing and deserializing binary payloads via DataFrames.



Attributes
----------

.. autoapisummary::

   ds_resource_plugin_py_lib.common.serde.binary._BINARY_KWARGS
   ds_resource_plugin_py_lib.common.serde.binary._DEFAULT_COLUMN
   ds_resource_plugin_py_lib.common.serde.binary._DEFAULT_ROW


Functions
---------

.. autoapisummary::

   ds_resource_plugin_py_lib.common.serde.binary.binary_kwargs
   ds_resource_plugin_py_lib.common.serde.binary.deserialize_binary
   ds_resource_plugin_py_lib.common.serde.binary.serialize_binary


Module Contents
---------------

.. py:data:: _BINARY_KWARGS

.. py:data:: _DEFAULT_COLUMN
   :value: 'binary'


.. py:data:: _DEFAULT_ROW
   :value: 0


.. py:function:: binary_kwargs(kwargs: dict[str, Any]) -> dict[str, Any]

   Return kwargs with binary-specific keys removed.


.. py:function:: deserialize_binary(value: Any, *, column: str = _DEFAULT_COLUMN, encoding: str | None = None) -> pandas.DataFrame

   Wrap raw binary input in a single-row DataFrame.

   :param value: Binary payload as ``bytes``, ``bytearray``, ``BytesIO``, or ``str``.
   :param column: Column name for the binary value.
   :param encoding: When set, encode ``str`` input with this encoding.

   :returns: A one-row DataFrame containing the binary payload.

   :raises DeserializationError: If the input is not binary.


.. py:function:: serialize_binary(obj: pandas.DataFrame, *, column: str = _DEFAULT_COLUMN, row: int = _DEFAULT_ROW, encoding: str | None = None) -> bytes

   Extract binary payload from a DataFrame row and column.

   :param obj: Source DataFrame.
   :param column: Column containing the binary value.
   :param row: Row index to read from.
   :param encoding: When set, encode ``str`` cell values with this encoding.

   :returns: The binary payload as ``bytes``.

   :raises SerializationError: If the column, row, or cell value is invalid.