0%

Strukturierte Ausgabe · Übung

Den Typ jedes Werts benennen

Am Ende von Lektion 2 hat eine Antwort mit "answer_index": "abc" jede Prüfung bestanden, weil die Prüfungen nie gesagt haben, welchen Typ jeder Wert haben soll. Bevor du Typen prüfen lassen kannst, brauchst du eine Möglichkeit, sie aufzuschreiben. Python hat eine: Type Hints (Typhinweise).

Ein Hint benennt einen Typ

Ein Hint steht hinter einem Namen, mit einem Doppelpunkt:

name: str = "Ana"
count: int = 3
scores: list[int] = [90, 72, 85]
ages: dict = {"Ana": 31}
print(name, count, scores, ages)

name: str = "Ana" liest sich als „name ist ein String, und sein Wert ist "Ana"“. list[int] bedeutet eine Liste, deren Elemente ganze Zahlen sind, und list[str] eine Liste von Strings. Ein einfaches dict sagt, dass der Wert ein Dictionary ist, ohne mehr über seine Schlüssel und Werte zu sagen; list[dict] ist eine Liste von Dictionaries. Mehr Formen braucht dieser Kurs nicht.

Auch Funktionen bekommen Hints. Jeder Parameter bekommt einen hinter seinem Namen, und das Ergebnis bekommt einen hinter ->, zwischen der schließenden Klammer und dem Doppelpunkt:

def describe(name: str, count: int) -> str:
    return f"{name} has {count} items"


print(describe("scores", 3))

Python prüft Hints nicht

Ein Hint ist eine Information für Menschen und für Werkzeuge. Python speichert ihn und ignoriert ihn ansonsten, wenn der Code läuft:

def double(number: int) -> int:
    return number * 2


print(double("ab"))

Der Hint sagt, dass number eine ganze Zahl ist, Python ruft die Funktion trotzdem mit einem String auf, und "ab" * 2 ergibt "abab". Kein Fehler, keine Warnung. Code-Editoren und Prüfwerkzeuge wie mypy lesen Hints und können dich vor einem solchen Aufruf warnen, bevor du irgendetwas ausführst, und wer def double(number: int) -> int: liest, weiß, was er übergeben muss, ohne den Rumpf zu lesen. Dafür sind Hints hier da: Sie sagen, was eine Funktion erwartet und zurückgibt.

Füge deinen beiden Funktionen Hints hinzu

Gib den Funktionen aus Lektion 2 ihre Hints. Nur die def-Zeilen ändern sich:

def quiz_request(note_text: str) -> dict:
def read_quiz_json(text: str) -> list[dict]:

quiz_request nimmt die Notiz als Text entgegen und gibt einen Anfrage-Body zurück, ein Dictionary. read_quiz_json nimmt den Antworttext entgegen und gibt die Liste der Frage-Dictionaries zurück.

Ausführen

Führe python structured.py aus. Seit Lektion 2 ruft die Demonstration auch read_quiz_json(42) auf, also eine Zahl, wo der Hint jetzt Text verlangt:

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.

Die Ausgabe ist vor und nach dem Hinzufügen der Hints dieselbe, und genau darum geht es. Der Fehler kommt nicht vom Hint. Er kommt von json.loads, der ersten Zeile des Rumpfs, die keine Zahl dekodieren kann. Ohne diese Zeile wäre die Zahl weiter gewandert, bevor irgendetwas fehlschlägt.

Hints in einer Klasse

Noch eine Form, weil Lektion 4 sie liest. In einem Klassenrumpf kann eine Zeile einen Namen und einen Hint haben und überhaupt keinen Wert:

question: str
choices: list[str]
answer_index: int

Ganz oben in einer Datei, wie hier, bewirken diese Zeilen nichts Sichtbares. In einem Pydantic-Modell, der Art von Klasse, die Lektion 4 liest, deklariert jede davon ein Feld: einen benannten Wert, den jedes Objekt dieses Modells hat, zusammen mit dem Typ, den er haben soll. In Lektion 4 siehst du genau diese drei Zeilen in einer Klasse, die eine Quizfrage beschreibt, und dort werden sie tatsächlich geprüft, weil Pydantic die Hints liest.

Eine Funktion ist als def double(number: int) -> int: definiert und gibt number * 2 zurück. Was macht double("ab")?

Welcher Hint beschreibt, was read_quiz_json zurückgibt?

Aufgabe

Füge in structured.py den beiden Funktionen aus Lektion 2 Type Hints hinzu. Ändere nur ihre def-Zeilen:

  • quiz_request(note_text): note_text ist ein str, und die Funktion gibt ein dict zurück.

  • read_quiz_json(text): text ist ein str, und die Funktion gibt eine list[dict] zurück.

Lass die Rümpfe unverändert: Hints ändern nichts, wenn der Code läuft. Führe python structured.py aus, um zu sehen, dass ein Wert, der gegen einen Hint verstößt, im Code scheitert und nicht am Hint, und prüfe dann deine Arbeit.