Rifattorizzare, se qualcosa va storto
I messaggi dei test e cosa vogliono dire
I messaggi che vedrai di più in questo capitolo. Quasi tutti vengono dai test dello zip, e sono scritti per dire dove guardare, non come fare. Per ognuno: cosa leggi, cosa vuol dire, cosa fai.
| Leggi | Vuol dire | Cosa fai |
|---|---|---|
L'uscita è cambiata alla riga 9. poi prima: e adesso: | Il programma stampa qualcosa di diverso da prima. La riga prima: è la fotografia, adesso: è quello che stampa ora | Leggi le due righe una sopra l'altra: spesso cambia un carattere (un 6.0 al posto di 6, un testo ritoccato). Poi git diff per vedere cosa hai toccato. Se non lo trovi, git restore e rifai il passo più piccolo |
Manca l'a capo alla fine dell'ultima riga. | L'ultima print ha perso il suo a capo | Cerca un end="" o una print in meno alla fine |
L'uscita è più corta: manca la riga 1, … | Il programma non stampa più una riga che prima stampava. Per gli avvisi: non ne stampa ancora | Per gli avvisi, controlla che l'except ci arrivi e che la print abbia file=sys.stderr. Per lo stdout, git diff |
L'uscita è più lunga: c'è una riga 2 in più, … | Il programma stampa una riga in più | Una print di debug lasciata dentro, o un avviso finito su stdout |
L'uscita è cambiata alla riga 1. e adesso: è un avviso (Riga 18 ignorata: …) | L'avviso è finito su stdout, in cima al resoconto | print(…, file=sys.stderr): senza file=, la print scrive su stdout |
Importare biglietteria.py lo farebbe partire: c'è codice fuori dalle funzioni, riga 164 (una chiamata). | Il file ha del codice che parte da solo quando lo importi | Mettilo in una funzione (di solito main) e chiamalo dal blocco if __name__ == "__main__": |
Nomi di una o due lettere: ['d', 'f', …] | Restano delle variabili con nomi troppo corti | Quelle della lista: F2 e un nome che dice cosa contengono |
Numeri senza un nome (riga, numero): [(36, 65)] | Alla riga 36 c'è un 65 scritto così com'è | Una costante in maiuscolo in cima al file, e al suo posto il nome. Controlla che la usi ovunque |
Except che fanno sparire gli errori (riga, perché): [(97, 'except Exception: …')] | Alla riga 97 c'è un except che prende troppo, o che tace | except ValueError: (o l'errore che aspetti davvero), e dentro non un pass ma un avviso |
Hai segnalato 1 bug con # BUG: ma nel programma sono almeno due | Ne hai segnalato meno di quanti ce ne sono | Rileggi il codice di Aldo confrontandolo con le regole: ogni riga che non tornano ha il suo commento |
Hai corretto un bug: il resoconto di Aldo è già archiviato, si segnala e basta | Hai cambiato il comportamento invece di segnalarlo | git restore, e al posto della correzione un commento # BUG: |
Ruff ha ancora da dire: e una riga biglietteria.py:49:5: ANN201 … | Ruff ha trovato qualcosa: il numero dopo il nome è riga e colonna, il codice è la regola | Guarda la riga indicata. Per capire una regola: ruff rule ANN201 |
Il file non è impaginato come farebbe ruff format | L'impaginazione non è quella di Ruff | ruff format storia/biglietteria.py, poi di nuovo pytest |
Il «Ruff ha ancora da dire» che vedi sullo scheletro, per fare un esempio, ha questo aspetto (con ruff check --output-format concise):
storia/biglietteria.py:85:5: E722 Do not use bare `except`
storia/biglietteria.py:91:83: UP031 Use format specifiers instead of percent format
storia/biglietteria.py:93:99: UP031 Use format specifiers instead of percent format
storia/biglietteria.py:94:97: UP031 Use format specifiers instead of percent format
storia/biglietteria.py:95:93: UP031 Use format specifiers instead of percent format
storia/biglietteria.py:115:58: UP031 Use format specifiers instead of percent format
storia/biglietteria.py:116:28: UP031 Use format specifiers instead of percent format
Found 7 errors.Gli errori che non danno errori
Anche in questo capitolo i guai peggiori sono quelli senza traceback. Il programma gira, il test è rosso, e il messaggio dice una riga sola. Di solito è uno di questi.
Il test verde che non vale. Hai cambiato il programma e il golden master è verde, ma il programma non è quello che pensi: il test guarda solo i file di dati che gli dai. Se il caso che hai rotto non è nei dati, nessun test lo vede. Per questo i test dello zip usano più file, anche quelli piccoli per i casi limite (un file vuoto, una riga storta, un confine).
La correzione travestita da rifattorizzazione. Hai «sistemato» una riga e ti è sembrato migliore. Il test rosso dice solo che l'uscita è diversa. Se non ricordi di aver cambiato un comportamento, guarda git diff: c'è quasi sempre un > diventato >=, o un round al posto di :.2f.
Più cose in un colpo solo. Hai cambiato nomi, funzioni e numeri, e adesso c'è un rosso che non sai da dove arriva. git restore e ricomincia con un passo solo.
Il resoconto è identico ma il programma non lo prova nessuno. Il golden master verde non dice che le funzioni siano giuste una per una: dice che l'uscita è uguale. Per le funzioni, test veri: Scrivere un test.
Per i bug che non fanno rumore il metodo è nel capitolo I bug silenziosi, e il debugger, quando ti serve per vedere cosa succede dentro un ciclo, in Il debugger, passo per passo.
Se il problema non è il codice
pytest: command not found, No module named pytest, No module named 'controlli', il pannello Testing vuoto: non è il tuo codice, è l'ambiente. È il caso più comune, e ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente.
E se hai fatto un pasticcio con Git (un file che non torna, un restore che non ricordi): Rimettere a posto.