它是Foobar
模块的所有元数据。
第一个是docstring
模块的,已经在Peter的答案中进行了解释。
这样就可以将文件作为脚本运行,例如在CGI上下文中隐式调用解释器。
如果描述很长,则第一行应该是一个简短的摘要,该摘要应具有其自身的意义,并以换行符分隔其余部分。
否则,解释器将无法识别该文档字符串,并且您将无法在交互式会话中(即通过obj.__doc__
)或使用自动化工具生成文档时访问该文档字符串。
特别是,模块的路径和名称的添加可能会快速更改:将它们放在一个位置可以使它们更容易找到。
此信息应遵循以下格式:
__author__ = "Rob Knight, Gavin Huttley, and Peter Maxwell"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Rob Knight", "Peter Maxwell", "Gavin Huttley",
"Matthew Wakefield"]
__license__ = "GPL"
__version__ = "1.0.1"
__maintainer__ = "Rob Knight"
__email__ = "rob@spot.colorado.edu"
__status__ = "Production"
状态通常应为“原型”,“开发”或“生产”之一。__maintainer__
应该是将修复错误并进行改进(如果导入)的人。__credits__
不同之处在于__author__
,这些__credits__
人报告了错误修复,提出了建议等,但实际上并未编写代码。
在这里你有更多的信息,上市__author__
,__authors__
,__contact__
,__copyright__
,__license__
,__deprecated__
,__date__
和__version__
作为公认的元数据。