python编码规范

#-*-coding:utf-8-*-
'''
Created on 2015年11月2日

@author: Zroad
'''


#1、编码
"""
所有的 Python 脚本文件都应在文件头标上 #-*- coding:utf8 -*- 。设置编辑器，默认保存为 utf8 格式。
"""
#2、main函数
#应用程序要定义main函数而不要直接写脚本
def main():
    dosomething()

if __name__ == "__main__":
    main()

#3、常量
#常量名所有字母大写，由下划线连接各个单词，如：
WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1

#4、变量
#变量名全部小写，由下划线连接各个单词，如：
color = WHITE
this_is_a_variable = 1

"""
不论是类成员变量还是全局变量，均不使用m或g前缀。私有类成员使用单一下划线前缀标识。
变量名不应带有类型信息，因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
"""

#5、函数
#函数名的命名规则与变量名相同。

#6、类
#类名单词首字母大写，不使用下划线连接单词，也不加入 C、T 等前缀。如：
class ThisIsAClass(object):
    pass

#7、模块
#模块名全部小写，对于包内使用的模块，可以加一个下划线前缀，如：
""""
module.py
_internal_module.py
"""

#8、包
#包的命名规范与模块相同

#9、import模块
"""
import 语句有以下几个原则需要遵守：
1）import 的次序，先import Python内置模块，再import第三方模块，最后import自己开发的项目中的其它模块；这几种模块中用空行分隔开来。
2）一条import语句import一个模块。
3）当从模块中 import 多个对象且超过一行时，使用如下断行法（此语法 py2.5 以上版本才支持）：
from module import (obj1, obj2, obj3, obj4,
obj5, obj6)
4）不要使用 from module import *，除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。
"""

#10、赋值：
"""
对于赋值语言，主要是不要做无谓的对齐，如：

a         = 1
variable  = 2
fn        = callback_function
应该写成：

a = 1
variable = 2
fn = callback_function
"""

#11、分支和循环
"""
不要写成一行，如：

if !flg: pass
for i in xrange(10): print i
应该写成：

if !flg:
    pass
for i in xrange(10):
    print i
"""

#12、空格
"""
空格
空格在Python 代码中是有意义的，因为Python的语法依赖于缩进，在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在 Python 代码中没有意义，但适当地加入非前导空格可以增进代码的可读性。
1）在二元算术、逻辑运算符前后加空格：如 a = b + c；
2）在一元前缀运算符后不加空格，如 if !flg: pass；
3）":"用在行尾时前后皆不加空格，如分支、循环、函数和类定义语言；用在非行尾时后端加空格，如 dict 对象的定义 d = {'key': 'value'}。
4）括号（含圆括号、方括号和花括号）前后不加空格，如 do_something(arg1, arg2)，而不是 do_something( arg1, arg2 )；
5）逗号后面加一个空格，前面不加空格。
"""

#13、空行
"""
1）在类、函数的定义间加空行；
2）在import不同种类的模块间加工行；
3）在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔。
"""