python hook_五分钟内用Python实现GitHook
githooks.png
Githook 也称 Git 钩子,是在 Git 仓库中特定事件发生时自动运行的脚本。它可以让你自定义 Git 内部的行为,在开发周期中的关键点出发自定义行为。
Git Hook 最常见的使用场景包括推行提交信息规范,根据仓库状态来改变项目环境,和接入持续集成工作流。但是因为脚本可以完全定制,你可以用 Git Hook 来自动化或者优化你开发工作流中任意部分。
Git Hook 是仓库中特定事件发生时 Git 自动运行的普通脚本。因此 Git Hook 安装和配置也非常容易。Hook 在本地或服务端仓库都可以部署,且只会在仓库中事件发生时被执行。
背景:想在每一次代码commit的时候发送一封邮件到相关人员的邮箱
前提:阅读以下文字需要有一定Git基础的朋友,请参见之前的文章:五步法掌握Git基本操作
实验环境:
Python3.5
Pycharm(最顺手的IDE而已)
Windows系统 Win7
Hook 存在于每个 Git 仓库的 .git/hooks 目录中。当你初始化仓库时,Git 自动生成这个目录和一些示例脚本。你可以在某个 .git/hooks 中,查看这些文件,如下图:
Hooks目录.png
注:本地没有git仓库的可以随意git clone一个,但是需要有权限可以做git commit,好做之后的练习。
编写脚本语言
内置的脚本大多是 shell 和 perl 语言实现的,但你也可以使用任何脚本语言,只要它们最后能编译到可执行文件。每次脚本中 #!/bin/sh 定义了你的文件将如何被解释。
这次我们采用Python语言来实现GitHook,在Linux系统下可以直接编写Python脚本,但是在Windows系统下需要做一个小小的转换。
1)新建一个shell脚本,取名为post-commit,内容如下:
#!/bin/sh
python3 .git/hooks/post-commit.py
2)新建一个post-commit.py,里面编写Hook中需要发送邮件的功能
注:上面一个文件中写的python3是因为CC先生的Windows环境中同时有python2和python3(Python2和Python3共存),此处特意表明用python3来处理,否则就直接写python即可。
内容如下:
# -*- coding: utf-8 -*-
import smtplib
from email.mime.text import MIMEText
from email.header import Header
from subprocess import check_output
#使用QQ邮箱做测试,填写QQ的smtp服务器名称
mail_host = "smtp.qq.com"
#替换成自己使用的QQ邮箱
mail_user = "***@qq.com"
#替换成自己使用的授权码(非自己的QQ密码)授权码详见;http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=28&&no=1001256
mail_pass = "*****"
#使用Python中的subprocess的check_output函数来捕获运行了git命令后的标准输出
log = check_output(['git', 'log', '-1', '-p']).decode()
m = log.split('\n',5)[4]
#分割字符串得到最后的一个参数 email
arg = m.split(' ')[-1]
if arg[:6] == 'email:':
receiver = arg[6:]
print(receiver)
sender = mail_user
receivers = [receiver]
message = MIMEText(log)
message['From'] = Header(mail_user, 'utf-8')
message['To'] = Header(str(receivers), 'utf-8')
subject = 'This is a commit log for you!'
message['Subject'] = Header(subject, 'utf-8')
try:
smtpObj = smtplib.SMTP_SSL(mail_host, 465)
smtpObj.login(mail_user,mail_pass)
smtpObj.sendmail(sender, receivers, message.as_string())
smtpObj.quit()
print ("Send the diff email to:", receiver)
except smtplib.SMTPException as e:
print (e)
3.可以在git命令中尝试GitHook
随意改写一个仓库中的文件,比如README.md
$git add README.md
2)提交修改
$ git commit -m 'Update readme. email:xgengshax@msn.com',如下图:
gitcommit.png
4.查看QQ邮箱已发送邮件(此处因为QQ邮箱的安全设置会收到发送失败的提示邮件,不过这个表示Hook已经成功,只是QQ的安全设置而已)
QQ mail.png
至此,我们已经完成了只要git commit一次,就会发送邮件的简单功能。
回顾一下使用到的知识点:
Git基础知识
Python对SMTP的使用
Python中subprocess子进程的使用
拓展:
钩子的作用域
对于任何 Git 仓库来说 Hook 都是本地的,而且它不会随着 git clone 一起复制到新的仓库。而且因为钩子是本地的,任何能接触到仓库的人都可以修改。对于开发团队来说,这有很大的影响。所以在开发团队中维护钩子是比较复杂的,因为 .git/hooks 目录不随你的项目一起拷贝,也不受版本控制影响。一个简单的解决办法是把你的 Hook 存在项目的实际目录中(在 .git 外)。这样你就可以像其他文件一样进行版本控制。为了安装 Hook ,你可以在 .git/hooks 中创建一个符号链接,或者简单地在更新后把它们复制到 .git/hooks 目录下。
本地 Hook 只影响它们所在的仓库。以下是最常用的 6 个本地 >Hook:
pre-commit
prepare-commit-msg
commit-msg
post-commit
post-checkout
pre-rebase
前四个 Hook 介入到版本提交的生命周期,后两个允许执行一些额外的操作,分别为 git checkout 和 git rebase 的安全检查。所有与带 pre- 的 Hook 代表即将发生的某个阶段,带 post- 只用于通知。
---------------------
作者:weixin_33695450
来源:CSDN
原文:https://blog.csdn.net/weixin_33695450/article/details/86909554
python hook_五分钟内用Python实现GitHook相关推荐
- 五分钟内用Python实现GitHook
2019独角兽企业重金招聘Python工程师标准>>> githooks.png Githook 也称 Git 钩子,是在 Git 仓库中特定事件发生时自动运行的脚本.它可以让你自定 ...
- 在五分钟内学习使用Python进行类型转换
by PALAKOLLU SRI MANIKANTA 通过PALAKOLLU SRI MANIKANTA 在五分钟内学习使用Python进行类型转换 (Learn typecasting in Pyt ...
- 五分钟内搭建的混沌电路
简 介: 针对一种简单的混沌电路进行测试,没有能够复现电路的工作状态.具体原因尚未清楚. 关键词: 混沌电路,相移单管电路 #mermaid-svg-QPl6WYe8NnE6m9yt .label{f ...
- boost::python模块实现使用内置 python 数据类型创建 ndarrays 的示例,并提取成员变量的类型和值测试程序
boost::python模块实现使用内置 python 数据类型创建 ndarrays 的示例,并提取成员变量的类型和值测试程序 实现功能 C++实现代码 实现功能 boost::python模块实 ...
- Android进阶之路 - Citypicker 五分钟内快速实现地址选择器
从早期的时候就比较喜欢拉框架直接用,所以以前记录了很多 关于 CityPicker 框架,我用的时候还是2017年,但是这几年(2022)改变了很多,扩展性也很强,如果要了解最新使用的话,最好还是去 ...
- python记录日志_5分钟内解释日志记录—使用Python演练
python记录日志 Making your code production-ready is not an easy task. There are so many things to consid ...
- python程序-30分钟学会用Python编写简单程序
原标题:30分钟学会用Python编写简单程序 参与文末每日话题讨论,赠送异步新书 异步图书君 学习目标 知道有序的软件开发过程的步骤. 了解遵循输入.处理.输出(IPO)模式的程序,并能够以简单的方 ...
- 【小程序制作经验分享】怎么在五分钟内做出查询天气快递/星座运势/天天鸡汤等的小程序?(不是用模板)
✨API是什么? 应用程序接口(英语:Application Programming Interface,缩写API),是软件系统不同组成部分衔接的约定. 为了实现更多的功能,Zion 为用户提供了& ...
- python如何编写数据库_如何在几分钟内用Python编写一个简单的玩具数据库
python如何编写数据库 MySQL, PostgreSQL, Oracle, Redis, and many more, you just name it - databases are a re ...
最新文章
- PHP zval内存回收机制和refcount_gc和is_ref_gc
- python中列表生成式strip_列表生成式|让你的代码简洁又美观
- 快速幂(Fast_Power)
- 实验九 根据材料编程
- 一文讲透大型网站架构模式核心原理与案例分析
- 在Java中实现过滤器和面包店锁
- leetcode 321. 拼接最大数(单调栈)
- 控件的布局 1124
- 【jQuery】学习整理(一) 认识jQuery
- iOS开发问题之Could not instantiate class named NSLayoutConstraint
- Android中生成库文件与移除以及导入jar包重复问题
- spark filter过滤某个字段在几个值里面_Spark案例学习-PV的统计
- 《CSS权威指南》第3版
- AnyLogic简介
- Filter过滤器详解
- 如何优雅高效地使用Python——这些Python技巧你必须学会!
- 关于DDS文件格式的说明
- 【不全】网络工程师术语表
- 小心肝队-冲刺日志(第六天)
- 中国农业银行h5支付(php接入中国农业银行h5支付)
热门文章
- 【python基础语法】列表的查询操作(包括切片)
- _tkinter.TclError: invalid command name “tixComboBox“ 的解决办法
- [Common 17-39] ‘connect_bd_intf_net‘ failed due to earlier errors. 的解决办法
- AD19中画MOSFET的常见错误——封装出错
- spring-cloud-demo
- Leetcode Trie Conclusion
- Ubuntu 左边栏和顶栏都不见了,ctrl+alt+t 也调用不出terminal
- 150330之软件测试
- [转载] 在python中pop的用法_python中pop()函数如何使用
- [转载] Python面向对象编程系列第一篇