【转】Python命名习惯
常量:
常量名所有字母大写,由下划线连接各个单词,如
WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1
变量:
1.普通变量:
全部小写,由下划线连接各个单词,如:
1
color = WHITE
2
this_is_a_variable = 1
2.保护成员变量:
单下划线作前缀,意思是只有类对象和子类对象自己能访问到这些变量,且不能用'from module import *'导入。如:
1
_name=name
3.私有成员变量:
双下划线作前缀,意思是只有类对象自己能访问,连子类对象也不能访问到这个数据。
1
__ha=ha
4.全局变量:
大写字母,单词之间用_分割。
对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线
1
NUMBER
2
COLOR_WRITE
5. 注意:
(1) 不论是类成员变量还是全局变量,均不使用 m 或 g 前缀
(2)变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
函数:
1. 普通函数:
与普通变量一致,函数名应该为小写,可以用下划线风格单词以增加可读性。
混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容
1
myfunctio()
2
my_example_function()
3
myName()
2. 私有函数:
以双下划线开头。如:
1
__get_name()
3.函数的参数:
总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。
模块:
应该是简短的、小写的名字,单词之间用_分割。模块就是指文件
1
hello.py
2
ad_stats.py
类:
类名单词首字母大写,不使用下划线连接单词,也不加入 C、T 等前缀
实例用小写字母
1
class MyClass(object)
包:
命名方式同模块,是文件夹
特定命名方式:__xxx__
主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。
摘自 rebecca.hu的博客