从笔记本（notebook）到命令行

大多数python初学者都喜欢使用jupyter-notebook写代码。Jupyter-notebook的开发环境非常友好，所见即所得，可以快速测试一些短代码进行概念验证。但是它存在很多问题：不可测试、不可模块化、难以复用、难以进行版本管理……

一个生产可用的python项目应当以命令行为入口，通过执行脚本实现所有设计功能。任何需要传递的参数和选项也应当以标准的命令行传入给程序，然后通过python的sys库读取。实践中更多的是使用click库[1]来处理命令行的数据交互。

代码风格

一致的代码风格对于代码共享和团队协作至关重要。Python官方有PEP8文件[2]提供完整的代码风格指南。一般的项目一般会使用以下任一工具来进行代码风格检查：

Pylint：https://github.com/PyCQA/pylint
Flake8：https://github.com/pycqa/flake8

以上检查工具都会对代码进行打分，一个企业级高质量python项目应当力争在代码风格上完全遵守PEP8代码规范

此外以上代码风格检查工具都提供了自动格式化功能帮助处理常见的格式问题，但功能并不完善； python代码格式化工具Black（beta公测中）可作为更好的选择：

Black：https://github.com/psf/black

显式类型声明

尽管python是一个弱类型语言，我们可以任意改变变量的类型而不受任何限制。然而，这种自由度会严重损害代码的可读性。为了促进协作，提升代码可读性，编写代码时应当尽可能的显式声明所有变量类型。Python官方提供了PEP 484 — Type Hints[3]来规范代码中类型标记的使用，同时我们可以使用mypy工具进行类型检查

Mypy：http://mypy-lang.org/

代码文档

企业级环境下一定会有许多可在项目间复用的代码，这些代码需要有详细的使用文档才能够保证团队的无障碍使用，python官方提供了PEP 257 — Docstring Conventions[4]作为代码注释的标准规范，同时我们也可以使用pydocstyle工具进行注释规范强制检查：

pydocstyle： https://github.com/PyCQA/pydocstyle

此外我们可以使用文档编译工具根据代码中的注释自动生成文档，常用的工具包括：

Sphinx：https://www.sphinx-doc.org/en/master/
Doxygen：https://www.doxygen.nl/manual/docblocks.html
Mkdocs：https://www.mkdocs.org/getting-started/

Sphinx是python项目使用最为广泛的文档编译工具，但以rst为首选文档编辑语言。doxygen支持python以外的其他语言，mkdocs则有着最好的markdown支持。

除了自动生成的代码文档以外，对于重要的函数和模块，项目文档应当提供足够多的样例和教程保障可重用的代码真正发挥价值。

有些企业会有专门的文档库（例如confluence）存放所有项目文档。尽管如此，代码文档依旧不可缺少，它应当跟随代码一起保存和更新。

一个企业级高质量python项目应当确保完整的文档，否则任何员工的离职都是一场灾难。认真准备文档是对同事和公司负责任的表现。

测试驱动

任何软件项目进入生产环境前都需要足够多的测试，python也不例外。一个可维护的python项目应当包含尽可能多的测试（如单元测试、集成测试、回归测试等），常用的测试工具包括：

Pytest：https://docs.pytest.org
Unittest：https://docs.python.org/3/library/unittest.html

同时我们需要关注测试覆盖率，使用pytest-cov[5]等工具检查测试案例是否覆盖了所有的代码，100%测试覆盖率只能作为测试的最低标准，企业级高质量代码需要确保任何代码通过了所有极端案例的测试。

对于开发人员，可以考虑使用测试驱动开发TDD（Test Driven Development）模式工作，不仅能够提升调试（debug）效率，同时能够从一开始就思考如何让代码模块化以便设计单元测试。

虚拟环境

一个python项目往往会依赖许多不同的库，这些依赖库的版本至关重要。一旦使用了不兼容的版本就会导致整个程序的崩溃，一致的依赖库版本管理一直是python调试部署的一大痛点。

传统的解决方案是使用venv[6], conda[7], pipenv[8], poetry[9]，pyenv[10]等工具进行不同版本的python虚拟环境管理。但是这些工具都是通过修改环境变量实现在同一个操作系统中的环境切换，无法做到绝对的隔离，往往会造成意料之外的错误和额外的维护成本。特别是一些需要链接库的python包（如lightgbm）很难简单的通过pip安装成功。

实践下来，最优的python虚拟环境解决方案还是Docker，通过Dockerfile定义完全干净隔离的虚拟环境，同时能够很好的解决相关二进制链接库的依赖，并随时可以打包部署到生产环境。

此外docker也可以很方便的启动程序依赖的其他服务（如数据库、内存缓存、消息队列、其他依赖API），实现快速的集成测试。