python / python/mypy

Improve "override" error output

Aperta
#12,466 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

diagnostics topic-error-reporting topic-inheritance topic-usability
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

(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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con la demo live di mypy-play e con l’esempio di overload A/B fornito per riprodurre la diagnostica attuale. Segui la diagnostica della firma di override e i relativi test di formattazione; il lavoro è completo quando l’output identifica l’overload differente, indica la mancata corrispondenza e conserva il contesto di confronto esistente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
28/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.