【python | gunicorn 】python的文件头如何组织

当我看第一个文件six.py，我发现这个文件的头中包含了作者信息。

之前自己写代码没有编写过这些信息，查了一些网上的信息，见<文件头组成>描述。

但是其实，第5部分的相关信息，写在文件头是有些反clean code原则的，除非这是一个脚本文件。

 

<文件头组成>

1、每个文件的第一行应该是#!/usr/bin/env python。

这使得可以将文件作为隐式调用解释器的脚本运行，例如在CGI上下文中

 

2、接下来应该是带有描述的docstring。如果描述很长，则第一行应该是一个简单的摘要，它自己是有意义的，通过换行符与其余部分分开

 

3、所有代码（包括import语句）都应遵循docstring。否则，解释器将无法识别docstring，您将无法在交互式会话中（即通过obj.__doc__）或使用自动化工具生成文档时访问它。

 

4、首先导入内置模块，然后导入第三方模块，然后对路径和您自己的模块进行任何更改。特别是，模块的路径和名称的添加可能会迅速改变：将它们保存在一个位置使它们更容易找到。

 

5、接下来应该是作者信息。此信息应遵循以下格式：

__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"