簡單總結一下:
類名:首字母大寫,如
myclass,
內部類可以使用額外的前導下劃線。
函式&方法名:小寫+下劃線
函式和方法的引數:如果函式的引數名稱和保留關鍵字衝突,通常加乙個字尾下劃線
全域性變數:避免使用全域性變數
變數:小寫,使用下劃線連線各個單詞。如
this_is_a_variable = 1
說明:1)
私有類成員使用單一下劃線作為字首標識。
2)變數名不應帶有型別資訊,因為
python
是動態型別語言。如
ivalue
、names_list
、dict_obj
等都是不好的命名。
常量:常量名所有字母大寫,由下劃線連線,如
max_overflow
,total。
異常:以
「error」
作為字尾。
檔名:全小寫
,可使用下劃線
包:簡短、小寫的名字,可以加入下劃線改善可讀性。如my_package。
模組:與包的規範同,如
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程式設計規範
1,python程式設計規範 編碼 所有的 python 指令碼檔案都應在檔案頭標上 coding utf 8 用於設定編輯器,預設儲存為 utf 8 格式。注釋 業界普遍認同 python 的注釋分為兩種,堅持適當注釋原則。對不存在技術難點的 堅持不注釋,對存在技術難點的 必須注釋。但與注釋不同,...
Python 程式設計規範
二 縮排 三 空行 四 命名 五 import 好的 vs 不好的 參考資料 一 注釋 兩重意思,兩種方式 兩種方式 個人注釋 docstrings 表明如何使用這個包 模組 類 函式 方法 甚至包括使用示例和單元測試。推薦對每乙個包 模組 類 函式 方法 寫 docstrings。示例 函式或者類...
Python程式設計規範
1,python程式設計規範 編碼 所有的 python 指令碼檔案都應在檔案頭標上 coding utf 8 用於設定編輯器,預設儲存為 utf 8 格式。注釋 業界普遍認同 python 的注釋分為兩種 堅持適當注釋原則。對不存在技術難點的 堅持不注釋,對存在技術難點的 必須注釋。但與注釋不同,...