教你阅读 Python 开源项目代码

Destiny 的个人博客 / 14540 / 2 / 创建于 6年前 / 更新于 3年前 / 1 个改进

file

为什么要阅读开源代码

阅读 Python 开源项目代码主要有如下三个原因：

在工作过程中遇到一些问题 Google 和 StackOverFlow 等网站找不到解决办法，只能去翻源码。
对某些项目或者方向非常感兴趣，希望深入。
学习遇到瓶颈需要汲取开源项目的经验和用法来做提高。

要有目的的阅读开源项目

没有目的的阅读开源项目就是耍流氓，浪费了时间，但是能学到的东西也很少。怎么样根据自身情况去阅读呢？

和兴趣以及工作契合。举个例子，工作中没有机会用到 Celery 又不是想自己造个轮子，读它的源码做什么？所以要从平时能接触到的那些项目中选取。有时候不去看 Django 的代码，因为日常工作基本遇不到，遇到了现翻就好了。
一个方向只看一两个典型的就可以了。比如 Web 框架只看过 Bottle 和 Flask 的源码。
清楚自己看代码的目的。就是你看代码是想了解人家怎么设计、调试 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开发者可以阅读一些相关的项目：

runscope/httpbin 使用 flask
jahaja/psdash 使用 flask 和 psutils 的获取 Linux 系统信息的面板应用。
pallets/flask-website flask 官方网站应用。
pypa/warehouse 如果你使用 pyramid，这个新版的 PYPI 网站可以帮助你理解很多。

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，绝大多数都被拒绝了。