WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

function.__doc__

Dieses Funktionsattribut enthält den Docstring oder None bei fehlender Dokumentation.

Version: Python 3.14; repository image, production runtime not attested

Syntax

documentation = function.__doc__

Dieses Funktionsattribut enthält den Docstring oder None bei fehlender Dokumentation.

function.__doc__

Ein Zeichenkettenliteral als erste Anweisung liefert den Docstring. Schreiben über einen Alias ändert Metadaten desselben Objekts ohne Änderung des Rumpfs.

plain hat None und area(3) liefert nach der Änderung weiterhin 9.

def f():
    n=1
    "Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'

Beispiele

def area(n):
    """Return the area of a square."""
    return n*n
def plain(): pass
alias = area
print(area.__doc__, plain.__doc__)
alias.__doc__ = "Area in cm²."
print(area.__doc__, area(3))

Ergebnis

Return the area of a square. None
Area in cm². 9

plain hat None und area(3) liefert nach der Änderung weiterhin 9.

Quellen