Python 的 pydoc 帮助函数从哪里获取其内容？

Question

我有很多可调用对象，它们都正确填写了 __doc__ 字符串，但是对它们运行帮助会生成其类的帮助，而不是基于 __doc__ 的帮助。

我想更改它，以便对它们运行帮助会生成自定义帮助，这些帮助看起来基本上就像如果它们是实际函数而不是实现 __call__ 的类的实例时我会得到的帮助。

在代码中，我想使输出如下：

class myCallable:
    def __init__(self, doc):
        self.__doc__ = doc

    def __call__(self):
        # do some stuff
        pass

myFunc = myCallable("some doco text")
help(myFunc)

看起来更像是输出：

def myFunc():
    "some doco text"
    # do some stuff
    pass

help(myFunc)

Answer 1

help 函数（在 pydoc 模块中实现）不准备查找每个实例的文档字符串。我快速浏览了该模块，看看是否有办法提供明确的帮助，但似乎没有。它使用 inspect 模块来确定它是什么类型的东西，并且你的 myFunc 看起来不像一个函数，它看起来像一个实例。因此 pydoc 会打印有关实例类的帮助。

如果与 __doc__ 类似，您可以添加一个 __help__ 属性，那就太好了，但不支持这样做。

我犹豫是否建议这样做，但最好的选择可能是定义一个新的 help 函数：

old_help = help
def help(thing):
    if hasattr(thing, '__help__'):
        print thing.__help__
    else:
        old_help(thing)

然后在您的实例上放置一个 __help__ 属性：

class myCallable:
    def __init__(self, doc):
        self.__doc__ = doc
        self.__help__ = doc

Answer 2

我不太清楚你的问题到底是什么。我的理解是，你有一个类和其中定义的函数，并且你想知道 Python 从哪里获取该函数的帮助文本。

Python 从该类/方法中提供的文档字符串中获取帮助文本。

如果您有一个类“A”和该类中的方法“f”，并且函数“f”中有文档字符串，那么以下终端转储应该有助于清除您的问题：

>>> class A:
        def __init__(self):
            self.c = 0   # some class variable
        def f(self, x):
            """this is the documentation/help text for the function "f" """
            return x+1

>>> help(A.f)
Help on method f in module __main__:

f(self, x) unbound __main__.A method
this is the documentation/help text for the function "f" 

>>> A.f.__doc__
'this is the documentation/help text for the function "f" '

希望这有帮助