python - 记录由 C API 生成的 Python 模块的最佳方法是什么？

Question

我在我的 C 应用程序中嵌入和扩展了 python，现在我想记录一下。我已经使用 C API 定义了一个模块，因此 pydoc 工具将看不到它（对吗？）。

到目前为止，我能想到的最好方法是在运行时在我的模块上使用“pydoc”模块（因此我定义的扩展模块将出现）。这应该允许我为我的 API 吐出 HTML 和文本版本的文档。

像（在我的脑海中）：

import pydoc
import sys

d = pydoc.HTMLDoc()
print(d.page("my api", d.docmodule(sys.modules["mymodule"])))

有没有更好的办法？

Answer 1

我不确定你是如何使用 C-API 的（因为你刚刚说过你已经在你的 C 应用程序中嵌入和扩展了 Python）。

但是，pydoc 导入一个模块并使用自省为模块生成文档，因此如果您在已编译的模块上运行它，它仍然可以工作。关键是它不看源头。