前言

從很多地方搬運+總結，以後根據這個標準再將python的一些奇技淫巧結合起來，寫出更pythonic的代碼~

PEP8 編碼規範

英文原版請點擊這裏

以下是@bobo的整理，原文請見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

1. 行註釋，在一句代碼後加註釋。比如：x = x + 1 # Increment x
   但是這種方式盡量少使用。
2. 避免無謂的註釋。

文檔描述

1. 為所有的共有模塊、函數、類、方法寫docstrings；非共有的沒有必要，但是可以寫註釋（在def的下一行）。
2. 單行註釋請參考如下方式

def kos_root():
    """Return the pathname of the KOS root directory."""
    global _kos_root
    if _kos_root: return _kos_root
    ...

命名規則

* 總體原則，新編代碼必須按下面命名風格進行，現有庫的編碼盡量保持風格。絕不要單獨使用例如大寫的’i’和大寫的’o’*

1. 模塊命名盡量短小，使用全部小寫的方式，可以使用下劃線。
2. 包命名盡量短小，使用全部小寫的方式，不可以使用下劃線。
3. 類的命名使用CapWords的方式，模塊內部使用的類采用_CapWords的方式。
4. 異常命名使用CapWords+Error後綴的方式。
5. 全局變量盡量只在模塊內有效，類似C語言中的static。實現方法有兩種，一是all機制;二是前綴一個下劃線。
6. 函數命名使用全部小寫的方式，可以使用下劃線。
7. 常量命名使用全部大寫的方式，可以使用下劃線。
8. 類的屬性（方法和變量）命名使用全部小寫的方式，可以使用下劃線。
9. 類的屬性有3種作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public屬性前，前綴一條下劃線。
10. 類的屬性若與關鍵字名字沖突，後綴一下劃線，盡量不要使用縮略等其他方式。
11. 為避免與子類屬性命名沖突，在類的一些屬性前，前綴兩條下劃線。比如：類Foo中聲明__a,訪問時，只能通過Foo._Foo__a，避免歧義。如果子類也叫Foo，那就無能為力了。
12. 類的方法第一個參數必須是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。例如

try:
    ...
except Exception as ex:
    print ex

1. 異常中try的代碼盡可能少。

2. 使用startswith() and endswith()代替切片進行序列前綴或後綴的檢查。

foo = ‘abc000xyz‘

if foo.startswith(‘abc‘) and foo.endswith(‘xyz‘):
    print ‘yes‘
else:
    print ‘no‘

#yes

#而如下的方式不提倡
if foo[:3]==‘abc‘ and foo[-3:]==‘xyz‘:
    print ‘yes‘
else:
    print ‘no‘

1. 使用isinstance()比較對象的類型。比如:

foo = ‘abc000xyz‘

# 提倡
print isinstance(foo,int) # false

# 不提倡
print type(foo) == type(‘1‘) #true

1. 判斷序列空或不空，有如下規則：

foo = ‘abc000xyz‘

if foo:
    print "not empty"
else:
    print "empty"

#不提倡使用如下
if len(foo):
    print "not empty"
else:
    print "empty"

1. 二進制數據判斷使用 if boolvalue的方式。

PEP8規範 Python