Docstring是变量还是函数？

Question

我已经开始了一个小项目，开发了一些使用sklearn操作的方便类。

由于使用了sklearn父类，它们中的大多数都很短，但我最终得到了巨大的Docstring，每当我试图进行小更改或检查类时，它都会降低可读性。

有没有什么正式的方法可以在不“欺骗”?和不在类中使用多行注释的情况下保留Docstring的属性(即可用于help()、__doc__或Python )？

到目前为止，我得到的唯一方法是：

doc_foo = """foo docstring"""
doc_bar = """bar docstring"""

class foo(object):

    __doc__ = doc_foo

    def __init__(self):
        pass

    def bar(self):
        pass

但是，这只适用于类，而不适用于方法或函数。

Answer 1

您可以在定义函数后设置该函数的docstring。

def bar(self):
    pass

bar.__doc__ = doc_bar

你可以通过一个装饰器来实现这一点：

def set_doc(docstr):
    def _(f):
        f.__doc__ = docstr
        return f
    return _


@set_doc(doc_bar)
def bar(self):
    pass