pre-commit检查python代码

我自己用的是yapf+flake8,来检查Python代码风格规范的检查,还有许多其他的库,可以根据自己需求选择,这个网站是Python代码风格检查库的介绍让 Python 代码更易维护的七种武器,其他语言也有相对应检查自己代码风格库。

代码检查会来检查编写的代码中,存在的语法及格式不规范问题,例如Python的格式规范a=[1,2,3],执行检查命令会帮你自动格式化a = [1, 2, 3],Pycharm中的格式化就是这样的;代码如果是语法错误就得自己手动改了。

安装

$ pip install pre-commit

编写.pre-commit-config.yaml文件

repos:
-   repo: https://github.com/pre-commit/mirrors-yapf   # git克隆的存储库url
     hooks:            # 钩子的列表,映射到repo地址
-   id: yapf           # 选择要使用的钩子,在repo地址的hooks文件里
     files: .*\.py$    # 规定检查哪些文件,支持正则,(opt).*\.py$此写法可规定只检查opt目录里的py文件
-   repo: https://github.com/pre-commit/pre-commit-hooks
     hooks:
-   id: flake8
    files: .*\.py$

具体可参考pre-commit官文
每次git commit的时候都会触发检查

命令

# 安装hooks脚本至当前git中,安装后git commit才可触发检查
$ pre-commit install

# 指定检查某个文件
$ pre-commit run --files [filename]

# 检查全部文件
$ pre-commit run --all-files

pre-commit所有hooks

Supported hooks

posted @ 2020-04-27 11:17  iducn3  阅读(527)  评论(0)    收藏  举报