最近在帮朋友做一些Python项目的Code Review(代码审查),发现主要项目主要有以下几点问题:
-
没有进行环境隔离
由于Python开发常常会依赖各种各样的包,包之间还存在各种依赖,如果环境没有进行隔离,不同版本比如Python2和Python3版本,或者统一Python版本各种包不一致,常常会导致各种依赖问题。并且我们电脑上面可能同时开发多个Python项目。环境的依赖是我们首先要处理的。
环境隔离常见 virtualenv
(推荐),zc.buildout
,当然本地直接用docker
也可以做到方便隔离,我们团队日常开发就是通过docker开发,测试,生产环境进行统一的。
-
没有错误收集报警
我们日常出现了错误是需要马上定位修复的,需要一个错误反馈机制来收集具体错误上下文,通过邮件进行报警。如果没有一个这样的收集工具我们就会后知后觉。
这里面我推荐Sentry
,通过docker进行安装部署这个工具非常快捷。
-
格式混乱
很多同学都能写Python,但是不代表能写好,适当遵守相关标准规范或规范有助于快速和专业的Python开发者交流。
这里我推荐写Python同学看下Google开源风格规范: http://t.cn/RkcabfS
并且结合 yapf
和 flake8
来进行批量格式化校验自己代码格式,团队合作在编辑器中加入 editorconfig
文件保证统一格式
-
没有测试用例
作为一个严肃的项目,没有测试是不可信的,不仅产品质量低,而且迭代的频率也较低,具体原因大家可以去了解下。
这里主要推荐 unittest/pytest,mock,tox,coverage
等相关的测试工具。
-
没有自动化版本更新工具
由于我们项目迭代发布需要做很多操作,比如打包,上传代码,备份,更新数据表,重启服务等等一些操作,手动操作很可能忘记其中的一步或者几步,没有自动化发布更新工具效率无疑是低效的并且是不靠谱的。
这里面主要推荐 Fabric
和 Ansible
等工具
-
没有系统管理工具
在代码审阅过程中,发现代码上线之后只是用shell写了脚本 nohup进行执行的,没有Python进程管理工具,如果服务挂掉需要重启什么的,多个应用服务没法做到快速重启,关闭等操作。
这里推荐supervisor
这个工具进行服务批量管理控制。
-
其他
比如日志打印不规范或者不打印,捕获所有错误异常,字符串硬编码,if else语句过多,模块耦合度太高等等这些需要长期在编码中积累和学习的。「代码整洁之道」
「编写可读性代码的艺术」
虽然我这里主要以Python举例,推荐工具也是以Python语言为主,但实际情况这是接触新语言新技术都需要了解的和知道的。
如果能做到上面的几点,你的Python项目及代码便开始变得专业起来,更多的我们下一篇继续聊。有问题欢迎大家给我留言或者加我微信 pengtaotalk