Python 整理头文件
约 345 字大约 1 分钟
2025-01-17
在Python
中我们可以使用isort
来整理我们项目中的头文件,规范文件格式。
安装
$ pip3 install isort
使用
具体使用方法参考isort。我这里主要说一下,结合pre-commit
将isort
集成到git hooks
中。
集成到git
流程中
- 安装
pre-commit
。
$ pip3 install pre-commit
- 编写
isort
的配置文件.isort.cfg
。
[settings]
# profile = black
line_length = 120
- 编写
pre-commit
的配置文件.pre-commit-config.yaml
。
repos:
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
4.添加pre commit
到git
钩子中
执行如下命令:
$ 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
,整理头文件。