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. 30

Sette regole, se qualcosa va storto

I messaggi dei test e le righe di Ruff

Gli errori che vedrai di più in questo capitolo. Ce ne sono di due tipi: i messaggi dei test (ti dicono dove è il problema, mai come si risolve) e le righe di Ruff (con un codice, come E741). Per ognuno: cosa leggi, cosa vuol dire, cosa fai.

I messaggi dei test

Ogni riga che comincia con E nell'uscita di pytest è il messaggio che ti riguarda. Il resto del rosso (le righe con assert, i Full diff) puoi non leggerlo.

LeggiVuol direCosa fai
L'uscita è cambiata alla riga 2. con sotto prima: e adesso:Il programma stampa qualcosa di diverso da prima: hai cambiato il comportamentoConfronta le due righe, carattere per carattere. Di solito è una scritta ritoccata, un numero cambiato, un < diventato <=. Annulla l'ultima modifica e rifalla più piccola
L'uscita è più corta: manca la riga 1, 'Riga 4 ignorata: Largo Lista,molti'Manca un pezzo di uscita: nel caso dell'esercizio 4, su stderr non esce nienteControlla che l'avviso ci sia, e che sia scritto con file=sys.stderr
Numeri senza un nome (riga, numero): [(16, 5), (16, 23), …]Alla riga 16 c'è un 5 e un 23 scritti così come sonoUna costante in maiuscolo in cima al file per ogni numero, e al suo posto il nome. Lo 0 e l'1 non contano
Nomi troppo corti: ['d', 'f', 't', 'v', 'x']Hai variabili o funzioni con un nome di una o due lettereUn nome che dice cosa contiene. Con F2 in VS Code lo cambi dappertutto
Nomi che non dicono cosa contengono: ['calc', 'res', 'tmp']Sono nomi vaghi: lunghi abbastanza, ma non dicono nienteChiediti: cosa c'è dentro? Cosa fa? E scrivilo
Except che fanno sparire gli errori (riga, perché): [(27, 'except da solo: …')]Alla riga 27 c'è un except da solo, o except Exception, o con dentro solo pass o continueexcept ValueError: e dentro un avviso su stderr
Pezzi quasi uguali (riga del primo, riga del secondo): [(25, 30)]Il blocco che comincia alla riga 25 e quello alla 30 sono lo stesso, con un valore o un nome cambiatoUna funzione con un parametro, oppure un ciclo. Non basta metterli in due funzioni: devono diventare una
Testi scritti più volte (testo: quante): {'--------------------': 2}Lo stesso testo tra virgolette compare in due puntiUna costante in maiuscolo con quel testo
Commenti che ripetono il codice: ['apro il file', …]Ci sono ancora i commenti sul cosa dello scheletroCancellali: la riga sotto dice già quello che dicono
Manca un commento che spieghi il perché …Non c'è un commento con almeno quattro parole che dia la ragioneScrivi sopra la riga strana il perché (regolamento, ragione, effetto), non cosa fa la riga
Non trovo calcolo_scontrino.py: il file deve restare con questo nomeIl file nuovo dell'esercizio 2 non esiste, o ha un altro nomeCrealo nella cartella palestra/, con quel nome preciso
Importare calcolo_scontrino.py lo farebbe partire: c'è codice fuori dalle funzioni, riga 1 (una chiamata).Nel file c'è un print o un'altra chiamata fuori da ogni funzione: appena lo importi, parteMettilo dentro una funzione. In un modulo che calcola ci sono solo def e costanti
In scontrino_distributore.py funzioni con più di 8 righe (nome: righe): {'scontrino': 10}La funzione scontrino ha il corpo lungo 10 righeSpezzala: ogni compito, una funzione
ModuleNotFoundError: No module named 'calcolo_scontrino'Il programma importa un modulo che Python non trovaIl file calcolo_scontrino.py deve stare accanto al programma, nella stessa cartella palestra/, e il nome nell'import senza .py
Ruff segnala: seguito da righe come orari_capolinea.py:32:18: E711 …ruff check ha qualcosa da dire sul fileVedi la tabella qui sotto
Il file non è impaginato come farebbe Ruff: con righe - e +ruff format cambierebbe il file: le righe - sono come sono, le + come le vorrebberuff format palestra/orari_capolinea.py
Type hints mancanti: con riga 18, minuti_di_attesa: manca il tipo di orariUn parametro, o quello che la funzione restituisce, non ha il tipoorari: list[int] per un parametro, -> int per quello che restituisce

