python / python/mypy

@overload doesn't work with @asynccontextmanager

Abierto
#17,340 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug
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 trying to annotate overloads for an asynccontextmanager, I think mypy incorrectly reports an invalid return type.

To Reproduce

from contextlib import asynccontextmanager, contextmanager
from typing import AsyncIterator, Iterator, overload

@overload
@asynccontextmanager
async def test_async() -> AsyncIterator[int]: ...


@overload
@asynccontextmanager
async def test_async(val: int = ...) -> AsyncIterator[int]: ...


@asynccontextmanager
async def test_async(val: int = 1) -> AsyncIterator[int]:
    yield val


@overload
@contextmanager
def test_sync() -> Iterator[int]: ...


@overload
@contextmanager
def test_sync(val: int = ...) -> Iterator[int]: ...


@contextmanager
def test_sync(val: int = 1) -> Iterator[int]:
    yield val

This gives an error of "Argument 1 to "asynccontextmanager" has incompatible type "Callable[[int], Coroutine[Any, Any, AsyncIterator[int]]]"; expected "Callable[[int], AsyncIterator[Never]]"

Where the synchronous version checks fine.

Expected Behavior

I expect the async version to work the same as the sync version

Actual Behavior

Mypy reports and error

mypy test.py
test.py:5: error: Argument 1 to "asynccontextmanager" has incompatible type "Callable[[], Coroutine[Any, Any, AsyncIterator[int]]]"; expected "Callable[[], AsyncIterator[Never]]"  [arg-type]
test.py:10: error: Argument 1 to "asynccontextmanager" has incompatible type "Callable[[int], Coroutine[Any, Any, AsyncIterator[int]]]"; expected "Callable[[int], AsyncIterator[Never]]"  [arg-type]
Found 2 errors in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: 1.10.0
  • Mypy command-line flags: mypy test.py
  • Mypy configuration options from mypy.ini (and other config files):
  • Python version used: Python 3.11.4

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

Comienza ejecutando la reproducción proporcionada en test.py con mypy y compara los casos de asynccontextmanager y contextmanager. Rastrea la comprobación de tipos de estos decoradores, luego añade una prueba de regresión que cubra funciones asynccontextmanager sobrecargadas y verifica que mypy no informe de errores para el comportamiento corregido.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.