郑文峰的博客
·
基于pre-commit的Python代码规范落地实践
💡
原文中文，约3600字，阅读约需9分钟。
📝
内容提要
pre-commit 是一个开源工具，用于管理 Git 钩子，确保代码质量。它通过自动执行代码检查和格式修正，帮助保持项目的一致性。本文介绍了如何在 Python 项目中配置 pre-commit，以提升代码质量，并提供了安装和使用的示例。
🎯
关键要点
- pre-commit 是一个开源工具，用于管理和执行 Git 钩子，确保代码库的一致性和质量。
- 通过自动运行代码风格检查和格式修正，pre-commit 有助于保持项目代码的统一标准。
- 本文介绍了如何在 Python 项目中配置 pre-commit，以提高代码质量。
- 安装 pre-commit 的命令是：pip install pre-commit。
- 安装成功后，可以通过 pre-commit --version 验证安装。
- 设置 Git 钩子脚本的命令是：pre-commit install。
- 在项目根目录下创建 .pre-commit-config.yaml 文件，配置要使用的仓库和钩子。
- 配置文件中包含 repos、repo、rev 和 hooks 等字段，定义了要执行的钩子。
- 执行 commit 命令时，自动调用配置文件中定义的钩子脚本检查代码。
- 默认情况下，仅检查新添加或修改的文件，可以使用 pre-commit run --all-files 手动检查所有文件。
- 可以在 commit 命令中加上 --no-verify 参数临时跳过校验。
- 将 .pre-commit-config.yaml 纳入版本控制，确保团队配置一致。
- 定期运行 pre-commit autoupdate 保持工具最新版本。
- 优先修复问题而不是使用 --no-verify，让规范成为肌肉记忆。
❓
延伸问答
pre-commit是什么？
pre-commit是一个开源工具，用于管理和执行Git钩子，确保代码库的一致性和质量。
如何在Python项目中安装pre-commit？
可以通过命令pip install pre-commit来安装pre-commit。
如何配置pre-commit以检查代码？
在项目根目录下创建.pre-commit-config.yaml文件，配置要使用的仓库和钩子。
执行commit时，pre-commit会做什么？
执行commit命令时，pre-commit会自动调用配置文件中定义的钩子脚本，检查代码是否符合规范。
如何手动检查所有文件？
可以使用命令pre-commit run --all-files手动检查所有文件。
如何确保团队使用相同的pre-commit配置？
将.pre-commit-config.yaml文件纳入版本控制，以确保团队配置一致。
➡️
