Skip to content

gh-132021: Add bool type to the list of allowed JSON key types #132048

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
Merged
merged 6 commits into from
Apr 8, 2025
Merged

gh-132021: Add bool type to the list of allowed JSON key types #132048

merged 6 commits into from
Apr 8, 2025
+4 −4

Conversation

srinivasreddy
Copy link
Contributor

@srinivasreddy srinivasreddy commented Apr 3, 2025 •
edited by bedevere-app bot
Loading

@srinivasreddy
pythongh-132021: Add bool type to the list of types that were allowed…
Loading
Loading status checks…
a1e77cd 
… in keys of encode(...) method
@bedevere-app bedevere-app bot mentioned this pull request Apr 3, 2025
Closed
@brianschubert
Copy link
Contributor

Hi! This updates the docstring for JSONEncoder.__init__ (i.e. what's shown by help(json.JSONEncoder)). Technically gh-132021 is about this passage from the docs, not the docstring, but it doesn't hurt to clarify the docstring as well. Can you make a similar change to the docs passage in Doc/library/json.rst?

brianschubert
brianschubert reviewed Apr 3, 2025
View reviewed changes
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@srinivasreddy
Updated documentation as well
Loading
Loading status checks…
ce8c920
@srinivasreddy
Address review comments
Loading
Loading status checks…
4008114
@srinivasreddy
Revert the spacing
Loading
Loading status checks…
1b782e3
ericvsmith
ericvsmith approved these changes Apr 3, 2025
View reviewed changes
Copy link
Member

@ericvsmith ericvsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@python-cla-bot
Copy link

python-cla-bot bot commented Apr 6, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@ericvsmith
Merge branch 'main' into pythongh-132021
Loading
Loading status checks…
a4958a9
@picnixz picnixz changed the title gh-132021: Add bool type to the list of types that were allowed in keys of encode(...) method gh-132021: Add bool type to the list of allowed JSON key types Apr 7, 2025
@ericvsmith
Merge branch 'main' into pythongh-132021
Loading
Loading status checks…
d26c614
@hugovk hugovk merged commit 403886c into python:main Apr 8, 2025
39 checks passed
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Apr 8, 2025
@miss-islington-app
Copy link

Thanks @srinivasreddy for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @srinivasreddy for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 8, 2025
@srinivasreddy @ericvsmith @miss-islington
pythongh-132021: Add bool type to the list of allowed JSON key types (p…
Loading
Loading status checks…
2fa19d2 
…ythonGH-132048)

(cherry picked from commit 403886c)

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

(cherry picked from commit 403886c)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <[email protected]>
Co-authored-by: Eric V. Smith <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Apr 8, 2025

GH-132255 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 8, 2025
@bedevere-app
Copy link

bedevere-app bot commented Apr 8, 2025

GH-132256 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Apr 8, 2025
@srinivasreddy srinivasreddy deleted the gh-132021 branch April 8, 2025 08:39
hugovk pushed a commit that referenced this pull request Apr 8, 2025
@miss-islington @srinivasreddy @ericvsmith
[3.12] gh-132021: Add bool type to the list of allowed JSON key types (…
Loading
Loading status checks…
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 (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <[email protected]>
Co-authored-by: Eric V. Smith <[email protected]>
hugovk pushed a commit that referenced this pull request Apr 8, 2025
@miss-islington @srinivasreddy @ericvsmith
[3.13] gh-132021: Add bool type to the list of allowed JSON key types (…
Loading
Loading status checks…
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 (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <[email protected]>
Co-authored-by: Eric V. Smith <[email protected]>
seehwan pushed a commit to seehwan/cpython that referenced this pull request 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianschubert brianschubert

@StanFromIreland StanFromIreland

@ericvsmith ericvsmith

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@srinivasreddy @brianschubert @ericvsmith @StanFromIreland @hugovk