标准的Python文件应该按照下面的顺序来组织：
- 起始行（Unix shebang）
- 有了起始行可以直接通过文件名字执行脚本
- 编码注释（
# -*- coding: utf-8 -*-）- 实际上Python只检查#、coding和编码字符串
- 详细了解编码声明可以参考：Python脚本的编码声明
- 模块文档（docstring）
- 从__future__导入的内容（参考PEP8）：
Python mandates that future-imports must appear in the module before any other code except docstrings.
-
1
2
3
4
5
6
7
8
9
__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"
__status__ = "Production"
- 模块导入
- 标准库导入
- 第三方库导入
- 应用程序指定导入
- 每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.
- 全局变量定义
- 应该尽量使用局部变量代替全局变量
- 类定义（如果有）
- 函数定义
- 模块被导入的时候，class就会执行（定义）
- 主程序
- 在主程序里面写测试代码，保证每次都会通过