Kurrikulum Leson 25 van 250 · Funksies
Funksies

Docstrings en Tipwysings

Twee klein aanpassings verander 'n werkende funksie in 'n professionele een: 'n docstring en type hints.

A docstring is 'n string-letterling wat as die heel eerste reël van die funksie-liggaam geplaas word. Dit verduidelik wat die funksie doen. Gereedskap en help() lees dit, en Python stoor dit 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.

Trippelaanhalingstekens laat 'n docstring oor meerdere reëls strek, wat handig is vir langer verduidelkings.

Type hints aandui watter tipes die parameters en die terugwaarde moet wees. Jy skryf name: type vir elke parameter en -> type vir die terugwaarde:

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

Wysings dwing niks af tydens uitvoering nie. Python sal jou nie verhoed om 'n string oor te gee nie. Hulle is dokumentasie wat redakteure en kontroleerders gebruik om foute vroeg te vang, en hulle maak jou signatures selfverduidelikend. Algemene wysingstipes sluit int, float, str, en bool in.

Van nou af af skryf jy funksies met albei: 'n duidelike docstring en eerlike type hints.

Jou beurt

Definieer 'n funksie multiply met tipewenke def multiply(a: int, b: int) -> int: en 'n docstring (die eerste reël) wat presies Return the product of a and b. lees. Die liggaam moet return a * b.

Sien jy 'n probleem in hierdie les? Rapporteer dit · Vra oor hierdie les

Hierdie oefening open binnekort

Voltooi die lesie voor dit en hierdie een sal ontvanklik wees. Die hele kursus is gratis, geen rekening nodig nie, en jy kan hierdie les nou lees.