使用哪些工具，可以提升 Python 项目质量？

前记

在编写项目时，都会对代码质量有一定的追求， 比如代码艺术、设计模式、 重构设计等等。但是一个良好 Python 项目除了程序员本身的代码质量能力之外， 还有系统设计和代码质量工具等等。不过由于每个系统的设计都会有一些不同， 系统设计需要程序员一定的经验， 需要跟着项目去一起成长。

代码质量工具可以都抽离出来，应用到每个项目中， 本文则是我对这些代码质量工具的简要使用总结。

0.提交代码规范

每个团队或个人， 都必须要有一套自己的分支管理和提交代码规范， 对于分支管理， 一般会选用git flow, 如果不太会使用， 前期可以使用git flow 备忘清单(https://danielkummer.github.io/git-flow-cheatsheet/index.zh_CN.html), 并且对于master, develop等分支设置一些权权限。另外提交的信息也要有对应的规范， 比如本次提交属于哪种类型， 本次提交的功能是什么等等, 但是这个提交规范往往都没有一个标准， 只要团队和个人用的顺心， 能通过这些规范来减少开发矛盾， 复盘代码等等即可。我常使用的是：

git commit -m"<issue_id>:<file change>:<operating>:<info>"

其中每个字段代表的含义如下：

• issue_id: 代表一个issue的id, 在准备写功能或者修复一个bug时，都应该先提一个issue, 这个issue要详细的写明要修改什么，达到什么目的，然后再针对这个issue提交代码

• file change: 代表文件的变化， 如增加， 删除， 修改;也有人使用+,-，*来分别代表增加， 删除， 修改

• operating: 代表本次代码变化, 具体有如下几种

  • feat：新功能

  • fix：修复bug

  • doc：文档改变

  • style：代码格式改变

  • refactor：某个已有功能重构

  • perf：性能优化

  • test：增加测试

  • build：改变了build工具 如 grunt换成了 npm

  • revert：撤销上一次的commit

• info: 简要的说明本次提交信息

1.项目环境管理-Poetry

一个项目最重要的就是跑起来， 而大家基本会同时在本地开发多个项目， 每个项目用到的环境都是不一样的， 所以就需要用到虚拟环境隔离。在Python中提供了一个叫venv的虚拟环境管理包，他非常稳定， 同时功能也不是很多， 一般只用在服务器上， 对于本地开发来说， 都会想要更多的功能， 更加方便的对虚拟环境， 依赖包进行管理， Python包管理领域相关工具很多， 包括争议很大的Pipenv, 我在经过多种尝试后， 觉得Poetry比较好用, 坑也比较少。

Poetry(https://python-poetry.org/)官网的简介就是让Python包安装和依赖管理变得容易，  我觉得Poetry是最好用的, 他不止对包管理有很多的支持， 还有其他的拓展功能， 如方便的打包和发布， 脚本简写等等。

在第一次大多数的Python项目编写中， 基本上都是按以下流程进行：

• 1.安装对应的Python版本

• 2.通过python -m venv <name>的方式在项目创建venv的虚拟环境

• 3.在使用的过程中通过python -m pip install <name>的方式安装依赖

• 4.在代码编写完毕后通过python -m pip freeze > requirements.txt生成依赖文件

而Poetry则十分简单， 以下是poetry的创建流程：

1.1.创建项目

通过命令poetry new就可以创建一个项目手脚架

➜ poetry new example
➜ tree
.
└── example
    ├── example
    │   └── __init__.py
    ├── pyproject.toml
    ├── README.rst
    └── tests
        ├── __init__.py
        └── test_example.py

3 directories, 5 files

可以看到Poetry创建了一个example的项目， 生成了对应的文件夹以及包括项目信息的pyproject.toml。如果在已有项目， 则通过命令poetry init来初始化：

➜  example poetry init

This command will guide you through creating your pyproject.toml config.
# 交互bash， 通过该交互bash填写项目信息。
Package name [example]:  example
Version [0.1.0]:  0.0.8
Description []:  example project
Author [so1n <qaz6803609@163.com>, n to skip]:  n
License []:  
Compatible Python versions [^3.7]:  

Would you like to define your main dependencies interactively? (yes/no) [yes] no
Would you like to define your development dependencies interactively? (yes/no) [yes] no
Generated file
# 填写完项目信息后会生成以下内容， 之后会在刚才的路径创建pyproject.toml文件， 并写入。 
[tool.poetry]
name = "example"
version = "0.0.8"
description = "example project"
authors = ["Your Name <you@example.com>"]

[tool.poetry.dependencies]
python = "^3.7"

[tool.poetry.dev-dependencies]

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "