Vai al contenuto
code-to-code

Apro l'indice…

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

Codice pulito e test1. Sette regole per chi leggep. 16

Sette regole, la palestra

Sette script di Ivo da rimettere in ordine

  • 90–120 minuti di lavoro

Sette esercizi, uno per regola, dal ★ al ★★★, sulla Linea Menta. In ognuno c'è uno script di Ivo che funziona già: tu non cambi quello che fa, cambi come è scritto. Quando i test sono tutti verdi, 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-sette-regole.zip30 KB

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt (installa pytest e Ruff), code .. Se è la prima volta, la pagina Come si usa un esercizio lo fa con te, un comando alla volta.

Ogni esercizio, sempre gli stessi passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi.
  2. Prima di toccare niente, lancia il test del file. I test sul comportamento sono già verdi, quelli sulla forma sono rossi: è giusto, il lavoro è questo.
  3. Un cambiamento piccolo alla volta, e dopo ognuno di nuovo pytest. Un test che era verde e diventa rosso vuol dire che hai cambiato quello che il programma stampa: torna indietro.
  4. Tutto verde: finito. Bloccato da quindici minuti? Apri il primo aiutino, non le soluzioni.

Per esempio, il primo esercizio, prima di toccarlo:

Terminale
pytest palestra/test_ricarica_tessera.py -v
palestra/test_ricarica_tessera.py::test_stesso_output_sul_file_di_esempio PASSED [ 25%]
palestra/test_ricarica_tessera.py::test_solo_l_intestazione_nessuna_riga PASSED [ 50%]
palestra/test_ricarica_tessera.py::test_nessun_nome_di_una_o_due_lettere FAILED [ 75%]
palestra/test_ricarica_tessera.py::test_nessun_nome_vago FAILED          [100%]

I primi due sono il comportamento: il programma stampa quello di prima. Gli altri due sono la forma, e finché sono rossi c'è da lavorare. I messaggi dicono dove è il problema, mai come si risolve: quello lo decidi tu.

#EsercizioRegolaDifficoltà
1La ricarica della tesserai nomi★
2Lo scontrino del distributoreuna funzione, un compito, e un modulo nuovo★★★
3Le fasce dei tornelliniente numeri magici★
4I passeggeri della nottegli errori non si nascondono★★
5Il resoconto delle lineenon ripeterti★★
6Il giro di ispezionecommenti sul perché★
7Gli orari del capolineala forma, con Ruff★

1 · La ricarica della tessera ★

palestra/ricarica_tessera.py

Lo script somma le ricariche di ogni tessera e stampa il saldo. Funziona, ma tra d, x, t, v, res, tmp e calc Marta non capisce niente. Cambia i nomi: ogni variabile e ogni funzione deve dire cosa contiene o cosa fa.

Terminale
python palestra/ricarica_tessera.py palestra/esempi/ricariche.csv
T-101: 12.50 euro
T-205: 10.00 euro
T-340: 20.00 euro

Deve stampare sempre questo. Come provi: pytest palestra/test_ricarica_tessera.py -v

Aiutino 1
Per ogni nome chiediti: cosa c'è dentro? Una riga del file, una tessera, un importo, un saldo? Scrivilo come lo diresti a Marta.
Aiutino 2
Con il rename in VS Code (F2 sul nome) cambi tutte le occorrenze insieme. E la funzione calc ha un nome vago come le variabili: che verbo la descrive?

2 · Lo scontrino del distributore ★★★

palestra/scontrino_distributore.py

Il distributore di Largo Lista stampa lo scontrino con una funzione sola che legge il file, fa i conti e stampa. Dividi i compiti: crea un file nuovo, palestra/calcolo_scontrino.py, con due funzioni che calcolano e restituiscono (senza stampare e senza leggere file):

Python
importo_riga(prezzo: float, quantita: int) -> float     # prezzo per quantità
totale_scontrino(importi: list[float]) -> float          # la somma degli importi

Poi il programma le importa e le usa. In nessuno dei due file c'è una funzione con più di 8 righe nel corpo. Lo scontrino stampato non cambia:

Terminale
python palestra/scontrino_distributore.py palestra/esempi/acquisti.csv
acqua    2 x 1.20 = 2.40
caffe    3 x 0.80 = 2.40
panino   1 x 3.50 = 3.50
succo    2 x 2.10 = 4.20
Totale: 12.50

Come provi: pytest palestra/test_scontrino_distributore.py -v

Aiutino 1
Cominciando dallo scheletro, tutto il test è rosso: c'è un file che non esiste. Crealo accanto agli altri, con quel nome preciso, e le due funzioni con i nomi e i parametri della consegna.
Aiutino 2
Tre compiti, tre funzioni nel programma: leggere il file e restituire i dati; stampare le righe e il totale; main che le mette in fila. I conti li fanno le due funzioni del modulo nuovo, importate con from calcolo_scontrino import ….
Aiutino 3
Se il test dice che lo scontrino è cambiato, guarda le righe prima: e adesso:: di solito è un print finito nel modulo che calcola (o un a capo perso).

3 · Le fasce dei tornelli ★

palestra/fasce_tornelli.py

I tornelli fanno pagare di meno di notte e di più nelle ore di punta. Nessuno sa dire da dove vengano quel 5, quel 23, quel 2.4. Dai un nome a ogni numero (tranne 0 e 1): una costante in MAIUSCOLO in cima al file, con un nome fatto da più parole separate da un trattino basso.

Terminale
python palestra/fasce_tornelli.py palestra/esempi/passaggi_orari.csv
 4:00    35 passaggi     52.50 euro
 5:00   120 passaggi    240.00 euro
 7:00   900 passaggi   2160.00 euro
 9:00  1100 passaggi   2640.00 euro
