python开发简单命名规范

python日常开发命名简洁规范,一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。

HearGlobal.com

常量

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

WHITE = 0XFFFFFF

THIS_IS_A_CONSTANT = 1

 

变量

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

color = WHITE

this_is_a_variable = 1

    不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。

    变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValuenames_listdict_obj 等都是不好的命名。

 

函数

函数名的命名规则与变量名相同

 

类名单词首字母大写,不使用下划线连接单词,也不加入 C、T 等前缀

class ThisIsAClass(object):

    passs

 

模块

模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如

module.py

_internal_module.py

 

的命名规范与模块相同

 

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

字段名全部小写,由下划线连接各个单词

 

缩写

命名应当尽量使用全拼写的单词,缩写的情况有如下两种

1) 常用的缩写,如 XML、ID等,在命名时也应只大写首字母,如

class XmlParser(object):pass

2) 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式,如去除元音、包含辅音的首字符等方式,例如:

function 缩写为 fn

text 缩写为 txt

number 缩写为 num,等。

 

特定命名方式

主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如

class Base(object):

    def __init__(self, id, parent = None):

        self.__id__ = id

        self.__parent__ = parent

    def __message__(self, msgid):

        # …略语句