python / python/mypy

`TypeGuard` has no effect when nested in the presence of other problems

Offen
#17,138 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug Report

A TypeGuard declared and used near the top of a function is sometimes rendered ineffective (i.e., there is no change to the type of the first argument to the TypeGuard even when the TypeGuard returns True), but only when there is an apparently-unrelated mypy-detectable problem later in the same function.

The problem does not occur if the TypeGuard definition is not nested within an outer function, or if the apparently-unrelated problem is corrected.

Because any erroneous errors triggered by this bug appear above the triggering problem in the error report, users will find it difficult to solve this issue if they approach the problem using a [run mypy, fix first issue, repeat] workflow.

To Reproduce

[mypy-play.net]

from __future__ import annotations
from typing_extensions import (
        TypeGuard,
        assert_type,
        )

def some_func(arg: object) -> None:
    '''must encapsulate the following in a func, or issue won't repro
    '''
    def tg_int(arg: object) -> TypeGuard[int]:
        '''must be nested: issue won't repro if decl'd at module scope'''
        b: bool
        return b

    # replacing 'arg' with a local var works just as well
    if tg_int(arg):                                                     # line 16
        assert_type(arg, int)                                           # line 17
                # expected: no error
                # got: [assert-type]
                #   "Expression is of type 'object', not 'int'"

    # this is wrong, but removing it causes the unexpected error to
    # vanish:
    var1 = non_existant_var  # type: ignore[name-defined]

Expected Behavior

The TypeGuard invocation at line 16 should change the type of arg to int when the if statement's condition is truthy. The assert_type() on line 17 should pass.

Actual Behavior

The TypeGuard has no effect on the type of its argument.

Your Environment

  • Mypy version used: 1.9.0, master (as provided by mypy-play.net as of 2024-04-17)
  • Mypy command-line flags: (none necessary)
  • Mypy configuration options from mypy.ini (and other config files): none
  • Python version used: 3.8, 3.12

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem verlinkten mypy-play.net-Reproducer und führe ihn gegen mypy 1.9.0 oder master aus. Untersuche, warum der verschachtelte TypeGuard arg nicht eingrenzt, wenn der spätere name-defined-Fehler vorhanden ist; abgeschlossen ist dies, wenn die assert_type(arg, int)-Prüfung erfolgreich ist, während der spätere Fehler weiterhin ignoriert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.