10:00   640 passaggi   1280.00 euro
12:00   520 passaggi   1040.00 euro
17:00   980 passaggi   2352.00 euro
19:00   870 passaggi   2088.00 euro
20:00   430 passaggi    860.00 euro
22:00   300 passaggi    600.00 euro
23:00   150 passaggi    225.00 euro

Deve stampare sempre questo. Come provi: pytest palestra/test_fasce_tornelli.py -v

Aiutino 1
Il test ti dice la riga e il numero di ogni numero magico. Per ognuno: cosa misura? Un'ora di inizio? Un'ora di fine? Un prezzo?
Aiutino 2
Due ore (7 e 10) formano un intervallo: servono due costanti, una per l'inizio e una per la fine. Occhio ai confini: se cambi un < in <= mentre sistemi, la tabella dell'ora 5 o dell'ora 10 cambia.

4 · I passeggeri della notte ★★

palestra/passeggeri_per_stazione.py

Ivo conta i passeggeri della notte da un file con qualche riga rotta. Per non fermarsi ha scritto except: pass, e le righe rotte spariscono senza dirlo a nessuno. Togli l'except che nasconde e gestisci l'errore previsto (un ValueError): per ogni riga rotta, su stderr, scrivi una riga fatta così (il numero è quello della riga nel file, l'intestazione è la riga 1):

Riga 4 ignorata: Largo Lista,molti

Quello che il programma stampa su stdout non cambia:

Righe valide: 4
Passeggeri contati: 281
Terminale
python palestra/passeggeri_per_stazione.py palestra/esempi/passeggeri_notte.csv

Come provi: pytest palestra/test_passeggeri_per_stazione.py -v

Aiutino 1
Cosa fa fallire una riga rotta, int("molti") o split che non trova la virgola? Il tipo dell'errore che si alza è lo stesso: lo vedi nel traceback quando togli il try.
Aiutino 2
Il numero di riga non c'è ancora: ti serve enumerate, con start=2 perché la riga 1 è l'intestazione che hai già saltato.
Aiutino 3
Per scrivere su stderr: print(..., file=sys.stderr). Il test confronta l'intera uscita su stderr: nemmeno uno spazio in più.

5 · Il resoconto delle linee ★★

palestra/resoconto_linee.py

Il resoconto della sera è stato scritto per la linea M e poi copiato e incollato per la linea T. Quando Marta ha chiesto di cambiare una scritta, Ivo l'ha cambiata in un posto solo. Togli le ripetizioni: una funzione che stampa il resoconto di una linea, usata per tutte e due, e un nome per il testo che compare più volte.

Terminale
python palestra/resoconto_linee.py palestra/esempi/corse.csv
Linea M
  corse: 3
  passeggeri: 1000
  media: 333.3
--------------------
Linea T
  corse: 3
  passeggeri: 660
  media: 220.0
--------------------

Come provi: pytest palestra/test_resoconto_linee.py -v

Aiutino 1
Metti i due blocchi uno accanto all'altro: cosa cambia? Quello che cambia è il parametro della funzione, il resto è uguale.
Aiutino 2
Il test dice anche che un testo non può comparire due volte: la riga di trattini ha bisogno di un nome (una costante). E le due liste, una per linea, possono stare in un dizionario con la lettera della linea come chiave.

6 · Il giro di ispezione ★

palestra/giro_di_ispezione.py

Ivo commenta ogni riga, «per chiarezza». Ma i commenti dicono quello che il codice dice già, e proprio la riga strana (quella che nessuno capisce) non ha nessun commento. Cancella i commenti che ripetono il codice. Poi scrivine uno solo, sulla riga strana: i minuti dei treni T si contano doppi. Il perché: i treni T hanno due piani, e il regolamento richiede un secondo ispettore, quindi un secondo controllo.

Terminale
python palestra/giro_di_ispezione.py palestra/esempi/ispezioni.csv
Minuti di ispezione: 167

Come provi: pytest palestra/test_giro_di_ispezione.py -v

Aiutino 1
Per ogni commento chiediti: se lo cancello, perde qualcosa chi legge? Se la risposta è «no, lo dice già la riga sotto», va via.
Aiutino 2
Il commento nuovo deve rispondere a «perché?», non a «cosa fa?». Il test cerca parole come «perché», «regolamento» o «richiede»: la ragione che ti ho dato sopra è il contenuto.

7 · Gli orari del capolinea ★

palestra/orari_capolinea.py

Il tabellone di Vecchia Fiera usa tre funzioni scritte da Ivo alle tre di notte: funzionano, ma sono impaginate a caso e senza tipi. Porta il file in forma: Ruff non deve avere niente da dire, né check né format, e ogni funzione deve avere i type hints. Nomi e parametri delle funzioni restano quelli, e quello che restituiscono non cambia. Orari e minuti sono numeri interi.

Terminale
ruff check palestra/orari_capolinea.py
ruff format palestra/orari_capolinea.py

Come provi: pytest palestra/test_orari_capolinea.py -v

Aiutino 1
Comincia da ruff format: sistema da solo gli spazi, le virgole e le righe sulla stessa riga. Poi ruff check --output-format concise e una riga alla volta.
Aiutino 2
Se non sai cosa vuol dire un codice (E712, E711...), la pagina Se qualcosa va storto li spiega uno per uno.
Aiutino 3
Una funzione che può restituire un numero oppure niente ha il tipo int | None. Un parametro con un valore di ripiego, come sciopero=False, si scrive sciopero: bool = False.

Finito? Confronta le tue con le soluzioni: per ogni esercizio ci sono il ragionamento, il codice e le trappole più comuni.