python - インスタンスなしでメソッドのドキュメント文字列にアクセスする、Python

Question

Python では、クラスのインスタンスなしでメソッドの docstring にアクセスするにはどうすればよいですか?

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)