1. 程式人生 > >python PEP8規範

python PEP8規範

(一) 程式碼的編排

1、 縮排。每行需要4個空格的縮排,不要使用Tap鍵,更不能混合使用Tap鍵和空格。

2 、每行最大長度79,換行可以使用反斜槓,但最好使用圓括號。換行點要在操作符的後邊敲回車。

3 、類和top-level函式定義之間空兩行;類中的方法定義之間空一行;函式內邏輯無關段落之間空一行;其他地方儘量不要再空行。

(二 )文件的編排

1、 模組內容的順序:模組說明和docstring—import—globals&constants—其他定義。其中import部分,又按標準、第三方和自己編寫順序依次排放,之間空一行。

from django.db import models

from datetime import datetime

from django.contrib.auth.models import AbstractUser

# 自己定義程式碼放置處

2 、不要在一行import多個庫,比如import os, sys,雖說沒有錯誤但是並不推薦。

3、 如果採用from xx import xx的方式來引用某個庫,可以省略module.,但是可能會出現命名的衝突,所以這時就要採用import xx的方式。

(三)空格的使用

總體原則,避免不必要的空格。

1、 各種右括號前不要加空格。

2、 逗號、冒號、分號前不要加空格。

3 、函式的左括號前不要加空格。如function(1)。

4 、序列的左括號前不要加空格。如list[2]。

5、操作符左右各加一個空格,不要為了對齊增加空格。

6 、函式預設引數使用的賦值符左右省略空格。

7、不要將多句語句寫在同一行,儘管使用;允許。

8、 if/for/while語句中,即使執行語句只有一句,也必須另起一行。

(四)命名的規範

總體原則,新編程式碼必須按下面命名風格進行,現有庫的編碼儘量保持風格。

1 、儘量單獨使用小寫字母‘l’,大寫字母‘O’等容易混淆的字母。

2、 模組命名儘量短小,使用全部小寫的方式,可以使用下劃線。

3、 包命名儘量短小,使用全部小寫的方式,不可以使用下劃線。

4、 類的命名使用CapWords的方式,模組內部使用的類採用_CapWords的方式。

5、 異常命名使用CapWords+Error字尾的方式。

6 、全域性變數儘量只在模組內有效,類似C語言中的static。實現方法有兩種,一是all機制;二是字首一個下劃線。

7 、函式命名使用全部小寫的方式,可以使用下劃線。

8 、常量命名使用全部大寫的方式,可以使用下劃線。

9 、類的屬性(方法和變數)命名使用全部小寫的方式,可以使用下劃線。

10、類的屬性有3種作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public屬性前,字首一條下劃線。

11 、類的屬性若與關鍵字名字衝突,字尾一下劃線,儘量不要使用縮略等其他方式。

12 、為避免與子類屬性命名衝突,在類的一些屬性前,字首兩條下劃線。比如:類Foo中宣告__a,訪問時,只能通過Foo._Foo__a,避免歧義。如果子類也叫Foo,那就無能為力了。

13 、類的方法第一個引數必須是self,而靜態方法第一個引數必須是cls。

(五)編碼的建議

1、編碼中考慮到其他python實現的效率等問題,比如運算子‘+’在CPython(Python)中效率很高,都是Jython中卻非常低,所以應該採用.join()的方式。

2 、儘可能使用‘is’‘is not’取代‘==’,比如if x is not None 要優於if x。

3 、使用基於類的異常,每個模組或包都有自己的異常類,此異常類繼承自Exception。

4 、異常中不要使用裸露的except,except後跟具體的exceptions。

5 、異常中try的程式碼儘可能少。比如:

~~~

try:

value = collection[key]

except KeyError:

return key_not_found(key)

else:

return handle_value(value)

~~~

要優於

~~~

try:

# Too broad!

return handle_value(collection[key])

except KeyError:

# Will also catch KeyError raised by handle_value()

return key_not_found(key)

~~~

6 、使用startswith() and endswith()代替切片進行序列字首或字尾的檢查。比如:

Yes: if foo.startswith(‘bar’):優於No: if foo[:3] == ‘bar’:

7 、使用isinstance()比較物件的型別。比如:

Yes: if isinstance(obj, int):優於No: if type(obj) is type(1):

8、 判斷序列空或不空,有如下規則:

Yes: if not seq:

if seq:

優於

No: if len(seq)

if not len(seq)

9 、字串不要以空格收尾。

10、二進位制資料判斷使用 if boolvalue的方式。

如果你想獲得更多關於PEP8的資訊,可以查閱這篇資訊PEP8 Python 編碼規範整理或者官方文件PEP8的官方文件