WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

help()

Zeigt die Dokumentation eines Objekts mit der vom Modul site bereitgestellten Hilfe.

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

Syntax

help()
help(request)

Zeigt die Dokumentation eines Objekts mit der vom Modul site bereitgestellten Hilfe.

Bei meters enthält sie den Docstring der Funktion. Das Abfangen der Ausgabe und Prüfen eines Satzes ergibt unabhängig vom Layout True. Der Aufruf liefert None.

Ohne Argument startet die interaktive Hilfe.

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

Beispiele

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

Ergebnis

True

Ohne Argument startet die interaktive Hilfe.

Quellen