python / python/mypy

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

Ouverte
#17,138 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug
Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Métriques de merge des PR
Métriques de PR en attente

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le reproducer mypy-play.net lié et exécutez-le avec mypy 1.9.0 ou master. Cherchez pourquoi le TypeGuard imbriqué ne restreint pas arg lorsque l’erreur name-defined ultérieure est présente ; c’est terminé lorsque la vérification assert_type(arg, int) réussit tandis que l’erreur ultérieure reste ignorée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.