python / python/mypy

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

Abierto
#17,868 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug topic-type-context
Lenguaje dominante
Python
Estrellas
20.6k
Forks
3.3k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza ejecutando el reproductor mínimo con mypy 1.11.2 y compara los casos de Union/Tuple/List sin envolver con func_fail1 y func_fail2. Lee el issue #3351 para consultar el comportamiento relacionado y, después, sigue el recorrido de comprobación de tipos para las expresiones Union y Tuple anidadas; el trabajo estará terminado cuando los casos indicados pasen de forma consistente con una prueba de regresión.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
compilers
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.