将文档字符串添加到namedtuple字段中
问题描述:
我知道可以通过继承它来为namedtuples添加文档字符串,例如,将文档字符串添加到namedtuple字段中
from collections import namedtuple
NT = namedtuple('NT', ['f1', 'f2', 'f3'])
class NTWithDoc(NT):
""" DOCSTRING """
__slots__ =()
现在我想为f1,f2和f3添加文档字符串。有没有办法做到这一点?我们公司正在使用Python2,不认为人们会让我使用3.
答
我不确定在python2.x上是否有这样做的好方法。在python3.x,你可以换出__doc__
直接:
$ python3
Python 3.6.0a2 (v3.6.0a2:378893423552, Jun 13 2016, 14:44:21)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from collections import namedtuple
>>> NT = namedtuple('NT', ['f1', 'f2', 'f3'])
>>> NT.f1.__doc__
'Alias for field number 0'
>>> NT.f1.__doc__ = 'Hello'
不幸的是,python2.x让你在这一点上的错误:
>>> NT.f1.__doc__ = 'Hello World.'
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: readonly attribute
在python2.x,你可以得到它重新定义的所有属性:
>>> from collections import namedtuple
>>> NT = namedtuple('NT', ['f1', 'f2', 'f3'])
>>> class NTWithDoc(NT):
... """docstring."""
... __slots__ =()
... f1 = property(NT.f1.fget, None, None, 'docstring!')
...
>>> help(NTWithDoc)
>>> a = NTWithDoc(1, 2, 3)
>>> a.f1
1
但是,这感觉就像是很多的麻烦去获得文档字符串:-)。
请注意,您不需要在该代码中使用'pass':-) – mgilson
反正您使用的是py 2或py 3 –
请确定您是否使用了[本主题](http://stackoverflow.com/questions/1606436/adding -docstrings-to-namedtuples)覆盖问题? – alecxe