如何使用 Python 操作 Git 代码?GitPython 入门介绍
点击上方“视学算法”,选择“置顶或者星标”
第一时间阅读精彩文章!
作者:匿蟒
链接:https://note.qidong.name/2018/01/gitpython
有时,需要做复杂的 Git 操作,并且有很多中间逻辑。用 Shell 做复杂的逻辑运算与流程控制就是一个灾难。所以,用 Python 来实现是一个愉快的选择。这时,就需要在 Python 中操作 Git 的库。
GitPython 简介
GitPython是一个与Git库交互的Python库,包括底层命令(Plumbing)与高层命令(Porcelain)。它可以实现绝大部分的Git读写操作,避免了频繁与Shell交互的畸形代码。它并非是一个纯粹的Python实现,而是有一部分依赖于直接执行git
命令,另一部分依赖于GitDB。
GitDB也是一个Python库。它为.git/objects
建立了一个数据库模型,可以实现直接的读写。由于采用流式(stream)读写,所以运行高效、内存占用低。
GitPython安装
pip install GitPython
其依赖GitDB会自动安装,不过可执行的git
命令需要额外安装。
基本用法
init
import git
repo = git.Repo.init(path='.')
这样就在当前目录创建了一个Git库。当然,路径可以自定义。
由于git.Repo
实现了__enter__
与__exit__
,所以可以与with
联合使用。
with git.Repo.init(path='.') as repo:# do sth with repo
不过,由于只是实现了一些清理操作,关闭后仍然可以读写,所以使用这种形式的必要性不高。详见附录。
clone
clone分两种。一是从当前库clone到另一个位置:
new_repo = repo.clone(path='../new')
二是从某个URL那里clone到本地某个位置:
new_repo = git.Repo.clone_from(url='git@github.com:USER/REPO.git', to_path='../new')
commit
with open('test.file', 'w') as fobj:fobj.write('1st line\n')
repo.index.add(items=['test.file'])
repo.index.commit('write a line into test.file')with open('test.file', 'aw') as fobj:fobj.write('2nd line\n')
repo.index.add(items=['test.file'])
repo.index.commit('write another line into test.file')
status
GitPython并未实现原版git status
,而是给出了部分的信息。
>>> repo.is_dirty()
False
>>> with open('test.file', 'aw') as fobj:
>>> fobj.write('dirty line\n')
>>> repo.is_dirty()
True
>>> repo.untracked_files
[]
>>> with open('untracked.file', 'w') as fobj:
>>> fobj.write('')
>>> repo.untracked_files
['untracked.file']
checkout(清理所有修改)
>>> repo.is_dirty()
True
>>> repo.index.checkout(force=True)
<generator object <genexpr> at 0x7f2bf35e6b40>
>>> repo.is_dirty()
False
branch
获取当前分支:
head = repo.head
新建分支:
new_head = repo.create_head('new_head', 'HEAD^')
切换分支:
new_head.checkout()
head.checkout()
删除分支:
git.Head.delete(repo, new_head)
# or
git.Head.delete(repo, 'new_head')
merge
以下演示如何在一个分支(other
),merge另一个分支(master
)。
master = repo.heads.master
other = repo.create_head('other', 'HEAD^')
other.checkout()
repo.index.merge_tree(master)
repo.index.commit('Merge from master to other')
remote, fetch, pull, push
创建remote:
remote = repo.create_remote(name='gitlab', url='git@gitlab.com:USER/REPO.git')
远程交互操作:
remote = repo.remote()
remote.fetch()
remote.pull()
remote.push()
删除remote:
repo.delete_remote(remote)
# or
repo.delete_remote('gitlab')
其它
其它还有Tag、Submodule等相关操作,不是很常用,这里就不介绍了。
GitPython的优点是在做读操作时可以方便地获取内部信息,缺点是在做写操作时感觉很不顺手,隔靴搔痒。当然,它还支持直接执行git
操作。
git = repo.git
git.status()
git.checkout('HEAD', b="my_new_branch")
git.branch('another-new-one')
git.branch('-D', 'another-new-one')
这……感觉又回到了老路,而且仍然感觉怪怪的。
其它操作Git的方法
subprocess
这就是所谓『老路』。在另一个进程,执行Shell命令,并通过stdio来解析返回结果。
import subprocess
subprocess.call(['git', 'status'])
dulwich
dulwich是一个纯Python实现的Git交互库,以后有空再研究吧。
官方网站:https://www.dulwich.io/
pygit2
pygit2是基于libgit2实现的一个Python库。底层是C,而上层Python只是接口,运行效率应该是最高的,然而孤还是放弃了。其缺点是,需要环境中预先安装libgit2。相比之下,GitPython只需要环境预置Git,简单多了。
官方网站:http://www.pygit2.org/
参考
《GitPython Documentation》
《Welcome to GitDB’s documentation!》
《Git - 底层命令 (Plumbing) 和高层命令 (Porcelain)》
《GitPython | Hom》
附录
在git.Repo
中对context相关接口的实现如下:
def __enter__(self):return selfdef __exit__(self, exc_type, exc_value, traceback):self.close()def __del__(self):try:self.close()except:passdef close(self):if self.git:self.git.clear_cache()gc.collect()gitdb.util.mman.collect()gc.collect()
可见只是一些清理操作,关闭的必要性不高。即使关闭,也仍然可以对这个git.Repo
的instance进行读写操作。
以上,便是今天的分享,希望大家喜欢,觉得内容不错的,欢迎点击「在看」支持,谢谢各位。
如何使用 Python 操作 Git 代码?GitPython 入门介绍相关推荐
- Python操作git
一.Git版本管理 很多公司在使用git的tag进行版本的管理. git tag -n 查看本地Tag git tag -l 'v1.4.2.*' 查看本地Tag,模糊匹配 git show v1.0 ...
- python提取hbase数据_详解python操作hbase数据的方法介绍
配置 thrift python使用的包 thrift 个人使用的python 编译器是pycharm community edition. 在工程中设置中,找到project interpreter ...
- python做项目管理代码_代码发布项目(三)——python操作git、代码发布流程(服务器管理、项目管理)...
一.python如何操作git 如果你想用python代码操作git需要下载一个模块 安装 pip install gitpython 基本使用 #从远处仓库下载代码到本地 importosfrom ...
- open python语言实现 pdf_使用python操作Pdf代码实现
近期有一些工作上的事情需要对pdf进行一些的操作,所以结下来稍微总结一下吧: 写在前面: 需要对PyPDF2,PyMuPDF库安装 直接pip就好: pip install PyPDF2 pip in ...
- 最全Python操作excel代码,让你每天早下班两小时
在数字化时代,很多人工作中经常和excel打交道.本文介绍Python操作excel的脚本,让你工作效率更高. 文章目录 一.安装openpyxl模块 二.加载库 三.创建文件和工作表 四.在工 ...
- Python 01:Pyton历史和入门介绍
Pyton历史和入门介绍 Python是在1991年诞生的一门面向对象.解释型计算机程序设计语言.Python能做很多事情,小到简单脚本大到后端架构设计,也可以使用python来做胶水语言.学习程序设 ...
- python猜年龄代码_python入门教程NO.7用python来写一个猜数字游戏
python入门教程 本文涉及的python基础语法为while循环 #python#3中while语句常常被用于循环执行某个程序,任何非0和非空null的值,都会被条件判断为True while 条 ...
- 由于误操作Git代码被覆盖如何解决?
首先要分情况: 被覆盖的代码已经在本地commit 用git reflog 被覆盖的代码未commit(期望本地历史记录里有,否则就真丢了) 被覆盖的代码已经在本地commit git reflog ...
- 懒人python操作,代码中永远只需要导入一个库
Pyforest是一个开源的Python库,可以自动导入代码中使用到的Python库. [阅读全文] 实话说,作为一个程序员还是得不停的学习呀.昨天晚上睡觉之前就在论坛上面溜达了一会儿,发现了有个叫p ...
最新文章
- 非关系型数据库mongodb的打开与连接
- easy_install 安装
- RE validation in Java EE
- Android官方开发文档Training系列课程中文版:通过NFC共享文件之从其它设备接收文件
- 前后端分离djangorestframework——序列化与反序列化数据
- 23. PE结构-PE详解之输出表(导出表)
- 【*项目调研+论文阅读】SVM-BILSTM-CRF模型SVM-BILSTM-CRF模型 | day7
- 开源项目选择许可证License
- Win10系统,ColorPix取色位置偏移如何解决?
- [电动智能汽车-7]:汽车CAN总线详解
- Axure中继器的高级功能
- python 答题卡识别_opencv+python机读卡识别整合版
- C语言利用图的邻接矩阵的存储方式实现拓扑排序
- 数学建模训练 — 红楼梦作者解析
- 疯狂模渲大师|什么是室内设计?是免费设计吗?
- 【SDK】01 支付宝当面付 - 沙箱环境
- 机构不会教的python入门学习路线
- R语言 - 安装R及RStudio(Linux、Windows双重记录)
- Java并发原理解析!java零基础教学系列视频教程
- 计算机考研复试面试题二
热门文章
- python解析json
- 反转!BAT编程吸金榜来了,AI程序员刷爆了......
- 打工人,打工魂,抽终身会员,成为人上人!
- “应付”大学作业,我花3小时写了一个“文本转手写”神器
- 银行卡大小的充电宝,买就送耳机!
- 漫画:我用深度学习框架画下女朋友最美的脸
- 全球超2万名开发者调研:Python 3渗透率至84%
- AI芯片的“战国时代”:计算力将会驶向何方?
- 性能优化之使用LongAdder替换AtomicLong
- 我真不想学 happens - before 了!