djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/ujson: Document dump() and load() functions.

This commit is contained in:
Damien George 2018-02-06 15:48:24 +11:00
parent d9bca1f7bd
commit e05fca4ef3
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/library/ujson.rst
View File

@ -12,10 +12,23 @@ data format.
Functions Functions
--------- ---------
.. function:: dump(obj, stream)
Serialise *obj* to a JSON string, writing it to the given *stream*.
.. function:: dumps(obj) .. function:: dumps(obj)
Return *obj* represented as a JSON string. 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) .. function:: loads(str)
Parse the JSON *str* and return an object. Raises :exc:`ValueError` if the Parse the JSON *str* and return an object. Raises :exc:`ValueError` if the