Python—PEP8編碼和命名習慣
程式碼編排
使用4空格縮排,不使用Tab,更不允許用Tab和空格混合縮排
每行最大長度最大79位元組,超過部分使用反斜槓折行
類和全域性函式定義間隔兩個空行,類內方法定義間隔一個空行.其它地方可以不加空行。
文件編排
其中import部分,又按標準、三方和自己編寫順序依次排放,之間空一行。
不要在一句import中匯入多個模組,比如不推薦import os, sys。
儘可能用import XX 而不採用from XX import YY引用庫,因為可能出現名字衝突。
空格的使用
各種右括號前不用加空格
逗號、冒號、分號前不要加空格。
函式的左括號前不要加空格。如func(1)。
序列的左括號前不要加空格。如list[2]。
操作符左右各加一個空格,不要為了對齊增加空格。
函式預設引數使用的賦值符左右省略空格。
不要將多條語句寫在同一行,儘管使用‘;’允許。
if/for/while語句中,即使執行語句只有一句,也必須另起一行
原則:避免不必要的空格
命名習慣
1.恆定量(常量)使用全大寫與下劃線:比如規定的不可更改的變數的值
2.私有變數使用前導下劃線和小寫,如:_message
3.一般的變數則應該:
全小寫,用下劃線隔開
表示型別的字母放在最前面
作用或要完成的工作則在中間
屬於誰放在最後,或可省略
例如:
numpy_creat_data_set_test表示的意思是:
該變數是numpy型別,被建立為一個數據集,用於測試(test這個函式的內部變數)
4.當一個變數被用於保存於布林值時,做好使用is或has作為字首,這樣更易於理解
5.當一個變數被用於儲存序列時,最好使用複數形式
6.當一個變數被用於臨時儲存時,最好加上temp_的字首
7.當一個變數被用於作為字典時,應該使用顯示名稱,如一個用來儲存個人地址的變數:person_address
8.應當避免使用通用名稱,現有名稱(已有名稱,變數i,j可以迴圈使用),
避免關鍵字,非得使用可以使用字尾下劃線
9.類名使用駝峰命名法,當定義的是模組的私有類時,還可能有一個前導下劃線
10.類內的名稱必須簡明,精確,並足以從中理解類所完成的工作.
常見的方法是表示其型別或特性的字尾:SQLEngine
11.對於基類而言,可以使用一個Base或Abstract字首,如:BaseCookie
下面關於類中屬性的命名規則:
12.屬性名稱是用小寫或者小寫加上下劃線命名的.大部分時候,它們表示物件的狀態,可以是一個名詞或一個形容詞,在需要的時候也可以是一個小短語
13.特殊方法是以兩個下劃線開始和結束的
14.應嘗試避免類及其特性名稱之間的冗餘,如:STMP.smtp_send()存在冗餘