1. Python命名规范

1.1 文件名、包名、模块名、变量名、函数名、实例名

全部采用小写的形式,并使用下划线连接,如下所示:

1
2
my_car.py
my_car

1.2 类名

采用驼峰命名法,即将类中的每个单词的首字母都大写,且不使用下划线,如下所示:

1
ElectricCar

1.3 常量名

所有字母大写,单词之间采用下划线连接,如下所示:

1
MAX_NUM = 100

2. Google Python命名规范

模块名写法: module_name ;
包名写法: package_name ;
类名: ClassName ;
方法名: method_name ;
异常名: ExceptionName ;
函数名: function_name ;
全局常量名: GLOBAL_CONSTANT_NAME ;
全局变量名: global_var_name ;
实例名: instance_var_name ;
函数参数名: function_parameter_name ;
局部变量名: local_var_name .

3. Python中代码格式

对于每个类、函数、方法都应在后面紧跟一个文档字符串,这种文档字符串简要地描述这个类、函数、方法的相关功能,对于每个模块也都应该包含一个文档字符串,模块中的文档字符串应该对其中的类的作用进行描述。

可使用空行来组织代码,但不要滥用。在类中,可使用一个空行来分隔方法;而在模块中,通常使用两个空行来分隔类