一代碼編排

1縮進。4個空格的縮進(python編輯器都可以完成此功能)，不使用Tap，更不能混合使用Tap和空格。

2每行最大長度79，換行可以使用反斜杠，最好使用圓括號。換行點要在操作符的后邊敲回車。

3類和top-level函數定義之間空兩行;類中的方法定義之間空一行;函數內邏輯無關段落之間空一行;其他地方盡量不要再空行。

二文檔編排

1模塊內容的順序：模塊說明和docstring—import—globals&constants—其他定義。其中import部分，又按標準、三方和自己編寫順序依次排放，之間空一行。

2不要在一句import中多個庫，比如importos,sys不推薦。

3如果采用fromXXimportXX引用庫，可以省略‘module.’，都是可能出現命名沖突，這時就要采用importXX。

三空格的使用

總體原則，避免不必要的空格。

1各種右括號前不要加空格。

2逗號、冒號、分號前不要加空格。

3函數的左括號前不要加空格。如Func(1)。

4序列的左括號前不要加空格。如list[2]。

5操作符左右各加一個空格，不要為了對齊增加空格。

6函數默認參數使用的賦值符左右省略空格。

7不要將多句語句寫在同一行，盡管使用‘;’允許。

8if/for/while語句中，即使執行語句只有一句，也必須另起一行。

四注釋

總體原則，錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時，第一件事就是要修改注釋!

注釋必須使用英文，最好是完整的句子，首字母大寫，句后要有結束符，結束符后跟兩個空格，開始下一句。如果是短語，可以省略結束符。

1塊注釋，在一段代碼前增加的注釋。在‘#’后加一空格。段落之間以只有‘#’的行間隔。比如：

#Description:Moduleconfig.

#

#Input:None

#

#Output:None

2行注釋，在一句代碼后加注釋。比如：x=x+1#Incrementx

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

3避免無謂的注釋。

五文檔描述

1為所有的共有模塊、函數、類、方法寫docstrings;非共有的沒有必要，但是可以寫注釋(在def的下一行)。

2如果docstring要換行，參考如下例子,詳見PEP257

"""Returnafoobang

Optionalplotzsaystofrobnicatethebizbazfirst.

"""

六命名規范

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

1盡量單獨使用小寫字母‘l’，大寫字母‘O’等容易混淆的字母。

2模塊命名盡量短小，使用全部小寫的方式，可以使用下劃線。

3包命名盡量短小，使用全部小寫的方式，不可以使用下劃線。

4類的命名使用CapWords的方式，模塊內部使用的類采用_CapWords的方式。

5異常命名使用CapWords+Error后綴的方式。

6全局變量盡量只在模塊內有效，類似C語言中的static。實現方法有兩種，一是__all__機制;二是前綴一個下劃線。

7函數命名使用全部小寫的方式，可以使用下劃線。

8常量命名使用全部大寫的方式，可以使用下劃線。

9類的屬性(方法和變量)命名使用全部小寫的方式，可以使用下劃線。

9類的屬性有3種作用域public、non-public和subclassAPI，可以理解成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’‘isnot’取代‘==’，比如ifxisnotNone要優于ifx。

3使用基于類的異常，每個模塊或包都有自己的異常類，此異常類繼承自Exception。

4異常中不要使用裸露的except，except后跟具體的exceptions。

5異常中try的代碼盡可能少。比如：

try:

value=collection[key]

exceptKeyError:

returnkey_not_found(key)

else:

returnhandle_value(value)

要優于

try:

#Toobroad!

returnhandle_value(collection[key])

exceptKeyError:

#WillalsocatchKeyErrorraisedbyhandle_value()

returnkey_not_found(key)

6使用startswith()andendswith()代替切片進行序列前綴或后綴的檢查。比如：

Yes:iffoo.startswith('bar'):優于

No:iffoo[:3]=='bar':

7使用isinstance()比較對象的類型。比如

Yes:ifisinstance(obj,int):優于

No:iftype(obj)istype(1):

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

Yes:ifnotseq:

ifseq:

優于

No:iflen(seq)

ifnotlen(seq)

9字符串不要以空格收尾。

10二進制數據判斷使用ifboolvalue的方式。

以上內容為大家介紹了PEP8Python編碼規范，希望對大家有所幫助，如果想要了解更多Python相關知識，請關注IT培訓機構:千鋒教育。http://www.jun-ho.cn/