Python命名規範

2021-08-30 11:04:24 字數 2127 閱讀 4590

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__。絕對不要創造這樣的名字,而只是使用它們。

*注意*:關於下劃線的使用存在一些爭議。

特定命名方式

主要是指 __***__ 形式的系統保留字命名法。專案中也可以使用這種命名,它的意義在於這種形式的變數是唯讀的,這種形式的類成員函式盡量不要過載。如

class base(object):

def __init__(self, id, parent = none):

self.__id__ = id

self.__parent__ = parent

def __message__(self, msgid):

其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。

python命名規範

常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...

Python命名規範

常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...

python命名規範

常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...