教你閱讀Python開源項目代碼

註：本專欄文章未經允許請勿轉載。

知乎上有不少人問和關注閱讀開源項目代碼這個問題，比如「初學 Python，有哪些 Pythonic 的源碼推薦閱讀？」、「github中適合新人閱讀的Python項目有哪些?」、「如何去閱讀並學習一些優秀的開源框架的源碼？」等。本文將從推薦可閱讀的Python項目和如何閱讀者2個方面聊聊這個話題。

閱讀Python開源項目代碼主要有如下三個原因：

1. 在工作過程中遇到一些問題，Google和StackOverFlow等網站找不到解決辦法，只能去翻源碼。

2. 對某些項目或者方向非常感興趣，希望深入。

3. 學習遇到瓶頸需要汲取開源項目的經驗和用法來做提高。

沒有目的的閱讀開源項目就是耍流氓。浪費了時間，但是能學到的東西也很少。怎麼樣根據自身情況去閱讀呢？

1. 和興趣以及工作契合。舉個例子，工作中沒有機會用到Celery又不是想自己造個輪子，讀它的源碼做什麼？所以要從平時能接觸到的那些項目中選取。比如我，我肯定不去看Django的代碼，因為日常工作基本遇不到，遇到了現翻就好了。

2. 一個方向只看一兩個典型的就可以了。比如Web框架，我只看過Bottle和Flask的源碼（其實之前也看過Django的，只是淺嘗輒止），而且看Bottle已經是好幾年前的事情了。並不是堆的多了更好，有時候反而選擇太多會懵。

3. 不同技術階段的選擇代碼量、複雜度不一樣的項目，下面會具體推薦。

4. 清楚自己看代碼的目的。就是你看代碼是想了解人家怎麼設計、調試BUG、還是只是想學習正確的編程用法呢？其實沒有必要細摳每個代碼細節，有時候當黑盒看，知道輸入輸出就可以了。

我個人的喜好

和工作中看別人代碼差不多，基本每個人、每個項目、每個團隊都有自己寫代碼的風格，比如變數命名風格、某些語言特性使用方式、代碼規範要求、目錄風格等，其實開源項目的作者也是一樣。看代碼，如看人（團隊）。 首先介紹下我的喜好（排名分先後）：

1. kennethreitz。requests和python-guide作者。他還有一個非常勵志的故事，有興趣的可以看 誰說程序員不是潛力股？

2. mitsuhiko。flask、Jinja2、werkzeug和flask-sqlalchemy作者。

3. sigmavirus24。flake8、pycodestyle（原pep8）、requests、urllib3等項目的主要貢獻者和維護者。

4. ask。Celery及相關依賴的作者。

5. ajdavis。mongo-python-driver（pymongo）、tornado等項目的主要貢獻者。

6. bitprophet。fabric、paramiko（Python的ssh庫）作者。

前2個是公認的Python領域代碼寫的最好的、最有創意的工程師。

初學者推薦閱讀項目

初學者可以先閱讀一些代碼量比較少的，最好是單文件的項目：

1. GitHub - kennethreitz/pip-pop: Tools for managing requirements files.

2. GitHub - kennethreitz/envoy: Python Subprocesses for Humans?.

3. GitHub - kennethreitz/records: SQL for Humans?

4. GitHub - mitsuhiko/pluginbase: A simple but flexible plugin system for Python.

5. GitHub - mitsuhiko/pipsi: pip script installer

6. GitHub - mitsuhiko/unp: Unpacks things.

7. GitHub - chrisallenlane/cheat

8. GitHub - jek/blinker: A fast Python in-process signal/event dispatching system.

9. GitHub - mitsuhiko/platter: A useful helper for wheel deployments.

10. GitHub - kennethreitz/tablib: Python Module for Tabular Datasets in XLS, CSV, JSON, YAML, &c.

看代碼主要是了解別人寫代碼的方式，語法實踐這些內容。看完之後，你可以針對這些項目能解決的問題自己寫個項目，寫完之後和上述項目去對比一下，看看哪些方面做的不好。

進階閱讀項目

進階的時候就要閱讀一些相對複雜的項目，它們能幫助你提升Python編程技巧：

1. faif/python-patterns。使用Python實現一些設計模式的例子。

2. pallets/werkzeug。flask的WSGI工具集。其中包含了實現非常好的LocalProxy、cached_property、import_string、find_modules、TypeConversionDict等。

