pre-commit

代码规范利器——pre-commit

毫无疑问,git已经成为代码托管工具的主力军。最近研究了一个基于git的代码规范利器——pre-commit,已应用到我们项目组。pre-commit用于commit 之前触发git钩子来做一系列动作,这个时候就可以做代码检查,如果不符合规范则commit失败。下面就以我们项目用到的三个钩子(black、flake、bandit)来介绍一下它的骚操作,由于这个项目是python项目,所以是基于python来介绍的,其它的语言也有相应的方法去使用:

准备工作

  • 准备一个git仓库
    在这里插入图片描述
  • 执行pip install pre-commit 安装pre-commit,并在项目根目录下创建一个名为.pre-commit-config.yaml的文件作为pre-commit的配置文件:
    在这里插入图片描述
  • 注意,这时候我们还并未安装成功,目前pre-commit还只是作为python的一个模块安装到python环境中来,我们需要应用到git中来。接下来,我们可以在配置文件中添加我们需要安装的钩子,在这里我们先看一下格式,首次安装可以不作配置,后面我们添加完配置后在commit的时候会自安装我们新配置的钩子,配置格式如下:
    repos:
    -   repo:       # 来源
        rev:        # 版本
        hooks:
    - id:        # 钩子 id
     args:      # 执行钩子时候可以添加参数
        language_version:         # python 版本
    
  • 如下图,执行pre-commit install完成应用:在这里插入图片描述

钩子

black

black会根据PEP8及PEP257编码规范自动格式化代码,从而方

  • 0
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
pytest和pre-commit是两个不同的工具。pytest是一种用于Python的测试框架,用于编写和运行单元测试。它可以帮助开发者更轻松地编写可靠的测试代码,并提供丰富的断言和测试运行控制功能。 pre-commit是一个用于管理和维护多种语言的git pre-commit hooks框架。它允许你在每次提交代码之前运行预定义的脚本或命令,以执行代码格式化、静态代码分析、代码审查等操作。通过pre-commit,你可以轻松地将他人创建并分享的pre-commit hooks安装到自己的项目仓库中,解决环境依赖问题。 所以,pytest和pre-commit是两个用途不同的工具。pytest主要用于编写和运行单元测试,而pre-commit用于在提交代码之前运行预定义的脚本或命令。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [fondat-aws:Amazon Web Services的Fondat软件包](https://download.csdn.net/download/weixin_42131424/15625298)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [使用哪些工具,可以提升 Python 项目质量?](https://blog.csdn.net/m0_72444380/article/details/126869817)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值