Le righe di Ruff

Il formato è sempre lo stesso: file:riga:colonna: CODICE cosa non va. Il codice è una lettera e un numero. Ecco quelli che incontrerai, tutti insieme, nello stesso file di prova:

Python
import os


def OrarioPartenza(treno: str):
    Ritardo = 5
    messaggio = "pronto"
    with open("orari.txt", "r") as file:
        l = file.read()
    if treno == True:
        pass
    try:
        print(l, Ritardo)
    except:
        pass
    return None


def cerca(treno, orari: list[str]) -> bool:
    return orari == None
Terminale
ruff check --output-format concise guai.py
guai.py:1:8: F401 [*] `os` imported but unused
guai.py:4:5: N802 Function name `OrarioPartenza` should be lowercase
guai.py:4:5: ANN201 Missing return type annotation for public function `OrarioPartenza`
guai.py:5:5: N806 Variable `Ritardo` in function should be lowercase
guai.py:6:5: F841 Local variable `messaggio` is assigned to but never used
guai.py:7:28: UP015 [*] Unnecessary mode argument
guai.py:8:9: E741 Ambiguous variable name: `l`
guai.py:9:8: E712 Avoid equality comparisons to `True`; use `treno:` for truth checks
guai.py:13:5: E722 Do not use bare `except`
guai.py:18:11: ANN001 Missing type annotation for function argument `treno`
guai.py:19:21: E711 Comparison to `None` should be `cond is None`
Found 11 errors.
[*] 2 fixable with `--fix` (4 unsafe fixes available with `--fix --unsafe-fixes`).
LeggiVuol direCosa fai
F401 imported but unusedHai importato un modulo e non lo usiCancella la riga di import
F841 assigned to but never usedUna variabile riceve un valore che nessuno leggeCancellala, o usala: spesso è un nome scritto male
E711 Comparison to Nonex == Nonex is None (e x is not None)
E712 equality comparisons to Truex == Trueif x: (o if not x: per il contrario)
E722 bare exceptUn except: da soloIl tipo dell'errore che ti aspetti: except ValueError:
E741 Ambiguous variable nameUn nome come l, O, I, che somiglia a un numeroUn nome vero, che dice cosa contiene
E701 Multiple statements on one lineif x: return 0 su una rigaVai a capo: lo fa da solo ruff format
N802 Function name … should be lowercaseUna funzione con le maiuscole, come OrarioPartenzaorario_partenza: minuscole e trattino basso
N806 Variable … should be lowercaseUna variabile con la maiuscola dentro una funzioneritardo, minuscolo. Le maiuscole sono per le costanti in cima al file
ANN001 Missing type annotation for function argumentUn parametro senza tipotreno: str
ANN201 Missing return type annotationUna funzione senza il tipo di ciò che restituisce-> str (o -> None se non restituisce niente)
UP015 Unnecessary mode argumentopen(file, "r"): la "r" è già il valore di defaultToglila

La [*] dopo il codice vuol dire che Ruff sa correggerla da solo con ruff check --fix. Fidati dei cambiamenti che fa, ma rileggi sempre cosa ha fatto: e rilancia i test.

Se il problema non è il codice

pytest: command not found, No module named pytest, Nel venv manca Ruff, il pannello Testing vuoto, No module named 'controlli' (hai lanciato pytest da un'altra cartella: cd nella cartella dello zip): non è il tuo codice, è l'ambiente. Il venv va acceso con source .venv/bin/activate, dalla cartella dello zip, e pip install -r requirements.txt va fatto una volta. Ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente.

Per l'estensione Ruff di VS Code, la pagina VS Code per Python.