3. bottlepy/bottle。閱讀一個Web框架對Web開發就會有更深刻的理解，flask太大，bottle就4k多行，當然如果你有毅力和興趣直接看flask是最好了的。

4. msiemens/tinydb。了解用Python實現資料庫。

5. coleifer/peewee。了解ORM的實現。

6. pallets/click。click已經內置於在flask 0.11里，提供命令行功能，值得閱讀。

7. mitsuhiko/flask-sqlalchemy。了解一個flask插件是怎麼實現的。

除此之外Web開發者可以閱讀一些相關的項目：

1. runscope/httpbin。使用flask，網站是httpbin(1): HTTP Client Testing Service。

2. jahaja/psdash。使用flask和psutils的獲取Linux系統信息的面板應用。

3. pallets/flask-website。 flask官方網站應用。

4. pypa/warehouse。如果你使用pyramid，這個新版的PYPI網站，可以幫助你理解很多。

當然，2個學習flask重要的資源必須爆一爆：

1. GitHub - realpython/discover-flask: Full Stack Web Development with Flask。

2. The Flask Mega-Tutorial。 這個就是《Flask Web開發：基於Python的Web應用開發實戰》的原始博客。

500lines

推薦一個非常厲害的項目 GitHub - aosabook/500lines: 500 Lines or Less, 它裡面包含了22個由該領域的專家完成，用不到500行的代碼實現一個特定功能的子項目。連Guido van Rossum都親自來寫基於asyncio爬蟲了，Nick Coghlan、ajdavis也出場了。更具體的介紹可以看Python 的練手項目有哪些值得推薦？ - 小小搬運工的回答。

怎麼閱讀開源項目源碼

我基於個人興趣和日常開發需要閱讀過一些開源項目，我列一些比較通用的經驗和感悟：

1. 不要畏懼。我發現大家都經常會感嘆XXX強大，YYY流行，無形中你會把它放在一個不可觸及到的地位，感覺它很難，而令自己不敢去挑戰它。其實是人就會產出bug，假如你發現它有問題，就應該抓住機會去驗證它。這個過程中，它的神秘感也就消失了，有過這麼幾次經驗你就有信心了。其次是不要怕你提交的PR被拒絕。這是非常正常的，我有很多PR是被拒絕的，尤其是給標準庫提交的Patch，絕大多數都被拒絕了。

2. 帶著問題去閱讀代碼，這也是我認為最有效的方式。這會讓你在閱讀時候有個主線，比較有針對性。

3. 斷點調試。在Python代碼中使用pdb一般不太好使，因為代碼複雜的話，這種斷點需要你使用多個n跳到對應的位置，我一般都是先拋出異常，然後使用pdb的up/down/n等命令調試。當然在目標位置添加一些print日誌或注釋部分代碼然後直接使用exit()退出也是可以的。

4. 善用文檔，官網例子。閱讀一個項目一開始會有點無從下手，那麼就先好好這些內容，它們一般都是作者表達這個項目的第一個入口。quickstart、tutorial等內容中的最小化的例子其實就是最好的閱讀入口，先去看這些引用的模塊和調用的對應方法或者函數的對應實現，從下至上去閱讀。

5. 理解作者的思考方式。不同的項目要有不同的思考方式來閱讀，不要擰著自己的習慣去閱讀，這樣會很累，得嘗試接受別人的觀點，甚至於改變自己。

6. 閱讀項目的早期版本。一些項目隨著時間演進已經非常複雜了，讀起來有難度，那麼你可以回到項目的早期版本上，先去看相對簡單地版本，然後設置幾個時間點或者版本節點，漸進的來閱讀。

7. 記憶並繪製項目架構。項目就是一堆代碼的組合，除了學習編程技巧，還要了解項目的架構決策，這對於未來自己寫大型項目非常用用。這種理解越補充，你會對它就越來越清晰。

8. 參與。如果只是看和思考而不參與，其實效果大打折扣。我建議要參與一些issue討論、向作者提問、提PR添加新的功能、幫助改善文檔等等。很多時候你理解的其實和作者是有衝突的，無論是你說服他和被他說服，對自己的成長都是很有幫助的。

無恥的廣告：《Python Web開發實戰》上市了！

歡迎關注本人的微信公眾號獲取更多Python相關的內容（也可以直接搜索「Python之美」）：

推薦閱讀：