Python中的规范方式是向/从文档字符串添加或检索元信息？

Question

我想在我的Python模块的文档字符串中添加一些元信息,例如作者,电子邮件,版本.有没有规范的方法呢？我搜索了很长一段时间,但在这里或网上找不到具有明确权限的东西.

PEP 426 - Python软件包2.0的元数据谈论它.它看起来像__author__,__version__其他一些被pydoc(V2.7)认可.此外,还有epydoc和sphinx-doc.

是否有标准方法在docstring中包含此类信息？还是作为全局变量？如果是,是否有可接受的关键字/变量名称列表？

例:

#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
   Author: Sue Baru
   EMail: sb@carparts.com
   Version: 1.0
"""

更新

这不是一个真正的答案,但我最终使用了__author__'关键字'而没有别的.通过检入git仓库来完成版本控制.

Answer 1

Sphinx 是这样做的（使用 reST）：

"""A pypi demonstration vehicle.

.. moduleauthor:: Andrew Carter <andrew@invalid.com>

"""

有关更多信息，请参阅使用 Sphinx 记录您的项目和此备忘单。