Python命名规范

搬运：https://zhuanlan.zhihu.com/p/423130392

文件名、包名、模块名、局部变量名、函数&方法名

全小写+下划线式驼峰 example：this_is_var

类

首字母大写式驼峰。如ClassName()。

内部类可以使用额外的前导下划线。

函数和方法的参数

类实例方法第一个参数使用self, 类方法第一个参数使用cls

如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线好于使用缩写或奇怪的拼写。

全局变量

对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线:全大写+下划线式驼峰　　example：GLOBAL_VAR

!!!注意:应避免使用全局变量

变量

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

注意：

不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。

私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。

变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj等都是不好的命名。因为python在解释的时候才确定类型。

常量

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

异常

因为异常也是一个类，所以遵守类的命名规则。此外，如果异常实际上指代一个错误的话，应该使用“Error”做后缀。

缩写

命名应当尽量使用全拼写的单词，缩写的情况有如下两种：

常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。

命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。

• 例如：

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