python / python/mypy

Redefinition of function arguments can give unclear error message

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

With

import typing
# simulate an untyped module function
def function() -> typing.Any:
    return []

def foo(var: list|str) -> list:
   # insert a lot of code so that it's totally unobvious that "var" is a function parameter
    var = function()
    return var

You get the output

$ mypy ./test2.py 
test2.py:8: error: Incompatible return value type (got "list[Any] | str", expected "list[Any]")  [return-value]
Found 1 error in 1 file (checked 1 source file)
$ mypy--version
mypy 1.10.0 (compiled: yes)

which is technically correct, as var was defined as list[Any] | str as a parameter. But if you don't realise that, say there is a ton of code between where that's defined and where the return value is, you are left looking at var = function(); return var and wondering why the heck function() has been inferred to return list[Any] | str.

For a "standard" redefinition a [no-redef] warning comes out making it fairly clear. It would be great if somehow it remembered function arguments too, and then put out for this case Name "var" already defined as function parameter on line 7 which would make this very clear.

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 con la reproducción de Python proporcionada y ejecútala con mypy 1.10.0 para observar el error actual del valor de retorno. Sigue el diagnóstico existente [no-redef] para las redefiniciones ordinarias y determina dónde se gestionan las redefiniciones de parámetros de función. Se considera terminado cuando el ejemplo informe del nombre del parámetro y de su línea de declaración con un diagnóstico claro.

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

Evaluación

Stack tecnológico
python
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 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.