包
應該是簡短的、小寫的名字。如果下划線可以改善可讀性可以加入。如mypackage。
模塊
與包的規范同。如mymodule。
類
總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下划線。
函數&方法
小寫+下划線hainiu_test()
全局變量
大寫字母,單詞之間用_分割 LOG_DIR
普通變量
小寫,由下划線連接各個單詞。如color = WHITE,this_is_a_variable = 1
trffic_cost
age_of_oldboy
常量
常量名所有字母大寫,由下划線連接各個單詞如MAX_OVERFLOW,TOTAL,AGE_OF_OLDBOY
異常
以“Error”作為后綴。
文件名
全小寫,可使用下划線
縮寫
命名應當盡量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫,如XML、ID等,在命名時也應只大寫首字母,如XmlParser。
2.命名中含有長單詞,對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等。
特定命名方式
主要是指 __xxx__ 形式的系統保留字命名法。項目中也可以使用這種命名,它的意義在於這種形式的變量是只讀的,這種形式的類成員函數盡量不要重載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
其中 __id__、__parent__ 和 __message__ 都采用了系統保留字命名法。