python / python/mypy

Cast for input function monkey-patch doesn't fix things as expected type changes

Abierto
#17,519 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

I'm writing code that monkey-patches the built-in input function, like so:

import builtins

def f(x: str) -> str:
    print(x)
    return 'hi'

builtins.input = f

print(input('what'))  # prints 'what' and then 'hi'

MyPy reasonably gives me a type error on the assignment to input, saying:

t.py:7: error: Incompatible types in assignment (expression has type "Callable[[str], str]", variable has type "Callable[[object], str]")  [assignment]
Found 1 error in 1 file (checked 1 source file)

Okay, fine so I change my code like this, exactly matching the reported variable type:

import builtins

from typing import cast, Callable

def f(x: str) -> str:
    print(x)
    return 'hi'

builtins.input = cast(Callable[[object], str], f)

print(input('what'))  # prints 'what' and then 'hi'

I'm now casting to exactly what the error message said was expected. However, I still get a mypy error on the same line, and the expected type has changed:

t.py:9: error: Incompatible types in assignment (expression has type "Callable[[object], str]", variable has type "Callable[[DefaultArg(object)], str]")  [assignment]
Found 1 error in 1 file (checked 1 source file)

Looking it up, it seems like DefaultArg is from mypy_extensions? That wasn't obvious, but I can get this to work by doing:

import builtins

from typing import cast, Callable
from mypy_extensions import DefaultArg

def f(x: str) -> str:
    print(x)
    return 'hi'

builtins.input = cast(Callable[[DefaultArg(object)], str], f)

print(input('what'))  # prints 'what' and then 'hi'

To Reproduce

Run the code snippets provided above through mypy by saving them to a file and running mypy filename.

Expected Behavior

If I cast to the type that the error message says it needs, then the type error should go away.

If an "optional extensions" type is required to correctly type code dealing with a core built-in function, it should be mentioned somewhere in the python.org core documentation maybe? I first turned to searching docs.python.org to figure out what DefaultArg was so I could figure out where to import it from, but there are zero hits. Web searches without careful quoting are near useless, since modern search engines find all sorts of conversations about default arguments that have nothing to do with mypy. Thankfully I was clued in enough to search my mypy documentation pages and finally found it. I realize this may not be fixable, but maybe some kind of reminder could be included in the error message when DefaultArg is required?

The minimal correct fix here should be for the original error message to include DefaultArg in the expected type, since defining a function which has no default for its first argument and setting that as input will cause crashes for people who expect the usual behavior.

Actual Behavior

First type error message is just wrong about the expected/required type.

Your Environment

  • Mypy version used: 1.8.0, so I upgraded to 1.10.1 (current latest) and have the exact same issue.
  • Mypy command-line flags: None
  • Mypy configuration options from mypy.ini (and other config files): none specified
  • Python version used: 3.11.8

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

Reproduce el problema guardando los snippets proporcionados y ejecutando mypy sin flags de línea de comandos ni configuración. Empieza rastreando cómo se representan la firma integrada de input y DefaultArg en el error de asignación; estará hecho cuando el diagnóstico inicial informe de la forma requerida de DefaultArg y ya no sugiera un cast insuficiente.

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

Evaluación

Stack tecnológico
python
Área
tooling
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 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.