Opt-in error for `if x:` when `x: None | int` or `None | str` etc.
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 20.6k
- Forks
- 3.3k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Feature
The bug function below has a bug: the else branch will execute both when x is None and when it is empty, and the latter is unexpected. The programmer was hoping "" would be handled by the if branch.
It'd be handy if Mypy could (optionally) flag this sort of mistake, to help reminder the programmer that they probably should write something like fixed, i.e. take optional values like None | str as expressing intent that "" should behave differently to None.
def bug(x: None | str):
if x: # error: None and str
print(f"the str value is {x}")
else:
print("the value is None")
def fixed(x: None | int):
if x is not None: # no error
print(f"the int value is {x}")
else:
print("the value is None")
This also applies to:
- built-ins like
bool,float,int,list,dict,set(etc) - any "truthy" types, that implement
__bool__or__len__ - arguably, type variables that could be substituted with any of those types (e.g.
def bug[T](x: None | T)called likebug(""))
Pitch
It's very easy to write if x: out of habit when handling strings, lists and any other type with falsey values. When None is involved, this can lead to unexpected behaviour, where the falsey values like [], 0, "", {} are handled like None.
Mypy is very well positioned to catch this mistake given it has full type info (and indeed linters without full type info cannot do so).
This is likely to have some false-positives, and so should be optional. It feels conceptually similar, to me, to truthy-bool.
I've sketched an incomplete implementation in https://github.com/python/mypy/pull/17893, that I can complete with agreement/guidance.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner l’implémentation incomplète de la pull request 17893 avec les exemples bug et fixed de l’issue. Suivez la manière dont mypy restreint actuellement None | str et None | int dans les tests de truthiness, puis déterminez le comportement du diagnostic optionnel et sa gestion des built-ins, des types truthy et des variables de type. Le travail est terminé lorsque les cas convenus sont diagnostiqués sans que la vérification soit requise par défaut.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- devtools
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100