5 年 Python 的我，總結(jié)了這 90 條寫 Python 程序的建議

自己寫 Python 也有四五年了，一直是用自己的“強迫癥”在維持自己代碼的質(zhì)量。都有去看Google的Python代碼規(guī)范，對這幾年的工作經(jīng)驗，做個簡單的筆記，如果你也在學pythpn，準備要學習python，希望這篇文章對你有用。

1. 首先

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

建議2、編寫Pythonic代碼

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

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

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

建議4：在代碼中適當添加注釋

建議5：適當添加空行使代碼布局更加合理

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

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

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

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

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

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

2. 編程慣用法

建議8：利用assert語句來發(fā)現(xiàn)問題，但要注意，斷言assert會影響效率

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

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

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

建議12：不推薦使用type來進行類型檢查，因為有些時候type的結(jié)果并不一定可靠。如果有需求，建議使用isinstance函數(shù)來代替

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

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

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

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

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

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

3. 基礎(chǔ)用法

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

建議32：警惕默認參數(shù)潛在的問題，特別是當默認參數(shù)為可變對象時

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

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

（2）如果因為函數(shù)參數(shù)過多而是用變長參數(shù)簡化函數(shù)定義，那么一般該函數(shù)可以重構(gòu)

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

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

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

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

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

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

4. 庫的使用

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

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

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

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

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

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

建議40：深入掌握ConfigParse

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

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

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

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

建議43：使用ElementTree解析XML

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

優(yōu)勢：接口簡單、各平臺通用、支持的數(shù)據(jù)類型廣泛、擴展性強

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

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

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

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

建議48：使用threading模塊編寫多線程程序

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

5. 設(shè)計模式

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

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

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

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

6. 內(nèi)部機制

建議54：理解build-in對象

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

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

局部作用域

全局作用域

嵌套作用域

內(nèi)置作用域

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

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

建議59：理解描述符機制

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

建議61：使用更安全的property

建議62：掌握元類metaclass

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

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

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

建議66：熟悉Python的生成器

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

建議68：理解GIL的局限性

建議69：對象的管理和垃圾回收

7. 使用工具輔助項目開發(fā)

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

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

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

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

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

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

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

代碼風格審查

代碼錯誤檢查

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

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

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

能夠基于Python代碼生成UML圖

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

建議90：使用Cythonb編寫擴展模塊