Obtener la cadena de documentación de una función
Tengo la siguiente función:
def my_func():
"""My docstring is both funny and informative"""
pass
¿Cómo obtengo acceso a la cadena de documentación?
Aceptado
De forma interactiva, puede visualizarlo con
help(my_func)
O desde el código puede recuperarlo (rodearlo con print(.)para obtener una salida formateada):
my_func.__doc__
También puedes usar inspect.getdoc. Limpia __doc__normalizando las pestañas a espacios y desplazando el cuerpo del documento hacia la izquierda para eliminar los espacios iniciales comunes.
En ipython o jupyter notebook, puedes usar todas las formas mencionadas anteriormente, pero yo elijo
my_func?
o
?my_func
para obtener un resumen rápido de la firma del método y la cadena de documentación.
evito usar
my_func??
(como lo comentó @rohan) para docstring y úselo solo para verificar el código fuente
