python / python/cpython

Improve visibility of key type coercion limitation in json module docs

Ouverte
#137,533 0 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs stdlib
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

Hi team,

I’d like to suggest enhancing the JSON module documentation by placing the warning about non‑string dictionary keys being coerced to strings more prominently, ideally at the very beginning of the module overview or in a shared introductory note.

Currently, that note appears under json.dumps() and reads:

“Keys in key/value pairs of JSON are always of the type str. When a dictionary is converted into JSON, all the keys of the dictionary are coerced to strings. As a result of this, if a dictionary is converted into JSON and then back into a dictionary, the dictionary may not equal the original one. That is, loads(dumps(x)) != x if x has non‑string keys.”
docs.python.org/3/library/json.html#json.dumps

Even though it's technically accurate, it's tucked away in a method-specific section. Given how fundamental this behavior is—and how easy it is to overlook—it should be surfaced at the module level, so users understand that it applies to both dump() and dumps().


Why it matters

The JSON standard (RFC 7159) explicitly states:

“An object is an unordered collection of zero or more name/value pairs, where a name is a string and a value is a string, number, boolean, null, object, or array.”
— RFC 7159 §1
https://datatracker.ietf.org/doc/html/rfc7159#section-1

While this is unambiguous, not all Python users are aware of the JSON RFC, and it's not realistic to expect them to be. Many developers rely solely on Python's documentation as their interface to the JSON format. That's why it's crucial that the behavior of coercing non-string keys is clearly stated up front—before diving into function-specific details.

This helps avoid silent bugs where json.loads(json.dumps(x)) != x, and removes the expectation that dicts with int or bool keys will round-trip without transformation.


@facundobatista — would you mind taking a look?

Linked PRs
  • gh-137545

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la documentation du module JSON de Python et par l’avertissement existant dans la section consacrée à json.dumps(). Faites apparaître l’avertissement concernant la coercition des clés de dictionnaire qui ne sont pas des chaînes dans la présentation du module ou l’introduction commune, en précisant qu’il s’applique à la fois à dump() et à dumps() ; la documentation est terminée lorsque ce comportement est visible avant les détails propres à chaque fonction.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.