python - 如何访问属性的文档？

Question

我有一个带有文档字符串的属性，但我似乎无法使用 help() 访问它。

我尝试了以下两种访问方式:

class Mini(object):
    @property
    def t(self):
        """ ahhhh """
        return 0

x = Mini()
help(x.t)

class MiniNew(object):
    t = property(doc='This is a doc')

y = MiniNew()
help(y.t)

第一个帮助返回了Help on int object: blahblahblah，第二个帮助返回了AttributeError: unreadable attribute。

访问属性文档的正确方法是什么？

Answer 1

您需要从类中访问该属性。从实例访问时，它就像返回值一样，这不是您记录的内容。

class Example(object):
    @property
    def value(self):
        """help text"""
        return 1

help(Example.value)

这将打印:

Help on property:

    help text