一代碼編排

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

2每行最大長(zhǎng)度79，換行可以使用反斜杠，最好使用圓括號(hào)。換行點(diǎn)要在操作符的后邊敲回車(chē)。

3類(lèi)和top-level函數(shù)定義之間空兩行;類(lèi)中的方法定義之間空一行;函數(shù)內(nèi)邏輯無(wú)關(guān)段落之間空一行;其他地方盡量不要再空行。

二文檔編排

1模塊內(nèi)容的順序：模塊說(shuō)明和docstring—import—globals&constants—其他定義。其中import部分，又按標(biāo)準(zhǔn)、三方和自己編寫(xiě)順序依次排放，之間空一行。

2不要在一句import中多個(gè)庫(kù)，比如importos,sys不推薦。

3如果采用fromXXimportXX引用庫(kù)，可以省略‘module.’，都是可能出現(xiàn)命名沖突，這時(shí)就要采用importXX。

三空格的使用

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

1各種右括號(hào)前不要加空格。

2逗號(hào)、冒號(hào)、分號(hào)前不要加空格。

3函數(shù)的左括號(hào)前不要加空格。如Func(1)。

4序列的左括號(hào)前不要加空格。如list[2]。

5操作符左右各加一個(gè)空格，不要為了對(duì)齊增加空格。

6函數(shù)默認(rèn)參數(shù)使用的賦值符左右省略空格。

7不要將多句語(yǔ)句寫(xiě)在同一行，盡管使用‘;’允許。

8if/for/while語(yǔ)句中，即使執(zhí)行語(yǔ)句只有一句，也必須另起一行。

四注釋

總體原則，錯(cuò)誤的注釋不如沒(méi)有注釋。所以當(dāng)一段代碼發(fā)生變化時(shí)，第一件事就是要修改注釋!

注釋必須使用英文，最好是完整的句子，首字母大寫(xiě)，句后要有結(jié)束符，結(jié)束符后跟兩個(gè)空格，開(kāi)始下一句。如果是短語(yǔ)，可以省略結(jié)束符。

1塊注釋?zhuān)谝欢未a前增加的注釋。在‘#’后加一空格。段落之間以只有‘#’的行間隔。比如：

#Description:Moduleconfig.

#

#Input:None

#

#Output:None

2行注釋?zhuān)谝痪浯a后加注釋。比如：x=x+1#Incrementx

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

3避免無(wú)謂的注釋。

五文檔描述

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

2如果docstring要換行，參考如下例子,詳見(jiàn)PEP257

"""Returnafoobang

Optionalplotzsaystofrobnicatethebizbazfirst.

"""

六命名規(guī)范

總體原則，新編代碼必須按下面命名風(fēng)格進(jìn)行，現(xiàn)有庫(kù)的編碼盡量保持風(fēng)格。

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

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

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

4類(lèi)的命名使用CapWords的方式，模塊內(nèi)部使用的類(lèi)采用_CapWords的方式。

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

6全局變量盡量只在模塊內(nèi)有效，類(lèi)似C語(yǔ)言中的static。實(shí)現(xiàn)方法有兩種，一是__all__機(jī)制;二是前綴一個(gè)下劃線。

7函數(shù)命名使用全部小寫(xiě)的方式，可以使用下劃線。

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

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

9類(lèi)的屬性有3種作用域public、non-public和subclassAPI，可以理解成C++中的public、private、protected，non-public屬性前，前綴一條下劃線。

11類(lèi)的屬性若與關(guān)鍵字名字沖突，后綴一下劃線，盡量不要使用縮略等其他方式。

12為避免與子類(lèi)屬性命名沖突，在類(lèi)的一些屬性前，前綴兩條下劃線。比如：類(lèi)Foo中聲明__a,訪問(wèn)時(shí)，只能通過(guò)Foo._Foo__a，避免歧義。如果子類(lèi)也叫Foo，那就無(wú)能為力了。

13類(lèi)的方法第一個(gè)參數(shù)必須是self，而靜態(tài)方法第一個(gè)參數(shù)必須是cls。

七編碼建議

1編碼中考慮到其他python實(shí)現(xiàn)的效率等問(wèn)題，比如運(yùn)算符‘+’在CPython(Python)中效率很高，都是Jython中卻非常低，所以應(yīng)該采用.join()的方式。

2盡可能使用‘is’‘isnot’取代‘==’，比如ifxisnotNone要優(yōu)于ifx。

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

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

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

try:

value=collection[key]

exceptKeyError:

returnkey_not_found(key)

else:

returnhandle_value(value)

要優(yōu)于

try:

#Toobroad!

returnhandle_value(collection[key])

exceptKeyError:

#WillalsocatchKeyErrorraisedbyhandle_value()

returnkey_not_found(key)

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

Yes:iffoo.startswith('bar'):優(yōu)于

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

7使用isinstance()比較對(duì)象的類(lèi)型。比如

Yes:ifisinstance(obj,int):優(yōu)于

No:iftype(obj)istype(1):

8判斷序列空或不空，有如下規(guī)則

Yes:ifnotseq:

ifseq:

優(yōu)于

No:iflen(seq)

ifnotlen(seq)

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

10二進(jìn)制數(shù)據(jù)判斷使用ifboolvalue的方式。

以上內(nèi)容為大家介紹了PEP8Python編碼規(guī)范，希望對(duì)大家有所幫助，如果想要了解更多Python相關(guān)知識(shí)，請(qǐng)關(guān)注IT培訓(xùn)機(jī)構(gòu):千鋒教育。http://jsszjs.cn/