Vai al contenuto
code-to-code

Apro l'indice…

↑ ↓ per scegliere, Invio per aprire, Esc per chiudere

Codice pulito e test2. Rifattorizzare senza romperep. 49

Rifattorizzare, la palestra

Tre programmi vecchi da sistemare, con il golden master

  • 60–90 minuti di lavoro

Tre programmi della Linea Menta che funzionano e sono scritti male. Ognuno ha il suo file di test, con il golden master dentro. Il tuo lavoro: cambiare come sono scritti, non cosa fanno. Quando il test è tutto verde, hai finito.

Gli esercizi da scaricare

Una cartella con i file da completare e i test già pronti. Come si usa: la guida in cinque passi.

pulito-rifattorizzare.zip34 KB

Nello stesso zip c'è anche la storia del capitolo, L'eredità del vecchio programmatore: la trovi nella pagina dopo.

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt, code .. Se non ricordi come si fa: Il venv e pip e VS Code per Python.

Ogni esercizio, sempre gli stessi passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi.
  2. Prima di toccare qualcosa: pytest palestra/test_<nome>.py -v. I test che cominciano con stesso_output sono verdi: sono la fotografia. Quelli sulla forma sono rossi.
  3. Un cambiamento piccolo, poi pytest. Verde: avanti. Rosso su un stesso_output: hai cambiato quello che il programma stampa. git diff per vedere cosa, e torna indietro.
  4. Se vuoi, un commit dopo ogni passo verde: git init nella cartella dello zip la prima volta.
#EsercizioLa cosa da fareDifficoltà
1I passaggi ai tornellipassi piccoli: nomi, funzioni, main★★
2Il registro delle puliziegli avvisi su stderr★★
3I turni dei capotrenoil bug che non si tocca★★★

1 · I passaggi ai tornelli ★★

palestra/passaggi_tornelli.py

Ogni mattina Marta Villa stampa i passaggi ai tornelli, stazione per stazione: entrate, uscite e l'ora di punta. Il programma funziona, ma è tutto in un blocco e le variabili si chiamano d, s, h, mo.

Il file dei passaggi, una riga per passaggio:

stazione,ora,verso
Porta Codice,07:12,entrata
Porta Codice,07:15,entrata
Largo Lista,07:20,uscita

Quello che stampa sul file di esempio, e che deve restare identico:

Terminale
python palestra/passaggi_tornelli.py palestra/esempi/passaggi.csv
Porta Codice: 3 entrate, 1 uscite, ora di punta 07
Largo Lista: 3 entrate, 2 uscite, ora di punta 08
Via Variabile: 1 entrate, 1 uscite, ora di punta 08
Totale: 11 passaggi

Sì, «1 uscite». Non è un errore tuo: è l'uscita da conservare. L'ora di punta di Largo Lista è 08 anche se 08 e 09 hanno lo stesso numero di passaggi: vince la prima.

Cosa fai. Tre cose, a passi piccoli:

  1. dai ai nomi una lunghezza che si legge (niente nomi di una o due lettere);
  2. metti il lavoro in funzioni: quello che sta fuori dalle funzioni parte appena importi il file, e il test lo vieta;
  3. scrivi una main che racconta i passi, non lunga più di 8 righe (docstring esclusa).
Terminale
pytest palestra/test_passaggi_tornelli.py -v
Aiutino 1
Comincia dai nomi, un passo solo: F2 su d e scegli un nome che dica cosa contiene. Poi pytest. Se resta verde, fai la variabile dopo.
Aiutino 2
Per metterlo in funzioni, cerca nel programma i pezzi che fanno una cosa sola: leggere il file, contare per stazione, trovare l'ora di punta, stampare una stazione. Comincia dall'ultimo: ha un print e un ciclo, ed è il più facile da isolare.
Aiutino 3
La main è l'indice: legge, conta, stampa. Tutto il codice che stava in giro deve finire in una funzione, e in fondo al file c'è if __name__ == "__main__": con la chiamata. Ricordi Moduli e file?

