Python命名规范

Google Python命名规范

module_name, 模块
package_name, 包
ClassName, 类
method_name, 方法
ExceptionName, 异常
function_name, 函数
GLOBAL_VAR_NAME, 常量
instance_var_name, 实例
function_parameter_name, 参数
local_var_name. 本变量

类
　　总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。

函数&方法
　　小写+下划线
　　*注意*：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容。

函数和方法的参数
　　如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线

全局变量
　　对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线。
　　*注意*:应避免使用全局变量

变量
　　小写，由下划线连接各个单词。如color = WHITE，this_is_a_variable = 1
　　*注意*：
　　1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
　　2.私有类成员使用单一下划线前缀标识。
　　3.变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量
　　常量名所有字母大写，由下划线连接各个单词如MAX_OVERFLOW，TOTAL。

异常
　　以“Error”作为后缀。

文件名
　　全小写,可使用下划线

包
　　应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。

模块
　　与包的规范同。如mymodule。

缩写
　　命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
　　1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
　　2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。

　　例如：
　　function 缩写为 fn
　　text 缩写为 txt
　　object 缩写为 obj
　　count 缩写为 cnt
　　number 缩写为 num，等。

前导后缀下划线
　　一个前导下划线：表示非公有。
　　一个后缀下划线：避免关键字冲突。
　　两个前导下划线：当命名一个类属性引起名称冲突时使用。
　　两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。
　　*注意*：关于下划线的使用存在一些争议。

特定命名方式
　　主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如
　　class Base(object):
　　　　def __init__(self, id, parent = None):
　　　　　　self.__id__ = id
　　　　　　self.__parent__ = parent
　　　　def __message__(self, msgid):
　　其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。