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

时间:2013-03-16 18:12:29

标签: python pydoc

我甚至不确定这些东西是正式调用的,但是,Python有元数据,通常位于模块文件的顶部,例如__version__ = '0.1'

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

1 个答案:

答案 0 :(得分:10)

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

  • 所有正常的全局变量都显示在那里 - 你可以通过在一个模块上运行 pydoc 来看到这一点,其中一些全局变量是空的。
  • 显示“特殊”名称(但不是私人名称):将显示__SomeClass____a_special_variable__等名称,但不会显示__this_is_private等名称。
  • 显示
  • Named tuples,以及与指定它们的模式匹配的任何内容:对象的名称以_开头,对象具有_fields属性(即它具有公共字段)

这些基本规则有例外;保留列表中的名称​​不得到相同的处理:

{'__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中排名很好的地方。