python命名规范

项目名

首字母大写,其余小写单词,若多个单词组合可以添加“_”下划线增加可读性。
如 Demo_test

文件名

全小写,可使用下划线。

包、模块

使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)。
如mypackage,mymodule。


类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头。

如CamelCase。

函数、方法

函数名一律小写,如有多个单词,用下划线隔开。

如:myfunction,my_function。

函数和方法的参数
总使用“self”作为实例方法的第一个参数。

总使用“cls”作为类方法的第一个参数。


全局变量
对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。
注意:避免使用全局变量


变量
变量名全部小写,由下划线连接各个单词。

如color = WHITE,this_is_a_variable = 1

注意:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。


常量
常量名所有字母大写,由下划线连接各个单词如MAX_OVERFLOW,TOTAL。


异常
以“Error”作为后缀。


缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。
如:
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。

注:将Evernote中的笔记整理迁移至博客园,包含转载内容。

原文地址:https://www.cnblogs.com/annawong/p/9662670.html