diff options
author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-10-28 12:11:21 (GMT) |
---|---|---|
committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-10-28 12:11:21 (GMT) |
commit | 42b8932c12f8faaa9462b7cdedb8674d54ddfa1a (patch) | |
tree | 9b26e1c90ac4fce3ae713466a6c0bf268fba8e8e /Doc | |
parent | 61254b939127d437c94f7833e8de293a27a4aabd (diff) | |
parent | 6d50a5447af687e2a1303876a3c7867734477762 (diff) | |
download | cpython-42b8932c12f8faaa9462b7cdedb8674d54ddfa1a.zip cpython-42b8932c12f8faaa9462b7cdedb8674d54ddfa1a.tar.gz cpython-42b8932c12f8faaa9462b7cdedb8674d54ddfa1a.tar.bz2 |
Merge issue #14570: Document json sort_keys parameter properly.
Patch by Chris Rebert.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/json.rst | 13 |
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`. |