Vai al contenuto
code-to-code

Apro l'indice…

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

Codice pulito e test2. Rifattorizzare senza romperep. 53

L'eredità del vecchio programmatore

La biglietteria della Linea Menta, a sei livelli

  • 90–120 minuti di lavoro

Milano, venerdì sera. Piazza Query, ufficio della capostazione.

Aldo Ronchi esce dall'ufficio con uno scatolone in braccio. Dopo trentacinque anni alla Linea Menta, è in pensione. Sulla scrivania di Marta Villa lascia una chiavetta e un biglietto: «biglietteria.py. Funziona. Non toccare.»

Il programma lo ha scritto lui, nel 2009. Ogni sera stampa il resoconto degli incassi del mese, e la sede lo confronta con le casse. Lunedì cambiano le tariffe, e qualcuno dovrà modificarlo.

Marta lo apre. Più di cento righe. Variabili che si chiamano st, gg, ta, et. Un except: che butta via le righe che non capisce. Numeri dappertutto.

«Prima di cambiare le tariffe», dice Marta, «devo capire cosa c'è dentro. E prima ancora, devo poterlo toccare senza rompere il resoconto.»

Il resoconto di ottobre, com'è adesso, sta in un file. Basta farlo restare uguale.

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

Lo zip è lo stesso della palestra: la storia è nella cartella storia/.

Il resoconto

Il programma legge dati/ottobre.csv (una riga per biglietto: giorno, stazione, tessera, età, tariffa, zone) e stampa questo:

Terminale
python storia/biglietteria.py storia/dati/ottobre.csv
BIGLIETTERIA LINEA MENTA - OTTOBRE
===================================
Per stazione:
  Porta Codice    21 biglietti   incasso    48.96
  Via Variabile   20 biglietti   incasso    36.60
  Largo Lista     19 biglietti   incasso    33.15
  Ponte Ciclo     14 biglietti   incasso    30.04
  Piazza Query    15 biglietti   incasso    26.85
Per tariffa:
  ordinario       53 biglietti   incasso   115.40
  studenti        17 biglietti   incasso    28.92
  gruppo          19 biglietti   incasso    31.28
Per zone:
  1 zona          41
  2 zone          33
  3 zone          15
Per eta':
  sotto i 18 anni   7
  da 18 a 64 anni  60
  da 65 anni       22
Biglietti gratuiti: 8
Righe scartate: 4
Giorno migliore: 14 (incasso 16.33)
TOTALE INCASSI: 175.60
Prezzo medio: 1.97

Questo è il golden master della storia: ogni livello, quando hai finito, deve stampare esattamente questo. Nello zip, in attesi/ottobre.txt.

I file

FileCosa c'èSi tocca?
biglietteria.pyIl programma di AldoSì, solo questo
test_biglietteria.pyI test: il resoconto identico, più un controllo per livello. Usano anche due file di prova piccoli, non solo quello di ottobreNo
dati/ottobre.csv (i biglietti), tessere.csv (di chi è ogni tessera), due file di provaNo, si legge
attesi/Quello che il programma stampa ora, su stdout e su stderrNo
verifica.pyIl commissario controlla il nome che gli daiNo

Le regole delle tariffe, come le scriveva Aldo: 1 zona 2,20 euro, 2 zone 3,10, dalla terza 4,00. Studenti sconto del 40%, gruppi del 20%. Sotto i 6 anni si viaggia gratis, dai 65 anni compiuti si paga la metà.

Come si gioca

Un livello alla volta, sempre così:

  1. Leggi la richiesta di Marta e la cosa nuova del livello.
  2. Un passo piccolo, poi: pytest storia -v -k "resoconto or livello_1" (poi livello_2, e così via). I test resoconto sono il golden master: devono restare verdi. Se uno diventa rosso, l'ultimo passo ha cambiato il resoconto: git diff, git restore.
  3. Quando il livello è verde, un commit. Se la cartella non è ancora un repository: git init, poi git add . e un primo commit prima di cominciare, con il programma di Aldo com'è.
  4. Per ogni livello, il test del livello è rosso e dice dove guardare, non come fare.

Alla partenza, pytest storia -v dice: tre test verdi (i resoconto) e gli altri rossi. È il punto di partenza giusto.


Livello 1 · I nomi

«Non so nemmeno cosa sia gg.»

Ogni variabile con un nome che dice cosa contiene. Nessun nome di una o due lettere.

La cosa nuova: i nomi, e un golden master che ti para la schiena. Non devi capire tutto il programma per rinominare: ti basta capire una variabile alla volta. È l'esempio B.

Aiutino 1
F2 su un nome in VS Code lo cambia ovunque. Comincia da quello che capisci meglio (f è il file, r le righe). Dopo ognuno, pytest.
Aiutino 2
Per quelli che non capisci, guarda dove vengono usati, non dove sono creati. ta[t][0] aggiunto a ogni biglietto, ta[t][1] all'incasso: cosa sono?

Livello 2 · Le funzioni

«Per provare un pezzo devo lanciare tutto il programma.»

Il programma diventa importabile: ogni pezzo in una funzione, con un compito solo, e in fondo il blocco if __name__ == "__main__":. Una funzione, in particolare, si deve chiamare prezzo_biglietto(tariffa, eta, zone): restituisce il prezzo di un biglietto in euro, arrotondato a due decimali, e non stampa niente.

La cosa nuova: dividere in funzioni un programma che non ne ha. Il test importa il programma e prova prezzo_biglietto da solo, con la tariffa, l'età e le zone: dopo questo livello i prezzi si possono controllare uno per uno. È la regola «una funzione, un compito» del capitolo precedente, su un programma vero.

Aiutino 1
Il programma ha tre fasi: legge e conta, calcola il prezzo, stampa. Comincia dalla fase che si capisce meglio da sola: il calcolo del prezzo, nel try, dalle zone fino al round.
Aiutino 2
Il prezzo dipende da tariffa, età e zone: sono i tre parametri. Una cosa però non è nell'elenco, e il resoconto la usa: guarda bene cosa fa il programma con la tessera. Quella non è un parametro di prezzo_biglietto: resta fuori.
Aiutino 3
Passo piccolo: prima la funzione prezzo_biglietto e la chiamata, e pytest. Poi il pezzo che stampa, in una o più funzioni. Per ultimo, tutto quello che resta in giro finisce in main.

Livello 3 · I numeri con un nome

«Cos'è quel 0.6? E quel 65? E quel numero a cinque cifre?»

Ogni numero che conta diventa una costante in maiuscolo, in cima al file, con un nome che dice cosa è. Puoi lasciare 0, 1 e 2.

La cosa nuova: i numeri con un nome. Il test ti dà la lista di quelli rimasti, con la riga. Scorrendola, uno non si lascia nominare. Non c'è nessun nome che gli stia bene, perché non si capisce a cosa serva. Tienilo a mente: ci torni al livello 5, e al finale.

Aiutino 1
TARIFFA_PER_ZONA, SCONTO_STUDENTI, ETA_ANZIANI… Un nome per ogni numero, e il nome dice cosa è, non quanto vale: TRENTA non dice niente.
Aiutino 2
I numeri nelle stringhe di formato (ljust, rjust) contano anche loro: sono larghezze di colonna. Oppure scrivili in una f-string con la larghezza dentro: f"{nome:<15}" non ha numeri sciolti per il test.

Livello 4 · Gli avvisi su stderr

«Righe scartate: 4. Ma quali?»

Una riga che il programma scarta non sparisce più in silenzio. Per ogni riga scartata, una riga su stderr, in questo formato:

Riga 18 ignorata: 9,Largo Lista,40233,n/d,ordinario,2

Il numero è quello del file (l'intestazione è la riga 1) e dopo i due punti c'è la riga com'era. L'except che prende tutto sparisce: ne serve uno stretto. Il resoconto su stdout non cambia di un carattere, compresa la riga «Righe scartate: 4».

La cosa nuova: stderr al posto del pass. È l'esempio C.

Aiutino 1
except ValueError: prende l'errore di int("n/d") e quello di una riga con troppi pezzi o troppo pochi, se li spacchetti in sei nomi. Per sapere a quale riga sei: enumerate(righe, start=…).
Aiutino 2
Nel ramo except, due cose: l'avviso su stderr (file=sys.stderr) e il conteggio delle righe scartate, perché il resoconto lo stampa ancora.

Livello 5 · # BUG:

«Questa riga non dice quello che dice la regola.»

Rileggendo il codice, ci sono cose che non tornano. Non si correggono: il resoconto di Aldo è già archiviato. Si segnalano, con un commento # BUG: … accanto alla riga, che dice cosa non torna e perché non lo correggi.

Il test controlla che i bug segnalati siano almeno due, e che chi ha esattamente 65 anni paghi ancora come prima.

La cosa nuova: trovare un bug e lasciarlo dov'è. È l'esempio D.

Aiutino 1
Confronta le regole scritte in cima al file di Aldo con quello che il codice fa. «Dai 65 anni compiuti»: com'è scritto il confronto?
Aiutino 2
Il secondo bug lo hai già visto al livello 3: un numero che non si lascia nominare. Cosa fa, quel if? E c'è una regola, scritta da qualche parte, che lo giustifica?
Aiutino 3
Il commento dice tre cose: cosa non torna, cosa farebbe la correzione, e che non la fai. Nel capitolo sui bug silenziosi c'è il metodo per descriverli bene.

Livello 6 · Ruff, e il finale

«Adesso devo solo lasciarlo in ordine.»

Ruff, il linter e formattatore del capitolo precedente, non ha più niente da dire: ruff check storia/biglietteria.py e ruff format storia/biglietteria.py.

La cosa nuova: lasciare il lavoro in ordine, con un attrezzo che controlla al posto tuo. Se hai già dato tipi alle funzioni e rimosso % e except:, ti resta poco.

Terminale
ruff check storia/biglietteria.py
ruff format storia/biglietteria.py
Aiutino 1
ruff check --output-format concise storia/biglietteria.py dà una riga per segnalazione. Il codice davanti (per esempio ANN001) è quello di una regola: scrivilo nella ricerca di VS Code, o chiedi a Ruff: ruff rule ANN001.
Aiutino 2
I % nelle stringhe ("%.2f" % x) sono la vecchia scrittura: la f-string f"{x:.2f}" fa lo stesso, con lo stesso risultato.

Il finale

Il resoconto è identico, il programma si legge. Marta ripassa il codice per l'ultima volta, e si ferma su una riga.

Il numero che al livello 3 non voleva un nome. Un if che fa pagare zero a una sola tessera, senza che nessuna regola lo dica. Non è un errore del programma: è una porta sul retro. Aldo l'ha scritta nel 2009 e da allora nessuno l'ha mai vista, perché il resoconto non dice mai chi viaggia gratis.

Marta chiama il commissario Mapelli.

«Mi serve un nome», dice lui. «A chi è intestata la tessera che viaggia gratis?»

Il numero lo trovi nel codice. L'intestatario è in dati/tessere.csv. Dal terminale, grep cerca le righe che contengono un testo:

Terminale
grep 40305 storia/dati/tessere.csv
40305,Elena Mariani

(40305 è una tessera qualunque: al suo posto metti il numero che hai trovato.) Quando hai un nome:

Terminale
python storia/verifica.py "Nome Cognome"

Se è sbagliato, per le piste più probabili il commissario ti dice dove hai preso la strada sbagliata.