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

CKTIS / Python

help()

Affiche la documentation d’un objet via l’aide fournie par le module site.

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

Syntaxe

help()
help(request)

Affiche la documentation d’un objet via l’aide fournie par le module site.

Pour meters elle contient la chaîne de documentation de la fonction. Capturer la sortie et vérifier une phrase donne True indépendamment de la mise en page. L’appel renvoie None.

Sans argument l’aide devient interactive.

from contextlib import redirect_stdout
from io import StringIO
def meters():
    """Convert distance into metres."""
out = StringIO()
with redirect_stdout(out):
    assert help(request=meters) is None
assert meters.__doc__ in out.getvalue()

Exemples

from contextlib import redirect_stdout
from io import StringIO

def meters():
    """Convert distance into metres."""

with redirect_stdout(StringIO()) as buffer:
    help(meters)
print("Convert distance into metres." in buffer.getvalue())

Résultat

True

Sans argument l’aide devient interactive.

Sources