用Python玩转Git自动化（详解pre-commit Git钩子配置与实战）

为什么需要 pre-commit Git钩子？

• 防止提交不符合规范的代码（如未格式化的 Python 文件）
• 自动修复常见问题（如自动格式化、移除尾随空格）
• 统一团队代码风格，减少 Code Review 中的低级问题
• 提升 自动化代码检查 效率，节省人工时间

安装 pre-commit

首先，你需要在你的 Python 环境中安装 pre-commit。推荐使用虚拟环境：

pip install pre-commit

初始化 pre-commit 配置

在你的 Git 项目根目录下，创建一个名为 .pre-commit-config.yaml 的文件。这是 pre-commit 的核心配置文件。

下面是一个典型的 Python 项目配置示例：

repos:  - repo: https://github.com/psf/black    rev: 24.3.0    hooks:      - id: black  - repo: https://github.com/pycqa/flake8    rev: 7.0.0    hooks:      - id: flake8  - repo: https://github.com/pre-commit/pre-commit-hooks    rev: v4.5.0    hooks:      - id: trailing-whitespace      - id: end-of-file-fixer      - id: check-yaml

上面的配置会启用以下功能：

• black：自动格式化 Python 代码
• flake8：检查代码风格和潜在错误
• trailing-whitespace：删除行尾多余空格
• end-of-file-fixer：确保文件以换行符结尾
• check-yaml：验证 YAML 文件语法是否正确

安装 Git 钩子

配置好后，在项目根目录运行以下命令，将 pre-commit 安装为 Git 钩子：

pre-commit install

这会在 .git/hooks/pre-commit 中生成一个脚本，以后每次执行 git commit 时都会自动触发检查。

手动运行 pre-commit

你也可以不等待提交，直接对所有文件运行检查：

pre-commit run --all-files

小贴士：首次提交可能失败？

第一次使用时，如果代码不符合规范（比如没用 black 格式化），pre-commit 会阻止提交，并告诉你哪些文件需要修改。你可以根据提示修改，或者让工具自动修复（如 black 会自动重写文件），然后重新 git add 并再次提交。

总结

通过配置 pre-commit Git钩子，你可以轻松实现 Python代码格式化 与 自动化代码检查，大幅提升开发效率和代码质量。无论你是个人开发者还是团队协作，这套流程都值得引入到你的项目中。

现在就试试吧！只需几步，就能让你的 Git 提交更智能、更规范。