Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

function.__doc__

Atrybut funkcji przechowuje jej dokumentację albo None przy braku docstringa.

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

Składnia

documentation = function.__doc__

Atrybut funkcji przechowuje jej dokumentację albo None przy braku docstringa.

function.__doc__

Pierwsza instrukcja będąca literałem tekstowym dostarcza dokumentację. Zmiana atrybutu przez alias działa na ten sam obiekt i nie zmienia obliczeń funkcji.

plain ma None, a po zmianie opisu area(3) nadal daje 9.

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

Przykłady

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))

Wynik

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

plain ma None, a po zmianie opisu area(3) nadal daje 9.

Źródła