總結(jié):
變量:
- 前帶_的變量: 標明是一個私有變量, 只用于標明, 外部類還是可以訪問到這個變量
- 前帶兩個_ ,后帶兩個_ 的變量: 標明是內(nèi)置變量,
- 大寫加下劃線的變量: 標明是 不會發(fā)生改變的全局變量
函數(shù): - 前帶_的變量: 標明是一個私有函數(shù), 只用于標明,
- 前帶兩個_ ,后帶兩個_ 的函數(shù): 標明是特殊函數(shù)
Python 的代碼風(fēng)格由 PEP 8 描述。這個文檔描述了 Python 編程風(fēng)格的方方面面鳖昌。在遵守這個文檔的條件下局骤,不同程序員編寫的 Python 代碼可以保持最大程度的相似風(fēng)格己沛。這樣就易于閱讀缠局,易于在程序員之間交流扎瓶。
1 變量
常量 : 大寫加下劃線
USER_CONSTANT
對于不會發(fā)生改變的全局變量蕊爵,使用大寫加下劃線著蛙。
私有變量 : 小寫和一個前導(dǎo)下劃線
_private_value
Python 中不存在私有變量一說删铃,若是遇到需要保護的變量,使用小寫和一個前導(dǎo)下劃線踏堡。但這只是程序員之間的一個約定猎唁,用于警告說明這是一個私有變量,外部類不要去訪問它顷蟆。但實際上诫隅,外部類還是可以訪問到這個變量。
內(nèi)置變量 : 小寫帐偎,兩個前導(dǎo)下劃線和兩個后置下劃線
__class__
兩個前導(dǎo)下劃線會導(dǎo)致變量在解釋期間被更名逐纬。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突。用戶定義的變量要嚴格避免這種風(fēng)格削樊。以免導(dǎo)致混亂豁生。
2 函數(shù)和方法
總體而言應(yīng)該使用,小寫和下劃線漫贞。但有些比較老的庫使用的是混合大小寫甸箱,即首單詞小寫,之后每個單詞第一個字母大寫迅脐,其余小寫芍殖。但現(xiàn)在,小寫和下劃線已成為規(guī)范仪际。
私有方法 : 小寫和一個前導(dǎo)下劃線
def _secrete(self):
print "don't test me."
這里和私有變量一樣围小,并不是真正的私有訪問權(quán)限。同時也應(yīng)該注意一般函數(shù)不要使用兩個前導(dǎo)下劃線(當(dāng)遇到兩個前導(dǎo)下劃線時树碱,Python 的名稱改編特性將發(fā)揮作用)肯适。特殊函數(shù)后面會提及。
特殊方法 : 小寫和兩個前導(dǎo)下劃線成榜,兩個后置下劃線
def __add__(self, other):
return int.__add__(other)
這種風(fēng)格只應(yīng)用于特殊函數(shù)框舔,比如操作符重載等。
函數(shù)參數(shù) : 小寫和下劃線赎婚,缺省值等號兩邊無空格
def connect(self, user=None):
self._user = user
3 類
類總是使用駝峰格式命名刘绣,即所有單詞首字母大寫其余字母小寫。類名應(yīng)該簡明挣输,精確纬凤,并足以從中理解類所完成的工作。常見的一個方法是使用表示其類型或者特性的后綴撩嚼,例如:
SQLEngine
MimeTypes-
對于基類而言停士,可以使用一個 Base 或者 Abstract 前綴
BaseCookie
AbstractGroupclass UserProfile(object): def __init__(self, profile): return self._profile = profile def profile(self): return self._profile
4 模塊和包
除特殊模塊 init 之外,模塊名稱都使用不帶下劃線的小寫字母完丽。
若是它們實現(xiàn)一個協(xié)議恋技,那么通常使用lib為后綴,例如: import smtplib
5 關(guān)于參數(shù)
5.1 不要用assert來實現(xiàn)靜態(tài)類型檢測
assert可以用于檢查參數(shù)逻族,但不應(yīng)僅僅是進行靜態(tài)類型檢測蜻底。 python 是動態(tài)類型語言,靜態(tài)類型檢測違背了其設(shè)計思想聘鳞。assert應(yīng)該用于避免函數(shù)不被毫無意義的調(diào)用薄辅。
5.2 不要濫用 *args 和 **kwargs
*args 和 **kwargs 參數(shù)可能會破壞函數(shù)的健壯性。它們使簽名變得模糊搁痛,而且代碼常常開始在不應(yīng)該的地方構(gòu)建小的參數(shù)解析器长搀。
6 其他
6.1 使用 has 或 is 前綴命名布爾元素
is_connect = True
has_member = False
6.2 用復(fù)數(shù)形式命名序列
members = ['user_1', 'user_2']
6.3 用顯式名稱命名字典
person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}
7 一些數(shù)字
一行列數(shù) : PEP 8 規(guī)定為 79 列,這有些苛刻了鸡典。根據(jù)自己的情況源请,比如不要超過滿屏?xí)r編輯器的顯示列數(shù)。這樣就可以在不動水平游標的情況下彻况,方便的查看代碼谁尸。
一個函數(shù) : 不要超過 30 行代碼, 即可顯示在一個屏幕類,可以不使用垂直游標即可看到整個函數(shù)纽甘。
一個類 : 不要超過 200 行代碼良蛮,不要有超過 10 個方法。
一個模塊 不要超過 500 行悍赢。
8 驗證腳本
可以安裝一個 pep8 腳本用于驗證你的代碼風(fēng)格是否符合 PEP8决瞳。
easy_install pep8
pep8 -r --ignoire E501 Test.py
這個命令行的意思是货徙,重復(fù)打出錯誤,并且忽略 501 錯誤(代碼超過 79 行)皮胡。