python - 如何在 python 中记录部分应用的函数？

Question

我的包中有几个部分应用的函数 ( functools.partial)。我怎样才能记录它们？我试过设置，myfunc.__doc__但这似乎不起作用。我希望在使用 Sphinx 构建 API 文档时显示文档。

一个例子是：

from collections import deque
from functools import partial

# Consume an iterable
consume = partial(deque, maxlen=0)
consume.__doc__ = "Consume an iterable"

当我使用 sphinx 生成我的 API 文档时，或者当我以交互方式导入它并调用help(consume). 就像是：

consume(Iterable)
    Consume an iterable

所以我更新了__doc__. 但是调用help(consume)仍然显示文档partial，Sphinxconsume完全忽略（见截图）！这个例子是微不足道的，但在我的包中，我还有其他案例，文档中可以提到很多，例如代码示例。

编辑：我想我有备用选项来实际编写一个单行函数包装器。

标签： pythonpython-3.xpython-sphinxfunctools