python - 访问没有实例的方法文档字符串，Python

Question

在 Python 中，如何在没有类实例的情况下访问方法上的文档字符串？

Answer 1

您可以使用__doc__：

class Test():
    def test_method(self):
        """I'm a docstring"""
        print "test method"


print Test.test_method.__doc__  # prints "I'm a docstring"

或者，来自模块的getdoc() ：inspect

inspect.getdoc(object)

获取一个对象的文档字符串，用 cleandoc() 清理。

print inspect.getdoc(Test.test_method)  # prints "I'm a docstring"

Answer 2

你可以help()在这里使用：

>>> class Test:
...     def foo(self, bar):
...             """ Returns the parameter passed """
...             return bar
... 
>>> help(Test.foo)

回报：

Help on method foo in module __main__:

foo(self, bar) unbound __main__.Test method
    Returns the parameter passed
(END)