diff options
| author | Damien George <damien.p.george@gmail.com> | 2018-02-06 15:48:24 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-02-15 11:37:48 +1100 |
| commit | e05fca4ef399b321464cae6f0ba2ddc16b58a1b2 (patch) | |
| tree | 004b8cf9a2cfc4c3ce8d7ce0097e2ce1fed034de | |
| parent | d9bca1f7bddad762aac72b0fcbdd84eb22e1c3c1 (diff) | |
docs/library/ujson: Document dump() and load() functions.
| -rw-r--r-- | docs/library/ujson.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/library/ujson.rst b/docs/library/ujson.rst index 82b35ecde..5668eb21a 100644 --- a/docs/library/ujson.rst +++ b/docs/library/ujson.rst @@ -12,10 +12,23 @@ 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 |