Python命名規範

Google Python命名規範

module_name,  模塊

package_name,  包

ClassName,  類

method_name,  方法

ExceptionName,   異常

function_name,  函數

GLOBAL_VAR_NAME, 常量

instance_var_name,  實例

function_parameter_name,   參數

local_var_name.  本變量

 

類

老是使用首字母大寫單詞串。如MyClass。內部類可使用額外的前導下劃線。

 

函數&方法    

小寫+下劃線

*注意*：混合大小寫僅被容許用於這種風格已經佔據優點的時候，以便保持向後兼容。

 

函數和方法的參數
若是一個函數的參數名稱和保留的關鍵字衝突，一般使用一個後綴下劃線

 

全局變量
對於from M import *導入語句，若是想阻止導入模塊內的全局變量可使用舊有的規範，在全局變量上加一個前導的下劃線。
*注意*:應避免使用全局變量

 

變量

小寫，由下劃線鏈接各個單詞。如color = WHITE，this_is_a_variable = 1
*注意*：
1.不管是類成員變量仍是全局變量，均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標識。
3.變量名不該帶有類型信息，由於Python是動態類型語言。如 iValue、names_list、dict_obj 等都是很差的命名。

 

常量
常量名全部字母大寫，由下劃線鏈接各個單詞如MAX_OVERFLOW，TOTAL。

 

異常
以「Error」做爲後綴。

 

文件名
全小寫,可以使用下劃線

 

包
應該是簡短的、小寫的名字。若是下劃線能夠改善可讀性能夠加入。如mypackage。

 

模塊
與包的規範同。如mymodule。

 

縮寫
命名應當儘可能使用全拼寫的單詞，縮寫的狀況有以下兩種：
1.經常使用的縮寫，如XML、ID等，在命名時也應只大寫首字母，如XmlParser。
2.命名中含有長單詞，對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。

例如：
function 縮寫爲 fn
text 縮寫爲 txt
object 縮寫爲 obj
count 縮寫爲 cnt
number 縮寫爲 num，等。

前導後綴下劃線
一個前導下劃線：表示非公有。
一個後綴下劃線：避免關鍵字衝突。
兩個前導下劃線：當命名一個類屬性引發名稱衝突時使用。
兩個前導和後綴下劃線：「魔」（有特殊用圖）對象或者屬性，例如__init__或者__file__。絕對不要創造這樣的名字，而只是使用它們。
*注意*：關於下劃線的使用存在一些爭議。

 

特定命名方式 主要是指 __xxx__ 形式的系統保留字命名法。項目中也可使用這種命名，它的意義在於這種形式的變量是隻讀的，這種形式的類成員函數儘可能不要重載。如 class Base(object): def __init__(self, id, parent = None): self.__id__ = id self.__parent__ = parent def __message__(self, msgid): 其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。