python docstring用法_python – 实现保留docstring的类属性

我有一个描述符,可以将方法转换为类级别的属性：

class classproperty(object):

def __init__(self, getter):

self.getter = getter

self.__doc__ = getter.__doc__

def __get__(self, instance, owner):

return self.getter(owner)

像这样使用：

class A(object):

@classproperty

def test(cls):

"docstring"

return "Test"

但是,我现在无法访问__doc__属性(这是合乎逻辑的,因为访问A.test .__ doc__将获取str的__doc__,因为A.test已经返回“Test”.

我的最终目标是我的docstring将出现在sphinx中,因此以任何其他方式检索docstring是不可行的,而不是通过访问属性__doc__属性.我发现自己想知道这是否有可能以任何方式实现.

我知道该属性通过在没有实例的情况下调用返回类来解决此问题.但是,显然这与我的目标相冲突.

我开始担心这在Python中是不可能的.

注意：我愿意在classproperty中拉出任何特技,只要它是稳定的(即不在返回值上设置__doc__).但是,对classproperty的用户施加任何负担是不可行的(即他们应该只使用装饰器并完成它).

解决方法:

实际上,test是返回字符串的属性.你必须继承str并给它一个__doc__属性：

class docstring_str(str):

def __new__(cls, v, __doc__=''):

s = super(docstring_str, cls).__new__(cls, v)

s.__doc__ = __doc__

return s

演示：

>>> class docstring_str(str):

... def __new__(cls, v, __doc__=''):

... s = super(docstring_str, cls).__new__(cls, v)

... s.__doc__ = __doc__

... return s

...

>>> s = docstring_str('Test', 'docstring')

>>> s

'Test'

>>> s.__doc__

'docstring'

用于：

class A(object):

@classproperty

def test(cls):

return docstring_str("Test", "docstring')

因为str对象是不可变的,所以不能在装饰器中设置__doc__属性.您必须返回一个代理对象,而不是完全包装除__doc__属性之外的实际返回值.这变得复杂而且难看.

另一种方法是在元类上加上常规属性;班级：

class MetaClass(type):

@property

def test(cls):

"docstring"

return "Test"

class A(object):

__metaclass__ = MetaClass

现在A有一个test属性,docstring可以作为MetaClass.test .__ doc__或类型(A).test .__ doc__访问：

>>> A.test

'Test'

>>> type(A).test

>>> type(A).test.__doc__

'docstring'

标签：python,decorator,properties,docstring,python-decorators

来源： https://codeday.me/bug/20190612/1226061.html