python / python/cpython

Unify interpretation of values of environment variables and CLI options

Ouverte
#116,907 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

There is inconsistency in interpreting values of different environment variables that have equivalent of CLI options.

  • For some environment variables, defining them with any values (even empty) is interpreted as true.
  • For some environment variables, any values except 0 (including non-numbers and empty value) are interpreted as true. Only 0 is interpreted as false. For some of these variables it makes sense to set integer value > 1, but for other they are just booleans.
  • PYTHONUTF8 and PYTHON_GIL only accept "1" and "0". All other values are errors. Although the code for these two variables is very different.
  • PYTHON_FROZEN_MODULES only accepts "on" and "off". All other values are errors.
  • PYTHONCOERCECLOCALE has three state: "0", "warn" and... anything other.
  • Some environment variables has "0" as a special value, but PYTHON_CPU_COUNT uses "default".

There are similar things for corresponding CLI options which accept optional arguments.

Such diversity makes it difficult to document and use environment variables and CLI options. It can lead to subtle bugs if "0" is interpreted differently. An empty value of the environment variable can be the result of a hidden bug, but in most cases it is currently silently accepted and interpreted as true value.

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 inventorier les variables d’environnement et les options CLI équivalentes décrites dans l’issue, en comparant leur traitement actuel des valeurs vides, numériques, booléennes et invalides. Une politique d’interprétation convenue doit être définie avant l’implémentation. Le travail sera considéré comme terminé lorsque les variables d’environnement listées et les options CLI correspondantes suivront des règles cohérentes, y compris pour le traitement des valeurs invalides.

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

Évaluation

Stack technique
python
Domaine
cli
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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