0%

Strukturierte Ausgabe · Übung

Die Antwort des Modells validieren

Du hast jetzt ein Pydantic-Modell, das die Form des Quiz einschließlich der Typen festlegt. In dieser Lektion prüfst du damit die Antwort des Sprachmodells: den JSON-Text dekodieren, jeden Schlüssel und jeden Typ prüfen und entweder ein QuizSet zurückbekommen oder eine genaue Liste dessen, was falsch ist. Daten so gegen ein Modell zu prüfen, nennt man Validierung (validation).

Dekodiere und validiere in einem Schritt

Jedes Pydantic-Modell hat eine Methode, die JSON-Text entgegennimmt:

quiz = QuizSet.model_validate_json(text)

Sie erledigt die Arbeit von json.loads und von jeder Prüfung in read_quiz_json und prüft zusätzlich die Typen. Ist der Text ein gültiges Quiz, bekommst du ein QuizSet. Ist er es nicht, egal aus welchem Grund, löst sie einen einzigen Fehler aus: pydantic.ValidationError. Text, der überhaupt kein JSON ist, löst denselben Fehler aus, ein Aufrufer muss also nur eine Ausnahme behandeln.

ValidationError wird oben in structured.py aus pydantic importiert.

Was der Fehler sagt

Hier ist die Antwort, die in Lektion 2 durch read_quiz_json gerutscht ist:

from pydantic import BaseModel, ValidationError


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


class QuizSet(BaseModel):
    questions: list[QuizQuestion]


text = '{"questions": [{"question": "Q?", "choices": ["a", "b"], "answer_index": "abc"}]}'
try:
    QuizSet.model_validate_json(text)
except ValidationError as error:
    print(error)
    for item in error.errors():
        print(item["loc"], item["msg"])
1 validation error for QuizSet
questions.0.answer_index
  Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='abc', input_type=str]
    For further information visit https://errors.pydantic.dev/2.14/v/int_parsing
('questions', 0, 'answer_index') Input should be a valid integer, unable to parse string as an integer

Wenn du den Fehler ausgibst, bekommst du einen vollständigen Bericht für Programmierer, mit einem Link zur Dokumentation von Pydantic. error.errors() liefert dieselben Fakten als Daten: eine Liste mit einem Dictionary pro Problem. Zwei Schlüssel sind hier wichtig. "loc" gibt an, wo das Problem liegt, als Tupel von Schritten vom Anfang des Dokuments aus: der Schlüssel questions, Element 0 dieser Liste, dessen Schlüssel answer_index. Die Positionen in einer Liste sind ganze Zahlen; die Schlüssel sind Strings. "msg" sagt in einem Satz, was falsch ist.

Eine Antwort mit mehreren Problemen liefert mehrere Elemente, in der Reihenfolge, in der Pydantic sie gefunden hat. Text, der kein JSON ist, liefert ein Element, dessen loc leer ist, (), weil das Problem die ganze Antwort ist, und dessen Meldung mit Invalid JSON beginnt.

Hier sind die drei Arten, eine Antwort zu lesen, die dieses Kapitel verwendet hat, nebeneinander. numbered_lines und read_quiz_json geben jeweils ohne Beschwerde einen falschen Wert zurück. Das Pydantic-Modell bricht ab, und sein Fehler sagt, wo das Problem liegt.

Freier Text und von Hand geprüftes JSON lassen beide einen falschen Wert ohne Fehler durch, während ein Pydantic-Modell ValidationError auslöst und questions.0.answer_index nennt.

Baue parse_quiz und error_lines

parse_quiz(text) gibt QuizSet.model_validate_json(text) zurück. Die Funktion fängt nichts ab: Was mit einer ungültigen Antwort geschehen soll, entscheidet der Aufrufer, und Lektion 8 gibt dem Aufrufer etwas Sinnvolles zu tun.

error_lines(error) macht aus einem ValidationError kurze Zeilen, eine pro Element von error.errors(), jede f"{location}: {item['msg']}". Baue location aus den Teilen von item["loc"]: Wandle jeden Teil mit str() um, weil einige ganze Zahlen sind und ".".join nur Strings verbindet, und verbinde sie dann mit ".". So wird aus ('questions', 0, 'answer_index') questions.0.answer_index. Wenn loc leer ist, verwende stattdessen (whole reply).

Ausführen

Führe python structured.py aus. Die Demonstration validiert die JSON-Antwort aus Lektion 2 mit deinem parse_quiz, gibt ihm dann drei ungültige Antworten und gibt für jede deine error_lines aus:

The JSON reply, validated by parse_quiz:
  3 questions. The first answer is '85'.
Replies that fail validation, explained by error_lines:
  questions.0.answer_index: Input should be a valid integer, unable to parse string as an integer
  questions.0.question: Field required
  questions.0.answer_index: Field required
  (whole reply): Invalid JSON: expected value at line 1 column 1
The system message from quiz_system_message:
Run stopped at the next function to build: quiz_system_message is built in Lesson 7.

Die erste ungültige Antwort hat "abc", wo eine ganze Zahl hingehört. Die zweite hat eine Frage mit nur choices, es fehlen also zwei Felder, und du bekommst zwei Zeilen. Die dritte ist Here is your quiz!, und das ist kein JSON. Jede Zeile sagt, wo und was, und mehr braucht ein Mensch oder ein Sprachmodell nicht, um die Antwort zu korrigieren.

Was Validierung nicht verspricht

Drei Dinge solltest du im Kopf behalten:

  • Pydantic wandelt manche Werte um. Für ein int-Feld akzeptiert es den String "3" als 3 und true als 1. Bei Text, der über das Netzwerk kam, ist das meist das, was du willst, aber es ist keine strenge Typprüfung.

  • Ein gültiges Quiz kann trotzdem falsch sein. Eine Frage mit zwei Auswahlmöglichkeiten und "answer_index": 5 ist gültig, weil 5 eine ganze Zahl ist. Validierung prüft die Form, die du deklariert hast. Wenn darüber hinaus eine Regel wichtig ist, etwa dass der Index zu den Auswahlmöglichkeiten passt, muss dein Programm sie selbst prüfen.

  • Das ist ein anderer Fehler als der von read_quiz_json. read_quiz_json hat einen einfachen ValueError ausgelöst, den du geschrieben hast. parse_quiz löst Pydantics ValidationError aus. Ein ValidationError ist eine Art ValueError, also würde except ValueError: beide abfangen, aber except ValidationError: sagt genau, was du meinst, und das fängt der Rest dieses Kapitels ab.

parse_quiz bekommt den Text Sure! Here is your quiz. Was passiert?

Warum wandelt error_lines jeden Teil von loc mit str() um, bevor es sie verbindet?

Aufgabe

Ersetze in structured.py die unfertigen Rümpfe von parse_quiz(text) und error_lines(error).

  • parse_quiz(text) gibt QuizSet.model_validate_json(text) zurück. Die Funktion fängt nichts ab, ein ValidationError kommt also beim Aufrufer an.

  • error_lines(error) nimmt einen ValidationError entgegen und gibt eine Liste mit einem String pro Element von error.errors() zurück: f"{location}: {item['msg']}". Die Ortsangabe besteht aus den Teilen von item["loc"], jeder mit str() umgewandelt und mit "." verbunden, wie in questions.0.answer_index. Wenn loc leer ist, lautet die Ortsangabe (whole reply).

Führe python structured.py aus, um zu sehen, wie eine Antwort validiert wird und drei ungültige Antworten erklärt werden, und prüfe dann deine Arbeit.