Vai al contenuto
code-to-code

Apro l'indice…

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

Codice pulito e test4. Prima il testp. 111

Il validatore dei badge

Otto regole, un test alla volta

  • 90–120 minuti di lavoro

Milano, Linea Menta. Deposito di Vecchia Fiera, notte.

La Linea Menta cambia i badge del personale. Quelli vecchi si copiavano con una fotocopia. I nuovi hanno un formato fisso e, in fondo, una cifra di controllo: un numero che si calcola dal resto, e che chi copia a occhio non sa calcolare.

LM-0427-DEP-3

Una sigla, il numero, il reparto, la cifra. Ernesto Pozzi, il capo deposito, ha un lettore al cancello e una richiesta chiara:

«Mi serve una funzione. Le do un badge, mi dà la lista di quello che non va. Lista vuota, il badge è buono. E la voglio provata, regola per regola: non mi fido di un codice senza test.»

Stanotte, al cancello di Vecchia Fiera, sono passati trenta badge. Uno è falso.

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-tdd.zip22 KB

Nello zip la storia è nella cartella storia/: apri il suo README.md.

Come si lavora

Un livello alla volta. In ogni livello, per ogni regola, il giro del capitolo: rosso, verde, pulisci.

  1. In storia/test_badge.py scrivi un test per la regola, con l'esempio della tabella. pytest storia/test_badge.py -v: deve essere rosso, e per il motivo giusto.
  2. In storia/badge.py scrivi il codice minimo che lo fa passare. Di nuovo pytest: verde.
  3. Pulisci: nomi, numeri senza un nome, ripetizioni. pytest dopo ogni modifica.
  4. Il controllo del livello: pytest storia -v -k livello_1 (poi livello_2, …).

Il controllo guarda lo stato finale di ogni livello, non l'ordine in cui lo hai fatto: quel giro lo fai tu. Per ogni livello controlla due cose: che il tuo codice rispetti la regola, e che i tuoi test si accorgano se la regola sparisce. Per questo i test non possono essere pochi.

I file

FileCosa c'èSi tocca?
badge.pyLa funzione errori_badge, da far crescere un test alla volta. In fondo, il quadernoSì
test_badge.pyI tuoi test. Il primo c'è già, ed è rossoSì
test_controllo_badge.pyIl controllo di ogni livelloNo
dati.pyI trenta badge della notte (BADGE_DELLA_NOTTE) e il personale (PERSONALE)No, si legge
verifica.pyErnesto controlla il nome che gli daiNo

Le regole

I messaggi sono esattamente questi: il controllo li confronta lettera per lettera. Un badge giusto non ha errori: [].

