Skip to content

[3.12] Docs: amend json.dump() post gh-128482 (GH-128489) #128494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2025
Merged

[3.12] Docs: amend json.dump() post gh-128482 (GH-128489) #128494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions Doc/library/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,6 @@ Basic Usage
:term:`file-like object`) using this :ref:`Python-to-JSON conversion 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::

Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol,
Expand Down Expand Up @@ -186,6 +182,13 @@ Basic Usage
If ``True`` (the default), their JavaScript equivalents
(``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:
If a positive integer or string, JSON array elements and
object members will be pretty-printed with that indent level.
Expand All @@ -212,7 +215,7 @@ Basic Usage
If ``None`` (the default), :exc:`!TypeError` is raised.
:type default: :term:`callable` | None

:param sort_keys:
:param bool sort_keys:
If ``True``, dictionaries will be outputted sorted by key.
Default ``False``.

Expand Down
Loading