python - pydoc 支持 python 元数据，例如 __version__ = '0.1'

Question

我什至不确定这些东西的正式名称是什么，尽管 Python 有元数据，通常位于模块文件的顶部，例如 __version__ = '0.1'。

如何找到 PyDoc 支持的所有列表？

Answer 1

任何遵循特定命名约定的顶级私有(private)全局变量都将包含在 Pydoc 生成的 Data 部分中:

• 所有普通的全局变量都显示在那里——您只需在包含一些全局变量的模块上运行 pydoc 就可以看到这一点，否则这些全局变量是空的。
• 显示“特殊”名称(但不显示私有(private)名称):将显示 __SomeClass__ 或 __a_special_variable__ 等名称，但显示 __this_is_private不会。
• Named tuples被显示，与指定它们的模式匹配的任何东西:对象的名称以 _ 开头并且对象具有 _fields 属性(即它具有公共(public)字段)。

这些基本规则也有异常(exception)；保留列表中的名称​​不会得到相同的处理:

{'__author__', '__builtins__', '__cached__', '__credits__',
 '__date__', '__doc__', '__file__', '__initializing__',
 '__loader__', '__module__', '__name__', '__package__',
 '__path__', '__qualname__', '__slots__', '__version__'}

Pydoc 将自动为 __version__、__date__、__author__ 和 __credits__ 构建不同的部分。其他的是“冗余的或内部的”(例如 __name__ 和 __package__ 被分配到它们自己的部分，但 Pydoc 也会自动生成这些字段，无论您是否设置它们)。

所有这些都可以通过浏览 source 找到，但似乎没有任何其他地方汇编此信息 — 或者至少没有一个在 Google 中排名靠前的地方。