python 基础命名规范
模块应该使用尽可能短的、全小写命名,可以在模块命名时使用下划线以增强可读性。同样包的命名也应该是这样的,虽然其并不鼓励下划线
模块名
通常是小写字母,单词之间用_分割
ad_stats.py
包名
和模块名一样
文件名
全小写,可使用下划线
类名
几乎毫无例外的,类名都使用首字母大写开头(Pascal命名风格)的规范。
使用 _单下划线开头的类名为内部使用
变量
全局变量名(类变量,在java中相当于static变量)
大写字母,单词之间用 _分割
普通变量
小写字母,单词之间用 _分割
注意:
- 不论是类成员变量还是全局变量,均不使用 m 或 g 前缀(匈牙利标记法)。
- 私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
- 变量名不应带有类型信息,因为Python是动态类型语言。如
iValue、names_list、dict_obj等都是不好的命名。
实例变量:
以 _ 开头,其他和普通变量一样
私有实例变量(外部访问会报错)
以 __开头(2个下划线),其他和普通变量一样
专有变量
__开头,__结尾,一般为python的自有变量,
函数
普通函数
和普通变量一样
私有函数(外部访问会报错)
以 __ 开头(2个下划线),其他和普通函数一样
函数和方法的参数
总使用“self”作为实例方法的第一个参数。
总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写
常量
常量名所有字母大写,由下划线连接各个单词如 MAX_OVERFLOW,TOTAL
异常
因为异常也是一个类,所以遵守类的命名规则
浙公网安备 33010602011771号