summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorAndrew Svetlov <andrew.svetlov@gmail.com>2012-10-28 12:12:50 (GMT)
committerAndrew Svetlov <andrew.svetlov@gmail.com>2012-10-28 12:12:50 (GMT)
commit21b102481bd1b261fe6a5351fc959a6a978a094f (patch)
tree220ee3ea078796ec8b81c520cccd35cdd90c359f /Doc/library
parentfb90c0934c22041cad1fc4019c9853205befc967 (diff)
parent2ec53be2e272bbe475b2c8173a03dbb29d1413ba (diff)
downloadcpython-21b102481bd1b261fe6a5351fc959a6a978a094f.zip
cpython-21b102481bd1b261fe6a5351fc959a6a978a094f.tar.gz
cpython-21b102481bd1b261fe6a5351fc959a6a978a094f.tar.bz2
merge heads
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/json.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index 95f120c..f9547cb 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -116,7 +116,10 @@ Using json.tool from the shell to validate and pretty-print::
Basic Usage
-----------
-.. function:: dump(obj, fp, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, **kw)
+.. function:: dump(obj, fp, skipkeys=False, ensure_ascii=True, \
+ check_circular=True, allow_nan=True, cls=None, \
+ indent=None, separators=None, default=None, \
+ sort_keys=False, **kw)
Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting
:term:`file-like object`).
@@ -159,12 +162,18 @@ Basic Usage
*default(obj)* is a function that should return a serializable version of
*obj* or raise :exc:`TypeError`. The default simply raises :exc:`TypeError`.
+ If *sort_keys* is ``True`` (default: ``False``), then the output of
+ dictionaries will be sorted by key.
+
To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the
:meth:`default` method to serialize additional types), specify it with the
*cls* kwarg; otherwise :class:`JSONEncoder` is used.
-.. function:: dumps(obj, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, **kw)
+.. function:: dumps(obj, skipkeys=False, ensure_ascii=True, \
+ check_circular=True, allow_nan=True, cls=None, \
+ indent=None, separators=None, default=None, \
+ sort_keys=False, **kw)
Serialize *obj* to a JSON formatted :class:`str`. The arguments have the
same meaning as in :func:`dump`.