python编码规范
参考
https://www.python.org/dev/peps/pep-0008/
http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/
https://google.github.io/styleguide/pyguide.html
用Python进行开发时的编码风格约定（epes:PEP 008《Style Guide for Python Code》）
- 分号：不要在行尾加分号, 也不要用分号将两条命令放在同一行.
- 行长度：每行不超过80个字符
- 缩进：使用4个空格来缩进代码，不要使用tab，或者tab空格混用
- 空行：函数或者类定义之间空2行，方法定义之间空1行
- 空格：不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).
- 类：如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.
- 导入格式：每个导入应该独占一行
- 语句：通常每个语句应该独占一行
命名
module_name
package_name
method_name
instance_var_name
function_parameter_name
local_var_name
function_name
ClassName
ExceptionName
GLOBAL_VAR_NAME
1、所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的
- 用单下划线(_)开头表示模块变量或函数是protected的(使用from package import * 时不会包含)
- 用双下划线(__)开头的实例变量或方法表示类内私有
2、将相关的类和顶级函数放在同一个模块里。 不像Java, 没必要限制一个类一个模块
3、对类名使用大写字母开头的单词(驼峰命名), 但是模块名应该用小写加下划线的方式(如lower_with_under.py)。尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰。