从函数获取文档string
我有以下function:
def my_func(): """My docstring is both funny and informative""" pass
我如何获得文档string?
以交互方式显示
help(my_func)
或者从代码你可以检索它
my_func.__doc__
你也可以使用inspect.getdoc 。 它通过将制表符归一化为空格并向左移动文档主体来移除常用的前导空格来清理__doc__。
在ipython或jupyter笔记本上,你可以使用上面提到的所有方法,但是我一起去
my_func?
要么
?my_func
快速总结方法签名和文档string。
我避免使用
my_func??
(如@rohan所评论的)docstring,并只用它来检查源代码