總結(jié) 91 條寫(xiě) Python 程序的建議

開(kāi)始學(xué) Python 的時(shí)候，我們的目標(biāo)是實(shí)現(xiàn)功能，少出bug。但當(dāng)有了一定經(jīng)驗(yàn)之后，就會(huì)對(duì)代碼規(guī)范和風(fēng)格有更高的要求。這樣既能提升代碼的質(zhì)量，也更易于后期的維護(hù)和擴(kuò)展，尤其在與他人協(xié)作開(kāi)發(fā)時(shí)非常重要。

今天我們?cè)诖朔窒硪恍?Python 編程中的經(jīng)驗(yàn)建議，希望對(duì)各位 Python 的學(xué)習(xí)者和使用者有幫助。

注：本文內(nèi)容來(lái)源于
《編寫(xiě)高質(zhì)量代碼：改善Python程序的91個(gè)建議》
https://l1nwatch.gitbook.io/writing_solid_python_code_gitbook/

1. 引論

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

建議2、編寫(xiě) Pythonic 代碼

（1）避免不規(guī)范代碼，比如只用大小寫(xiě)區(qū)分變量、使用容易混淆的變量名、害怕過(guò)長(zhǎng)變量名等。有時(shí)候長(zhǎng)的變量名會(huì)使代碼更加具有可讀性。

（2）深入學(xué)習(xí) Python 相關(guān)知識(shí)，比如語(yǔ)言特性、庫(kù)特性等，比如Python演變過(guò)程等。深入學(xué)習(xí)一兩個(gè)業(yè)內(nèi)公認(rèn)的 Pythonic 的代碼庫(kù)，比如Flask等。

建議3：理解 Python 與 C 的不同之處，比如縮進(jìn)與 {}，單引號(hào)雙引號(hào)，三元操作符？， Switch-Case 語(yǔ)句等。

建議4：在代碼中適當(dāng)添加注釋

建議5：適當(dāng)添加空行使代碼布局更加合理

建議6：編寫(xiě)函數(shù)的 4 個(gè)原則

（1）函數(shù)設(shè)計(jì)要盡量短小，嵌套層次不宜過(guò)深

（2）函數(shù)聲明應(yīng)該做到合理、簡(jiǎn)單、易用

（3）函數(shù)參數(shù)設(shè)計(jì)應(yīng)該考慮向下兼容

（4）一個(gè)函數(shù)只做一件事，盡量保證函數(shù)粒度的一致性

建議7：將常量集中在一個(gè)文件，且常量名盡量使用全大寫(xiě)字母

2. 編程慣用法

建議8：利用 assert 語(yǔ)句來(lái)發(fā)現(xiàn)問(wèn)題，但要注意，斷言 assert 會(huì)影響效率

建議9：數(shù)據(jù)交換值時(shí)不推薦使用臨時(shí)變量，而是直接 a, b = b, a

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

建議11：理解枚舉替代實(shí)現(xiàn)的缺陷（最新版 Python 中已經(jīng)加入了枚舉特性）

建議12：不推薦使用 type 來(lái)進(jìn)行類型檢查，因?yàn)橛行r(shí)候 type 的結(jié)果并不一定可靠。如果有需求，建議使用 isinstance 函數(shù)來(lái)代替

建議13：盡量將變量轉(zhuǎn)化為浮點(diǎn)類型后再做除法（Python3 以后不用考慮）

建議14：警惕eval()函數(shù)的安全漏洞，有點(diǎn)類似于 SQL 注入

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

建議16：分清 == 和 is 的適用場(chǎng)景，特別是在比較字符串等不可變類型變量時(shí)（詳見(jiàn)評(píng)論）

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

建議18：構(gòu)建合理的包層次來(lái)管理 Module

3. 基礎(chǔ)用法

建議19：有節(jié)制的使用 from…import 語(yǔ)句，防止污染命名空間

建議20：優(yōu)先使用 absolute import 來(lái)導(dǎo)入模塊（Python3中已經(jīng)移除了relative import）

建議21：i+=1 不等于 ++i，在 Python 中，++i 前邊的加號(hào)僅表示正，不表示操作

建議22：習(xí)慣使用 with 自動(dòng)關(guān)閉資源，特別是在文件讀寫(xiě)中

建議23：使用 else 子句簡(jiǎn)化循環(huán)（異常處理）

建議24：遵循異常處理的幾點(diǎn)基本原則

（1）注意異常的粒度，try 塊中盡量少寫(xiě)代碼

（2）謹(jǐn)慎使用單獨(dú)的 except 語(yǔ)句，或 except Exception 語(yǔ)句，而是定位到具體異常

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

（4）使用更加友好的異常信息，遵守異常參數(shù)的規(guī)范

建議25：避免 finally 中可能發(fā)生的陷阱

建議26：深入理解 None，正確判斷對(duì)象是否為空。

建議27：連接字符串應(yīng)優(yōu)先使用 join 函數(shù)，而不是+操作

建議28：格式化字符串時(shí)盡量使用 format 函數(shù)，而不是 % 形式

建議29：區(qū)別對(duì)待可變對(duì)象和不可變對(duì)象，特別是作為函數(shù)參數(shù)時(shí)

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

建議31：函數(shù)傳參數(shù)，既不是傳值也不是傳引用，而是傳對(duì)象或者說(shuō)對(duì)象的引用

建議32：警惕默認(rèn)參數(shù)潛在的問(wèn)題，特別是當(dāng)默認(rèn)參數(shù)為可變對(duì)象時(shí)

建議33：函數(shù)中慎用變長(zhǎng)參數(shù) args 和 kargs

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

