python / python/mypy

Opt-in error for `if x:` when `x: None | int` or `None | str` etc.

Aperta
#17,892 1 commento 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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 like bug(""))

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando l’implementazione incompleta nella pull request 17893 insieme agli esempi bug e fixed dell’issue. Traccia il modo in cui mypy restringe attualmente None | str e None | int nei controlli di truthiness, quindi determina il comportamento della diagnostica opzionale e la sua gestione dei built-in, dei tipi truthy e delle variabili di tipo. Il lavoro è completato quando i casi concordati vengono diagnosticati senza richiedere il controllo per impostazione predefinita.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.