Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / Python

help()

Muestra la documentación de un objeto mediante la ayuda suministrada por el módulo site.

Versión: Python 3.14; repository image, production runtime not attested

Sintaxis

help()
help(request)

Muestra la documentación de un objeto mediante la ayuda suministrada por el módulo site.

Para meters contiene la cadena de documentación de la función. Capturar la salida y comprobar una frase da True sin depender de la disposición. La llamada devuelve None.

Sin argumento inicia la ayuda interactiva.

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

Ejemplos

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

Resultado

True

Sin argumento inicia la ayuda interactiva.

Fuentes