如何将 lint-staged 与 FastAPI 集成：打造 Python 高性能 API 开发流程

【免费下载链接】lint-staged 项目地址: https://gitcode.com/gh_mirrors/lin/lint-staged

在现代 Python 开发中，保持代码质量和开发效率同样重要。FastAPI 作为高性能的 API 框架，以其快速开发和自动文档生成而备受青睐。而 lint-staged 作为一款强大的代码检查工具，能够在提交代码前自动对暂存文件进行 linting 和格式化，确保代码质量。本文将详细介绍如何将这两者无缝集成，打造高效、规范的 Python API 开发工作流。

为什么选择 lint-staged 与 FastAPI 集成？

lint-staged 是一个在 Git 暂存文件上运行 linters 的工具，它能够只对修改过的文件进行检查，大大提高了开发效率。而 FastAPI 作为基于 Starlette 和 Pydantic 的现代 API 框架，需要严格的代码规范来保证接口的稳定性和可维护性。将两者结合，可以在开发过程中自动检测代码问题，减少错误，提升代码质量。

图：lint-staged 在代码提交前自动运行代码检查的演示效果

快速安装与配置步骤

1. 安装必要依赖

首先，确保你的项目中已经安装了 Node.js 和 npm，然后通过 npm 安装 lint-staged：

npm install --save-dev lint-staged

同时，为了在 Python 项目中使用 lint-staged，你还需要安装一些 Python 代码检查工具，如 flake8、black 等：

pip install flake8 black isort

2. 配置 lint-staged

在项目根目录下创建或编辑 package.json 文件，添加 lint-staged 配置：

{
  "scripts": {
    "lint-staged": "lint-staged"
  },
  "lint-staged": {
    "*.py": ["flake8", "black", "isort"]
  }
}

3. 集成到 Git 钩子

使用 husky 来设置 Git 钩子，在提交代码前自动运行 lint-staged：

npm install --save-dev husky
npx husky install
npx husky add .husky/pre-commit "npx lint-staged"

高级配置：自定义检查规则

1. 配置 flake8

在项目根目录创建 .flake8 文件，自定义代码检查规则：

[flake8]
max-line-length = 120
extend-ignore = E203

2. 配置 black

创建 pyproject.toml 文件，配置 black 格式化工具：

[tool.black]
line-length = 120
target-version = ['py38']

3. 配置 isort

同样在 pyproject.toml 中添加 isort 配置：

[tool.isort]
profile = "black"
multi_line_output = 3

集成 FastAPI 项目示例

项目结构

假设你的 FastAPI 项目结构如下：

my_fastapi_project/
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── routers/
│       ├── __init__.py
│       └── items.py
├── tests/
├── .flake8
├── package.json
└── pyproject.toml

在 FastAPI 项目中使用 lint-staged

当你修改了 app/main.py 并暂存后，运行 git commit 时，lint-staged 会自动对该文件运行 flake8、black 和 isort，确保代码符合规范。

常见问题与解决方案

问题 1：lint-staged 不运行

解决方案：检查 husky 钩子是否正确配置，确保 .husky/pre-commit 文件存在且包含 npx lint-staged 命令。

问题 2：Python 工具找不到

解决方案：确保 Python 工具（flake8、black、isort）安装在当前环境中，或者在 lint-staged 配置中指定 Python 路径：

"lint-staged": {
  "*.py": ["python -m flake8", "python -m black", "python -m isort"]
}

总结

通过将 lint-staged 与 FastAPI 集成，我们可以在开发过程中自动检查和格式化代码，大大提高代码质量和开发效率。这种集成不仅适用于 FastAPI 项目，也可以推广到其他 Python 项目中，帮助团队建立统一的代码规范，减少错误，提升开发体验。

现在，你已经掌握了 lint-staged 与 FastAPI 的集成方法，赶快在你的项目中尝试吧！如果你有任何问题或建议，欢迎在项目的 issue 中提出。

仓库地址：https://gitcode.com/gh_mirrors/lin/lint-staged

【免费下载链接】lint-staged 项目地址: https://gitcode.com/gh_mirrors/lin/lint-staged