2 · Il registro delle pulizie ★★

palestra/pulizie_treni.py

Ogni notte, al deposito, qualcuno scrive nel registro quanti minuti ha pulito un treno. A volte una riga viene storta: il programma la salta con un except: e un pass, e nessuno lo sa mai.

treno,pulitore,minuti
M12,Ivo Brambati,45
T28,Tommaso Greco,30
M12,Sergio Colombo,20
M14,Ernesto Pozzi,abc
T28,Ivo Brambati

Ecco cosa stampa adesso (lo stdout) sul file di esempio:

M12: 75 minuti
T28: 30 minuti
M16: 50 minuti
Totale: 155 minuti

Cosa fai. Le righe saltate vanno dette su stderr, una riga di avviso per ognuna, in questo formato:

Riga 5 ignorata: M14,Ernesto Pozzi,abc

Il numero è quello del file (l'intestazione è la riga 1) e dopo i due punti c'è la riga com'era scritta. L'except che tace sparisce: prendi solo l'errore che ti aspetti. Lo stdout non cambia di un carattere.

Terminale
pytest palestra/test_pulizie_treni.py -v
Aiutino 1
Che errore fa Python con int("abc")? E con una riga che ha due pezzi invece di tre, quando provi a spacchettarla in tre nomi? Provali nel terminale di Python: se sono lo stesso errore, ne basta uno solo nell'except.
Aiutino 2
Per il numero di riga serve enumerate, che numera mentre scorri: for numero, riga in enumerate(righe, start=…). Da dove parte il file, se la riga 1 è l'intestazione?
Aiutino 3
L'avviso è una print con file=sys.stderr. Metti quella nel ramo except, al posto del pass. La riga va senza l'a capo in fondo: riga.strip().

3 · I turni dei capotreno ★★★

palestra/turni_capotreno.py

Il deposito stampa le ore di ogni capotreno e, oltre le 8 ore, lo straordinario. Nel file di esempio c'è un turno di notte, e il conto di quella riga è sbagliato: un bug. Ma la sede ha già archiviato questo resoconto: deve restare com'è.

capotreno,inizio,fine
Lucia Ferri,06:00,14:00
Sergio Colombo,14:00,23:30
Nadia Russo,22:00,06:00
Tommaso Greco,05:30,13:30
Ivo Brambati,13:15,21:45
Terminale
python palestra/turni_capotreno.py palestra/esempi/turni.csv
Lucia Ferri: 8.00 ore
Sergio Colombo: 9.50 ore (straordinario 1.50)
Nadia Russo: -16.00 ore
Tommaso Greco: 8.00 ore
Ivo Brambati: 8.50 ore (straordinario 0.50)

Nadia Russo che lavora −16 ore: è il bug. Non correggerlo.

Cosa fai. Dai un nome ai numeri (niente numeri sciolti, tranne 0 e 1) e alle variabili (niente nomi di una o due lettere). Poi segnala il bug con un commento che comincia con # BUG:, accanto alla riga che lo causa. Il resoconto, bug compreso, non cambia di un carattere.

Terminale
pytest palestra/test_turni_capotreno.py -v
Aiutino 1
Quali numeri ci sono nel programma, e cosa vuol dire ognuno? Uno è «minuti in un'ora», l'altro «minuti di un turno normale». Scrivili in cima al file con un nome che lo dice, in MAIUSCOLO.
Aiutino 2
Dov'è il bug? Prova a calcolare a mano i minuti di Nadia Russo: fine meno inizio, con le 06:00 e le 22:00. Il segno è la risposta. Il commento va dove si fa quella sottrazione.
Aiutino 3
Se per sbaglio correggi il bug (un if che aggiunge un giorno intero), il test stesso_output_sul_file_di_esempio diventa rosso alla terza riga. È il test che funziona: torna all'ultimo verde e segnala soltanto.

Finiti? Le soluzioni stanno nella loro pagina, in fondo al capitolo. Prima prova la storia: è lo stesso mestiere, su un programma più lungo.