[git]安装git-pylint-commit-hook提高python项目中的代码质量
什么是'git-pylint-commit-hook'
我在工作中,团队为了保证代码和提高代码的质量,要求每个项目都要求安装git-pylint-commit-hook
,它是个钩子,会在你提交代码到本地版本库的时候,自动运行,根据配置文件pylintrc
中的配置,去检测改动过文件中的代码,并会对其进行评分,如果未达到设置的分数线,则这次提交到本地版本库的操作(commit),强制取消。需要修改代码后,评分超过设定的分数,才可以提交到本地版本库。
我发现这个是个很好的东西,所以就在自己的项目中也尝试安装使用,用来提高自己项目的代码质量。
安装步骤如下:
-
cd 你的项目文件
,到你的项目根目录下(下面所有操作都是在项目根目录下操作) -
pip install -U git-pylint-commit-hook
,安装git-pylint-commit-hook
钩子 -
输入
mkdir .hooks/pre-commit
,初始化钩子 -
输入
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参数就是设定的最低评分。**
-
输入
touch .pylintrc
,创建配置文件,并加入内容:pylintrc配置 -
输入
ln -sf $(pwd)/.hooks/pre-commit .git/hooks/
,关联到github的commit事件,也就是执行commit指令时,自动运行pre-commit
脚本。
最终效果
之后每次执行commit指令时,会自动对你的代码评分,如下图:
这个钩子并不能完全保证代码的质量,但是可以在一定程度上统一代码风格,从而提高项目的整体质量。刚开始,用的时候会有些不适应,就像俗话说的:“良药苦口利于病”。
注意:使用过程中如果要忽略一些警告,则在[MESSAGES CONTROL]下,加入字段例如:disable=C0303,C0111,W0223
,就可以忽略这些非代码风格的错误,提高分数。
相关文章
- 【clickhouse专栏】对标mongodb存储类JSON数据文档统计分析
- linux-ext4格式文件误删除,该如何恢复?
- linux挂载新硬盘并进行分区格式化
- linux系统下文件误删除该如何恢复?
- MongoDB设计方法及技巧
- 实践GoF的23种设计模式:建造者模式
- 设备如何使用go sdk轻松连接华为云IoT平台?
- 一个故事看懂Linux文件权限管理
- 闯荡Linux帝国:nginx的创业故事
- 实践GoF的设计模式:单例模式
- Go 1.18 新特性:多模块工作区模式
- 用过 mongodb 吧, 这三个大坑踩过吗?
- 教你配置windows上的windbg,linux上的lldb,打入clr内部这一篇就够了
- 使用mongodb作为Quartz.Net下的JobStore实现底层的持久化机制
- mongodb之使用explain和hint性能分析和优化
- mongodb 3.x 之实用新功能窥看[2] ——使用$lookup做多表关联处理
- mongodb 3.x 之实用新功能窥看[1] ——使用TTLIndex做Cache处理
- 双十一来了,别让你的mongodb宕机了
- 分享几个你可能不知道的交互式Git 命令
- 实践GoF的23的设计模式:SOLID原则(下)