从函数中获取docstring

时间:2009-04-03 09:04:10

标签: python

我有以下功能:

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

如何访问docstring?

3 个答案:

答案 0 :(得分:205)

交互式地,您可以使用

显示它
help(my_func)

或者您可以使用

检索代码
my_func.__doc__

答案 1 :(得分:68)

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

答案 2 :(得分:3)

在ipython或jupyter笔记本上,您可以使用上述所有方法,但我选择

my_func?

?my_func

用于快速汇总方法签名和docstring。

我避免使用

my_func??
对于docstring,

(由@rohan评论)并仅用于检查源代码