Lehrplan Lektion 25 von 250 · Funktionen
Funktionen

Docstrings und Type Hints

Zwei kleine Anpassungen machen eine funktionierende Funktion zu einer professionellen: ein docstring und type hints.

A docstring ist ein String-Literal, das als allererste Zeile im Funktionskörper platziert wird. Es erklärt, was die Funktion tut. Tools und help() lesen es, und Python speichert es auf function.__doc__:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

Dreifache Anführungszeichen erlauben es einem docstring, über mehrere Zeilen zu gehen, was für längere Erklärungen praktisch ist.

Type hints geben an, welche Typen für die Parameter und den Rückgabewert erwartet werden. Du schreibst name: type für jeden Parameter und -> type für den Rückgabewert:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

Hints erzwingen nichts zur Laufzeit. Python wird dich nicht daran hindern, einen String zu übergeben. Sie sind Dokumentationen, die Editoren und Prüfer nutzen, um Fehler frühzeitig zu finden, und sie machen deine Signaturen selbsterklärend. Häufige Hint-Typen sind int, float, str und bool.

Ab jetzt schreibst du Funktionen mit beidem: einem klaren docstring und ehrlichen type hints.

Du bist dran

Definiere eine Funktion multiply mit Typenhinweisen def multiply(a: int, b: int) -> int: und einem Docstring (seine erste Zeile) mit dem Text Return the product of a and b.. Der Körper sollte return a * b.

Ein Problem in dieser Lektion entdeckt? Melde es · Frage zu dieser Lektion

Diese Übung öffnet bald

Beende die vorherige Lektion, damit diese freigeschaltet wird. Der ganze Kurs ist kostenlos, kein Konto erforderlich, und du kannst diese Lektion jetzt direkt lesen.