Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

function.__doc__

Cet attribut contient la documentation de la fonction ou None si elle n’en a pas.

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

Syntaxe

documentation = function.__doc__

Cet attribut contient la documentation de la fonction ou None si elle n’en a pas.

function.__doc__

Une chaîne littérale en première instruction fournit le docstring. Écrire via un alias modifie les métadonnées du même objet sans modifier le corps.

plain.__doc__ a pour valeur None et area(3) renvoie toujours 9 après modification.

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

Exemples

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

Résultat

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

`plain.__doc__` a pour valeur None et area(3) renvoie toujours 9 après modification.

Sources