Python学习笔记 --- Python命名规范

Python的编码命名规则


项目名


首字母大写，其余小写单词，若多个单词组合可以添加“_”下划线增加可读性


  Ui_test


包名、模块名


全部小写字母


package、 module
类名


首字母大写，其它字母小写，若多个单词时，才用驼峰，eg：UserLogin


class Login :


方法名


小写单词，多个单词时，用下划线分隔单词以增加可读性。


def user_login():


参数名


小写单词


def user_login(self):
如果函数的参数名与保留关键字冲突，在参数名后加一个下划线，比用缩写、错误 的拼写要好。因此 "_print" 比 "prnt" 好。


普通变量名


小写字母，单词之间用_分割 或者 遵守驼峰原则命名


month_pay  = 2000
monthPay = 2000


注意：
1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
3.变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
4.开头，结尾，一般为python的自有变量，不要以这种方式命名
5.以__开头（2个下划线），是私有实例变量（外部不嫩直接访问），依照情况进行命名


常量

常量定义全部为大写，必要时可用下划线分隔单词以增加可读性。

MAXN = 1000

异常
以“Error”作为后缀。




缩写
命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如：
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num，等。
前导后缀下划线
一个前导下划线：表示非公有。
一个后缀下划线：避免关键字冲突。
两个前导下划线：当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。
*注意*：关于下划线的使用存在一些争议。

  
命名注意：


不要使用小写字母'l'(el),大写字母'O'(oh),或者小写'i'作为单独变量名称。因为一些字体中，上诉字母和数字很难区分（比如：O和0，l和1）。