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

Doc: Improve library/json document. (GH-24390)

This commit is contained in:
Adorilson Bezerra 2021-03-01 22:51:58 -03:00 committed by GitHub
parent 72fcd14a82
commit a347bc0b35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/library/json.rst
View File

@ -333,7 +333,7 @@ Encoders and Decoders
*object_hook*, if specified, will be called with the result of every JSON *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 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 :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 *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 JSON object decoded with an ordered list of pairs. The return value of
@ -422,10 +422,9 @@ Encoders and Decoders
for ``o`` if possible, otherwise it should call the superclass implementation for ``o`` if possible, otherwise it should call the superclass implementation
(to raise :exc:`TypeError`). (to raise :exc:`TypeError`).
If *skipkeys* is false (the default), then it is a :exc:`TypeError` to If *skipkeys* is false (the default), a :exc:`TypeError` will be raised when
attempt encoding of keys that are not :class:`str`, :class:`int`, trying to encode keys that are not :class:`str`, :class:`int`, :class:`float`
:class:`float` or ``None``. If *skipkeys* is true, such items are simply or ``None``. If *skipkeys* is true, such items are simply skipped.
skipped.
If *ensure_ascii* is true (the default), the output is guaranteed to If *ensure_ascii* is true (the default), the output is guaranteed to
have all incoming non-ASCII characters escaped. If *ensure_ascii* is have all incoming non-ASCII characters escaped. If *ensure_ascii* is
@ -479,8 +478,8 @@ Encoders and Decoders
object for *o*, or calls the base implementation (to raise a object for *o*, or calls the base implementation (to raise a
:exc:`TypeError`). :exc:`TypeError`).
For example, to support arbitrary iterators, you could implement default For example, to support arbitrary iterators, you could implement
like this:: :meth:`default` like this::
def default(self, o): def default(self, o):
try: try: