PEP8 Python編程規範

官方文檔：

https://www.python.org/dev/peps/pep-0008/

------------------------------------------------------------------------

 

PEP8中文翻譯：

http://www.cnblogs.com/ajianbeyourself/p/4377933.html

------------------------------------------------------------------------

 

如下內容轉自 https://www.douban.com/note/134971609/

-------------------------------------------------------------------------

 

決定開始Python之路了，利用業餘時間，爭取更深刻學習Python。編程語言不是藝術，而是工做或者說是工具，因此整理並遵循一套編碼規範是十分必要的。因此今天下午我根據PEP 8整理了一份，之後都照此編碼了，還會持續更新。

PEP8 Python 編碼規範

一 代碼編排
1 縮進。4個空格的縮進（編輯器均可以完成此功能），不使用Tap，更不能混合使用Tap和空格。
2 每行最大長度79，換行可使用反斜槓，最好使用圓括號。換行點要在操做符的後邊敲回車。
3 類和top-level函數定義之間空兩行；類中的方法定義之間空一行；函數內邏輯無關段落之間空一行；其餘地方儘可能不要再空行。

二 文檔編排
1 模塊內容的順序：模塊說明和docstring—import—globals&constants—其餘定義。其中import部分，又按標準、三方和本身編寫順序依次排放，之間空一行。
2 不要在一句import中多個庫，好比import os, sys不推薦。
3 若是採用from XX import XX引用庫，能夠省略‘module.’，都是可能出現命名衝突，這時就要採用import XX。

三 空格的使用
        整體原則，避免沒必要要的空格。
1 各類右括號前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函數的左括號前不要加空格。如Func(1)。
4 序列的左括號前不要加空格。如list[2]。
5 操做符左右各加一個空格，不要爲了對齊增長空格。
6 函數默認參數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行，儘管使用‘；’容許。
8 if/for/while語句中，即便執行語句只有一句，也必須另起一行。

四 註釋
        整體原則，錯誤的註釋不如沒有註釋。因此當一段代碼發生變化時，第一件事就是要修改註釋！
        註釋必須使用英文，最好是完整的句子，首字母大寫，句後要有結束符，結束符後跟兩個空格，開始下一句。若是是短語，能夠省略結束符。
1 塊註釋，在一段代碼前增長的註釋。在‘#’後加一空格。段落之間以只有‘#’的行間隔。好比：
# Description : Module config.
#
# Input : None
#
# Output : None
2 行註釋，在一句代碼後加註釋。好比：x = x + 1 # Increment x
可是這種方式儘可能少使用。
3 避免無謂的註釋。

五 文檔描述
1 爲全部的共有模塊、函數、類、方法寫docstrings；非共有的沒有必要，可是能夠寫註釋（在def的下一行）。
2 若是docstring要換行，參考以下例子,詳見PEP 257
"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名規範
        整體原則，新編代碼必須按下面命名風格進行，現有庫的編碼儘可能保持風格。
1 儘可能單獨使用小寫字母‘l’，大寫字母‘O’等容易混淆的字母。
2 模塊命名儘可能短小，使用所有小寫的方式，可使用下劃線。
3 包命名儘可能短小，使用所有小寫的方式，不可使用下劃線。
4 類的命名使用CapWords的方式，模塊內部使用的類採用_CapWords的方式。
5 異常命名使用CapWords+Error後綴的方式。
6 全局變量儘可能只在模塊內有效，相似C語言中的static。實現方法有兩種，一是__all__機制;二是前綴一個下劃線。
7 函數命名使用所有小寫的方式，可使用下劃線。
8 常量命名使用所有大寫的方式，可使用下劃線。
9 類的屬性（方法和變量）命名使用所有小寫的方式，可使用下劃線。
9 類的屬性有3種做用域public、non-public和subclass API，能夠理解成C++中的public、private、protected，non-public屬性前，前綴一條下劃線。
11 類的屬性若與關鍵字名字衝突，後綴一下劃線，儘可能不要使用縮略等其餘方式。
12 爲避免與子類屬性命名衝突，在類的一些屬性前，前綴兩條下劃線。好比：類Foo中聲明__a,訪問時，只能經過Foo._Foo__a，避免歧義。若是子類也叫Foo，那就無能爲力了。
13 類的方法第一個參數必須是self，而靜態方法第一個參數必須是cls。

七 編碼建議
1 編碼中考慮到其餘python實現的效率等問題，好比運算符‘+’在CPython（Python）中效率很高，都是Jython中卻很是低，因此應該採用.join()的方式。
2 儘量使用‘is’‘is not’取代‘==’，好比if x is not None 要優於if x。
3 使用基於類的異常，每一個模塊或包都有本身的異常類，此異常類繼承自Exception。
4 異常中不要使用裸露的except，except後跟具體的exceptions。
5 異常中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)
6 使用startswith() and endswith()代替切片進行序列前綴或後綴的檢查。好比：
Yes: if foo.startswith('bar'):優於
No: if foo[:3] == 'bar':
7 使用isinstance()比較對象的類型。好比
Yes: if isinstance(obj, int): 優於
No: if type(obj) is type(1):
8 判斷序列空或不空，有以下規則
Yes: if not seq:
if seq:
優於
No: if len(seq)
if not len(seq)
9 字符串不要以空格收尾。
10 二進制數據判斷使用 if boolvalue的方式。

 

------------------------------------------------------------------