From 72b1426cfb6c19932f8303614720b2a528d1dd3c Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Tue, 28 Aug 2012 07:08:44 +0300 Subject: [PATCH] #11964: Document a change in v3.2 to the json indent parameter --- Doc/library/json.rst | 16 ++++++++++++---- Misc/NEWS | 3 +++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/Doc/library/json.rst b/Doc/library/json.rst index a5bfcd2e168..95f120cc7f2 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -149,6 +149,9 @@ Basic Usage indents that many spaces per level. If *indent* is a string (such as ``"\t"``), that string is used to indent each level. + .. versionchanged:: 3.2 + Allow strings for *indent* in addition to integers. + 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. @@ -371,10 +374,15 @@ Encoders and Decoders will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis. - If *indent* is a non-negative integer (it is ``None`` by default), then JSON - array elements and object members will be pretty-printed with that indent - level. An indent level of 0 will only insert newlines. ``None`` is the most - compact representation. + If *indent* is a non-negative integer or string, then JSON array elements and + object members will be pretty-printed with that indent level. An indent level + of 0, negative, or ``""`` will only insert newlines. ``None`` (the default) + selects the most compact representation. Using a positive integer indent + indents that many spaces per level. If *indent* is a string (such as ``"\t"``), + that string is used to indent each level. + + .. versionchanged:: 3.2 + Allow strings for *indent* in addition to integers. If specified, *separators* should be an ``(item_separator, key_separator)`` tuple. The default is ``(', ', ': ')``. To get the most compact JSON diff --git a/Misc/NEWS b/Misc/NEWS index bcf2921a93f..b333c0cc764 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -519,6 +519,9 @@ Build Documentation ------------- +- Issue #11964: Document a change in v3.2 to the behavior of the indent + parameter of json encoding operations. + - Issue #14674: Add a discussion of the json module's standard compliance. Patch by Chris Rebert.