apifrom.utils.serialization
===========================


Serialization utilities for APIFromAnything.

This module provides utilities for serializing and deserializing data.



.. py:currentmodule:: apifrom.utils.serialization

Overview
--------

**Classes**

* :py:class:`JSONEncoder`


**Functions**

* :py:func:`deserialize`
* :py:func:`deserialize_params`
* :py:func:`serialize`
* :py:func:`serialize_response`





Classes
-------

.. py:class:: JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None):bases: json.JSONEncoder


Custom JSON encoder for APIFromAnything.

   This encoder handles common Python types that are not natively supported by JSON.

   Constructor for JSONEncoder, with sensible defaults.

   If skipkeys is false, then it is a TypeError to attempt
   encoding of keys that are not str, int, float or None.  If
   skipkeys is True, such items are simply skipped.

   If ensure_ascii is true, the output is guaranteed to be str
   objects with all incoming non-ASCII characters escaped.  If
   ensure_ascii is false, the output can contain non-ASCII characters.

   If check_circular is true, then lists, dicts, and custom encoded
   objects will be checked for circular references during encoding to
   prevent an infinite recursion (which would cause an RecursionError).
   Otherwise, no such check takes place.

   If allow_nan is true, then NaN, Infinity, and -Infinity will be
   encoded as such.  This behavior is not JSON specification compliant,
   but is consistent with most JavaScript based encoders and decoders.
   Otherwise, it will be a ValueError to encode such floats.

   If sort_keys is true, then the output of dictionaries will be
   sorted by key; this is useful for regression tests to ensure
   that JSON serializations can be compared on a day-to-day basis.

   If indent is a non-negative integer, then JSON array
   elements and object members will be pretty-printed with that
   indent level.  An indent level of 0 will only insert newlines.
   None is the most compact representation.

   If specified, separators should be an (item_separator, key_separator)
   tuple.  The default is (', ', ': ') if *indent* is ``None`` and
   (',', ': ') otherwise.  To get the most compact JSON representation,
   you should specify (',', ':') to eliminate whitespace.

   If specified, default is a function that gets called for objects
   that can't otherwise be serialized.  It should return a JSON encodable
   version of the object or raise a ``TypeError``.






















.. method:: default(obj)

   Convert an object to a JSON-serializable type.

      :param obj: The object to convert.

      :returns: A JSON-serializable representation of the object.









Functions
---------

.. py:function:: deserialize(data, target_type)


Deserialize data to a specific type.

   :param data: The data to deserialize.
   :param target_type: The target type.

   :returns: The deserialized data.


.. py:function:: deserialize_params(params, func, type_hints = None)


Deserialize parameters for a function call.

   :param params: The parameters to deserialize.
   :param func: The function or signature to deserialize parameters for.
   :param type_hints: Optional type hints. If not provided, they will be extracted from the function.

   :returns: The deserialized parameters.


.. py:function:: serialize(obj)


Serialize an object to a JSON-compatible type.

   :param obj: The object to serialize.

   :returns: A JSON-compatible representation of the object.


.. py:function:: serialize_response(result)


Serialize a function result for an API response.

   :param result: The function result to serialize.

   :returns: A JSON-compatible representation of the result.