pep8編碼規範

    剛開始在新浪暑期實習,和導師溝通,希望能多接觸一些Python運維自動化開發,所以,查看了一些編碼規範的相關內容,現摘錄如下,共勉!(摘自:編寫高質量Python代碼的59個有效方法)

1、空白

1)使用空格來表示縮進,而不要使用tab

2)和語法相關的每一層縮進都用四個空格來表示

3)每行的字符數不超過79

4)對於佔據多行的長度表達式來說,除了行首之外的其餘各行都應在通常的縮進級別上再加四個空格

5)文件中的函數和類之間應該用兩個空行分開

6)在同一類中,各方法之間應該用同一個空行分隔

7)在使用下標來獲取列表元素、調用函數或給關鍵字參數賦值的時候,不要在兩旁添加空格

8)在爲變量賦值時,賦值符號的左側和右側應該各自寫上一個空格,而且只寫一個就

2、命名

1)函數、變量及屬性應該用小寫字母來拼寫,各單詞之間應該用下劃線相連。如:lowercase_underscore

2)受保護的實例屬性,應以單個下劃線來開頭,例如:_leading_underscore

3)私有實例屬性,應該以兩下劃線開頭,例如:__double_leading_underscore

4)類和異常,應該以每個單詞首字母都大寫的形式來命名,例如,CapitalizedWord

5)模塊級別的常量,應該使用大寫字母來拼寫,各單詞之間應該以下劃線相連,例如:ALL_CAPS

6)類中的實例方法,應該把首個參數命名爲self,以表示該對象自身

7)類方法的首個參數,應命名爲cls,以表示該類自身

3、表達式和語句

1)採用內聯形式的否定詞,而不要把否定詞放在整個表達式的前面,例如:寫if a is  not b 而不是寫 if not a is b

2)不要通過檢測長度的方法(如:if len(somelist) == 0)來判斷somelist是否爲[]或“”等值,而應該採用if not somelist 這種寫法來判斷,它會假設,空值自動評估爲False

3)檢測非空值爲[1]hi等非空值時,也應該如此,if somelist 語句默認會把非空的值判斷爲True

4)不要編寫單行的if 語句、for循環、while循環及except複合語句,而是應該把這些語句分成多行來寫,以示清晰

5)import 語句應該總放在文件開頭

6)引入模塊時,總應該使用絕對名稱,而不應該使用當前模塊的路徑來使用絕對名稱。例如,引入bar包中的foo模塊時,應該完整的寫出from bar import foo,而不應該簡寫爲import foo

7)如果一定要以相對名稱來編寫import語句,那就採用明確的寫法:from . import foo

8)文件中的那些import 語句應該按順序劃分爲三部分,分別表示爲標準庫模塊、第三方模塊、及自用模塊。在每一部分中各import語句應按模塊的字母順序來排序

 


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章