（2）如果因?yàn)楹瘮?shù)參數(shù)過(guò)多而是用變長(zhǎng)參數(shù)簡(jiǎn)化函數(shù)定義，那么一般該函數(shù)可以重構(gòu)

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

（1）兩者之間的目標(biāo)不同：str 主要面向客戶，其目的是可讀性，返回形式為用戶友好性和可讀性都比較高的字符串形式；而 repr 是面向 Python 解釋器或者說(shuō)Python開(kāi)發(fā)人員，其目的是準(zhǔn)確性，其返回值表示 Python 解釋器內(nèi)部的定義

（2）在解釋器中直接輸入變量，默認(rèn)調(diào)用repr函數(shù)，而print(var)默認(rèn)調(diào)用str函數(shù)

（3）repr函數(shù)的返回值一般可以用eval函數(shù)來(lái)還原對(duì)象

（4）兩者分別調(diào)用對(duì)象的內(nèi)建函數(shù) __str__() 和 __repr__()

建議35：分清靜態(tài)方法 staticmethod 和類方法 classmethod 的使用場(chǎng)景

4. 庫(kù)的使用

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

建議37：按需選擇 sort() 和 sorted() 函數(shù)

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

sorted() 可以排序任意的可迭代類型，同時(shí)不改變?cè)兞勘旧怼?/p>

建議38：使用copy模塊深拷貝對(duì)象，區(qū)分淺拷貝（shallow copy）和深拷貝（deep copy）

建議39：使用 Counter 進(jìn)行計(jì)數(shù)統(tǒng)計(jì)，Counter 是字典類的子類，在 collections 模塊中

建議40：深入掌握 ConfigParse

建議41：使用 argparse 模塊處理命令行參數(shù)

建議42：使用 pandas 處理大型 CSV 文件

Python 本身提供一個(gè)CSV文件處理模塊，并提供reader、writer等函數(shù)。

Pandas 可提供分塊、合并處理等，適用于數(shù)據(jù)量大的情況，且對(duì)二維數(shù)據(jù)操作更方便。

建議43：使用 ElementTree解析XML

建議44：理解模塊 pickle 的優(yōu)劣?

優(yōu)勢(shì)：接口簡(jiǎn)單、各平臺(tái)通用、支持的數(shù)據(jù)類型廣泛、擴(kuò)展性強(qiáng)

劣勢(shì)：不保證數(shù)據(jù)操作的原子性、存在安全問(wèn)題、不同語(yǔ)言之間不兼容

建議45：序列化的另一個(gè)選擇 JSON 模塊：load 和 dump 操作

建議46：使用 traceback 獲取棧信息

建議47：使用 logging 記錄日志信息

建議48：使用 threading 模塊編寫(xiě)多線程程序

建議49：使用 Queue 模塊使多線程編程更安全

5. 設(shè)計(jì)模式

建議50：利用模塊實(shí)現(xiàn)單例模式

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

建議52：用發(fā)布-訂閱模式實(shí)現(xiàn)松耦合

建議53：用狀態(tài)模式美化代碼

6. 內(nèi)部機(jī)制

建議54：理解 build-in 對(duì)象

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

建議56：理解變量的查找機(jī)制，即作用域

局部作用域

全局作用域

嵌套作用域

內(nèi)置作用域

建議57：為什么需要self參數(shù)

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

建議59：理解描述符機(jī)制

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

建議61：使用更安全的 property

建議62：掌握元類 metaclass

建議63：熟悉 Python 對(duì)象協(xié)議

建議64：利用操作符重載實(shí)現(xiàn)中綴語(yǔ)法

建議65：熟悉 Python 的迭代器協(xié)議

建議66：熟悉 Python 的生成器

建議67：基于生成器的協(xié)程和 greenlet，理解協(xié)程、多線程、多進(jìn)程之間的區(qū)別

建議68：理解 GIL 的局限性

建議69：對(duì)象的管理和垃圾回收

7. 使用工具輔助項(xiàng)目開(kāi)發(fā)

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

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

建議72：做 paster 創(chuàng)建包

建議73：理解單元測(cè)試的概念

建議74：為包編寫(xiě)單元測(cè)試

建議75：利用測(cè)試驅(qū)動(dòng)開(kāi)發(fā)（TDD）提高代碼的可測(cè)性

建議76：使用 Pylint 檢查代碼風(fēng)格

代碼風(fēng)格審查

代碼錯(cuò)誤檢查

發(fā)現(xiàn)重復(fù)以及不合理的代碼，方便重構(gòu)

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

支持各種 IDE 和編輯器的集成

能夠基于 Python 代碼生成 UML 圖

能夠與 Jenkins 等持續(xù)集成工具相結(jié)合，支持自動(dòng)代碼審查

建議77：進(jìn)行高效的代碼審查

建議78：將包發(fā)布到 PyPI

8. 性能剖析與優(yōu)化

建議79：了解代碼優(yōu)化的基本原則

建議80：借助性能優(yōu)化工具

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

建議82：使用 memory_profiler 和 objgraph 剖析內(nèi)存使用

建議83：努力降低算法復(fù)雜度

建議84：掌握循環(huán)優(yōu)化的基本技巧

減少循環(huán)內(nèi)部的計(jì)算

將顯式循環(huán)改為隱式循環(huán)，當(dāng)然這會(huì)犧牲代碼的可讀性

在循環(huán)中盡量引用局部變量

關(guān)注內(nèi)層嵌套循環(huán)

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

建議86：使用不同的數(shù)據(jù)結(jié)構(gòu)優(yōu)化性能

建議87：充分利用 set 的優(yōu)勢(shì)

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

建議89：使用線程池提高效率

建議90：使用C/C++模塊擴(kuò)展提高性能

建議91：使用 Cython 編寫(xiě)擴(kuò)展模塊