#11964: Document a change in v3.2 to the json indent parameter

This commit is contained in:
Petri Lehtinen 2012-08-28 07:08:44 +03:00
parent 72c6eefcc6
commit 72b1426cfb
2 changed files with 15 additions and 4 deletions

View File

@ -149,6 +149,9 @@ Basic Usage
indents that many spaces per level. If *indent* is a string (such as ``"\t"``), indents that many spaces per level. If *indent* is a string (such as ``"\t"``),
that string is used to indent each level. 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 If *separators* is an ``(item_separator, dict_separator)`` tuple, then it
will be used instead of the default ``(', ', ': ')`` separators. ``(',', will be used instead of the default ``(', ', ': ')`` separators. ``(',',
':')`` is the most compact JSON representation. ':')`` 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 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. 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 If *indent* is a non-negative integer or string, then JSON array elements and
array elements and object members will be pretty-printed with that indent object members will be pretty-printed with that indent level. An indent level
level. An indent level of 0 will only insert newlines. ``None`` is the most of 0, negative, or ``""`` will only insert newlines. ``None`` (the default)
compact representation. 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)`` If specified, *separators* should be an ``(item_separator, key_separator)``
tuple. The default is ``(', ', ': ')``. To get the most compact JSON tuple. The default is ``(', ', ': ')``. To get the most compact JSON

View File

@ -519,6 +519,9 @@ Build
Documentation 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. - Issue #14674: Add a discussion of the json module's standard compliance.
Patch by Chris Rebert. Patch by Chris Rebert.