PEP8——Python代碼規(guī)范 - CSDN博客
一 代碼編排
1 縮進垢乙。4個空格的縮進（編輯器都可以完成此功能）渣慕，不使用Tap氮兵，更不能混合使用Tap和空格裂逐。
2 每行最大長度79，換行可以使用反斜杠泣栈，最好使用圓括號卜高。換行點要在操作符的后邊敲回車弥姻。
3 類和top-level函數(shù)定義之間空兩行；類中的方法定義之間空一行掺涛；函數(shù)內(nèi)邏輯無關段落之間空一行庭敦；其他地方盡量不要再空行。
二 文檔編排
1 模塊內(nèi)容的順序：模塊說明和docstring—import—globals&constants—其他定義薪缆。其中import部分秧廉，又按標準、三方和自己編寫順序依次排放拣帽，之間空一行疼电。
2 不要在一句import中多個庫，比如import os, sys不推薦减拭。
3 如果采用from XX import XX引用庫蔽豺，可以省略‘module.’，都是可能出現(xiàn)命名沖突峡谊，這時就要采用import XX茫虽。
三 空格的使用
總體原則，避免不必要的空格既们。
1 各種右括號前不要加空格濒析。
2 逗號、冒號啥纸、分號前不要加空格号杏。
3 函數(shù)的左括號前不要加空格。如Func(1)斯棒。
4 序列的左括號前不要加空格盾致。如list[2]。
5 操作符左右各加一個空格荣暮，不要為了對齊增加空格庭惜。
6 函數(shù)默認參數(shù)使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行穗酥，盡管使用‘护赊；’允許。
8 if/for/while語句中砾跃，即使執(zhí)行語句只有一句骏啰，也必須另起一行。
四 注釋
總體原則抽高，錯誤的注釋不如沒有注釋判耕。所以當一段代碼發(fā)生變化時，第一件事就是要修改注釋翘骂！
注釋必須使用英文壁熄，最好是完整的句子帚豪，首字母大寫，句后要有結(jié)束符草丧，結(jié)束符后跟兩個空格志鞍，開始下一句。如果是短語方仿，可以省略結(jié)束符固棚。
1 塊注釋，在一段代碼前增加的注釋仙蚜。在‘#’后加一空格此洲。段落之間以只有‘#’的行間隔。比如：
# Description : Module config.
# Input : None
# Output : None
2 行注釋委粉，在一句代碼后加注釋呜师。比如：x = x + 1 # Increment x
但是這種方式盡量少使用。
3 避免無謂的注釋贾节。
五 文檔描述
1 為所有的共有模塊汁汗、函數(shù)、類栗涂、方法寫docstrings知牌；非共有的沒有必要，但是可以寫注釋（在def的下一行）斤程。
2 如果docstring要換行角寸，參考如下例子,詳見PEP 257
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
六 命名規(guī)范
總體原則，新編代碼必須按下面命名風格進行忿墅，現(xiàn)有庫的編碼盡量保持風格扁藕。
1 盡量單獨使用小寫字母‘l’，大寫字母‘O’等容易混淆的字母疚脐。
2 模塊命名盡量短小亿柑，使用全部小寫的方式，可以使用下劃線棍弄。
3 包命名盡量短小望薄，使用全部小寫的方式，不可以使用下劃線照卦。
4 類的命名使用CapWords的方式式矫，模塊內(nèi)部使用的類采用_CapWords的方式乡摹。
5 異常命名使用CapWords+Error后綴的方式役耕。
6 全局變量盡量只在模塊內(nèi)有效，類似C語言中的static聪廉。實現(xiàn)方法有兩種瞬痘，一是__all__機制;二是前綴一個下劃線故慈。
7 函數(shù)命名使用全部小寫的方式，可以使用下劃線框全。
8 常量命名使用全部大寫的方式察绷，可以使用下劃線。
9 類的屬性（方法和變量）命名使用全部小寫的方式津辩，可以使用下劃線拆撼。
9 類的屬性有3種作用域public、non-public和subclass API喘沿，可以理解成C++中的public闸度、private、protected蚜印，non-public屬性前莺禁，前綴一條下劃線。
11 類的屬性若與關鍵字名字沖突窄赋，后綴一下劃線哟冬，盡量不要使用縮略等其他方式。
12 為避免與子類屬性命名沖突忆绰，在類的一些屬性前浩峡，前綴兩條下劃線。比如：類Foo中聲明__a,訪問時错敢，只能通過Foo._Foo__a红符，避免歧義。如果子類也叫Foo伐债，那就無能為力了预侯。
13 類的方法第一個參數(shù)必須是self，而靜態(tài)方法第一個參數(shù)必須是cls峰锁。
七 編碼建議
1 編碼中考慮到其他python實現(xiàn)的效率等問題萎馅，比如運算符‘+’在CPython（Python）中效率很高，都是Jython中卻非常低虹蒋，所以應該采用.join()的方式糜芳。
2 盡可能使用‘is’‘is not’取代‘==’，比如if x is not None 要優(yōu)于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)
要優(yōu)于
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’):優(yōu)于
No: if foo[:3] == ‘bar’:
7 使用isinstance()比較對象的類型呻惕。比如
Yes: if isinstance(obj, int): 優(yōu)于
No: if type(obj) is type(1):
8 判斷序列空或不空，有如下規(guī)則
Yes: if not seq:
if seq:
優(yōu)于
No: if len(seq)
if not len(seq)
9 字符串不要以空格收尾滥比。
10 二進制數(shù)據(jù)判斷使用 if boolvalue的方式亚脆。
