0%

Gestructureerde uitvoer · oefening

Lees een pydantic-model

Les 3 eindigde met drie losse regels, question: str, choices: list[str] en answer_index: int, en de belofte dat ze in een klasse velden declareren. Deze les leest de klasse waar ze bij horen. Die staat in quiz_models.py, naast structured.py. Open het.

Lees quiz_models.py regel voor regel

from pydantic import BaseModel


class QuizQuestion(BaseModel):
    question: str
    choices: list[str]
    answer_index: int

from pydantic import BaseModel importeert uit pydantic, een veelgebruikte bibliotheek om gegevens te beschrijven en te controleren. Hij is geïnstalleerd in je sandbox; thuis is het pip install pydantic==2.14.2, de versie die requirements.txt noemt.

class QuizQuestion(BaseModel): begint een pydantic-model met de naam QuizQuestion. Deze cursus leert je niet om klassen te ontwerpen. Je neemt deze ene regel over als vaste vorm: het woord class, de naam van het model, (BaseModel) en een dubbele punt. Hij vertelt Python en pydantic dat de ingesprongen regels eronder één soort gegevens beschrijven. Volgens afspraak beginnen modelnamen met een hoofdletter en worden woorden aan elkaar geschreven, zoals QuizQuestion.

Vanaf hier gebruikt het hoofdstuk ‘model’ in twee betekenissen: het taalmodel dat het antwoord schrijft, en een pydantic-model zoals QuizQuestion dat gegevens beschrijft. Waar het allebei zou kunnen zijn, zegt de tekst welke bedoeld is.

De drie ingesprongen regels zijn de velden, in de vorm uit les 3. Elke QuizQuestion bevat een question die een string is, choices die een lijst van strings is, en een answer_index die een geheel getal is. Dat is dezelfde vorm die read_quiz_json in les 2 controleerde, opgeschreven als types.

Onder de klasse heeft quiz_models.py nog één regel, QuizSet = None. Dat is een plaatshouder die je in les 5 vervangt.

Maak er een en lees de waarden

Je roept een model aan om er een object van te maken, zoals je int("7") aanroept om een geheel getal te maken. Geef elk veld mee als keywordargument:

from pydantic import BaseModel


class QuizQuestion(BaseModel):
    question: str
    choices: list[str]
    answer_index: int


question = QuizQuestion(question="Which brackets make a list?", choices=["()", "[]", "{}"], answer_index=1)
print(question.question)
print(question.choices[question.answer_index])
print(question.model_dump())

question.choices leest de waarde van het veld choices. Een naam, een punt en een veldnaam lezen een waarde die op een object is opgeslagen. Je hebt dit eerder gedaan zonder het zo te noemen: in Python in de praktijk las je exc.response.status_code van een requests-fout, en in hoofdstuk 3 las je error.partial_text van een StreamBroken. Hier lees je een veld op dezelfde manier. De waarde is een gewone lijst, dus question.choices[question.answer_index] indexeert hem zoals elke lijst.

model_dump() geeft de waarden van het object terug als dictionary:

Which brackets make a list?
[]
{'question': 'Which brackets make a list?', 'choices': ['()', '[]', '{}'], 'answer_index': 1}

Vergeleken met de dictionary die read_quiz_json teruggeeft, maakt een model zijn vorm op één plek zichtbaar, en lees je de waarden met een punt in plaats van met vierkante haken en een sleutel tussen aanhalingstekens. Het controleert ook types, en les 6 zet dat aan het werk: een QuizQuestion maken met answer_index="first" geeft een fout in plaats van een object.

Bouw sample_question en correct_choice

sample_question() maakt één QuizQuestion en geeft die terug, met precies deze waarden:

QuizQuestion(question="What does len([1, 2, 3]) return?", choices=["2", "3", "4"], answer_index=1)

QuizQuestion is al geïmporteerd bovenaan structured.py.

correct_choice(question) krijgt een willekeurige QuizQuestion en geeft de tekst van de goede keuze terug: het item van question.choices op positie question.answer_index. Voor het voorbeeld is dat "3".

Een pydantic-model controleert alleen types, niet of de waarden samen kloppen. Een QuizQuestion met twee keuzes en answer_index=2 is voor pydantic volkomen geldig, en correct_choice werpt dan IndexError op. Laat dat gebeuren: een index voorbij de laatste keuze is een kapotte vraag, en de aanroeper moet dat te horen krijgen in plaats van een verzonnen antwoord.

Voer het uit

Voer python structured.py uit. De demonstratie bouwt je voorbeeldvraag, drukt die af, leest één veld, roept correct_choice aan en dumpt hem:

A QuizQuestion from sample_question:
  QuizQuestion(question='What does len([1, 2, 3]) return?', choices=['2', '3', '4'], answer_index=1)
  question.question is 'What does len([1, 2, 3]) return?'
  correct_choice gives '3'
  model_dump() gives {'question': 'What does len([1, 2, 3]) return?', 'choices': ['2', '3', '4'], 'answer_index': 1}
Run stopped at the next function to build: QuizSet is written in Lesson 5, in quiz_models.py.

De eerste regel laat zien hoe pydantic een model toont: de naam en elk veld met zijn waarde. De run stopt bij QuizSet, de plaatshouder in quiz_models.py, die je hierna schrijft.

question is een QuizQuestion. Welke expressie geeft de lijst met keuzes?

Een QuizQuestion heeft choices=["yes", "no"] en answer_index=5. Wat gebeurt er?

Opdracht

Vervang in structured.py de onafgemaakte bodies van sample_question() en correct_choice(question).

  • sample_question() geeft QuizQuestion(question="What does len([1, 2, 3]) return?", choices=["2", "3", "4"], answer_index=1) terug.

  • correct_choice(question) geeft de tekst van de goede keuze terug: het item van question.choices op positie question.answer_index.

correct_choice leest de velden met een punt en vangt niets af: een answer_index voorbij de laatste keuze werpt IndexError op, en die fout moet de aanroeper bereiken. Voer python structured.py uit om je vraag te zien, en controleer daarna je werk.