8000 Inconsistency in json.JSONEncoder Description Regarding skipkeys Behavior · Issue #132021 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Inconsistency in json.JSONEncoder Description Regarding skipkeys Behavior #132021

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

Jump to bottom
Closed
mouchen626 opened this issue Apr 2, 2025 &m 8000 iddot; 3 comments
Closed

Inconsistency in json.JSONEncoder Description Regarding skipkeys Behavior #132021

mouchen626 opened this issue Apr 2, 2025 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@mouchen626
Copy link
mouchen626 commented Apr 2, 2025 •
edited by bedevere-app bot
Loading

If skipkeys is false (the default), a TypeError will be raised when trying to encode keys that are not str, int, float or None. If skipkeys is true, such items are simply skipped.

However, boolean values (True and False) can be used as dictionary keys without raising a TypeError. I think this is a mistake.

json.JSONEncoder(skipkeys=False).encode({True:1})

Linked PRs
@ericvsmith ericvsmith added the docs Documentation in the Doc dir label Apr 2, 2025
@ericvsmith
Copy link
Member

bools are ints, so the statement is technically true.

>>> isinstance(True, int)
True
>>> isinstance(False, int)
True

Although maybe it makes sense to add bool to the list of types.

@mouchen626
Copy link
Author

Thank you, I understand. I noticed that the description of json.dump includes bool. It would be better to keep it consistent.

skipkeys (bool) – If True, keys that are not of a basic type (str, int, float, bool, None) will be skipped instead of raising a TypeError. Default False.

@brianschubert
Copy link
Contributor

Seems good - would you like to put up a PR?

srinivasreddy added a commit to srinivasreddy/cpython that referenced this issue Apr 3, 2025
@srinivasreddy
pythongh-132021: Add bool type to the list of types that were allowed…
a1e77cd 
… in keys of encode(...) method
@bedevere-app bedevere-app bot mentioned this issue Apr 3, 2025
Merged
ericvsmith added a commit to srinivasreddy/cpython that referenced this issue Apr 7, 2025
@ericvsmith
Merge branch 'main' into pythongh-132021
a4958a9
ericvsmith added a commit to srinivasreddy/cpython that referenced this issue Apr 7, 2025
@ericvsmith
Merge branch 'main' into pythongh-132021
d26c614
hugovk pushed a commit that referenced this issue Apr 8, 2025
@srinivasreddy @ericvsmith
gh-132021: Add bool type to the list of allowed JSON key types (#132048)
403886c 
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 8, 2025
@srinivasreddy @ericvsmith @miss-islington
pythongh-132021: Add bool type to the list of allowed JSON key types (p…
2fa19d2 
…ythonGH-132048)

(cherry picked from commit 403886c)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 8, 2025
@srinivasreddy @ericvsmith @miss-islington
pythongh-132021: Add bool type to the list of allowed JSON key types (p…
4b6248a 
…ythonGH-132048)

(cherry picked from commit 403886c)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
This was referenced Apr 8, 2025
Merged
Merged
@hugovk hugovk closed this as completed Apr 8, 2025
hugovk pushed a commit that referenced this issue Apr 8, 2025
@miss-islington @srinivasreddy @ericvsmith
[3.12] gh-132021: Add bool type to the list of allowed JSON key types (…
aab69a8 
…GH-132048) (#132256)

gh-132021: Add bool type to the list of allowed JSON key types (GH-132048)
(cherry picked from commit 403886c)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
hugovk pushed a commit that referenced this issue Apr 8, 2025
@miss-islington @srinivasreddy @ericvsmith
[3.13] gh-132021: Add bool type to the list of allowed JSON key types (…
5aa7aeb 
…GH-132048) (#132255)

gh-132021: Add bool type to the list of allowed JSON key types (GH-132048)
(cherry picked from commit 403886c)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
@srinivasreddy @ericvsmith @seehwan80
pythongh-132021: Add bool type to the list of allowed JSON key types (p…
564688d 
…ython#132048)

Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ericvsmith @hugovk @brianschubert @mouchen626
0