python / python/mypy

Enable --pretty by default

Aperta
#19,108 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature topic-usability
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Merge medio
1g 18h
PR unite (30g)
54

Descrizione

Feature

Enable --pretty by default. --no-pretty can still be used to get more concise error messages (it already works, so no need to implement it).

--pretty causes mypy to show the line with the error, and mypy will highlight the location on the line where the error was reported:

foo.py:13: error: List item 0 has incompatible type "str"; expected "int"  [list-item]
    aa = ["x"]
          ^~~

Also update documentation, including relevant command-line examples which show the error output from mypy.

Pitch

The additional context makes it easier to see what is wrong. For example, there may be multiple possible expressions which can generate the error, and the highlighting makes this obvious.

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 individuando la gestione della riga di comando per l'opzione --pretty esistente e gli esempi nella documentazione che mostrano l'output degli errori di mypy. Rendi --pretty l'impostazione predefinita mantenendo il comportamento esistente di --no-pretty, quindi aggiorna gli esempi interessati e verifica che il loro output corrisponda alla nuova impostazione predefinita.

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

Valutazione

Stack tecnologico
python
Ambito
cli, documentation
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.