Improve "override" error output
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 20.6k
- Forks
- 3.3k
- Métriques de merge des PR
- Métriques de PR en attente
Description
(Opening a new issue for this as discussed in #12390.)
Live demo: https://mypy-play.net/?mypy=latest&python=3.10&flags=strict&gist=d3e1a06857e4c6f1c698b7fa89e22f40
Example code:
import typing as t
class A:
@t.overload
def pop(self) -> int: ...
@t.overload
def pop(self, d: int = ...) -> int: ...
def pop(self, d: int = ...) -> int: ...
class B(A):
@t.overload
def pop(self) -> int: ...
@t.overload
def pop(self, d: int) -> int: ...
def pop(self, d: int = ...) -> int: ...
Current mypy output:
main.py:14: error: Signature of "pop" incompatible with supertype "A"
main.py:14: note: Superclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int = ...) -> int
main.py:14: note: Subclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int) -> int
Found 1 error in 1 file (checked 1 source file)
It's somewhat helpful that mypy quotes the code in this error output, but it would be really helpful if mypy's output helped us zero in on exactly where the problem is, e.g.:
main.py:14: error: Signature of "pop" incompatible with supertype "A" in second overload
main.py:14: note: Superclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int = ...) -> int
^^^^^
main.py:14: note: Subclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int) -> int
Found 1 error in 1 file (checked 1 source file)
Note the addition of "in second overload" in the error message, as well as the all-important ^ arrows pointing to exactly where the supertype differs (namely, d should be a keyword argument). Without the arrows, it's harder to see in the output that the only difference is the = ... in the code for the superclass.
This is exacerbated when method signatures are more complex than this, e.g. MutableMapping.pop(), where the current output makes it even harder to spot where the problem is compared to this minimized example (see https://github.com/python/mypy/issues/12390#issuecomment-1073811096). It is also exacerbated by mypy ignoring the signature in the actual implementation, where d correctly appears as a keyword argument in the subclass. Finally, it can be exacerbated when upgrading to a mypy version that includes typeshed changes like this one: https://github.com/python/typeshed/pull/6941/commits/92438dcbe3e9e7720d9de56c6be0f0b5d2b14a2e#diff-b12c4be0f8e39f89957bbe7be6b6327185e18b69ea80a0f62c0746bb26f4a58eL478
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la démonstration en direct de mypy-play et par l’exemple de surcharge A/B fourni afin de reproduire le diagnostic actuel. Suivez le diagnostic de la signature d’override et ses tests de formatage ; le travail est terminé lorsque la sortie identifie la surcharge différente, indique la discordance et conserve le contexte de comparaison existant.
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é
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 28/100