Tenga en cuenta que ejecutar Python con -OO elimina las cadenas de documentos. Si tiene la intención de distribuir su código a otros, tenga en cuenta que pueden ejecutarlo de esa manera. Hará que esas personas sean realmente infelices si su código se basa en cadenas de documentos, pero no capta el caso donde no existen.
Por cierto: esta técnica funciona con funciones integradas, así como módulos y clases (ayuda de prueba () con objetos también, también podría funcionar). ¡Esto hace que su shell de Python sea un shell de ayuda interactivo!
Daren Thomas el
3
En el indicador de ipython, puede hacer my_func ?? y también mostraría la cadena de documentación.
ronak
1
help (func) proporciona una salida legible, mientras que func .__ doc__ proporciona una salida en línea. Gracias por la respuesta.
imsrgadich
77
También puedes usar inspect.getdoc. Limpia las __doc__pestañas normalizando los espacios y desplazando a la izquierda el cuerpo del documento para eliminar los espacios iniciales comunes.
Respuestas:
Interactivamente, puede mostrarlo con
O desde el código puede recuperarlo con
fuente
También puedes usar
inspect.getdoc. Limpia las__doc__pestañas normalizando los espacios y desplazando a la izquierda el cuerpo del documento para eliminar los espacios iniciales comunes.fuente
En ipython o jupyter notebook, puede usar todas las formas mencionadas anteriormente, pero sigo con
o
para un resumen rápido de la firma del método y la cadena de documentación.
Evito usar
(como comentó @rohan) para docstring y úselo solo para verificar el código fuente
fuente