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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM