Programma Les 25 van 250 · Functies
Functies

Docstrings en Type Hints

Twee kleine aanpassingen maken van een werkende functie een professionele functie: een docstring en type hints.

A docstring is een string literal die als de allereerste regel van de functiebody wordt geplaatst. Het legt uit wat de functie doet. Tools en help() lezen het, en Python slaat het op op 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.

Triple quotes laten een docstring over meerdere regels lopen, wat handig is voor langere uitleg.

Type hints geven aan welke types de parameters en de return value moeten zijn. Je schrijft name: type voor elke parameter en -> type voor de return:

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

Hints dwingen niets af tijdens runtime. Python zal je niet tegenhouden om een string door te geven. Ze zijn documentatie die editors en checkers gebruiken om fouten vroegtijdig te vinden, en ze maken je signatures zelfverklarend. Veelvoorkomende hint types zijn int, float, str en bool.

Vanaf nu schrijf je functies met zowel: een duidelijke docstring als eerlijke type hints.

Jij bent aan de beurt

Definieer een functie multiply met type hints def multiply(a: int, b: int) -> int: en een docstring (de eerste regel) die precies Return the product of a and b. zegt. De body moet return a * b.

Een probleem ontdekt in deze les? Meld het · Vraag naar deze les

Deze oefening opent binnenkort

Maak de les ervoor af voordat deze wordt ontgrendeld. De hele cursus is gratis, geen account nodig, en je kunt deze les nu lezen.