summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2012-11-28 22:35:29 (GMT)
committerEzio Melotti <ezio.melotti@gmail.com>2012-11-28 22:35:29 (GMT)
commitd654dedbbb1116bfed989aafd2ee7a004828546b (patch)
tree14213ed055151133efc364b0c94294c3ac4d4fd3 /Doc
parent74120996f54b53c26b0682406647a2f8bdf53e8b (diff)
downloadcpython-d654dedbbb1116bfed989aafd2ee7a004828546b.zip
cpython-d654dedbbb1116bfed989aafd2ee7a004828546b.tar.gz
cpython-d654dedbbb1116bfed989aafd2ee7a004828546b.tar.bz2
#16333: document a way to get rid of trailing whitespace when indent is used.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/json.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index f9547cb..bdb6436 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -42,7 +42,8 @@ Compact encoding::
Pretty printing::
>>> import json
- >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
+ >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True,
+ ... indent=4, separators=(',', ': ')))
{
"4": 5,
"6": 7
@@ -155,6 +156,12 @@ Basic Usage
.. versionchanged:: 3.2
Allow strings for *indent* in addition to integers.
+ .. note::
+
+ Since the default item separator is ``', '``, the output might include
+ trailing whitespace when *indent* is specified. You can use
+ ``separators=(',', ': ')`` to avoid this.
+
If *separators* is an ``(item_separator, dict_separator)`` tuple, then it
will be used instead of the default ``(', ', ': ')`` separators. ``(',',
':')`` is the most compact JSON representation.
@@ -393,6 +400,12 @@ Encoders and Decoders
.. versionchanged:: 3.2
Allow strings for *indent* in addition to integers.
+ .. note::
+
+ Since the default item separator is ``', '``, the output might include
+ trailing whitespace when *indent* is specified. You can use
+ ``separators=(',', ': ')`` to avoid this.
+
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.