Skip to content

Doc: Improve library/json document. #24390

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 3 commits into from
Mar 2, 2021
Merged

Doc: Improve library/json document. #24390

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99a859c
[DOC] Add link to jsonrpc.org
adorilson Jan 30, 2021
e1a0479
[DOC] Improvement a text about TypeError in library/json
adorilson Jan 30, 2021
c5fc6de
[DOC] Surround a method with :meth: in library/json
adorilson Jan 30, 2021
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: 6 additions & 7 deletions Doc/library/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ Encoders and Decoders
*object_hook*, if specified, will be called with the result of every JSON
object decoded and its return value will be used in place of the given
:class:`dict`. This can be used to provide custom deserializations (e.g. to
support JSON-RPC class hinting).
support `JSON-RPC <http://www.jsonrpc.org>`_ class hinting).

*object_pairs_hook*, if specified will be called with the result of every
JSON object decoded with an ordered list of pairs. The return value of
Expand Down Expand Up @@ -422,10 +422,9 @@ Encoders and Decoders
for ``o`` if possible, otherwise it should call the superclass implementation
(to raise :exc:`TypeError`).

If *skipkeys* is false (the default), then it is a :exc:`TypeError` to
attempt encoding of keys that are not :class:`str`, :class:`int`,
:class:`float` or ``None``. If *skipkeys* is true, such items are simply
skipped.
If *skipkeys* is false (the default), a :exc:`TypeError` will be raised when
trying to encode keys that are not :class:`str`, :class:`int`, :class:`float`
or ``None``. If *skipkeys* is true, such items are simply skipped.

If *ensure_ascii* is true (the default), the output is guaranteed to
have all incoming non-ASCII characters escaped. If *ensure_ascii* is
Expand Down Expand Up @@ -479,8 +478,8 @@ Encoders and Decoders
object for *o*, or calls the base implementation (to raise a
:exc:`TypeError`).

For example, to support arbitrary iterators, you could implement default
like this::
For example, to support arbitrary iterators, you could implement
:meth:`default` like this::

def default(self, o):
try:
Expand Down