轉載自http://www.douban.com/note/134971609/
Python 的代碼風格由 PEP 8 描述。這個文檔描述了 Python 編程風格的方方面面。在遵守這個文檔的條件下，不同程序員編寫的 Python 代碼可以保持最大程度的相似風格。這樣就易於閱讀，易於在程序員之間交流。
1. 命名風格
- 總體原則，新編代碼必須按下面命名風格進行，現有庫的編碼盡量保持風格。
- 盡量以免單獨使用小寫字母'l'，大寫字母'O'，以及大寫字母'I'等容易混淆的字母。
- 模塊命名盡量短小，使用全部小寫的方式，可以使用下划線。
- 包命名盡量短小，使用全部小寫的方式，不可以使用下划線。
- 類的命名使用CapWords的方式，模塊內部使用的類采用_CapWords的方式。
- 異常命名使用CapWords+Error后綴的方式。
- 全局變量盡量只在模塊內有效，類似C語言中的static。實現方法有兩種，一是__all__機制;二是前綴一個下划線。對於不會發生改變的全局變量，使用大寫加下划線。
- 函數命名使用全部小寫的方式，可以使用下划線。
- 常量命名使用全部大寫的方式，可以使用下划線。
- 使用 has 或 is 前綴命名布爾元素，如: is_connect = True; has_member = False
- 用復數形式命名序列。如：
members = ['user_1', 'user_2'] - 用顯式名稱命名字典，如：person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}
- 避免通用名稱。諸如 list, dict, sequence 或者 element 這樣的名稱應該避免。又如os, sys 這種系統已經存在的名稱應該避免。
- 類的屬性（方法和變量）命名使用全部小寫的方式，可以使用下划線。
- 對於基類而言，可以使用一個 Base 或者 Abstract 前綴。如BaseCookie、AbstractGroup
- 內部使用的類、方法或變量前，需加前綴'_'表明此為內部使用的。雖然如此，但這只是程序員之間的約定而非語法規定，用於警告說明這是一個私有變量，外部類不要去訪問它。但實際上，外部類還是可以訪問到這個變量。import不會導入以下划線開頭的對象。
- 類的屬性若與關鍵字名字沖突，后綴一下划線，盡量不要使用縮略等其他方式。
- 雙前導下划線用於命名class屬性時，會觸發名字重整；雙前導和后置下划線存在於用戶控制的名字空間的"magic"對象或屬性。
- 為避免與子類屬性命名沖突，在類的一些屬性前，前綴兩條下划線。比如：類Foo中聲明__a,訪問時，只能通過Foo._Foo__a，避免歧義。如果子類也叫Foo，那就無能為力了。
- 類的方法第一個參數必須是self，而靜態方法第一個參數必須是cls。
- 一般的方法、函數、變量需注意，如非必要，不要連用兩個前導和后置的下線線。兩個前導下划線會導致變量在解釋期間被更名。兩個前導下划線會導致函數被理解為特殊函數，比如操作符重載等。
2 關於參數
- 要用斷言來實現靜態類型檢測。斷言可以用於檢查參數，但不應僅僅是進行靜態類型檢測。 Python 是動態類型語言，靜態類型檢測違背了其設計思想。斷言應該用於避免函數不被毫無意義的調用。
- 不要濫用 *args 和 **kwargs。*args 和 **kwargs 參數可能會破壞函數的健壯性。它們使簽名變得模糊，而且代碼常常開始在不應該的地方構建小的參數解析器
3 代碼編排
- 縮進。優先使用4個空格的縮進（編輯器都可以完成此功能），其次可使用Tap，但堅決不能混合使用Tap和空格。
- 每行最大長度79，換行可以使用反斜杠，最好使用圓括號。換行點要在操作符的后邊敲回車。
- 類和top-level函數定義之間空兩行；類中的方法定義之間空一行；函數內邏輯無關段落之間空一行；其他地方盡量不要再空行。
- 一個函數 : 不要超過 30 行代碼, 即可顯示在一個屏幕類，可以不使用垂直游標即可看到整個函數；一個類 : 不要超過 200 行代碼，不要有超過 10 個方法；一個模塊 不要超過 500 行。
4. 文檔編排
- 模塊內容的順序：模塊說明和docstring—import—globals&constants—其他定義。其中import部分，又按標准、三方和自己編寫順序依次排放，之間空一行。
- 不要在一句import中多個庫，比如import os, sys不推薦。
- 如果采用from XX import XX引用庫，可以省略‘module.’。若是可能出現命名沖突，這時就要采用import XX。
5. 空格的使用
- 總體原則，避免不必要的空格。
- 各種右括號前不要加空格。
- 函數的左括號前不要加空格。如Func(1)。
- 序列的左括號前不要加空格。如list[2]。
- 逗號、冒號、分號前不要加空格。
- 操作符（=/+=/-+/==/</>/!=/<>/<=/>=/in/not in/is/is not/and/or/not)左右各加一個空格，不要為了對齊增加空格。如果操作符有優先級的區別，可考慮在低優先級的操作符兩邊添加空格。如：hypot2 = x*x + y*y; c = (a+b) * (a-b)
- 函數默認參數使用的賦值符左右省略空格。
- 不要將多句語句寫在同一行，盡管使用‘；’允許。
- if/for/while語句中，即使執行語句只有一句，也必須另起一行。
6. 注釋
- 總體原則，錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時，第一件事就是要修改注釋！避免無謂的注釋
- 注釋必須使用英文，最好是完整的句子，首字母大寫，句后要有結束符，結束符后跟兩個空格，開始下一句。如果是短語，可以省略結束符。
- 行注釋：在一句代碼后加注釋，但是這種方式盡量少使用。。比如：x = x + 1 # Increment
- 塊注釋：在一段代碼前增加的注釋。在‘#’后加一空格。段落之間以只有‘#’的行間隔。比如：
# Description : Module config. # # Input : None # # Output : None
7. 文檔描述
- 為所有的共有模塊、函數、類、方法寫docstrings；非共有的沒有必要，但是可以寫注釋（在def的下一行）。
- 如果docstring要換行，參考如下例子,詳見PEP 257
"""Return a foobang Optional plotz says to frobnicate the bizbaz first. """
8. 編碼建議
- 編碼中考慮到其他python實現的效率等問題，比如運算符‘+’在CPython（Python）中效率很高，都是Jython中卻非常低，所以應該采用.join()的方式。
- 與None之類的單件比較，盡可能使用‘is’‘is not’，絕對不要使用‘==’，比如if x is not None 要優於if x。
- 使用startswith() and endswith()代替切片進行序列前綴或后綴的檢查。比如：建議使用if foo.startswith('bar'): 而非if foo[:3] == 'bar':
- 使用isinstance()比較對象的類型。比如：建議使用if isinstance(obj, int): 而非if type(obj) is type(1):
- 判斷序列空或不空，有如下規則：建議使用if [not] seq: 而非if [not] len(seq)
- 字符串不要以空格收尾。
- 二進制數據判斷使用 if boolvalue的方式。
- 使用基於類的異常，每個模塊或包都有自己的異常類，此異常類繼承自Exception。錯誤型的異常類應添加"Error"后綴，非錯誤型的異常類無需添加。
- 異常中不要使用裸露的except，except后跟具體的exceptions。
- 異常中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)
9. 驗證腳本
可以安裝一個 pep8 腳本用於驗證你的代碼風格是否符合 PEP8。Ubuntu上的安裝可以用命令：sudo apt-get install pep8