Google Python命名規(guī)范
module_name, 模塊
package_name, 包
模塊與包 包就是多個(gè)模塊的集合呕诉,單個(gè) .py文件 就是一個(gè)模塊
ClassName, 類
method_name, 方法
ExceptionName, 異常
function_name, 函數(shù)
GLOBAL_VAR_NAME, 全局變量
instance_var_name, 實(shí)例
function_parameter_name, 參數(shù)
local_var_name. 本變量
類
總是使用首字母大寫單詞串缘厢。如MyClass。內(nèi)部類可以使用額外的前導(dǎo)下劃線义钉。
函數(shù)&方法
小寫+下劃線
注意:混合大小寫僅被允許用于這種風(fēng)格已經(jīng)占據(jù)優(yōu)勢(shì)的時(shí)候昧绣,以便保持向后兼容。
函數(shù)和方法的參數(shù)
如果一個(gè)函數(shù)的參數(shù)名稱和保留的關(guān)鍵字沖突捶闸,通常使用一個(gè)后綴下劃線
全局變量
對(duì)于from M import *導(dǎo)入語句夜畴,如果想阻止導(dǎo)入模塊內(nèi)的全局變量可以使用舊有的規(guī)范,在全局變量上加一個(gè)前導(dǎo)的下劃線删壮。
注意:應(yīng)避免使用全局變量
變量
小寫贪绘,由下劃線連接各個(gè)單詞。如color = WHITE央碟,this_is_a_variable = 1
注意:
1.不論是類成員變量還是全局變量税灌,均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標(biāo)識(shí)亿虽。
3.變量名不應(yīng)帶有類型信息菱涤,因?yàn)镻ython是動(dòng)態(tài)類型語言。如 iValue洛勉、names_list粘秆、dict_obj 等都是不好的命名。
常量
常量名所有字母大寫收毫,由下劃線連接各個(gè)單詞如MAX_OVERFLOW攻走,TOTAL。
異常
以“Error”作為后綴此再。
文件名
全小寫,可使用下劃線
包
應(yīng)該是簡(jiǎn)短的昔搂、小寫的名字。如果下劃線可以改善可讀性可以加入输拇。如mypackage摘符。
模塊
與包的規(guī)范同。如mymodule策吠。
縮寫
命名應(yīng)當(dāng)盡量使用全拼寫的單詞议慰,縮寫的情況有如下兩種:
1.常用的縮寫,如XML奴曙、ID等,在命名時(shí)也應(yīng)只大寫首字母草讶,如XmlParser洽糟。
2.命名中含有長(zhǎng)單詞,對(duì)某個(gè)單詞進(jìn)行縮寫。這時(shí)應(yīng)使用約定成俗的縮寫方式坤溃。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num拍霜,等。
前導(dǎo)后綴下劃線
一個(gè)前導(dǎo)下劃線:表示非公有薪介。
一個(gè)后綴下劃線:避免關(guān)鍵字沖突祠饺。
兩個(gè)前導(dǎo)下劃線:當(dāng)命名一個(gè)類屬性引起名稱沖突時(shí)使用。
兩個(gè)前導(dǎo)和后綴下劃線:“魔”(有特殊用圖)對(duì)象或者屬性汁政,例如init或者file道偷。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字,而只是使用它們记劈。
注意:關(guān)于下劃線的使用存在一些爭(zhēng)議勺鸦。
特定命名方式
主要是指 xxx 形式的系統(tǒng)保留字命名法。項(xiàng)目中也可以使用這種命名目木,它的意義在于這種形式的變量是只讀的换途,這種形式的類成員函數(shù)盡量不要重載。如
class Base(object):
def init(self, id, parent = None):
self.id = id
self.parent = parent
def message(self, msgid):
其中 id刽射、parent 和 message 都采用了系統(tǒng)保留字命名法军拟。