python / python/mypy

Variable assigned in branches of an if statement is considered as being redefined

Aperta
#17,529 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Bug Report

The same variable assigned in different branches of an if statement is considered as being redefined, despite the fact that at in reality there is only one assignment being performed, it's just unknown at that stage which branch will be taken.

To Reproduce

from io import BytesIO
from typing import ClassVar

class IntegerAdapter:
    _size_: ClassVar[int] = 4

    @classmethod
    def from_wire(cls, buffer: bytes | bytearray | memoryview | BytesIO) -> int:
        if isinstance(buffer, BytesIO):
            data = buffer.read(cls._size_)
        else:
            data = buffer[:cls._size_]
        return int.from_bytes(data, byteorder='big', signed=True)

Expected Behavior

I would expect mypy to infer the type of the variable as the union of the types in all branches. This is not really a redefinition since the variable is not assigned twice in succession, only one branch is taken, it's just unknown which one.
Using --allow-redefinition doesn't help as one of the requirements for that is to read the variable before the next assignment, which is impossible.

Also the behavior is inconsistent with different ways of writing the if statement. Inverting the condition and reversing the branches makes the error go away. So does using an equivalent conditional expression.

Any of the following ways to rewrite the if statement will eliminate the error, but one should not have to retort to such gimmicks to avoid this.

        # this works because the 1st assignment is the one with a wider type that includes the type of the 2nd
        if not isinstance(buffer, BytesIO):
            data = buffer[:cls._size_]
        else:
            data = buffer.read(cls._size)

        # this works because the type is correctly inferred to be the union of the branch types
        data = buffer.read(cls._size_) if isinstance(buffer, BytesIO) else buffer[:cls._size_]

IMO the conditional statement is the only one that behaves correctly here as it infers the type as the union of the two.
But semantically the if-else and the conditional statement are the same, just differently written: take one branch and assign computed value to the variable.

Actual Behavior

typing-6.py:14: error: Incompatible types in assignment (expression has type "bytes | bytearray | memoryview", variable has type "bytes")  [assignment]
Found 1 error in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: mypy 1.12.0+dev.6a0657e5959ba1777c4d427f8f355d499035d145 (compiled: no)
  • Mypy command-line flags: with or without --allow-redefinition, makes no difference
  • Mypy configuration options from mypy.ini (and other config files):
[tool.mypy]
enable_incomplete_feature = "NewGenericSyntax"
disable_bytearray_promotion = true
disable_memoryview_promotion = true
check_untyped_defs = true
warn_unreachable = true
warn_redundant_casts = true
warn_unused_ignores = true
  • Python version used: 3.12

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 eseguendo il reproducer Python fornito con mypy e la configurazione mostrata, confrontando la forma if-else con l’espressione condizionale equivalente. Traccia come vengono verificate le assegnazioni nei rami e fai in modo che il caso if-else inferisca l’unione senza segnalare una ridefinizione incompatibile; verifica che il reproducer termini senza errori.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.