python - 将 pydoc 用于非公共/私人课程

Question

当我使用 _ 作为类名的前缀时（另请参见this和this），该类变为非公共并且不被 pydoc 显示：

    class _DoNotShowMeInPydoc:
      """Class Documentation which is not displayed"""

这正是我想要的，因为这个类只在内部使用，对于使用该模块的人来说并不重要。

但是 - 如果有人来想了解我的模块的内部结构怎么办，（当然）也记录在案。pydoc 是否有显示非公共类的标志或选项？

Answer 1

让我们假设文档有各种各样的受众，并且通过与源代码本身分开的文档来阅读代码是有价值的。

Pydoc 几乎不支持任何开关来控制输出。访问级别通常是临时约定，而不是 python 语言的一部分。

Pydoc 遵循这个不容易总结的规则来决定什么是 private-as-in-do-not-document。因此，您唯一的选择是更改代码以使其通过 visiblename() 函数。

Pdoc3 是 pydoc 的替代品，它使用__pdoc__字典来覆盖类似于 pydoc 的规则。

我创建了一个pydoc 的分支，它默认为所有内容生成文档。