python - Python 文档字符串中的字符串操作

Question

我一直在努力做到以下几点:

#[...]
    def __history_dependent_simulate(self, node, iterations=1,
                                     *args, **kwargs):
        """
        For history-dependent simulations only:
        """ + self.simulate.__doc___

我在这里试图完成的是让这个私有(private)方法的文档与方法 simulate 的文档相同，除了简短的介绍。这将使我能够避免复制粘贴，保留更短的文件，并且不必每次都更新两个函数的文档。

但它不起作用。有谁知道原因，或者是否有解决方案？

Answer 1

更好的解决方案可能是使用装饰器，例如:

def add_docs_for(other_func):  
    def dec(func):  
        func.__doc__ = other_func.__doc__ + "\n\n" + func.__doc__
        return func
    return dec

def foo():
    """documentation for foo"""
    pass

@add_docs_for(foo)
def bar():
    """additional notes for bar"""
    pass

help(bar) # --> "documentation for foo // additional notes for bar"

这样你就可以对文档字符串进行任意操作。