python 編碼規範整理

好處1：**風格的統一可以很好地提高**的可讀性。制定乙個相同的**風格，如直接選用python的pep8官方風格指南，嚴格遵守後可以得到美觀又統一風格的專案**，這在多人協作的開發中是很有必要的，每個人編寫**的習慣不一樣，特別是有些喜歡用一些奇怪或新奇的寫法，這樣可讀性很差。尤其是靈活的指令碼語言python、js等，越是靈活越需要規範，**更多是寫給人看，而不是僅僅給機器跑而已。實際上github上稍微正規的專案都有自己的專案**規範，如果沒有顯式標註，那便是預設使用官方的風格指南。python的pep8規範很詳細，作為語言本身重要的補充，規範是**簡潔美觀的有力保障。

好處2：可以發現隱藏的bug。**風格如果規範得好(像pep8)，是可以發現**中潛藏的bug的，比如未定義的變數，定義了變數卻沒使用，變數覆蓋等等，當**量越來越大，況且單元測試不完善的時候，**規範檢查可以發現一些基礎的不良寫法，發現隱藏的bug。(還是那句話，人都是不可靠的，總會有疏忽)

好處 3：可以稍微提高效能。比如定義的變數未使用，引入的模組未使用等，會造成額外的效能消耗和**冗餘，**規範可以方便地檢查出來。

**規範的檢查最好是做到自動化，最少也要配置快捷使用方式。可以使用flake8和autopep8等檢查規範和自動格式化**的工具，很多ide和編輯器都可以配置外掛程式和快捷使用方式。python中最專業最強大的ide當數pycharm，可以配置「external tools」，sublime之類的編輯器也可以方便地配置外掛程式。

即便有工具可以檢查和格式化**，但自己平時編寫**時最好還是按照規範來編寫，第一工具並非萬能，不能過分依賴；第二是按照規範來編寫本來就是乙個習慣問題，養成好習慣，也就離編寫漂亮又優雅**的目標不遠了。

1 縮排。4個空格的縮排（編輯器都可以完成此功能），不要使用tap，更不能混合使用tap和空格。

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

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

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

2 不要在一句import中多個庫，比如import os, sys不推薦。

3 如果採用from xx import xx引用庫，可以省略『module.』，都是可能出現命名衝突，這時就要採用import xx。

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

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

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

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

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

5 操作符左右各加乙個空格，不要為了對齊增加空格。

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

7 不要將多句語句寫在同一行，儘管使用『；』允許。

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

總體原則，錯誤的注釋不如沒有注釋。所以當一段**發生變化時，第一件事就是要修改注釋！

注釋必須使用英文，最好是完整的句子，首字母大寫，句後要有結束符，結束符後跟兩個空格，開始下一句。如果是短語，可以省略結束符。

1 塊注釋，在一段**前增加的注釋。在『#』後加一空格。段落之間以只有『#』的行間隔。

2 行注釋，在一句**後加注釋。比如：x = x + 1 # increment x

但是這種方式盡量少使用。

3 避免無謂的注釋。

1 為所有的共有模組、函式、類、方法寫docstrings；非共有的沒有必要，但是可以寫注釋（在def的下一行）。

2 如果docstring要換行，參考如下例子,詳見pep 257

"""return a foobang
optional plotz says to frobnicate the bizbaz first.
"""

總體原則，新編**必須按下面命名風格進行，現有庫的編碼盡量保持風格。

1 盡量單獨使用小寫字母『l』，大寫字母『o』等容易混淆的字母。

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

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

4 類的命名使用capwords的方式，模組內部使用的類採用_capwords的方式。

5 異常命名使用capwords+error字尾的方式。

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

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

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

9 類的屬性（方法和變數）命名使用全部小寫的方式，可以使用下劃線。

9 類的屬性有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的方式。

python 編碼規範整理

python 編碼規範整理

python 編碼規範整理

PEP8 Python 編碼規範整理

相關推薦