Skip to content
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

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 6 commits into from
+4 −4

Conversation

srinivasreddy
Copy link
Contributor

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

@bedevere-app bedevere-app bot mentioned this pull request Apr 3, 2025
Open
@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

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

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianschubert brianschubert brianschubert left review comments

@StanFromIreland StanFromIreland StanFromIreland left review comments

@ericvsmith ericvsmith ericvsmith approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@srinivasreddy @brianschubert @ericvsmith @StanFromIreland