gh-132021: Add bool type to the list of types that were allowed in keys of encode(...) method #132048
+4
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
srinivasreddy
commented
Apr 3, 2025
•
srinivasreddy
commented
- Issue: Inconsistency in json.JSONEncoder Description Regarding skipkeys Behavior #132021
… in keys of encode(...) method
|
Hi! This updates the docstring for |
Lib/json/encoder.py
Outdated
| @@ -108,7 +108,7 @@ def __init__(self, *, skipkeys=False, ensure_ascii=True, | |||
| """Constructor for JSONEncoder, with sensible defaults. | |||
|
|
|||
| If skipkeys is false, then it is a TypeError to attempt | |||
| encoding of keys that are not str, int, float or None. If | |||
| encoding of keys that are not bool, str, int, float or None. If | |||
There was a problem hiding this comment.
nitpick: json.dumps uses the order "str, int, float, bool, None" in its docstring and docs, so we might as well use the same order here for consistency
| @@ -486,8 +486,8 @@ Encoders and Decoders | |||
| (to raise :exc:`TypeError`). | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
Why change the spacing, the change is unrelated and it is consistent with the file?
There was a problem hiding this comment.
Reverted in 1b782e3
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.