python命名规范

Python命名规范

命名原则

1、不能以数字开头，不能出现中文。
2、命名以字母开头，包含数字，字母（区分大小写），下划线。
3、不能包含关键字。

1、项目名称

首字母大写+大写式驼峰，如：ProjectName

2、模块名和包名

全部小写+下划线驼峰，如：module_name package_name

3、类名称，异常

首字母大写+大写式驼峰，如：class ClassName: ，ExceptionName

class MyClass():
    pass

4、全局变量、常量

全部使用大写字母+下划线驼峰，如：GLOBAL_VAR_NAME，CONSTANT_NAME

#数据库相关配置
DATABASE_HOST = 'XXX'
DATABASE_PORT = 'XXX'
DATABASE_USER = 'XXX'
DATABASE_PASS = 'XXX'
DATABASE_NAME = 'XXX'

5、方法名，函数名，其余变量，参数，实例

全部小写+下划线驼峰，如：method_name，function_name，instance_var_name, function_parameter_name, local_var_name

# 函数名一律小写，如果有多个单词用下划线隔开。另外，私有函数下划线开头。
def my_func(var1, var2):
    pass

def _private_func(var1, var2):
    pass


# 变量要小写，若有多个单词，使用下划线分开。常量全部大写。
num = 20
this_is_a_variable = 21
PI = 3.1415926

6、见名知义

处理计数器外，不使用单字母命名

变量名要有意义，除常见的一些简写外（如res, req, num等），尽量用全拼，通过命名可以大致猜到变量的用处

7、严禁使用关键字作为变量名

# python查看关键字
import keyword
print(keyword.kwlist)