Skip to content

Python 整理头文件

约 345 字大约 1 分钟

2025-01-17

Python中我们可以使用isort来整理我们项目中的头文件,规范文件格式。

安装

$ pip3 install isort

使用

具体使用方法参考isort。我这里主要说一下,结合pre-commitisort集成到git hooks中。

集成到git流程中

  1. 安装pre-commit
$ pip3 install pre-commit
  1. 编写isort的配置文件.isort.cfg
[settings]
# profile = black
line_length = 120
  1. 编写pre-commit的配置文件.pre-commit-config.yaml
repos:
  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort

4.添加pre commitgit钩子中

执行如下命令:

$ pre-commit install

如果已经添加过,但是更新了.pre-commit-config.yaml文件,可以直接更新。

$ pre-commit autoupdate

或者,清除或卸载之后再添加。

$ pre-commit clean
$ pre-commit uninstall
$ pre-commit install

执行完上面的命令后,pre commit就添加到git钩子中了。后续执行git commit命令时,就会触发pre commit,然后自动执行isort,整理头文件。

延伸阅读

Python 格式自动修复

Python 格式校验

Python项目如何优雅的生成依赖文件

整理头文件

参考

Github isort

Github pre-commit

pre-commit文档