Programma Lezione 25 di 250 · Funzioni
Funzioni

Docstring e type hint

Due piccoli tocchi trasformano una funzione che funziona in una funzione professionale: una docstring e i type hint.

Una docstring è una stringa messa come primissima riga del corpo della funzione. Spiega che cosa fa la funzione. Gli strumenti e help() la leggono, e Python la salva in 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.

Le triple virgolette permettono a una docstring di occupare più righe, comodo per spiegazioni più lunghe.

I type hint indicano di che tipo dovrebbero essere i parametri e il valore restituito. Scrivi name: type per ogni parametro e -> type per il valore restituito:

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

Gli hint non impongono niente durante l'esecuzione. Python non ti impedirà di passare una stringa. Sono documentazione che editor e strumenti di controllo usano per scoprire presto gli errori, e rendono le tue firme chiare da sole. Tra i tipi più comuni ci sono int, float, str e bool.

Da qui in poi, scrivi le funzioni con entrambi: una docstring chiara e type hint onesti.

Tocca a te

Definisci una funzione multiply con i type hint def multiply(a: int, b: int) -> int: e una docstring (la sua prima riga) che dica esattamente Return the product of a and b.. Il corpo deve fare return a * b.

Hai notato un problema in questa lezione? Segnalalo · Chiedi qualcosa su questa lezione

Questo esercizio si apre presto

Finisci la lezione precedente e questa si sblocca. L'intero corso è gratuito, senza account, e puoi leggere questa lezione subito.