RegolaLivelloCosa deve rispettareEsempioNella lista degli errori
11Il badge non è vuoto"""badge vuoto" (da solo)
25Spazi ai lati e minuscole non contano: si sistemano prima di tutto il resto. Un badge di soli spazi è vuoto" LM-0427-DEP-3 ", "lm-0427-dep-3"niente: sono giusti
32Quattro pezzi separati da trattini"LM-0427", "LM0427DEP3""formato sbagliato" (da solo)
42Il primo pezzo è LM"XX-0427-DEP-3""sigla sbagliata"
53Il numero ha quattro cifre, tutte cifre"LM-427-DEP-3", "LM-04A7-DEP-3""numero non valido"
63Il reparto è DEP, TRE, STA o SIC"LM-0427-MAG-3""reparto sconosciuto"
74L'ultimo pezzo è la cifra di controllo: la somma delle cifre del numero, tenendo solo l'ultima cifra (il resto della divisione per 10). Se il numero non è valido, la cifra non si controlla"LM-0427-DEP-4", "LM-0427-DEP-X""cifra di controllo sbagliata"
86Tutti gli errori insieme, nell'ordine delle regole (4, 5, 6, 7)"XX-12-ABC-5"["sigla sbagliata", "numero non valido", "reparto sconosciuto"]

Per 0427: 0 + 4 + 2 + 7 = 13, la cifra è 3. Per 0999: 27, la cifra è 7. Se il formato è sbagliato (regola 3) o il badge è vuoto (regola 1), quello è l'unico errore: non c'è niente da controllare dentro.


Livello 1 · Il badge vuoto

«Il cancello deve dire cosa non va. Cominciamo dal caso più stupido: il badge che non c'è.»

errori_badge("") deve restituire ["badge vuoto"].

La cosa nuova: il primo rosso e il verde «che bara». Il test c'è già: lancialo e leggi la riga E. Poi scrivi il codice minimo. Anche una lista fissa va bene: è il modo giusto di cominciare.

Aiutino 1
Lancia pytest storia/test_badge.py -v. Il test è rosso: la funzione dà None. Il motivo è giusto: non c'è ancora niente dentro.
Aiutino 2
Al posto del pass, un return con la lista che il test si aspetta. Non serve nemmeno un if.

Quando è verde: pytest storia -v -k livello_1.


Livello 2 · Il formato e la sigla

«Un badge vuoto lo vedono tutti. Ma LM-0427 non ha il reparto e XX-0427-DEP-3 non è della Linea Menta.»

Regole 3 e 4.

La cosa nuova: il secondo test costringe il codice. Se il tuo codice restituisce sempre ["badge vuoto"], il primo test che prova un badge giusto lo smaschera: comincia da lì. Poi un test per il formato, poi uno per la sigla: sempre uno alla volta.

Aiutino 1
Primo test: errori_badge("LM-0427-DEP-3") == []. Rosso. Il codice minimo: se il badge è vuoto la lista con l'errore, altrimenti [].
Aiutino 2
Per dividere in pezzi: codice.split("-") dà una lista. Quanti pezzi? len(pezzi). Se non sono quattro: ["formato sbagliato"].
Aiutino 3
Per la sigla, il primo pezzo: pezzi[0]. O, meglio, spacchettali con un'assegnazione: sigla, numero, reparto, cifra = pezzi. Poi un if sigla != "LM".

Livello 3 · Il numero e il reparto

«Il numero ha quattro cifre. E i reparti sono quattro: deposito, treni, stazioni, sicurezza. Niente altro.»

Regole 5 e 6.

La cosa nuova: tanti casi con un solo test. Il numero può sbagliare in molti modi (427, 04271, 04A7): uno scrive un test per ognuno? No: parametrize, un test solo e la lista dei valori.

Aiutino 1
Per il numero servono due cose insieme: len(numero) == 4 e numero.isdigit(). Se una manca, un badge come 04A7 passa.
Aiutino 2
Per il reparto, una tupla con i quattro nomi e in: reparto in ("DEP", "TRE", "STA", "SIC"). Il test deve provare anche i quattro reparti giusti, non solo uno sbagliato.
Aiutino 3
Fino a qui il codice ha ancora dei return dentro gli if? Va bene: al livello 6 lo sistemerai. Per ora, un rosso alla volta.

Livello 4 · La cifra di controllo

«La cifra è quello che il falsario non sa. Somma delle cifre del numero, e si tiene solo l'ultima.»

Regola 7.

La cosa nuova: pulire sul verde. Quando il test della cifra è verde, il calcolo è nel mezzo di errori_badge e la rende lunga. Estrailo in una funzione sua, cifra_di_controllo(numero: str) -> int, con i suoi test: prima i test della funzione (cifra_di_controllo("0427") == 3), poi lo sposti. Con tutto verde, dai un nome a ogni numero (nel codice non devono restare numeri senza un nome, a parte 0 e 1).

Il controllo di questo livello guarda anche la forma: nessun numero senza un nome, nessun nome di una o due lettere, Ruff senza niente da dire.

Aiutino 1
Per sommare le cifre, un accumulatore e un ciclo: somma = 0, poi for cifra in numero:, somma = somma + int(cifra). Lo conosci da Liste e cicli.
Aiutino 2
Tenere solo l'ultima cifra è il resto della divisione per dieci: somma % 10. Prova la funzione su 0999: 27 deve dare 7.
Aiutino 3
La cifra nel badge è un testo ("3"), il risultato della funzione un numero. Confrontali dopo str(...). E il caso LM-0427-DEP-X: la cifra non è un numero, quindi diversa: errore.
Aiutino 4
I numeri con un nome: costanti in maiuscolo in cima al file (le quattro cifre del numero, il 10 del resto, i pezzi del badge).

Livello 5 · Gli spazi e le minuscole

«Il lettore del cancello ogni tanto mi consegna un badge con uno spazio davanti, o tutto minuscolo. Sono buoni lo stesso.»

Regola 2.

La cosa nuova: il caso che arriva dai dati veri. Lancia python storia/badge.py e guarda le righe: ce n'è una che sembra un badge buono e il tuo codice la boccia. Quello è il caso da riprodurre: prima il test con quel badge, rosso, e poi il codice.

Due test, uno per gli spazi e uno per le minuscole. Il controllo prova entrambi.

Aiutino 1
Il test con lo spazio: errori_badge(" LM-0427-DEP-3 ") == []. Rosso: quale errore dà? Leggi la riga E.
Aiutino 2
Si sistema il badge prima di tutto il resto: codice.strip() toglie gli spazi ai lati, .upper() rende maiuscolo. Le trovi in Le stringhe.
Aiutino 3
E un badge di soli spazi? Dopo strip() è vuoto: la regola 1 va controllata sul badge già sistemato.

Livello 6 · Tutti gli errori insieme

«Se un badge ha tre errori, voglio vederli tutti e tre: così so cosa dire a chi l'ha scritto.»

Regola 8.

La cosa nuova: un test che cambia la forma del codice. Con i return dentro gli if, il codice si ferma al primo errore. Il test errori_badge("XX-12-ABC-5") deve dare tre errori, nell'ordine delle regole: è rosso, e per farlo diventare verde serve una lista errori a cui aggiungere (append) e un solo return in fondo.

Restano come sono, da soli: il badge vuoto e il formato sbagliato (dentro non c'è niente da controllare).

Aiutino 1
Una lista vuota errori = [] prima degli if; in ogni if un errori.append("…") al posto del return; alla fine return errori.
Aiutino 2
La cifra di controllo si controlla solo se il numero è valido: se no, non c'è niente da sommare. Tieni da parte un numero_valido (vero o falso) e usalo nell'if della cifra.
Aiutino 3
Un test con tre errori. Poi uno con due, in cui uno dei due è la cifra: "XX-0427-DEP-4". L'ordine della lista è quello delle regole, non quello alfabetico.

Il finale

Il quaderno è pronto:

Terminale
python storia/badge.py

Trenta righe: un badge e i suoi errori. Quasi tutti sono buoni ([]) oppure sbagliati in un modo che si vede subito: un badge vuoto, un formato storto, una sigla LX. Il falsario invece conosceva il formato, la sigla, i reparti. Non conosceva la cifra di controllo.

  • Tra i trenta c'è un solo badge il cui unico errore è la cifra di controllo.
  • Il suo numero è quello di una persona vera: PERSONALE, in dati.py.
  • Se il quaderno ti mostra più di un candidato, il tuo validatore ha ancora un buco: torna al livello giusto.

Di chi è il numero copiato?

Terminale
python storia/verifica.py "Nome Cognome"

Se la risposta è sbagliata, per le piste più probabili Ernesto ti dice dove hai preso la strada sbagliata.