教你閱讀 Python 開源專案程式碼

Destiny發表於2018-01-05
Python

file

為什麼要閱讀開原始碼

閱讀 Python 開源專案程式碼主要有如下三個原因：

  • 在工作過程中遇到一些問題 Google 和 StackOverFlow 等網站找不到解決辦法，只能去翻原始碼。
  • 對某些專案或者方向非常感興趣，希望深入。
  • 學習遇到瓶頸需要汲取開源專案的經驗和用法來做提高。

要有目的的閱讀開源專案

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

  1. 和興趣以及工作契合。舉個例子，工作中沒有機會用到 Celery 又不是想自己造個輪子，讀它的原始碼做什麼？所以要從平時能接觸到的那些專案中選取。有時候不去看 Django 的程式碼，因為日常工作基本遇不到，遇到了現翻就好了。
  2. 一個方向只看一兩個典型的就可以了。比如 Web 框架只看過 Bottle 和 Flask 的原始碼。
  3. 清楚自己看程式碼的目的。就是你看程式碼是想了解人家怎麼設計、除錯 BUG、還是隻是想學習正確的程式設計用法呢？其實沒有必要細摳每個程式碼細節，有時候當黑盒看，知道輸入輸出就可以了。

優秀的開源作者

和工作中看別人程式碼差不多，基本每個人、每個專案、每個團隊都有自己寫程式碼的風格，比如變數命名風格、某些語言特性使用方式、程式碼規範要求、目錄風格等，其實開源專案的作者也是一樣。看程式碼，如看人「團隊」

  • kennethreitz Requests 和 Python-guide 作者。他還有一個非常勵志的故事，有興趣的可以看 誰說程式設計師不是潛力股？
  • mitsuhiko flask、Jinja2、werkzeug 和 flask-sqlalchemy 作者。
  • sigmavirus24 flake8、pycodestyle「原 pep 8」、requests、urllib3 等專案的主要貢獻者和維護者。
  • ask Celery 及相關依賴的作者。
  • ajdavis mongo-python-driver「pymongo」、tornado 等專案的主要貢獻者。
  • bitprophet fabric、paramiko「Python 的 ssh 庫」作者。

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

初學者推薦閱讀專案

初學者可以先閱讀一些程式碼量比較少的，最好是單檔案的專案：

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

進階閱讀專案

進階的時候就要閱讀一些相對複雜的專案，它們能幫助你提升 Python 程式設計技巧：

  • faif/python-patterns 使用 Python 實現一些設計模式的例子。
  • pallets/werkzeug flask 的 WSGI 工具集。其中包含了實現非常好的 LocalProxy、cached_property、import_string、find_modules、TypeConversionDict 等。
  • bottlepy/bottle 閱讀一個 Web 框架對 Web 開發就會有更深刻的理解，flask 太大，bottle 就 4k 多行，當然如果你有毅力和興趣直接看 flask 是最好了的。
  • msiemens/tinydb 瞭解用 Python 實現資料庫。
  • coleifer/peewee 瞭解 ORM 的實現。
  • pallets/click click 已經內建於在 flask 0.11 裡，提供命令列功能，值得閱讀。
  • mitsuhiko/flask-sqlalchemy 瞭解一個 flask 外掛是怎麼實現的。

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

500 Lines

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

建議

不要畏懼

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

帶著問題去閱讀程式碼

這也是我認為最有效的方式。這會讓你在閱讀時候有個主線，比較有針對性。

斷點除錯

在 Python 程式碼中使用 pdb 一般不太好使，因為程式碼複雜的話，這種斷點需要你使用多個 N 跳到對應的位置，我一般都是先丟擲異常，然後使用 pdb 的 up、down、n 等命令除錯。當然在目標位置新增一些 print 日誌或註釋部分程式碼然後直接使用 exit() 退出也是可以的。

善用文件

閱讀一個專案一開始會有點無從下手，那麼就先好好這些內容，它們一般都是作者表達這個專案的第一個入口。quickstart、tutorial 等內容中的最小化的例子其實就是最好的閱讀入口，先去看這些引用的模組和呼叫的對應方法或者函式的對應實現，從下至上去閱讀。

理解作者的思考方式

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

閱讀專案的早期版本

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

記憶並繪製專案架構

專案就是一堆程式碼的組合，除了學習程式設計技巧，還要了解專案的架構決策，這對於未來自己寫大型專案非常用用。這種理解越補充，你會對它就越來越清晰。

參考

將來的你一定會感謝現在努力的自己！

相關文章