circuitpython/docs/library/json.rst

:mod:`json` -- JSON encoding and decoding
==========================================

.. module:: json
   :synopsis: JSON encoding and decoding

|see_cpython_module| :mod:`cpython:json`.

This modules allows to convert between Python objects and the JSON
data format.

Functions
---------

.. function:: dump(obj, stream)

   Serialise ``obj`` to a JSON string, writing it to the given *stream*.

.. function:: dumps(obj)

   Return ``obj`` represented as a JSON string.

.. function:: load(stream)

   Parse the given ``stream``, interpreting it as a JSON string and
   deserialising the data to a Python object.  The resulting object is
   returned.

   Parsing continues until end-of-file is encountered.
   A :exc:`ValueError` is raised if the data in ``stream`` is not correctly formed.

.. function:: loads(str)

   Parse the JSON *str* and return an object.  Raises :exc:`ValueError` if the
   string is not correctly formed.
CIRCUITPY_* switches for JSON, RE, etc. Doc cleanup 2021-01-24 22:49:28 -05:00			:mod:`json` -- JSON encoding and decoding
docs: Cleanup and update some docs. 2014-10-31 22:21:37 +00:00			`==========================================`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00
CIRCUITPY_* switches for JSON, RE, etc. Doc cleanup 2021-01-24 22:49:28 -05:00			`.. module:: json`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00			`:synopsis: JSON encoding and decoding`

Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 17:34:59 -08:00			\|see_cpython_module\| :mod:`cpython:json`.
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 15:37:31 +03:00
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00			`This modules allows to convert between Python objects and the JSON`
			`data format.`

			`Functions`
			`---------`

docs/library/ujson: Document dump() and load() functions. 2018-02-06 15:48:24 +11:00			`.. function:: dump(obj, stream)`

WIP: complete manual inspection of all significant changes 2018-07-23 21:34:25 -04:00			Serialise ``obj`` to a JSON string, writing it to the given stream.
docs/library/ujson: Document dump() and load() functions. 2018-02-06 15:48:24 +11:00
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00			`.. function:: dumps(obj)`

WIP: complete manual inspection of all significant changes 2018-07-23 21:34:25 -04:00			Return ``obj`` represented as a JSON string.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00
docs/library/ujson: Document dump() and load() functions. 2018-02-06 15:48:24 +11:00			`.. function:: load(stream)`

WIP: complete manual inspection of all significant changes 2018-07-23 21:34:25 -04:00			Parse the given ``stream``, interpreting it as a JSON string and
docs/library/ujson: Document dump() and load() functions. 2018-02-06 15:48:24 +11:00			`deserialising the data to a Python object. The resulting object is`
			`returned.`

			`Parsing continues until end-of-file is encountered.`
WIP: complete manual inspection of all significant changes 2018-07-23 21:34:25 -04:00			A :exc:`ValueError` is raised if the data in ``stream`` is not correctly formed.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00
			`.. function:: loads(str)`

docs/library/ujson: Update to conform with docs conventions. The formatting of exception objects is done as per CPython conventions, eg: :exc:`TypeError` 2018-02-15 11:31:34 +11:00			Parse the JSON str and return an object. Raises :exc:`ValueError` if the
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-31 01:37:19 +00:00			`string is not correctly formed.`