重用python类中的方法中的文档字符串

Question

所以我在一个类中有一个方法，并且我有另一个单独的函数（即，在类外部），想要重用该方法的文档字符串。我在单独的函数下尝试了类似__doc__ = <Class Name>.<Method Name>.__doc__的方法，但这不起作用。因此，有办法吗？

Answer 1

__doc__需要分配为新功能like this的属性：

class C:
    def foo(self):
        'docstring'

def bar():
    pass

bar.__doc__ = C.foo.__doc__  # NOT __doc__ = ...

assert bar.__doc__ == 'docstring'

Answer 2

即使是这种情况，我也会使用文档字符串的手动副本。类或功能可以移动或分离到不同的项目。此外，阅读下面的函数并不会让我知道它在做什么。

请向PEP-8，PEP-257和PEP-20咨询以了解阻止此行为的更多信息。

def myfunc():
    ...


myfunc.__doc__ = other_obj.__doc__