PEP 8 Python 程式設計規範

1.程式碼佈局

• 縮排。
  4個空格的縮排（編輯器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。

YES

# 對準左括號
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

# 不對準左括號，但加多一層縮排，以和後面內容區別。
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

# 懸掛縮排必須加多一層縮排.
 

foo = long_function_name(
    var_one, var_two,
    var_three, var_four)

NO

# 不使用垂直對齊時，第一行不能有引數。
foo = long_function_name(var_one, var_two,
    var_three, var_four)

# 引數的縮排和後續內容縮排不能區別。
def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

• 每行最大長度79，換行可以使用反斜槓，最好使用圓括號。換行點要在操作符的後邊敲回車。
• 類和top-level函式定義之間空兩行；類中的方法定義之間空一行；函式內邏輯無關段落之間空一行；其他地方儘量不要再空行。

2.文件編排

• 模組內容的順序：模組說明和docstring—import—globals&constants—其他定義。其中import部分，又按標準、三方和自己編寫順序依次排放，之間空一行。
• 不要在一句import中多個庫，比如import os, sys不推薦。
• 如果採用from XX import XX引用庫，可以省略‘module.’，都是可能出現命名衝突，這時就要採用import XX。

3.空格的使用

• 總體原則，避免不必要的空格。
• 各種右括號前不要加空格。
• 逗號、冒號、分號前不要加空格。
• 函式的左括號前不要加空格。如Func(1)。
• 序列的左括號前不要加空格。如list[2]。
• 函式預設引數使用的賦值符左右省略空格。例如：a
• 不要將多句語句寫在同一行，儘管使用‘；’; if/for/while語句中，即使執行語句只有一句，也必須另起一行。

4.註釋

總體原則，錯誤的註釋不如沒有註釋。所以當一段程式碼發生變化時，第一件事就是要修改註釋！
註釋必須使用英文，最好是完整的句子，首字母大寫，句後要有結束符，結束符後跟兩個空格，開始下一句。如果是短語，可以省略結束符。

• 一塊註釋，在一段程式碼前增加的註釋。在‘#’後加一空格。段落之間以只有‘#’的行間隔。比如：

# Description : Module config.
# 
# Input : None
#
# Output : None

• 2 行註釋，在一句程式碼後加註釋。比如：

x = x + 1           # Increment x

但是這種方式儘量少使用。

• 避免無謂的註釋。

5.文件描述

1 為所有的共有模組、函式、類、方法寫docstrings；非共有的沒有必要，但是可以寫註釋（在def的下一行）。
2 如果docstring要換行，參考如下例子,詳見PEP 257
“”“Return a foobang

Optional plotz says to frobnicate the bizbaz first.

“”“

6.命名規範

總體原則，新編程式碼必須按下面命名風格進行，現有庫的編碼儘量保持風格。

• 儘量單獨使用小寫字母‘l’，大寫字母‘O’等容易混淆的字母。
• 模組：命名儘量短小，使用全部小寫的方式，可以使用下劃線。
• 包：命名儘量短小，使用全部小寫的方式，不可以使用下劃線。
• 類：的命名使用CapWords的方式，模組內部使用的類採用_CapWords的方式。
• 異常命名使用CapWords+Error字尾的方式。
  
  • 類的屬性（方法和變數）命名使用全部小寫的方式，可以使用下劃線。
  • 類的屬性有3種作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public屬性前，字首一條下劃線。
  • 類的屬性若與關鍵字名字衝突，字尾一下劃線，儘量不要使用縮略等其他方式。
  • 為避免與子類屬性命名衝突，在類的一些屬性前，字首兩條下劃線。比如：類Foo中宣告__a,訪問時，只能通過Foo._Foo__a，避免歧義。如果子類也叫Foo，那就無能為力了。
  • 類的方法第一個引數必須是self，而靜態方法第一個引數必須是cls。
• 全域性變數：儘量只在模組內有效，類似C語言中的static。實現方法有兩種，一是all機制;二是字首一個下劃線。
• 函式：命名使用全部小寫的方式，可以使用下劃線。
• 常量：命名使用全部大寫的方式，可以使用下劃線。

7.編碼建議

• . 編碼中考慮到其他python實現的效率等問題，比如運算子‘+’在CPython（Python）中效率很高，都是Jython中卻非常低，所以應該採用.join()的方式。
• 儘可能使用‘is’‘is not’取代‘==’，比如if x is not None 要優於if x。
• 使用基於類的異常，每個模組或包都有自己的異常類，此異常類繼承自Exception。
• 異常中不要使用裸露的except，except後跟具體的exceptions。
• 異常中try的程式碼儘可能少。比如：

try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
要優於
try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)

• 使用startswith() and endswith()代替切片進行序列字首或字尾的檢查。比如：

Yes:  if foo.startswith('bar'):
# 優於
No:  if foo[:3] == 'bar':

• 使用isinstance()比較物件的型別。比如

Yes:  if isinstance(obj, int):
# 優於
No:  if type(obj) is type(1):

• 判斷序列空或不空，有如下規則

Yes:  if not seq:
      if seq:
#優於
No:  if len(seq)
     if not len(seq)

• 字串不要以空格收尾。
• 二進位制資料判斷使用 if boolvalue的方式。

參考資料：