bpo-46001: Change OverflowError to RecursionError in JSON library docstrings (GH-29943)

This commit is contained in:
James Gerity 2021-12-07 04:58:40 -05:00 committed by GitHub
parent ddbab69b6d
commit 8db06528ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions

View File

@ -159,7 +159,7 @@ Basic Usage
If *check_circular* is false (default: ``True``), then the circular If *check_circular* is false (default: ``True``), then the circular
reference check for container types will be skipped and a circular reference reference check for container types will be skipped and a circular reference
will result in an :exc:`OverflowError` (or worse). will result in an :exc:`RecursionError` (or worse).
If *allow_nan* is false (default: ``True``), then it will be a If *allow_nan* is false (default: ``True``), then it will be a
:exc:`ValueError` to serialize out of range :class:`float` values (``nan``, :exc:`ValueError` to serialize out of range :class:`float` values (``nan``,
@ -432,7 +432,7 @@ Encoders and Decoders
If *check_circular* is true (the default), then lists, dicts, and custom If *check_circular* is true (the default), then lists, dicts, and custom
encoded objects will be checked for circular references during encoding to encoded objects will be checked for circular references during encoding to
prevent an infinite recursion (which would cause an :exc:`OverflowError`). prevent an infinite recursion (which would cause an :exc:`RecursionError`).
Otherwise, no such check takes place. Otherwise, no such check takes place.
If *allow_nan* is true (the default), then ``NaN``, ``Infinity``, and If *allow_nan* is true (the default), then ``NaN``, ``Infinity``, and

View File

@ -133,7 +133,7 @@ def dump(obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True,
If ``check_circular`` is false, then the circular reference check If ``check_circular`` is false, then the circular reference check
for container types will be skipped and a circular reference will for container types will be skipped and a circular reference will
result in an ``OverflowError`` (or worse). result in an ``RecursionError`` (or worse).
If ``allow_nan`` is false, then it will be a ``ValueError`` to If ``allow_nan`` is false, then it will be a ``ValueError`` to
serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``) serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``)
@ -195,7 +195,7 @@ def dumps(obj, *, skipkeys=False, ensure_ascii=True, check_circular=True,
If ``check_circular`` is false, then the circular reference check If ``check_circular`` is false, then the circular reference check
for container types will be skipped and a circular reference will for container types will be skipped and a circular reference will
result in an ``OverflowError`` (or worse). result in an ``RecursionError`` (or worse).
If ``allow_nan`` is false, then it will be a ``ValueError`` to If ``allow_nan`` is false, then it will be a ``ValueError`` to
serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``) in serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``) in

View File

@ -116,7 +116,7 @@ class JSONEncoder(object):
If check_circular is true, then lists, dicts, and custom encoded If check_circular is true, then lists, dicts, and custom encoded
objects will be checked for circular references during encoding to objects will be checked for circular references during encoding to
prevent an infinite recursion (which would cause an OverflowError). prevent an infinite recursion (which would cause an RecursionError).
Otherwise, no such check takes place. Otherwise, no such check takes place.
If allow_nan is true, then NaN, Infinity, and -Infinity will be If allow_nan is true, then NaN, Infinity, and -Infinity will be