mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: amend json.dump() post gh-128482 (#128489)

This commit is contained in:
Erlend E. Aasland 2025-01-04 19:57:59 +01:00 committed by GitHub
parent f28d471fbe
commit 87ee76062a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/library/json.rst
View File

@ -154,10 +154,6 @@ Basic Usage
:term:`file-like object`) using this :ref:`Python-to-JSON conversion table :term:`file-like object`) using this :ref:`Python-to-JSON conversion table
<py-to-json-table>`. <py-to-json-table>`.
To use a custom :class:`JSONEncoder` subclass (for example, one that overrides the
:meth:`~JSONEncoder.default` method to serialize additional types), specify it with the
*cls* keyword argument; otherwise :class:`JSONEncoder` is used.
.. note:: .. note::
Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol, Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol,
@ -197,6 +193,13 @@ Basic Usage
If ``True`` (the default), their JavaScript equivalents If ``True`` (the default), their JavaScript equivalents
(``NaN``, ``Infinity``, ``-Infinity``) are used. (``NaN``, ``Infinity``, ``-Infinity``) are used.
:param cls:
If set, a custom JSON encoder with the
:meth:`~JSONEncoder.default` method overridden,
for serializing into custom datatypes.
If ``None`` (the default), :class:`!JSONEncoder` is used.
:type cls: a :class:`JSONEncoder` subclass
:param indent: :param indent:
If a positive integer or string, JSON array elements and If a positive integer or string, JSON array elements and
object members will be pretty-printed with that indent level. object members will be pretty-printed with that indent level.
@ -223,7 +226,7 @@ Basic Usage
If ``None`` (the default), :exc:`!TypeError` is raised. If ``None`` (the default), :exc:`!TypeError` is raised.
:type default: :term:`callable` | None :type default: :term:`callable` | None
:param sort_keys: :param bool sort_keys:
If ``True``, dictionaries will be outputted sorted by key. If ``True``, dictionaries will be outputted sorted by key.
Default ``False``. Default ``False``.