|
工作中寫了個Python的模塊，CodeReview的時候被告知有些不符合Python規範的地方。於是找到了PEP8的全文(http://www.python.org/dev/peps/pep-0008/)閱讀了一番，還是受益匪淺。下面是做的一些摘要。 在項目中保持風格的一致性。代碼佈局縮進
對於每一次縮進使用4個空格。使用括號、中括號、大括號進行垂直對齊，或者縮進對齊。
製表符還是空格?永遠不要將製表符與空格混合使用。Python最常用的縮進方式是隻是用空格。
當調用Python命令行的 -t 選項時，它會檢測並警告代碼非法混合使用製表符和空格。當使用 -tt 選項時，警告變成了錯誤。
最大行長度限制所有行最長爲79個字符。
使用反斜槓來分行是一個很好的選擇。
我們應當選擇在二元操作符之後進行分行，而不是之前。
空行使用兩行空行來分隔頂層函數和類定義。
使用單行空行來分隔類方法定義。
在函數中使用空行來表示不同的邏輯塊。
編碼Python核心發行代碼裏面優先使用ASCII碼或Latin-1編碼。3.0後UTF-8編碼優先於Latin-1。
導入每一個導入通常應當使用單獨的行。
導入應當位於文件頂部，在模塊註釋和文檔字符串之後，在全局變量和常量之前。
導入應當按以下順序分組，且每組導入之間使用空行隔開：
1、標準庫導入
2、第三方庫導入
3、本地應用程序/定製庫導入
使用絕對包路徑導入。
表達式和語句中的空格使用兩行空行來分隔頂層函數和類定義。
註釋誤導的註釋不如沒有註釋
註釋應當爲完整的句子，且句號結尾的句子後面應當有2個空格。如果註釋很短，那麼結尾的句號可以忽略。
塊註釋塊註釋應當和代碼縮進保持一致。每行註釋開頭應以#開頭，然後緊跟一個空格。
塊註釋行註釋至少和語句間隔2個空格。同樣的註釋應當以#開頭，然後緊跟一個空格。
文檔字符串對於所有的公有模塊、類、函數和方法都需要編寫文檔字符串。
""" 作爲多行的文檔字符串的結束，應該單獨一行，並且之前有一個空行。
對於只有一行的文檔字符串來說，結尾的 """ 在同一行。
更詳細的文檔字符串規範見 PEP 257。
命名規範目前Python庫的命名規範尚未達成一致，但有一些推薦的標準。
在Python裏面，有一些具有特定意義的下劃線前綴或者後繼的特殊格式。如：
1、_single_leading_underscore：（單下劃線開始）弱"內部使用"指示器。例如：from
M import * 不會導入以下劃線開始的對象。
2、single_trailing_underscore_：（單下劃線結束）規定使用其來避免與Python關鍵字衝突，例如：
Tkinter.Toplevel(master, class_='ClassName') 在參數class後面加單下劃線，避免與關鍵字class衝突
3、__double_leading_underscore：（雙下劃線開始）命名一個類的屬性時，調用"name mangling"（類FooBar中，__boo 變爲了 _FooBar__boo;
見下文）
4、__double_leading_and_trailing_underscore__：（雙下劃線開始和結束）存活在用戶控制命名空間的"magic"對象或屬性。
例如__init__, __import__ 或 __file__。永遠不要起這樣的名字。
避免使用的命名不要使用小寫的L、大寫的O、以及大寫的I作爲單字符變量名。
包與模塊名稱模塊應當使用簡短、全小寫的名字，也可使用下劃線連接來提高可讀性。
包也應當使用簡短、全小寫的名字，但不要使用下劃線。
這是由於模塊名與文件名關聯，而在某些文件系統中大小寫不敏感，且會截斷過長的名字。
當使用C/C++來編寫一個擴展模塊時，應當使用下劃線作爲模塊名的前綴。
類名類名應當使用駝峯式（CapWords）。內部使用的類名應當加下劃線前綴。
異常名異常也是一個類，所以需要遵循類名規則。但如果你的異常確實是個錯誤的話，請使用Error前綴。
全局變量名遵循函數規則。
函數名函數名全小寫，可以使用下劃線分隔來提高可讀性。
函數與方法參數使用self作爲實例方法的第一個參數。
使用cls作爲類方法的第一個參數。
當函數的參數名與保留字衝突時，使用下劃線後綴（第二次提醒）。
方法名與實例變量遵循函數規則。
在私有方法和實例變量前用單下劃線前綴。
使用雙下劃線前綴來調用"name mangling"來避免與子類命名衝突。
如果類Foo有個屬性叫__a，那麼它不能使用Foo.__a讀取，但仍然可以Foo._Foo__a來讀取。
常量常量通常在模塊級別定義，使用全大寫和下劃線分隔的形式。
繼承設計在設計類的方法或實例變量時，應當覺得其實公有的還是非公有的。當不能確定時，設計爲私有的。
在Python中沒有真正的私有屬性。
公有屬性不應當使用下劃線開始。
當公有屬性與保留字衝突時，在名稱後面加下劃線後綴（第三次提醒）。
對於簡單的公有屬性，最好直接訪問其屬性名，而非get/set方法。
編程建議代碼應當適用於Python的多個實現。比如不要依賴CPython的高效字符串語句 a+=b，而應當使用join，從而保證在不同實現上的線性開銷。
當與類似於None的單例（singleton)進行比較式，要使用is 或者 is not， 而不是使用等於操作。
當使用複雜比較實現排序操作時，最好實現全部的六個比較操作。
使用基於對象的異常。
模塊或者包應當定義自己的異常基類，這個類應當繼承自內置的Exception類。
當拋出一個異常的時候，使用raise ValueError('message')代替舊的raise
ValueError, 'message'格式。這是由於當異常的參數很長或者是格式化字符串的時候，由於括號的關係，我們不需要使用多行連接符。 舊的格式在Python 3 中被移除。
當捕獲一個異常的時候，要用詳細的異常聲明來代替簡單的except: 語句。
一個空的except:語句將會捕獲
SystemExit 和 KeyboardInterrrupt 異常。這會使得很難用Control-C來中斷一個程序，並且還會隱藏其他的問題。
另外，對於所有的try/except語句，限制try語句來減少必要代碼的數量。
再者，可以避免掩蓋問題。
使用''.startswith() 和 ''.endswith()而非字符切片去檢測前綴或後綴。
對象類型比較總要用 isinstance() 而非直接比較。
對於序列，(strings, lists, tuples)，利用空序列爲false這一點來進行判斷，而非使用長度來判斷。
別用‘==’進行布爾值和 True 或者 False 的比較。
|
Python編程規範(PEP8)閱讀摘要
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章
python3 super 用法2
class MetaCls(type): def __new__(cls, *args, **kwargs): print("in MetaCls") # return super(Meta