博客
关于我
[git]安装git-pylint-commit-hook提高python项目中的代码质量
阅读量:455 次
发布时间:2019-03-06

本文共 984 字,大约阅读时间需要 3 分钟。

什么是'git-pylint-commit-hook'

我在工作中,团队为了保证代码和提高代码的质量,要求每个项目都要求安装git-pylint-commit-hook,它是个钩子,会在你提交代码到本地版本库的时候,自动运行,根据配置文件pylintrc中的配置,去检测改动过文件中的代码,并会对其进行评分,如果未达到设置的分数线,则这次提交到本地版本库的操作(commit),强制取消。需要修改代码后,评分超过设定的分数,才可以提交到本地版本库。

我发现这个是个很好的东西,所以就在自己的项目中也尝试安装使用,用来提高自己项目的代码质量。

安装步骤如下:

  1. cd 你的项目文件,到你的项目根目录下(下面所有操作都是在项目根目录下操作)

  2. pip install -U git-pylint-commit-hook,安装git-pylint-commit-hook钩子

  3. 输入mkdir .hooks/pre-commit,初始化钩子

  4. 输入chmod 755 .hooks/pre-commit,修改pre-commit权限,赋予可执行权限,并加入如下内容:

    #!/bin/sh

use pylint to check code,

Requirements:

pip install git-pylint-commit-hook

git-pylint-commit-hook --limit=9.0 --pylintrc=.pylintrc

```

**limit参数就是设定的最低评分。**
  1. 输入touch .pylintrc,创建配置文件,并加入内容:

  2. 输入ln -sf $(pwd)/.hooks/pre-commit .git/hooks/,关联到github的commit事件,也就是执行commit指令时,自动运行pre-commit脚本。

最终效果

之后每次执行commit指令时,会自动对你的代码评分,如下图:

这个钩子并不能完全保证代码的质量,但是可以在一定程度上统一代码风格,从而提高项目的整体质量。刚开始,用的时候会有些不适应,就像俗话说的:“良药苦口利于病”。

注意:使用过程中如果要忽略一些警告,则在[MESSAGES CONTROL]下,加入字段例如:disable=C0303,C0111,W0223,就可以忽略这些非代码风格的错误,提高分数。

转载地址:http://fdvbz.baihongyu.com/

你可能感兴趣的文章
数值压缩存储方法Varint
查看>>
Http压力测试工具HttpTest4Net
查看>>
机器学习实战 - 读书笔记(14) - 利用SVD简化数据
查看>>
CSS躬行记(2)——伪类和伪元素
查看>>
JavaScript作用域原理(一)——作用域链
查看>>
JavaScript中事件处理
查看>>
Hammer.js分析(四)——recognizer.js
查看>>
2019年8月19日~8月25日 第八周JAVA学习总结
查看>>
13.罗马数字转整数
查看>>
数据库优化
查看>>
[备忘]域用户登陆出现“此工作站和主域间的信任关系失败”错误解决方法
查看>>
继续聊WPF——用Blend自定义Listview控件的列表头
查看>>
【WPF】制作自定义的列表项面板
查看>>
【.net 深呼吸】启动一个进程并实时获取状态信息
查看>>
OO_Unit2 多线程电梯总结
查看>>
mybatis源码配置文件解析之五:解析mappers标签(解析class属性)
查看>>
json-lib的使用《二》
查看>>
LeetCode52题,别再问我N皇后问题了
查看>>
Swagger常用注解
查看>>
FunDA(16)- 示范:整合并行运算 - total parallelism solution
查看>>