總結 90 條寫 Python 程式的建議

自己寫 Python 也有四五年了，一直是用自己的“強迫症”在維持自己程式碼的質量。都有去看 Google 的 Python 程式碼規範，對這幾年的工作經驗，做個簡單的筆記，如果你也在學 Python，準備要學習 Python，希望這篇文章對你有用。

1. 首先

建議1、理解 Pythonic 概念—-詳見 Python 中的《Python之禪》

建議2、編寫 Pythonic 程式碼

（1）避免不規範程式碼，比如只用大小寫區分變數、使用容易混淆的變數名、害怕過長變數名等。有時候長的變數名會使程式碼更加具有可讀性。

（2）深入學習 Python 相關知識，比如語言特性、庫特性等，比如Python演變過程等。深入學習一兩個業內公認的 Pythonic 的程式碼庫，比如Flask等。

建議3：理解 Python 與 C 的不同之處，比如縮排與 {}，單引號雙引號，三元運算子？， Switch-Case 語句等。

建議4：在程式碼中適當新增註釋

建議5：適當新增空行使程式碼佈局更加合理

建議6：編寫函式的 4 個原則

（1）函式設計要儘量短小，巢狀層次不宜過深

（2）函式宣告應該做到合理、簡單、易用

（3）函式引數設計應該考慮向下相容

（4）一個函式只做一件事，儘量保證函式粒度的一致性

建議7：將常量集中在一個檔案，且常量名儘量使用全大寫字母

2. 程式設計慣用法

建議8：利用 assert 語句來發現問題，但要注意，斷言 assert 會影響效率

建議9：資料交換值時不推薦使用臨時變數，而是直接 a, b = b, a

建議10：充分利用惰性計算（Lazy evaluation）的特性，從而避免不必要的計算

建議11：理解列舉替代實現的缺陷（最新版 Python 中已經加入了列舉特性）

建議12：不推薦使用 type 來進行型別檢查，因為有些時候 type 的結果並不一定可靠。如果有需求，建議使用 isinstance 函式來代替

建議13：儘量將變數轉化為浮點型別後再做除法（Python3 以後不用考慮）

建議14：警惕eval()函式的安全漏洞，有點類似於 SQL 注入

建議15：使用 enumerate() 同時獲取序列迭代的索引和值

建議16：分清 == 和 is 的適用場景，特別是在比較字串等不可變型別變數時（詳見評論）

建議17：儘量使用 Unicode。在 Python2 中編碼是很讓人頭痛的一件事，但 Python3 就不用過多考慮了

建議18：構建合理的包層次來管理 Module

3. 基礎用法

建議19：有節制的使用 from…import 語句，防止汙染名稱空間

建議20：優先使用 absolute import 來匯入模組（Python3中已經移除了relative import）

建議21：i+=1 不等於 ++i，在 Python 中，++i 前邊的加號僅表示正，不表示操作

建議22：習慣使用 with 自動關閉資源，特別是在檔案讀寫中

建議23：使用 else 子句簡化迴圈（異常處理）

建議24：遵循異常處理的幾點基本原則

（1）注意異常的粒度，try 塊中儘量少寫程式碼

（2）謹慎使用單獨的 except 語句，或 except Exception 語句，而是定位到具體異常

（3）注意異常捕獲的順序，在合適的層次處理異常

（4）使用更加友好的異常資訊，遵守異常引數的規範

建議25：避免 finally 中可能發生的陷阱

建議26：深入理解 None，正確判斷物件是否為空。

建議27：連線字串應優先使用 join 函式，而不是+操作

建議28：格式化字串時儘量使用 format 函式，而不是 % 形式

建議29：區別對待可變物件和不可變物件，特別是作為函式引數時

建議30：[], {}和()：一致的容器初始化形式。使用列表解析可以使程式碼更清晰，同時效率更高

建議31：函式傳引數，既不是傳值也不是傳引用，而是傳物件或者說物件的引用

建議32：警惕預設引數潛在的問題，特別是當預設引數為可變物件時

建議33：函式中慎用變長引數 args 和 kargs

（1）這種使用太靈活，從而使得函式簽名不夠清晰，可讀性較差

（2）如果因為函式引數過多而是用變長引數簡化函式定義，那麼一般該函式可以重構

建議34：深入理解 str()和 repr() 的區別

（1）兩者之間的目標不同：str 主要面向客戶，其目的是可讀性，返回形式為使用者友好性和可讀性都比較高的字串形式；而 repr 是面向 Python 直譯器或者說Python開發人員，其目的是準確性，其返回值表示 Python 直譯器內部的定義

