python / python/mypy

Redefinition of function arguments can give unclear error message

Ouverte
#17,439 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug
Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Métriques de merge des PR
Métriques de PR en attente

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la reproduction Python fournie et exécutez-la avec mypy 1.10.0 afin d’observer l’erreur actuelle de valeur de retour. Suivez le diagnostic existant [no-redef] pour les redéfinitions ordinaires et déterminez où sont traitées les redéfinitions de paramètres de fonction. Le travail est terminé lorsque l’exemple signale le nom du paramètre et sa ligne de déclaration avec un diagnostic clair.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.