1. 程式人生 > >Python程式設計規範

Python程式設計規範

簡單總結一下:

類名: 首字母大寫,如MyClass,內部類可以使用額外的前導下劃線。

函式&方法名 小寫+下劃線

函式和方法的引數:如果函式的引數名稱和保留關鍵字衝突,通常加一個字尾下劃線

全域性變數:避免使用全域性變數

變數:小寫,使用下劃線連線各個單詞。如this_is_a_variable = 1
說明:
1)私有類成員使用單一下劃線作為字首標識。
2)變數名不應帶有型別資訊,因為Python是動態型別語言。如 iValuenames_listdict_obj 等都是不好的命名。

常量:常量名所有字母大寫,由下劃線連線,如MAX_OVERFLOWTOTAL

異常:

“Error”作為字尾。

檔名:全小寫,可使用下劃線

包:簡短、小寫的名字,可以加入下劃線改善可讀性。如my_package。

模組: 與包的規範同,如mymodule

縮寫:命名應當儘量使用全拼寫單詞,縮寫情況有如下兩種:
1)常用的縮寫,如XMLID等,在命名時也應只大寫首字母,如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__ 都採用了系統保留字命名法。