Python編碼規範
分號
- 行尾無分號。不要用分號將兩條命令放在同一行。
行長度
- 每行不超過
80個字符。 - 不要使用反斜槓連接行。
Python會將圓括號, 中括號和花括號中的行隱式的連接起來 。
括號
- 寧缺毋濫的使用括號。
- 除非是用於實現行連接，否則不要在返回語句或條件語句中使用括號。
縮進
- 用
4個空格來縮進代碼。
空行
- 頂級定義之間空兩行，方法定義之間空一行。
- 頂級定義之間空兩行，比如函數或者類定義。
- 方法定義，類定義與第一個方法之間，都應該空一行。
空格
- 括號內不要有空格。
- 不要在逗號, 分號, 冒號前面加空格, 但應該在它們後面加(除了在行尾)。
- 參數列表, 索引或切片的左括號前不應加空格。
- 在二元操作符兩邊都加上一個空格。
- 當’
='用於指示關鍵字參數或默認參數值時, 不要在其兩側使用空格。
大部分.py文件不必以#!作爲文件的開始. 根據 PEP-394 , 程序的main文件應該以 #!/usr/bin/python2或者 #!/usr/bin/python3開始。
註釋
- 確保對模塊, 函數, 方法和行內註釋使用正確的風格。
- 塊註釋
""" """、行註釋#。
類
- 如果一個類不繼承自其它類, 就顯式的從object繼承。嵌套類也一樣。
字符串
- 避免在循環中用+和+=操作符來累加字符串. 由於字符串是不可變的, 這樣做會創建不必要的臨時對象, 並且導致二次方而不是線性的運行時間. 作爲替代方案, 你可以將每個子串加入列表, 然後在循環結束後用 .join 連接列表。
- 在同一個文件中, 保持使用字符串引號的一致性. 使用單引號
'或者雙引號"之一用以引用字符串, 並在同一文件中沿用。
文件和sockets
- 推薦使用 "
with"語句 以管理文件。
導入格式
-
每個導入應該獨佔一行。
-
導入總應該放在文件頂部, 位於模塊註釋和文檔字符串之後, 模塊全局變量和常量之前. 導入應該按照從最通用到最不通用的順序分組:
- 標準庫導入
- 第三方庫導入
- 應用程序指定導入
每種分組中, 應該根據每個模塊的完整包路徑按字典序排序, 忽略大小寫。
語句
- 通常每個語句應該獨佔一行。
- 不過, 如果測試結果與測試語句在一行放得下, 你也可以將它們放在同一行. 如果是if語句, 只有在沒有else時才能這樣做. 特別地, 絕不要對 try/except 這樣做, 因爲try和except不能放在同一行。
命名
- module_name, package_name
- method_name, function_name
- instance_var_name, function_parameter_name, local_var_name
- ClassName, ExceptionName
- GLOBAL_VAR_NAME
命名約定
- 所謂"內部(
Internal)"表示僅模塊內可用, 或者, 在類內是保護或私有的。 - 用單下劃線(
_)開頭表示模塊變量或函數是protected的(使用import * from時不會包含)。 - 用雙下劃線(
__)開頭的實例變量或方法表示類內私有。 - 將相關的類和頂級函數放在同一個模塊裏.。不像Java, 沒必要限制一個類一個模塊。
- 對類名使用大寫字母開頭的單詞, 但是模塊名應該用小寫加下劃線的方式。儘管已經有很多現存的模塊使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因爲如果模塊名碰巧和類名一致, 這會讓人困擾。