Python的代碼風格一般由PEP8來描述。這個文檔描述了Python風格的方方面面,一般開發(fā)人員遵循這個規(guī)定風格,可以最大限度的保持代碼風格的相似性,便于開發(fā)人員之間的交流和維護。
在Python中,下劃線是比較特殊的字符,含有下劃線的也許有合數(shù)的意義?,F(xiàn)在對根據(jù)PEP8規(guī)定的風格,來說明帶下劃線的變量和函數(shù)的意義。
- 變量
- 前面帶一個_的變量:表明這是一個私有變量,外部類最好不要調(diào)用它。這只是一種聲明,因為Python中沒有所謂的私有變量一說,所以外部類還是可以訪問的。
- 前帶兩個,后帶兩個的變量:標明是內(nèi)部變量,外部類訪問不了。
- 大寫加下劃線的變量:標明是不會發(fā)生改變的全局變量。
- 函數(shù)
- 前帶_的函數(shù):聲明是私有函數(shù),只是一種聲明。
- 前帶兩個,后帶兩個的函數(shù):標明是特殊函數(shù)。
以上是帶下劃線的函數(shù)和變量的總結(jié)。
具體請看下面的例子:
- 變量
- 常量 : 大寫加下劃線,對于不會發(fā)生改變的全局變量,使用大寫加下劃線。
USER_CONSTANT - 私有變量 : 小寫和一個前導下劃線
_private_value
Python 中不存在私有變量一說,若是遇到需要保護的變量,使用小寫和一個前導下劃線。但這只是程序員之間的一個約定,用于警告說明這是一個私有變量,外部類不要去訪問它。但實際上,外部類還是可以訪問到這個變量。 - 內(nèi)置變量 : 小寫,兩個前導下劃線和兩個后置下劃線
class
兩個前導下劃線會導致變量在解釋期間被更名。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突,用戶定義的變量要嚴格避免這種風格,以免導致混亂。
函數(shù)和方法:總體而言,函數(shù)和方法應該使用,小寫和下劃線。小寫和下劃線已成為規(guī)范。
私有方法 : 小寫和一個前導下劃線
def _secrete(self):
print "don't test me."
這里和私有變量一樣,并不是真正的私有訪問權(quán)限。同時也應該注意一般函數(shù)不要使用兩個前導下劃線(當遇到兩個前導下劃線時,Python 的名稱改編特性將發(fā)揮作用)。特殊函數(shù)后面會提及。特殊方法 : 小寫和兩個前導下劃線,兩個后置下劃線:
def add(self, other):
return int.add(other)
這種風格只應用于特殊函數(shù),比如操作符重載等。函數(shù)參數(shù) : 小寫和下劃線,缺省值等號兩邊無空格
def connect(self, user=None):
self._user = user-
類
類總是使用駝峰格式命名,即所有單詞首字母大寫其余字母小寫。類名應該簡明,精確,并足以從中理解該類所完成的工作。常見的一個方法是使用表示其類型或者特性的后綴,例如:
SQLEngine
MimeTypes對于基類而言,可以使用一個 Base 或者 Abstract 前綴:
BaseCookie
AbstractGroup-
如下類,示例
class UserProfile(object):
def init(self, profile):
return self._profile = profiledef profile(self): return self._profile
-
模塊和包
- 除特殊模塊 init 之外,模塊名稱都使用不帶下劃線的小寫字母
import os
import sys - 若是它們實現(xiàn)一個協(xié)議,那么通常使用lib為后綴,例如:
import smtplib
- 除特殊模塊 init 之外,模塊名稱都使用不帶下劃線的小寫字母
關于參數(shù)
不要用斷言來實現(xiàn)靜態(tài)類型檢測
斷言可以用于檢查參數(shù),但不應僅僅是進行靜態(tài)類型檢測。 Python是動態(tài)類型語言,靜態(tài)類型檢測違背了其設計思想。斷言應該用于避免函數(shù)不被毫無意義的調(diào)用。不要濫用 *args 和 **kwargs
*args 和 **kwargs 參數(shù)可能會破壞函數(shù)的健壯性。它們使簽名變得模糊,而且代碼常常開始在不應該的地方構(gòu)建小的參數(shù)解析器。其他
使用 has 或 is 前綴命名布爾元素
is_connect = True
has_member = False用復數(shù)形式命名序列
members = ['user_1', 'user_2']用顯式名稱命名字典
person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}避免通用名稱
諸如 list, dict, sequence 或者 element 這樣的名稱應該避免。避免現(xiàn)有名稱
諸如 os, sys 這種系統(tǒng)已經(jīng)存在的名稱應該避免。-
Python編碼風格的一些數(shù)字
- 一行列數(shù) : PEP 8 規(guī)定為 79 列,這有些苛刻了。根據(jù)自己的情況,比如不要超過滿屏時編輯器的顯示列數(shù)。這樣就可以在不動水平游標的情況下,方便的查看代碼。
- 一個函數(shù) : 不要超過 30 行代碼, 即可顯示在一個屏幕類,可以不使用垂直游標即可看到整個函數(shù)。
- 一個類 : 不要超過 200 行代碼,不要有超過 10 個方法。
- 一個模塊 不要超過 500 行。
-
驗證腳本
可以安裝一個 pep8 腳本用于驗證你的代碼風格是否符合 PEP8。>>easy_install pep8 >>pep8 -r --ignoire E501 Test.py #這個命令行的意思是,重復打出錯誤,并且忽略 501 錯誤(代碼超過 79 行)。