代碼布局
1. 縮進
每級縮進用4個空格。括號中使用垂直隱式縮進或使用懸掛縮進。
正確示范:
2.最大行寬
每行最大行寬不超過 79 個字符,一般續行可使用反斜杠,括號內續行不需要使用反斜杠
正確示范:
3. 空行
兩行空行用於分割頂層函數和類的定義
單個空行用於分割類定義中的方法
正確示范:
5. 模塊導入
導入的每個模塊應該單獨成行,導入順序如下: (各模塊類型導入之間要有空行分割,各組里面的模塊的順序按模塊首字母自上而下升序排列)
1.標准庫
2.相關的第三方庫
3.本地庫
正確示范:
6. 字符串
單引號和雙引號作用是一樣的,但必須保證成對存在,不能夾雜使用. (建議句子使用雙引號, 單詞使用單引號, 但不強制.)
7.表達式和語句中的空格
括號里邊避免空格
正確示范:
逗號,冒號,分號之前避免空格
正確示范:
函數調用的左括號之前不能有空格
正確示范:
賦值等操作符前后不能因為對齊而添加多個空格
正確示范:
二元運算符兩邊放置一個空格,涉及 = 的復合操作符 ( += , -=等),比較操作符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not ),邏輯操作符( and , or , not )
正確示范:
8. 注釋
注釋塊
注釋塊通常應用在代碼前,並和代碼有同樣的縮進。每行以 ‘# ’ 開頭, 而且#后面有單個空格。
正常示范:
單行注釋(應避免無謂的注釋)
文檔字符串
多行文檔, 首行首字母大寫,結尾的 """ 應該單獨成行,單行的文檔, 結尾的 """ 在同一行。
9. 命名規則
包和模塊名:
包和模塊名應該簡短,全部用小寫字母, 多字母之間可以使用單下划線連接。
類名:
遵循駝峰命名
全局變量名:
全局變量名應盡量只在模塊內部使用, 對可能使用語句 from moduleName import variableName 而被導入的模塊,應采用 __all__ 機制來防止全局變量被別的模塊導入, 或者在全局變量名開頭加一個前置下划線.
正確示范:
函數名
函數名應該為全部小寫的凹駝峰規則。
正確示范:
常量名
常量全部使用大寫字母的凹駝峰規則來表示, 通常在模塊頂格定義
正確示范:
方法名和實例變量
非公開方法和實例變量開頭使用前置下划線,有時候可能會為了避免與子類命名沖突,采用兩個前置下划線,需要注意的是: 若 class Foo 的屬性名為 __a, 該屬性是不能以 Foo.__a 的方式訪問的(執著的用戶還是可以通過Foo._Foo__a 來訪問), 所以通常雙前置下划線僅被用來避免與基類的屬性發生命名沖突。
10. 編程建議
None 的比較用 is 或 is not,而不要用 ==,用 is not 代替 not … is, 前者的可讀性更好
正確示范
使用函數定義關鍵字 def 代替 lambda 賦值給標識符, 這樣更適合於回調和字符串表示
正確示范:
異常類應該繼承自Exception,而不是 BaseException,捕獲異常時盡量指明具體異常, 盡量不用 except Exception, 應該捕獲 出了什么問題,而不是 問題發生
正確示范
try/except 子句中的代碼要盡可能的少, 以免屏蔽掉其他的錯誤
正確示范:
函數或者方法在沒有返回值時要明確返回 None
正確示范:
使用字符串方法而不是 string 模塊 ,使用 .startswith() 和 .endswith() 代替字符串切片來檢查前綴和后綴 ,startswith() 和 endswith 更簡潔,利於減少錯誤
正確示范:
使用 isinstance() 代替對象類型的比較
正確示范:
空序列類型對象的 bool 為 False:
正確示范:
不要用 == 進行 bool 比較
正確示范