python / python/mypy

Enforce conditional values are booleans

Aperta
#16,734 9 commenti 12 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

A rule enforcing the strict use of boolean expressions in an if statement. It should be added to the "Miscellaneous strictness flags".

strict_conditional

    TYPE:
        boolean

    DEFAULT:
        False

    Enables or disables strict conditional checks. If True, `mypy` only allows boolean expressions in conditional expressions.

Pitch

I've encountered many hard-to-trace bugs due to non-boolean expressions used in conditionals. For instance, lists, containers, objects, or some literals being checked directly.

if [1,2,3]: # list is not a boolean value, will be treated as False if list is empty or None
    ...

if "Hello world": # str is not a boolean value, will be treated as False if string is empty or None
    ...

if None: # not a boolean, will be treated as False if None
    ...
    
if 2: # not a boolean, might be treated as false if it equals 0
    ...

Very often, the developer's intention was to perform a null-check, or sometimes, an emptiness check, but this syntax yields potential edge cases where the developer did not intend the conditional to yield False.

With strict_conditional enabled, all of the above scenarios should be flagged.

The below examples naturally should always be valid as the expression yields a boolean value.

if x < 0:
    ...

if isinstance(x, int):
    ...

if True:
    ...

if [1,2,3] is None:
    ....

if len({}) == 0:
    ....

This enforces explicit coding practices and better shows the intent of the developer.

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 individuando il controllo delle espressioni condizionali di mypy e la gestione della configurazione per i "Miscellaneous strictness flags". Aggiungi l'opzione strict_conditional proposta con valore predefinito False, imponi espressioni condizionali esclusivamente booleane quando è abilitata e copri con test i casi validi e non validi elencati.

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à
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.