python / python/mypy

@property returning descriptor instance triggers false positive

Abierto
#9,416 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

🐛 Bug Report

Accessing a field implementing the descriptor protocol via a property method causes MyPy to complain that there is no matching overload for __get__().

To Reproduce

Run MyPy with all default settings on the following code:

from typing import Optional
from typing import overload
from typing import Type

class A:
    pass

class Field:
    def __init__(self, attr: Optional["Field"] = None):
        self.attr = attr

    @property
    def crashing_property(self) -> Optional["Field"]:
        return self.attr

    @overload
    def __get__(self, instance: None, owner: Type["A"]) -> "Field":
        ...

    @overload
    def __get__(self, instance: "A", owner: Type["A"]) -> Optional["Field"]:
        ...

    def __get__(self, instance, owner):
        if not instance:
            return self
        return self.attr

f = Field()  # type: Field
f.attr  # Works fine
f.crashing_property  # Triggers "no overload variant"

n.b. adding __set__() makes no difference

Expected Behavior

Accessing crashing_property shouldn't cause an error.

Actual Behavior

The last line in the example throws the following error:

test.py:39: error: No overload variant of "__get__" of "Field" matches argument types "Field", "Type[Field]"
test.py:39: note: Possible overload variants:
test.py:39: note:     def __get__(self, instance: None, owner: Type[A]) -> Field
test.py:39: note:     def __get__(self, instance: A, owner: Type[A]) -> Optional[Field]

If you add this the code validates fine:

@overload
def __get__(self, instance: "Field", owner: Type["Field"]):
    ...

Your Environment

  • Mypy version used: 0.782, 0.800, 0.812, 0.910
  • Mypy command-line flags: None
  • Mypy configuration options from mypy.ini (and other config files): None, using all defaults
  • Python version used: CPython 3.7.7, 3.8.6, 3.9.1
  • Operating system and version: Ubuntu 20.04, MacOS 11.1 (Big Sur)

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 el reproductor de Python proporcionado con la configuración predeterminada de MyPy y confirma el error de overload falsamente positivo en el acceso a la propiedad. El trabajo estará terminado cuando ese acceso se valide sin requerir un overload get adicional para las instancias de Field, mientras el comportamiento existente del descriptor siga siendo válido.

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.