显式设置方法的docstring

Question

我帮助维护一个名为nxt-python的python包。它使用元类来定义控制对象的方法。下面是定义可用函数的方法：

class _Meta(type):
    'Metaclass which adds one method for each telegram opcode'

    def __init__(cls, name, bases, dict):
        super(_Meta, cls).__init__(name, bases, dict)
        for opcode in OPCODES:
            poll_func, parse_func = OPCODES[opcode]
            m = _make_poller(opcode, poll_func, parse_func)
            setattr(cls, poll_func.__name__, m)

我希望能够将不同的文档字符串添加到它添加的每个方法中。M是由_make_poller()返回的方法。有什么想法吗？有什么方法可以绕过python对更改文档字符串的限制吗？

Answer 1

对于普通函数：

def f():  # for demonstration
    pass

f.__doc__ = "Docstring!"
help(f)

这在python2和python3中都有效，适用于定义了文档字符串和未定义文档字符串的函数。你也可以做+=。请注意，它是__doc__而不是__docs__。

对于方法，您需要使用方法的__func__属性：

class MyClass(object):

    def myMethod(self):
        pass

MyClass.myMethod.__func__.__doc__ = "A really cool method"

Answer 2

您还可以在类/函数对象上使用setattr并设置文档字符串。

setattr(foo,'__doc__',"""My Doc string""")