python-naming

Python命名规范

所有命名规范都要准守这三条

1. 命名只能以字母或者_下划线开头
2. 名字不能包含空格
3. 名字不能与关键字重合

模块 module_name

包 package_name

类 ClassName

函数 function_name

方法 method_name

变量 var_name

全局变量

• 全部大写，多个单词用_下划线隔开，如需要阻止导入模块内的全局变量，可以加一个前导下划线，GLOBAL_VAR_NAME，_GLOBAL_VAL
• 常量和全局变量命名规范相同

异常 ExceptionName

• 以Error作为后缀

try:         
    pass     
except ValueError as result:         
    pass

参数 function_parameter_name

• 如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线

常用的命名缩写

• function 缩写为fn
• text 缩写为 txt
• object 缩写为 obj
• count 缩写为 cnt
• number 缩写为 num

前导后缀下划线说明

• 一个前导下划线：表示非公有
• 一个后缀下划线：避免关键字冲突
• 两个前导下划线：当命名一个类属性引起名称冲突时使用
• 两个前导和后缀下划线：有特殊用途的对象或者属性，例如__init和str__