从函数中获取docstring

我有以下功能:

def my_func():
    """My docstring is both funny and informative"""
    pass

如何访问docstring？

交互式地,您可以使用它进行显示

help(my_func)

或者从代码中,您可以使用它来检索它

my_func.__doc__

您也可以使用inspect.getdoc.它通过将制表符规范化为空格来清除__doc__,并左移移文档主体以删除公共前导空格.

在ipython或jupyter笔记本上，您可以使用上述所有方法，但我同意

my_func?

要么

?my_func

快速概述方法签名和文档字符串。

我避免使用

my_func??

（如@rohan所评论）以docstring，仅用于检查源代码