python的pre-commit库的使用

golitter.2025-02-05 11:39

在软件开发过程中，保持代码的一致性和高质量是非常重要的。pre-commit 是一个强大的工具，它可以帮助我们在提交代码到版本控制系统（如 Git）之前自动运行一系列的代码检查和格式化操作。通过这种方式，我们可以确保每次提交的代码都是干净的、格式化的并且符合项目的编码标准。

在版本控制系统中，hook 是一种脚本，用于在某些事件发生时触发。例如，在 Git 中，你可以设置一个 hook 在提交前运行。pre-commit 利用了 Git 的这一特性，允许用户定义一组钩子（hook），这些钩子会在提交之前自动执行。pre-commmit的hook有pre-commit、pre-push、post-merge、prepare-commit-msg。

pre-commit库是非官方库，所以需要先进行安装：

shell 复制代码

pip install pre-commit

安装完成之后，首先在根目录创建.pre-commit-config.yaml文件，并写入：

yaml 复制代码

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.9.4
  hooks:
    # Run the linter.
    - id: ruff
      args: [ "--config", "pyproject.toml", "--fix" ]
    # Run the formatter.
    - id: ruff-format
      args: [ "--config", "pyproject.toml" ]

此时目录为：

创建完成之后，需要使用命令行安装hook：

shell 复制代码

pre-commit install

如果之后有修改，不需要再次安装，会自动采用最新的yaml或者自定义hooks来运行。

如果你想要手动运行所有的钩子，可以使用以下命令：

shell 复制代码

pre-commit run --all-files

Git技巧：Pre-commit-CSDN博客