教你如何阅读 Python 开源项目代码
教你如何阅读 Python 开源项目代码
来源：https://learnku.com/articles/23010/teach-you-to-read-the-python-open-source-project-code
为什么要阅读开源代码
阅读 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 领域代码写的最好的、最有创意的工程师。
初学者推荐阅读项目
初学者可以先阅读一些代码量比较少的，最好是单文件的项目：
- GitHub - kennethreitz/pip-pop: Tools for managing requirements files
(https://github.com/heroku-python/pip-pop)
- GitHub - kennethreitz/envoy: Python Subprocesses for Humans™.
(https://github.com/not-kennethreitz/envoy)
- GitHub - kennethreitz/records: SQL for Humans™
(https://github.com/kennethreitz/records)
- GitHub - mitsuhiko/pluginbase: A simple but flexible plugin system for Python.
(https://github.com/mitsuhiko/pluginbase)
- GitHub - mitsuhiko/pipsi: pip script installer
(https://github.com/mitsuhiko/pipsi/)
- GitHub - mitsuhiko/unp: Unpacks things.
(https://github.com/mitsuhiko/unp)
- GitHub - chrisallenlane/cheat
(https://github.com/chrisallenlane/cheat/)
- GitHub - jek/blinker: A fast Python in-process signal/event dispatching system.
(https://github.com/jek/blinker)
看代码主要是了解别人写代码的方式，语法实践这些内容。看完之后，你可以针对这些项目能解决的问题自己写个项目，写完之后和上述项目去对比一下，看看哪些方面做的不好。
进阶阅读项目
进阶的时候就要阅读一些相对复杂的项目，它们能帮助你提升 Python 编程技巧：
- faif/python-patterns(https://github.com/faif/python-patterns) 使用 Python 实现一些设计模式的例子。
- pallets/werkzeug(https://github.com/pallets/werkzeug) flask 的 WSGI 工具集。其中包含了实现非常好的 LocalProxy、cached_property、import_string、find_modules、TypeConversionDict 等。
- bottlepy/bottle(https://github.com/bottlepy/bottle) 阅读一个 Web 框架对 Web 开发就会有更深刻的理解，flask 太大，bottle 就 4k 多行，当然如果你有毅力和兴趣直接看 flask 是最好了的。
- msiemens/tinydb(https://github.com/msiemens/tinydb) 了解用 Python 实现数据库。
- coleifer/peewee(https://github.com/coleifer/peewee) 了解 ORM 的实现。
- pallets/click(https://github.com/pallets/click) click 已经内置于在 flask 0.11 里，提供命令行功能，值得阅读。
- mitsuhiko/flask-sqlalchemy(https://github.com/pallets/flask-sqlalchemy) 了解一个 flask 插件是怎么实现的。
除此之外 Web 开发者可以阅读一些相关的项目：
- runscope/httpbin(https://github.com/kennethreitz/httpbin) 使用 flask
- jahaja/psdash(https://github.com/Jahaja/psdash) 使用 flask 和 psutils 的获取 Linux 系统信息的面板应用。
- pallets/flask-website(https://github.com/pallets/flask-website) flask 官方网站应用。
- pypa/warehouse(https://github.com/pypa/warehouse) 如果你使用 pyramid，这个 新版的 PYPI 网站 可以帮助你理解很多。
500 Lines
推荐一个非常厉害的项目 GitHub - aosabook/500lines(https://github.com/aosabook/500lines): 500 Lines or Less, 它里面包含了 22 个由该领域的专家完成，用不到 500 行的代码实现一个特定功能的子项目。连 Guido van Rossum 都亲自来写基于 asyncio 爬虫了，Nick Coghlan、ajdavis 也出场了。
不要畏惧
大家都经常会感叹 XXX 强大，YYY 流行，无形中你会把它放在一个不可触及到的地位，感觉它很难，而令自己不敢去挑战它。其实是人就会产出 bug，假如你发现它有问题，就应该抓住机会去验证它。这个过程中，它的神秘感也就消失了，有过这么几次经验你就有信心了。其次是不要怕你提交的 PR 被拒绝。这是非常正常的，我有很多 PR 是被拒绝的，尤其是给标准库提交的 Patch，绝大多数都被拒绝了。
带着问题去阅读代码
这也是我认为最有效的方式。这会让你在阅读时候有个主线，比较有针对性。
断点调试
在 Python 代码中使用 pdb 一般不太好使，因为代码复杂的话，这种断点需要你使用多个 N 跳到对应的位置，我一般都是先抛出异常，然后使用 pdb 的 up、down、n 等命令调试。当然在目标位置添加一些 print 日志或注释部分代码然后直接使用 exit() 退出也是可以的。
善用文档
阅读一个项目一开始会有点无从下手，那么就先好好这些内容，它们一般都是作者表达这个项目的第一个入口。quickstart、tutorial 等内容中的最小化的例子其实就是最好的阅读入口，先去看这些引用的模块和调用的对应方法或者函数的对应实现，从下至上去阅读。
理解作者的思考方式
不同的项目要有不同的思考方式来阅读，不要拧着自己的习惯去阅读，这样会很累，得尝试接受别人的观点，甚至于改变自己。
阅读项目的早期版本
一些项目随着时间演进已经非常复杂了，读起来有难度，那么你可以回到项目的早期版本上，先去看相对简单地版本，然后设置几个时间点或者版本节点，渐进的来阅读。
记忆并绘制项目架构
项目就是一堆代码的组合，除了学习编程技巧，还要了解项目的架构决策，这对于未来自己写大型项目非常用用。这种理解越补充，你会对它就越来越清晰