summaryrefslogtreecommitdiff
path: root/docs/library/ujson.rst
diff options
context:
space:
mode:
authorPeter Züger <zueger.peter@icloud.com>2021-02-03 09:24:25 +0100
committerDamien George <damien@micropython.org>2021-08-07 13:52:16 +1000
commitffc854f17f1c4a3a9904fa8909f0b6ab5385206f (patch)
tree889276a0ee111c6f771248e32ab1a6b07b3f2890 /docs/library/ujson.rst
parent8616129f2e382310802950db066178648a9429a3 (diff)
extmod/modujson: Add support for dump/dumps separators keyword-argument.
Optionally enabled via MICROPY_PY_UJSON_SEPARATORS. Enabled by default. For dump, make sure mp_get_stream_raise is called after mod_ujson_separators since CPython does it in this order (if both separators and stream are invalid, separators will raise an exception first). Add separators argument in the docs as well. Signed-off-by: Peter Züger <zueger.peter@icloud.com> Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs/library/ujson.rst')
-rw-r--r--docs/library/ujson.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/library/ujson.rst b/docs/library/ujson.rst
index 5668eb21a..65ed1867e 100644
--- a/docs/library/ujson.rst
+++ b/docs/library/ujson.rst
@@ -12,14 +12,20 @@ data format.
Functions
---------
-.. function:: dump(obj, stream)
+.. function:: dump(obj, stream, separators=None)
Serialise *obj* to a JSON string, writing it to the given *stream*.
-.. function:: dumps(obj)
+ 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