bpo-30550: Clarify JSON ordering guarantees (GH-15397)

This commit is contained in:
Raymond Hettinger 2019-08-22 15:14:42 -07:00 committed by GitHub
parent 4be11c009a
commit 657008ea03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -120,6 +120,18 @@ See :ref:`json-commandline` for detailed documentation.
value) is also a subset of YAML 1.0 and 1.1. This module can thus also be
used as a YAML serializer.
.. note::
This module's encoders and decoders preserve input and output order by
default. Order is only lost if the underlying containers are unordered.
Prior to Python 3.7, :class:`dict` was not guaranteed to be ordered, so
inputs and outputs were typically scrambled unless
:class:`collections.OrderedDict` was specifically requested. Starting
with Python 3.7, the regular :class:`dict` became order preserving, so
it is no longer necessary specify :class:`collections.OrderedDict` for
JSON generation and parsing.
Basic Usage
-----------