Python命名規範

標籤：sgid   _id   max   常用   全域   white   FN   __file__   資訊   

 

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__ 都採用了系統保留字命名法。

Python命名規範