python / python/mypy

Inconsistent "Incompatible return type" error when `List[int]` is returned for `List[Union[str, int]]` when layered up with Tuple/Union

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

Personne n'a encore pris cette issue.

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

Description

Bug Report

When layering up some Union/Tuple checks, at some point the type checking suddenly gets a lot more strict and starts failing, as if it's unable to fully parse the type checks anymore.

It's possibly related to this, but it doesn't explain why the behaviour changes only once it's wrapped under other things: https://github.com/python/mypy/issues/3351

To Reproduce

Here's a minimal reproducible example that shows how it works fine until it suddenly doesn't.

from typing import Union, Tuple, List

# Just to reduce the noise
S = Union[int, str]
L = List[S]

# It works with `([int],)`
def func_works1() -> Tuple[L]:
    return [1],
    
# It works with `([int, str],)`
def func_works2() -> Tuple[L]:
    return [1, 'a'],

# It works with `int | [int]`
def func_works3() -> Union[S, L]:
    return [1]

# It works with `(int,) | ([int],)` if returning (int,)
def func_works4() -> Union[Tuple[S], Tuple[L]]:
    return 1,

# It fails with `(int,) | ([int],)` if returning ([int],)
def func_fail1() -> Union[Tuple[S], Tuple[L]]:
    return [1],
main.py:21: error: Incompatible return value type (got "tuple[list[int]]", expected "tuple[int | str] | tuple[list[int | str]]")  [return-value]

# It fails with `(int,) | ([int],)` if returning ([int, str],)
def func_fail2() -> Union[Tuple[S], Tuple[L]]:
    return [1, 'a'],
main.py:25: error: Incompatible return value type (got "tuple[list[object]]", expected "tuple[int | str] | tuple[list[int | str]]")  [return-value]

https://mypy-play.net/?mypy=latest&python=3.12&gist=9477b2d4dab01919bef1aa6d2911f648

Expected Behavior

It passes the test.

Actual Behavior

In the code above. It complains that List[int] is not a valid List[Union[int | str]]. According to the issue linked above, this may not be wrong, but the behaviour is inconsistent as to when it flags it as wrong.

Your Environment

  • Mypy version used: 1.11.2
  • Mypy command-line flags: None
  • Mypy configuration options from mypy.ini (and other config files): I just run py -m mypy without any config files.
  • Python version used: 3.7, 3.11

Edit
This is nothing to do with the bug report, but in case anyone finds this issue with a similar use case, this is the fully working solution I've ended up with:

S = Union[int, str]
T = TypeVar('T', S, List[S])
FuncType = Tuple[T, T]

def func() -> FuncType:
   return a, b

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 exécuter le reproducteur minimal avec mypy 1.11.2 et comparez les cas Union/Tuple/List non enveloppés avec func_fail1 et func_fail2. Lisez l’issue #3351 pour le comportement associé, puis suivez le chemin de vérification des types pour les expressions Union et Tuple imbriquées ; le travail est terminé lorsque les cas signalés passent systématiquement avec un test de régression.

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é
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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