diff options
Diffstat (limited to 'docs/library/json.rst')
| -rw-r--r-- | docs/library/json.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/library/json.rst b/docs/library/json.rst new file mode 100644 index 0000000000..65ed1867e6 --- /dev/null +++ b/docs/library/json.rst @@ -0,0 +1,41 @@ +: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, separators=None) + + Serialise *obj* to a JSON string, writing it to the given *stream*. + + If specified, separators should be an ``(item_separator, key_separator)`` + tuple. The default is ``(', ', ': ')``. To get the most compact JSON + representation, you should specify ``(',', ':')`` to eliminate whitespace. + +.. function:: dumps(obj, separators=None) + + Return *obj* represented as a JSON string. + + The arguments have the same meaning as in `dump`. + +.. 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. |