.. _f-jsonhelper:

module ``tools.json_helper``
============================





.. inheritance-diagram:: lightmlrestapi.tools.json_helper


Short summary
+++++++++++++

module ``lightmlrestapi.tools.json_helper``

Helpers about :epkg:`json`.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------+--------------------------------------------------+
| class                                                           | truncated documentation                          |
+=================================================================+==================================================+
| :class:`JsonError <lightmlrestapi.tools.json_helper.JsonError>` | Raised when serialization to json does not work. |
+-----------------------------------------------------------------+--------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------+------------------------------------+
| function                                                         | truncated documentation            |
+==================================================================+====================================+
| :func:`json_dumps <lightmlrestapi.tools.json_helper.json_dumps>` | Dumps an object into :epkg:`json`. |
+------------------------------------------------------------------+------------------------------------+
| :func:`json_loads <lightmlrestapi.tools.json_helper.json_loads>` | Loads an object from :epkg:`json`. |
+------------------------------------------------------------------+------------------------------------+








Methods
+++++++

+---------------------------------------------------------------------------+-------------------------+
| method                                                                    | truncated documentation |
+===========================================================================+=========================+
| :py:meth:`__init__ <lightmlrestapi.tools.json_helper.JsonError.__init__>` |                         |
+---------------------------------------------------------------------------+-------------------------+


Documentation
+++++++++++++

.. automodule:: lightmlrestapi.tools.json_helper
    :members:
    :special-members: __init__
    :show-inheritance: