Gestructureerde uitvoer · oefening
Benoem het type van elke waarde
Aan het eind van les 2 kwam een antwoord met "answer_index": "abc" door elke controle, omdat de controles nooit zeiden welk type elke waarde moest hebben. Voordat je types kunt laten controleren, heb je een manier nodig om ze op te schrijven. Python heeft er een: type hints.
Een hint noemt een type
Een hint komt na een naam, met een dubbele punt:
name: str = "Ana"
count: int = 3
scores: list[int] = [90, 72, 85]
ages: dict = {"Ana": 31}
print(name, count, scores, ages)
name: str = "Ana" lees je als “name is een string, en de waarde is "Ana"”. list[int] betekent een lijst waarvan de items gehele getallen zijn, en list[str] een lijst van strings. Een kale dict zegt dat de waarde een dictionary is, zonder meer te zeggen over de sleutels en waarden; list[dict] is een lijst van dictionaries. Meer vormen heeft deze cursus niet nodig.
Functies krijgen ook hints. Elke parameter krijgt er een na zijn naam, en het resultaat krijgt er een na ->, tussen het sluithaakje en de dubbele punt:
def describe(name: str, count: int) -> str:
return f"{name} has {count} items"
print(describe("scores", 3))
Python controleert hints niet
Een hint is informatie voor mensen en voor tools. Python slaat hem op en negeert hem verder als de code draait:
def double(number: int) -> int:
return number * 2
print(double("ab"))
De hint zegt dat number een geheel getal is, Python roept de functie toch aan met een string, en "ab" * 2 is "abab". Geen fout, geen waarschuwing. Code-editors en controletools zoals mypy lezen hints en kunnen je voor zo’n aanroep waarschuwen voordat je iets uitvoert, en wie def double(number: int) -> int: leest, weet wat hij moet meegeven zonder de body te lezen. Daar zijn hints hier voor: ze zeggen wat een functie verwacht en teruggeeft.
Geef je twee functies hints
Geef de functies uit les 2 hun hints. Alleen de def-regels veranderen:
def quiz_request(note_text: str) -> dict:
def read_quiz_json(text: str) -> list[dict]:
quiz_request krijgt de notitie als tekst en geeft een requestbody terug, een dictionary. read_quiz_json krijgt de tekst van het antwoord en geeft de lijst met vraag-dictionaries terug.
Voer het uit
Voer python structured.py uit. Sinds les 2 roept de demonstratie ook read_quiz_json(42) aan, een getal waar de hint nu tekst zegt:
read_quiz_json given a number instead of text:
TypeError: the JSON object must be str, bytes or bytearray, not int
A QuizQuestion from sample_question:
Run stopped at the next function to build: sample_question is built in Lesson 4.
De uitvoer is hetzelfde voor en na het toevoegen van de hints, en daar gaat het om. De fout komt niet van de hint. Hij komt van json.loads, de eerste regel van de body, die een getal niet kan decoderen. Zonder die regel was het getal verder gereisd voordat er iets misging.
Hints in een klasse
Nog één vorm, omdat les 4 hem leest. In de body van een klasse kan een regel een naam en een hint hebben, en helemaal geen waarde:
question: str
choices: list[str]
answer_index: int
Bovenaan een bestand, zoals hier, doen deze regels niets wat je kunt zien. In een pydantic-model, het soort klasse dat les 4 leest, declareert elke regel een veld: een benoemde waarde die elk object van dat model bevat, met het type dat het moet hebben. In les 4 zie je precies deze drie regels in een klasse die één quizvraag beschrijft, en daar worden ze wel gecontroleerd, omdat pydantic de hints leest.
Een functie is gedefinieerd als def double(number: int) -> int: en geeft number * 2 terug. Wat doet double("ab")?
Welke hint beschrijft wat read_quiz_json teruggeeft?
Opdracht
Voeg in structured.py type hints toe aan de twee functies uit les 2. Verander alleen hun def-regels:
quiz_request(note_text):note_textis eenstr, en de functie geeft eendictterug.read_quiz_json(text):textis eenstr, en de functie geeft eenlist[dict]terug.
Laat de bodies zoals ze zijn: hints veranderen niets als de code draait. Voer python structured.py uit om te zien dat een waarde die een hint niet volgt in de code misgaat, niet in de hint, en controleer daarna je werk.