Vai al contenuto
code-to-code

Apro l'indice…

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

HTTP e API3. Fare richiestep. 70

Fare richieste, la palestra

Sei funzioni che fanno domande a InfoMenta

  • 60–90 minuti di lavoro

Sei esercizi corti, dal ★ al ★★★. Ognuno è una funzione Python che fa una richiesta a InfoMenta con httpx e restituisce quello che serve a qualcuno della Linea Menta. Ognuno ha il suo file di test: quando è 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.

http-fare-richieste.zip17 KB

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt, 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 quattro passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi.
  2. Al posto di pass scrivi il codice della funzione. La docstring ha gli esempi di cosa deve restituire.
  3. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code.
  4. Rosso? Leggi l'ultima riga del messaggio. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.

I test non hanno bisogno di InfoMenta accesa. Passano alla tua funzione un TestClient, che parla con InfoMenta direttamente (l'esempio E degli esercizi spiegati).

Per vederla dal vivo, invece, InfoMenta va accesa. Nel primo terminale fastapi dev palestra/infomenta.py; nel secondo, il file dell'esercizio:

Terminale
python3 palestra/orari.py

In fondo a ogni file c'è un blocco if __name__ == "__main__": che crea un httpx.Client verso http://127.0.0.1:8000 e chiama la tua funzione. Nel terminale del server vedi arrivare la richiesta.

#EsercizioLa cosa nuovaDifficoltà
1Gli orari sul tabletparams= e .json()★
2Che treno è il numero 5?l'id nel percorso, e il 404★
3Aperte, chiuse o tutteun filtro che a volte non si manda★★
4L'altoparlantejson= e il 201★★
5Il vecchio indirizzoun header della risposta, senza seguire il rimando★★
6Il registro del depositoun header della richiesta, e tre codici★★★

1 · Gli orari sul tablet ★

palestra/orari.py

Lucia Ferri, capotreno, vuole sul tablet di bordo le partenze di una stazione: per ognuna, l'ora e il treno. InfoMenta le dà con GET /partenze?stazione_id=1.

Python
orari_di(client, 1)   # ["05:42 M12", "05:54 M14", "06:06 M12"]
orari_di(client, 4)   # ["06:10 T09"]
orari_di(client, 6)   # []

Come provi: pytest palestra/test_orari.py -v

Aiutino 1
È la richiesta della teoria, con il client: client.get("/partenze", params=…). Il client conosce già l'inizio dell'indirizzo: tu scrivi solo il percorso.
Aiutino 2
risposta.json() è una lista di dizionari. Poi è un setaccio: lista vuota, for, append di f"{partenza['ora']} {partenza['treno']}". Il return fuori dal for.

2 · Che treno è il numero 5? ★

palestra/codice_treno.py

Sergio Colombo, macchinista, ha sul foglio di servizio solo l'id del treno: «il 5». Vuole il codice, quello scritto sul muso. Se il treno non c'è, InfoMenta risponde 404, e la funzione restituisce None.

Python
codice_del_treno(client, 1)    # "M12"
codice_del_treno(client, 5)    # "T09"
codice_del_treno(client, 99)   # None

Come provi: pytest palestra/test_codice_treno.py -v

Aiutino 1
L'id va nel percorso, non nella query: /treni/5. Per metterci dentro il numero, una f-string: f"/treni/{treno_id}".
Aiutino 2
Prima il codice, poi il JSON. Se risposta.status_code è 404, return None; solo dopo leggi risposta.json()["codice"].

3 · Aperte, chiuse o tutte ★★

palestra/stazioni.py

Marta Villa prepara il cartello delle stazioni. A volte le servono le aperte, a volte le chiuse, a volte tutte. Il filtro lo fa InfoMenta: GET /stazioni?aperta=true, GET /stazioni?aperta=false, oppure GET /stazioni senza filtro.

Python
nomi_stazioni(client, True)    # ["Porta Codice", "Via Variabile", "Largo Lista", "Ponte Ciclo", "Piazza Query"]
nomi_stazioni(client, False)   # ["Vecchia Fiera"]
nomi_stazioni(client)          # tutte e sei

Come provi: pytest palestra/test_stazioni.py -v

Aiutino 1
params={"aperta": True} va bene: httpx scrive da solo ?aperta=true. Ma con None scrive ?aperta= con niente dopo, e InfoMenta risponde 422. Quando aperta è None, il parametro non va mandato proprio.
Aiutino 2
Parti da un dizionario vuoto, parametri = {}, e aggiungi la chiave "aperta" solo se serve. Attento all'if: «c'è un filtro?» si chiede con is not None, perché anche False è un filtro.

4 · L'altoparlante ★★

palestra/annuncio.py

Marta Villa manda gli annunci all'altoparlante di Piazza Query: POST /annunci con il corpo {"testo": "…"}. InfoMenta risponde 201 e l'annuncio con il suo id. Ma a volte dice di no: il testo è vuoto (422), o l'altoparlante ha già parlato tre volte nell'ultimo minuto (429). In quei casi la funzione restituisce None.

Python
nuovo_annuncio(client, "Il M12 parte dal binario 2")   # 1
nuovo_annuncio(client, "Attenzione al gradino")        # 2
nuovo_annuncio(client, "")                             # None

Come provi: pytest palestra/test_annuncio.py -v

Aiutino 1
È la POST della teoria: client.post("/annunci", json=…). Con json= il corpo parte in JSON, con il suo Content-Type.
Aiutino 2
Quale codice vuol dire «creato»? Non è 200. Qualunque altro codice: None.
Aiutino 3
KeyError: 'id'? Hai letto il corpo di un errore, che ha solo detail. Il controllo sul codice va prima di .json().

5 · Il vecchio indirizzo ★★

palestra/vecchio_indirizzo.py

Tommaso Greco, macchinista, ha nei preferiti un indirizzo vecchio: /orari. InfoMenta risponde 301 («spostato per sempre») e nell'header location scrive dove guardare adesso. Tommaso vuole sapere dove porta, senza seguirlo. Se l'indirizzo non rimanda da nessuna parte: None.

Python
dove_porta(client, "/orari")                 # "/partenze"
dove_porta(client, "/orari?stazione_id=4")   # "/partenze?stazione_id=4"
dove_porta(client, "/partenze")              # None

Come provi: pytest palestra/test_vecchio_indirizzo.py -v

Uno dei tre test è già verde all'inizio, con il pass: è quello del None. Non è un errore, diventa importante quando scrivi il resto.

Aiutino 1
Rileggi l'esempio E degli esercizi spiegati: il TestClient segue i rimandi da solo. Diglielo tu, nella richiesta: follow_redirects=False.
Aiutino 2
Un header della risposta si legge come la chiave di un dizionario: risposta.headers["location"]. Ma c'è solo nei 301: prima controlla il codice.

6 · Il registro del deposito ★★★

palestra/registro.py

Il registro del deposito è solo per Ernesto Pozzi, il capo deposito (badge B-12). Il badge si manda nell'header Authorization: Bearer B-12. InfoMenta risponde 200 con la lista degli eventi, 401 se non sa chi sei, 403 se lo sa ma non puoi. La funzione restituisce una frase per ogni codice.

Python
leggi_registro(client, "B-12")   # "Ultimo evento: 04:55 M12 uscita"
leggi_registro(client, "B-07")   # "So chi sei, ma non puoi"
leggi_registro(client, "B-99")   # "Chi sei?"

Con il 200, la frase usa l'ultimo evento della lista: ora, treno ed evento, separati da uno spazio.

Come provi: pytest palestra/test_registro.py -v

Aiutino 1
L'header si manda con headers={"Authorization": …}. Il valore è la parola Bearer, uno spazio, il badge: una f-string.
Aiutino 2
Tre codici, tre frasi. Prima due if, uno per il 401 e uno per il 403, ognuno con il suo return. Quello che arriva in fondo è il 200.
Aiutino 3
L'ultimo elemento di una lista è eventi[-1]. Poi una f-string con le sue tre chiavi.

Prova tu: il browser, curl e Postman

Questi non hanno test: si fanno a mano, con InfoMenta accesa. Sono le stesse domande della palestra, con gli altri strumenti.

  1. Il browser. Scrivi nella barra http://127.0.0.1:8000/stazioni?aperta=false: il JSON è quello dell'esercizio 3. Poi prova http://127.0.0.1:8000/orari: dove ti ritrovi? Guarda la barra, dopo.
  2. La scheda Rete. Apri il tabellone, http://127.0.0.1:8000/, con la scheda Rete aperta, e ricarica. Togli il filtro Fetch/XHR: quante richieste vedi? Quale ha un codice diverso da 200, e perché?
  3. curl. Le tre chiamate dell'esercizio 6, con -i. Cambia solo il badge, e guarda la prima riga della risposta:
Terminale
curl -i http://127.0.0.1:8000/deposito/registro -H "Authorization: Bearer B-12"
curl -i http://127.0.0.1:8000/deposito/registro -H "Authorization: Bearer B-07"
curl -i http://127.0.0.1:8000/deposito/registro -H "Authorization: Bearer B-99"
  1. Postman. La richiesta dell'esercizio 4: POST, http://127.0.0.1:8000/annunci, Body → raw → JSON, {"testo": "Prova"}, Send. Ora premi Send altre tre volte, di fila: cosa risponde l'ultima? Guarda anche la scheda Headers della risposta: c'è un header che dice quanti secondi aspettare.

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