Unexpected Overloading overlap if String Literal is used within Sequence/Iterable/Collection
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 20.6k
- Forks
- 3.3k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
Bug Report
If I have a function that accepts a String Literal and Sequence of String Literal and want to overload this function for these two cases, mypy always returns:
Overloaded function signatures 1 and 2 overlap with incompatible return types [misc]
from typing import overload, Literal
@overload
def over(bar: Literal["bar"]) -> int: # Overloaded function signatures 1 and 2 overlap with incompatible return types [misc]
...
@overload
def over(bar: Sequence[Literal["foo"]]) -> str:
...
def over(bar: Literal["bar"]|Sequence[Literal["foo"]]) -> str|int:
if bar == "bar":
return 0
return ", ".join(bar)
To Reproduce
https://mypy-play.net/?mypy=latest&python=3.11&gist=d28d528c0765dc0a4a004c360a4008a4
Expected Behavior
No error, as if we would use a list instead:
@overload
def load(bar: Literal["bar"]) -> int:
...
@overload
def load(bar: list[Literal["foo"]]) -> str:
...
def load(bar: Literal["bar"]|list[Literal["foo"]]) -> str|int:
if bar == "bar":
return 0
return ", ".join(bar)
Actual Behavior
Mypy returns:
Overloaded function signatures 1 and 2 overlap with incompatible return types [misc]
Your Environment
MyPy playground....
- Mypy version used: 1.20
- Mypy command-line flags: none
- Mypy configuration options from
mypy.ini(and other config files): none - Python version used: tested with 3.10 and 3.11
Note
I am aware that a str is also a Sequence[str]. But as we using literals here, this shouldn't matter.
This is only an issue for mypy if used with overloads, it works correctly if simply used within a function
# Simple example, that if we use Sequences and Literals, mypy
# can determine stuff correctly
def foo(bar: Literal["bar"]|Sequence[Literal["foo"]]) -> None:
return None
foo("bar") # okay
foo(["foo"]) # okay
foo("foo") # not okay - as expected
foo(["bar"]) # not okay - as expected
Note that pyright does detect the overloads correctly (kind of).
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza ejecutando la reproducción enlazada de mypy-play y compara los ejemplos de overload usando Sequence, Iterable, Collection y list con las comprobaciones finales de las llamadas a funciones. Rastrea la compatibilidad de los overloads y el manejo de Literal implicados en el diagnóstico informado. Se considera terminado cuando los overloads válidos de String Literal y de secuencias ya no producen un error de solapamiento incompatible, mientras que las llamadas no válidas siguen siendo rechazadas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- compilers, devtools
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100