我在有关 Python 编码指南的文档中发现了以下 Python 源文件的标头格式:
#!/usr/bin/env python
"""Foobar.py: Description of what foobar does."""
__author__ = "Barack Obama"
__copyright__ = "Copyright 2009, Planet Earth"
这是 Python 世界中标头的标准格式吗?
我还可以在标题中放入哪些其他字段/信息?
Python 专家分享优秀 Python 源头的指南 :-)
它的所有元数据Foobar
module.
第一个是docstring
模块的,这已经在中解释过彼得的回答.
如何组织我的模块(源文件)? (档案)
每个文件的第一行应该是#!/usr/bin/env python
.这使得可以将文件作为隐式调用解释器的脚本运行,例如在 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__ = "[email protected]"
__status__ = "Production"
状态通常应为“原型”、“开发”或“生产”之一。__maintainer__
应该是在导入后修复错误并进行改进的人。__credits__
不同于__author__
在那里面__credits__
包括报告错误修复、提出建议等但实际上并未编写代码的人。
Here您有更多信息,列表__author__
, __authors__
, __contact__
, __copyright__
, __license__
, __deprecated__
, __date__
and __version__
作为公认的元数据。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)