- Python常用PEP8編碼規(guī)范和建議經(jīng)驗分享

EXAMPLE:
# 多行文檔, 首行首字母大寫，結(jié)尾的 """ 應(yīng)該單獨成行
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

# 單行的文檔， 結(jié)尾的 """ 在同一行。
"""Return a foobang"""

命名規(guī)則

包和模塊名:
包和模塊名應(yīng)該簡短，全部用小寫字母, 多字母之間可以使用單下劃線連接。

類名:
遵循駝峰命名

class MyClass(object):
pass

全局變量名:
全局變量名應(yīng)盡量只在模塊內(nèi)部使用, 對可能使用語句 from moduleName import variableName 而被導(dǎo)入的模塊，應(yīng)采用 __all__ 機制來防止全局變量被別的模塊導(dǎo)入, 或者在全局變量名開頭加一個前置下劃線.

EXAMPLE:
name = 'name'

函數(shù)名
函數(shù)名應(yīng)該為全部小寫的凹駝峰規(guī)則。

EXAMPLE:
vcenter_connection = ''

常量名
常量全部使用大寫字母的凹駝峰規(guī)則來表示, 通常在模塊頂格定義

EXAMPLE:
MAX_OVERFLOW = ''
TOTAL = 1

方法名和實例變量
非公開方法和實例變量開頭使用前置下劃線
有時候可能會為了避免與子類命名沖突，采用兩個前置下劃線
需要注意的是: 若 class Foo 的屬性名為 __a， 該屬性是不能以 Foo.__a 的方式訪問的(執(zhí)著的用戶還是可以通過Foo._Foo__a 來訪問), 所以通常雙前置下劃線僅被用來避免與基類的屬性發(fā)生命名沖突。

編程建議

None 的比較用 is 或 is not，而不要用 ==

用 is not 代替 not … is, 前者的可讀性更好

EXAMPLE:
# Yes
if foo is not None

# No
if not foo is None

使用函數(shù)定義關(guān)鍵字 def 代替 lambda 賦值給標識符, 這樣更適合于回調(diào)和字符串表示
# Yes
def f(x):
return 2*x

# No
f = lambda x: 2*x

異常類應(yīng)該繼承自Exception，而不是 BaseException

Python 2 中用raise ValueError('message') 代替 raise ValueError, 'message'

(考慮兼容python3和續(xù)行的方便性)

捕獲異常時盡量指明具體異常, 盡量不用 except Exception, 應(yīng)該捕獲 出了什么問題，而不是 問題發(fā)生

EXAMPLE:
# Yes (捕獲具體異常)
try:
import platform_specific_module
except ImportError:
platform_specific_module = None

# No (不要全局捕獲)
try:
import platform_specific_module
except:
platform_specific_module = None

try/except 子句中的代碼要盡可能的少, 以免屏蔽掉其他的錯誤

EXAMPLE:
# Yes
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)

# No
try:
return handle_value(collection[key])
except KeyError:
# 可能會捕捉到 handle_value()中的 KeyError, 而不是 collection 的
return key_not_found(key)

函數(shù)或者方法在沒有返回值時要明確返回 None
# Yes
def foo():
return None

# No
def foo():
return

使用字符串方法而不是 string 模塊
python 2.0 以后字符串方法總是更快，而且與 Unicode 字符串使用了相同的 API

使用使用 .startswith() 和 .endswith() 代替字符串切片來檢查前綴和后綴
startswith() 和 endswith 更簡潔，利于減少錯誤

EXAMPLE:
# Yes
if foo.startswith('bar'):

# No
if foo[:3] == 'bar':

使用 isinstance() 代替對象類型的比較

EXAMPLE:
# Yes
if isinstance(obj, int):

# No
if type(obj) is type(1):

空序列類型對象的 bool 為 False:
# Yes
if not seq:
pass
if seq:
pass

# No
if len(seq):
pass
if not len(seq):
pass

不要用 == 進行 bool 比較
# Yes
if greeting:
pass

# No
if greeting == True
pass
if greeting is True: # Worse
pass