（2）在直譯器中直接輸入變數，預設呼叫repr函式，而print(var)預設呼叫str函式

（3）repr函式的返回值一般可以用eval函式來還原物件

（4）兩者分別呼叫物件的內建函式 __str__ ()和 __repr__ ()

建議35：分清靜態方法 staticmethod 和類方法 classmethod 的使用場景

4. 庫的使用

建議36：掌握字串的基本用法

建議37：按需選擇 sort() 和 sorted() 函式

sort() 是列表在就地進行排序，所以不能排序元組等不可變型別。

sorted() 可以排序任意的可迭代型別，同時不改變原變數本身。

建議38：使用copy模組深複製物件，區分淺複製（shallow copy）和深複製（deep copy）

建議39：使用 Counter 進行計數統計，Counter 是字典類的子類，在 collections 模組中

建議40：深入掌握 ConfigParse

建議41：使用 argparse 模組處理命令列引數

建議42：使用 pandas 處理大型 CSV 檔案

Python 本身提供一個CSV檔案處理模組，並提供reader、writer等函式。

Pandas 可提供分塊、合併處理等，適用於資料量大的情況，且對二維資料操作更方便。

建議43：使用 ElementTree解析XML

建議44：理解模組 pickle 的優劣 

優勢：介面簡單、各平臺通用、支援的資料型別廣泛、擴充套件性強

劣勢：不保證資料操作的原子性、存在安全問題、不同語言之間不相容

建議45：序列化的另一個選擇 JSON 模組：load 和 dump 操作

建議46：使用 traceback 獲取棧資訊

建議47：使用 logging 記錄日誌資訊

建議48：使用 threading 模組編寫多執行緒程式

建議49：使用 Queue 模組使多執行緒程式設計更安全

5. 設計模式

建議50：利用模組實現單例模式

建議51：用 mixin 模式讓程式更加靈活

建議52：用釋出-訂閱模式實現松耦合

建議53：用狀態模式美化程式碼

6. 內部機制

建議54：理解 build-in 物件

建議55：__init__ ()不是構造方法，理解 __new__ ()與它之間的區別

建議56：理解變數的查詢機制，即作用域

區域性作用域

全域性作用域

巢狀作用域

內建作用域

建議57：為什麼需要self引數

建議58：理解 MRO（方法解析順序）與多繼承

建議59：理解描述符機制

建議60：區別 __getattr__ ()與 __getattribute__ ()方法之間的區別

建議61：使用更安全的 property

建議62：掌握元類 metaclass

建議63：熟悉 Python 物件協議

建議64：利用運算子過載實現中綴語法

建議65：熟悉 Python 的迭代器協議

建議66：熟悉 Python 的生成器

建議67：基於生成器的協程和 greenlet，理解協程、多執行緒、多程式之間的區別

建議68：理解 GIL 的侷限性

建議69：物件的管理和垃圾回收

7. 使用工具輔助專案開發

建議70：從 PyPI 安裝第三方包

建議71：使用 pip 和 yolk 安裝、管理包

建議72：做 paster 建立包

建議73：理解單元測試的概念

建議74：為包編寫單元測試

建議75：利用測試驅動開發（TDD）提高程式碼的可測性

建議76：使用 Pylint 檢查程式碼風格

程式碼風格審查

程式碼錯誤檢查

發現重複以及不合理的程式碼，方便重構

高度的可配置化和可定製化

支援各種 IDE 和編輯器的整合

能夠基於 Python 程式碼生成 UML 圖

能夠與 Jenkins 等持續整合工具相結合，支援自動程式碼審查

建議77：進行高效的程式碼審查

建議78：將包釋出到 PyPI

8. 效能剖析與最佳化

建議79：瞭解程式碼最佳化的基本原則

建議80：藉助效能最佳化工具

建議81：利用 cProfile 定位效能瓶頸

建議82：使用 memory_profiler 和 objgraph 剖析記憶體使用

建議83：努力降低演算法複雜度

建議84：掌握迴圈最佳化的基本技巧

減少迴圈內部的計算

將顯式迴圈改為隱式迴圈，當然這會犧牲程式碼的可讀性

在迴圈中儘量引用區域性變數

關注內層巢狀迴圈

建議85：使用生成器提高效率

建議86：使用不同的資料結構最佳化效能

建議87：充分利用 set 的優勢

建議88：使用 multiprocessing 模組克服 GIL 缺陷 

建議89：使用執行緒池提高效率

建議90：使用 Cythonb 編寫擴充套件模組