博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
[git]安装git-pylint-commit-hook提高python项目中的代码质量
阅读量:6640 次
发布时间:2019-06-25

本文共 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参数就是设定的最低评分。

  5. 输入touch .pylintrc,创建配置文件,并加入内容:

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

最终效果

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

759200-20160517142447091-696874238.png

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

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

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

你可能感兴趣的文章
在linux下如何使用yum查看安装了哪些软件包
查看>>
kafka集群配置调优详解
查看>>
《Perl语言入门》之六——正则表达式
查看>>
Linux之strace简单用法
查看>>
Javascript中的DOM
查看>>
按需路由原理 (ODR-On Demand Routing)
查看>>
corosync与pacemaker实现nfs作为共享存储的Mysql高可用!
查看>>
Safengine NoobyProtect 过注册半自动脚本
查看>>
redis_3.0.7_sds.c_sdsclear()
查看>>
MySQL阶段五——主从复制原理、主从延迟原理与解决
查看>>
我的友情链接
查看>>
JS 有趣的应用 : Array.prototype.slice.call(arguments,0)
查看>>
Linux命令:特殊权限SUID、GUID、Sticky
查看>>
<文明开房 低调叫床> 高考满分作文
查看>>
【Spark亚太研究院系列丛书】Spark实战高手之路-第一章 构建Spark集群(第四步)(4)...
查看>>
【linux系统优化】Selinux介绍及关闭方法
查看>>
阶段总结
查看>>
我的友情链接
查看>>
Spring aop 前置通知、后置通知、返回通知、 异常通知 、后置通知
查看>>
Android中选项卡TabHost的基本使用
查看>>