circuitpython/docs/library/ujson.rst

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

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

|see_cpython_module| :mod:`python: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.
docs: Cleanup and update some docs. 2014-10-31 18:21:37 -04:00			:mod:`ujson` -- JSON encoding and decoding
			`==========================================`
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-30 21:37:19 -04:00
			`.. module:: ujson`
			`:synopsis: JSON encoding and decoding`

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 08:37:31 -04:00			\|see_cpython_module\| :mod:`python: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-30 21:37:19 -04: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-05 23:48:24 -05:00			`.. function:: dump(obj, stream)`

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

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-30 21:37:19 -04:00			`.. function:: dumps(obj)`

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-14 19:31:34 -05: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-30 21:37:19 -04:00
docs/library/ujson: Document dump() and load() functions. 2018-02-05 23:48:24 -05:00			`.. 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.

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-30 21:37:19 -04: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-14 19:31:34 -05: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-30 21:37:19 -04:00			`string is not correctly formed.`