访问没有实例的方法docstring,Python

时间:2013-09-05 09:24:06

标签: python docstring

在Python中,如何在没有类实例的方法上访问文档字符串?

2 个答案:

答案 0 :(得分:3)

您可以使用__doc__

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


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

或者来自inspect模块的getdoc()

  

inspect.getdoc(object)

     

获取对象的文档字符串,   清理了cleandoc()。

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

答案 1 :(得分:1)

您可以在此处使用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)