Skip to content

gh-146440: Add an example for the json array_hook decoder parameter#154522

Open
fedonman wants to merge 1 commit into
python:mainfrom
fedonman:docs-json-array-hook-example
Open

gh-146440: Add an example for the json array_hook decoder parameter#154522
fedonman wants to merge 1 commit into
python:mainfrom
fedonman:docs-json-array-hook-example

Conversation

@fedonman

Copy link
Copy Markdown
Contributor

The array_hook parameter added to the JSON decoders in gh-146440 has version notes but no example, while the "Customizing JSON object decoding" section only shows object_hook and parse_float.

This adds two short examples there: one turning every JSON array into a tuple, and one pairing array_hook with object_pairs_hook to get a deeply immutable result, which is the use case the JSONDecoder docstring already describes. Both are marked # doctest: +SKIP, since the parameter needs Python 3.15 or later and the docs are often built with an older interpreter.

While there, it fixes a small wording slip in the array_hook parameter description ("decoded with as a Python list") and a typo ("structute") in the JSONDecoder docstring.

Documentation only, so there is no news entry.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33718809 | 📁 Comparing 3b3efc6 against main (206788a)

  🔍 Preview build  

1 file changed
± library/json.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant