在Python中继承方法的文档字符串
我有一个具有文档字符串的OO层次结构，它需要与代码本身一样多的维护。例如，
class Swallow(object):
def airspeed(self):
"""Returns the airspeed (unladen)"""
raise NotImplementedError
class AfricanSwallow(Swallow):
def airspeed(self):
# whatever现在，问题是AfricanSwallow.airspeed没有继承超类方法的文档字符串。我知道我可以使用模板方法模式保留文档字符串，即
class Swallow(object):
def airspeed(self):
"""Returns the airspeed (unladen)"""
return self._ask_arthur()并在每个子类中实现_ask_arthur。然而，我想知道是否有其他方法可以继承文档字符串，也许是一些我还没有发现的装饰器？
回答 5
Stack Overflow用户
发布于 2011-11-12 08:44:32
以类装饰器的风格编写一个函数来为您执行复制。在Python2.5中，您可以在创建类之后直接应用它。在以后的版本中，您可以应用@decorator表示法。
这里是关于如何做到这一点的第一个片段：
import types
def fix_docs(cls):
for name, func in vars(cls).items():
if isinstance(func, types.FunctionType) and not func.__doc__:
print func, 'needs doc'
for parent in cls.__bases__:
parfunc = getattr(parent, name, None)
if parfunc and getattr(parfunc, '__doc__', None):
func.__doc__ = parfunc.__doc__
break
return cls
class Animal(object):
def walk(self):
'Walk like a duck'
class Dog(Animal):
def walk(self):
pass
Dog = fix_docs(Dog)
print Dog.walk.__doc__在较新的Python版本中，最后一部分甚至更简单、更漂亮：
@fix_docs
class Dog(Animal):
def walk(self):
pass这是一种Pythonic技术，与标准库中现有工具的设计完全匹配。例如，类装饰器将缺少的丰富比较方法添加到类中。再举一个例子，装饰器将元数据从一个函数复制到另一个函数。
Stack Overflow用户
发布于 2011-11-12 07:17:19
这是Paul McGuire's DocStringInheritor metaclass的一个变体。
如果子成员的文档字符串为空，
- It将继承父成员的文档字符串。如果子类docstring为空，
- It将继承父类文档字符串。
- 它可以从基类的任何MRO中的任何类继承文档字符串，就像常规的属性继承一样。
- 与使用类装饰器不同，元类是继承的，因此您只需在某个顶级基类中设置一次元类，文档字符串继承将在整个OOP层次结构中发生。
import unittest
import sys
class DocStringInheritor(type):
"""
A variation on
http://groups.google.com/group/comp.lang.python/msg/26f7b4fcb4d66c95
by Paul McGuire
"""
def __new__(meta, name, bases, clsdict):
if not('__doc__' in clsdict and clsdict['__doc__']):
for mro_cls in (mro_cls for base in bases for mro_cls in base.mro()):
doc=mro_cls.__doc__
if doc:
clsdict['__doc__']=doc
break
for attr, attribute in clsdict.items():
if not attribute.__doc__:
for mro_cls in (mro_cls for base in bases for mro_cls in base.mro()
if hasattr(mro_cls, attr)):
doc=getattr(getattr(mro_cls,attr),'__doc__')
if doc:
if isinstance(attribute, property):
clsdict[attr] = property(attribute.fget, attribute.fset,
attribute.fdel, doc)
else:
attribute.__doc__ = doc
break
return type.__new__(meta, name, bases, clsdict)
class Test(unittest.TestCase):
def test_null(self):
class Foo(object):
def frobnicate(self): pass
class Bar(Foo, metaclass=DocStringInheritor):
pass
self.assertEqual(Bar.__doc__, object.__doc__)
self.assertEqual(Bar().__doc__, object.__doc__)
self.assertEqual(Bar.frobnicate.__doc__, None)
def test_inherit_from_parent(self):
class Foo(object):
'Foo'
def frobnicate(self):
'Frobnicate this gonk.'
class Bar(Foo, metaclass=DocStringInheritor):
pass
self.assertEqual(Foo.__doc__, 'Foo')
self.assertEqual(Foo().__doc__, 'Foo')
self.assertEqual(Bar.__doc__, 'Foo')
self.assertEqual(Bar().__doc__, 'Foo')
self.assertEqual(Bar.frobnicate.__doc__, 'Frobnicate this gonk.')
def test_inherit_from_mro(self):
class Foo(object):
'Foo'
def frobnicate(self):
'Frobnicate this gonk.'
class Bar(Foo):
pass
class Baz(Bar, metaclass=DocStringInheritor):
pass
self.assertEqual(Baz.__doc__, 'Foo')
self.assertEqual(Baz().__doc__, 'Foo')
self.assertEqual(Baz.frobnicate.__doc__, 'Frobnicate this gonk.')
def test_inherit_metaclass_(self):
class Foo(object):
'Foo'
def frobnicate(self):
'Frobnicate this gonk.'
class Bar(Foo, metaclass=DocStringInheritor):
pass
class Baz(Bar):
pass
self.assertEqual(Baz.__doc__, 'Foo')
self.assertEqual(Baz().__doc__, 'Foo')
self.assertEqual(Baz.frobnicate.__doc__, 'Frobnicate this gonk.')
def test_property(self):
class Foo(object):
@property
def frobnicate(self):
'Frobnicate this gonk.'
class Bar(Foo, metaclass=DocStringInheritor):
@property
def frobnicate(self): pass
self.assertEqual(Bar.frobnicate.__doc__, 'Frobnicate this gonk.')
if __name__ == '__main__':
sys.argv.insert(1, '--verbose')
unittest.main(argv=sys.argv)Stack Overflow用户
发布于 2016-07-17 02:30:01
仅供大家参考:从Python3.5开始，inspect.getdoc自动从继承层次结构中检索文档字符串。
因此，上面的响应对于Python 2很有用，或者如果您想更有创意地合并父级和子级的文档字符串。
我还创建了一些lightweight tools for docstring inheritance。它们开箱即用，支持一些不错的默认文档字符串样式(numpy、google、reST)。您也可以轻松地使用自己的文档字符串样式
https://stackoverflow.com/questions/8100166
复制相似问题
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号