Python命名規(guī)范
Google Python****命名規(guī)范
module_name, 模塊
package_name, 包
ClassName, 類
method_name, 方法
ExceptionName, 異常
function_name, 函數(shù)
GLOBAL_VAR_NAME, 全局變量
instance_var_name, 實例
function_parameter_name, 參數(shù)
local_var_name. 本地變量
類
總是使用首字母大寫單詞串说墨。如MyClass其垄。內部類可以使用額外的前導下劃線塘揣。
函數(shù)****&****方法
小寫+下劃線
注意:混合大小寫僅被允許用于這種風格已經(jīng)占據(jù)優(yōu)勢的時候,以便保持向后兼容。
函數(shù)和方法的參數(shù)
如果一個函數(shù)的參數(shù)名稱和保留的關鍵字沖突台丛,通常使用一個后綴下劃線
全局變量
對于from M import *導入語句,如果想阻止導入模塊內的全局變量可以使用舊有的規(guī)范,在全局變量上加一個前導的下劃線个绍。
注意:應避免使用全局變量
變量
小寫,由下劃線連接各個單詞浪汪。如color = WHITE巴柿,this_is_a_variable = 1
注意:
1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴死遭。
2.私有類成員使用單一下劃線前綴標識广恢。
3.變量名不應帶有類型信息,因為Python是動態(tài)類型語言呀潭。如 iValue钉迷、names_list、dict_obj 等都是不好的命名钠署。
常量
常量名所有字母大寫糠聪,由下劃線連接各個單詞如MAX_OVERFLOW,TOTAL踏幻。
異常
以“Error”作為后綴枷颊。
文件名
全小寫,可使用下劃線
包
應該是簡短的、小寫的名字该面。如果下劃線可以改善可讀性可以加入夭苗。如mypackage。
模塊
與包的規(guī)范同隔缀。如mymodule题造。
縮寫
命名應當盡量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫猾瘸,如XML界赔、ID等,在命名時也應只大寫首字母牵触,如XmlParser淮悼。
2.命名中含有長單詞,對某個單詞進行縮寫揽思。這時應使用約定成俗的縮寫方式袜腥。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等钉汗。
前導后綴下劃線
一個前導下劃線:表示非公有羹令。
一個后綴下劃線:避免關鍵字沖突鲤屡。
兩個前導下劃線:當命名一個類屬性引起名稱沖突時使用。
兩個前導和后綴下劃線:“魔”(有特殊用圖)對象或者屬性福侈,例如init或者file酒来。絕對不要創(chuàng)造這樣的名字,而只是使用它們肪凛。
注意:關于下劃線的使用存在一些爭議堰汉。
特定命名方式
主要是指 xxx 形式的系統(tǒ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)保留字命名法。