Python命名规范
项目 | 子项目 | 举例 | 说明 | 备注 |
---|---|---|---|---|
常量 | 常量 | HELLO_WORLD | 所有字母大写,由下划线连接各个单词 | |
变量 | 普通变量 | hello_world | 全部小写,由下划线连接各个单词 | 1.不论是类成员变量还是全局变量,均不使用m或者g前缀;2.变量名不应带有类型信息,因为python是动态类型语言。如ivalue、dict_obj等都是不好的命名; |
变量 | 保护成员变量 | _hello_world | 下划线开头,其他小写,由下划线连接各个单词,意思是只有类对象和子类对象能访问到这些变量,且不能用’from module import *’导入 | |
变量 | 私有成员变量 | __hello_world | 双下划线开头,其他小写,由下划线连接各个单词,意思是只有类对象自己能访问,连子类对象也不能访问这个数据 | |
变量 | 全局变量、类变量 | HELLO_WORLD | 所有字母大写,由下划线连接各个单词 | |
函数 | 普通函数 | hello_world() | 全部小写,由下划线连接各个单词 | 1.总是使用self作为实例方法的第1个参数,总是使用cls作为类方法的第1个参数;2.如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写; |
函数 | 私有函数 | __get_value() | 以双下划线开头,其他小写,由下划线连接各个单词 | |
模块 | 模块 | hello_world.py | 全部小写,由下划线连接各个单词 | |
类 | 类 | class HelloWorld(object) | 首字母大写,不使用下划线连接单词,也不加入C、T等前缀 | |
包 | 包 | hello_world | 命名方式同模块,是文件夹 | |
其他 | 系统保留字命名法(专有变量、专有函数) | xxx | 项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载 |
[1]: Python 3 https://docs.python.org/3/
[2]: Python 2 https://docs.python.org/2/