python / python/mypy

Method overloads ignored when dispatched via protocols

Abierto
#9,464 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Bug Report

At the moment I'm dealing with a number of numpy functions which, effectively, serve as wrappers
around a set of matching ndarray methods. Taking a simplified version of argmax as example,
a custom SupportsArgmax Protocol is herein used for dispatching the internals of the argmax
function to the ndarray.argmax method.

As it turns out, this works perfectly fine when the ndarray.argmax mods does not contain any
overloads, but when it does then any overloads beyond the first are ignored.

from typing import Protocol, overload, TypeVar

# Step 1: Define the class
class ndarray:
    @overload
    def argmax(self, axis: None) -> int: ...
    @overload
    def argmax(self, axis: int) -> ndarray: ...


# Step 2: Define a Protocol for describing the classes' argmax method
T_contra = TypeVar("T_contra", contravariant=True)
T_co = TypeVar("T_co", covariant=True)

class SupportsArgmax(Protocol[T_contra, T_co]):
    def argmax(self, axis: T_contra) -> T_co: ...


# Step 3: Define a wrapper function around the classes' argmax method
T1 = TypeVar("T1")
T2 = TypeVar("T2")

def argmax(a: SupportsArgmax[T1, T2], axis: T1) -> T2: ...

Now, when an ndarray instance is passed to the argmax function I'd expect the
return type to be int if axis=None and ndarray if axis=int(...), just as is
described in the ndarray.argmax method:

array: ndarray

# note: Revealed type is 'builtins.int*'
reveal_type(argmax(array, axis=None))

# error: Cannot infer type argument 1 of "argmax"
# note: Revealed type is 'Any'
reveal_type(argmax(array, axis=0))

As can be seen above, the expected behavior is indeed observed when passing
through the first ndarray.argmax overload, but the presence of any subsequent
overloads seems to be ignored. Swapping the two overloads in the original
ndarray.argmax method only serves to reverse the issue.

Expected Behavior

Mypy successfully infers the return type, regardless of whether the protocol should
extract it from the methods' first overload or any subsequent ones.

Actual Behavior

Mypy fails for any method overload overload beyond the first.

Your Environment

  • Mypy version used: mypy 0.782
  • Mypy command-line flags: --show-error-codes (including or excluding --strict makes no difference here)
  • Mypy configuration options from mypy.ini (and other config files): n.a.
  • Python version used: Python 3.8.5
  • Operating system and version: macOS 10.15.6

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 reproduciendo con mypy el ejemplo mínimo de Protocol y ndarray.argmax sobrecargado del issue, comprobando ambas llamadas a reveal_type y el error de inferencia informado. Sigue la ruta de comprobación de tipos para la compatibilidad de los métodos de Protocol y la selección de métodos sobrecargados. Se considera terminado cuando tanto las llamadas con axis=None como las llamadas con un eje entero infieran los tipos de retorno descritos en los overloads.

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
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.