guide - python__ doc__
Obtener la docstring de una función (3)
Tengo la siguiente función:
def my_func():
"""My docstring is both funny and informative"""
pass
¿Cómo obtengo acceso a la docstring?
En ipython o jupyter notebook, puede usar todas las formas mencionadas anteriormente, pero voy con
my_func?
o
?my_func
para obtener un resumen rápido de la firma del método y docstring.
Evito el uso
my_func??
(como comentó @rohan) para docstring y utilícelo solo para verificar el código fuente
Interactivamente, puede mostrarlo con
help(my_func)
O desde el código, puedes recuperarlo con
my_func.__doc__
También puedes usar inspect.getdoc . Limpia el __doc__ al normalizar las pestañas en espacios y dejó el desplazamiento del cuerpo del documento para eliminar los espacios iniciales comunes.