mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/ujson.rst

36 lines
926 B
ReStructuredText
Raw Normal View History

docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00: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-31 01:37:19 +00: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 13:37:31 +01: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-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 04:48:24 +00: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-31 01:37:19 +00: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-15 00:31:34 +00: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 04:48:24 +00: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-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 00:31:34 +00: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.