Google 开源的 Python 命令行库:fire 实现 git 命令
off999 2024-10-26 12:03 46 浏览 0 评论
作者:HelloGitHub-Prodesire
一、前言
在前面三篇介绍 fire 的文章中,我们全面了解了 fire 强大而不失简洁的能力。按照惯例,我们要像使用 argparse、docopt 和 click 一样使用 fire 来实现 git 命令。
本文的关注点并不在 git 的各种命令是如何实现的,而是怎么使用 fire 去打造一个实用命令行程序,代码结构是怎样的。因此,和 git 相关的操作,将会使用 gitpython 库来简单实现。
为了让没读过 使用 xxx 实现 git 命令(xxx 指 argparse、docopt 和 click) 的小伙伴也能读明白本文,我们仍会对 git 常用命令和 gitpython 做一个简单介绍。
本系列文章默认使用 Python 3 作为解释器进行讲解。
若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~二、git 常用命令
当你写好一段代码或增删一些文件后,会用如下命令查看文件状态:
确认文件状态后,会用如下命令将的一个或多个文件(夹)添加到暂存区:
然后使用如下命令提交信息:
最后使用如下命令将提交推送到远程仓库:
我们将使用 fire 和 gitpython 库来实现这 4 个子命令。
三、关于 gitpython
gitpython 是一个和 git 仓库交互的 Python 第三方库。我们将借用它的能力来实现真正的 git 逻辑。
安装:
四、思考
在实现前,我们不妨先思考下会用到 fire 的哪些功能?整个程序的结构是怎样的?
fire
git 的 4 个子命令的实现其实对应于四个函数,我们可以都放到一个类中,实现四个实例方法。而对于 git add 命令,需要接受任意个参数,在实例方法中用 *pathspecs 参数来表达。对于 git commit 命令,需要接受 -m 选项,在实例方法中用 m 参数来表达。
程序结构
程序结构上:
- 实例化 Git 对象,供全局使用
- 在 GitCli 类中定义四个命令对应的实例方法 status、add、commit、push
则基本结构如下:
下面我们将一步步地实现我们的 git 程序。
五、实现
假定我们在 fire-git.py文件中实现我们的 git 程序。
5.1 status 子命令
status 子命令不接受任何参数和选项,因此 status 方法无需任何入参。
不难看出,我们最后调用了真正的 git status 来实现,并打印了输出。
5.2 add 子命令
add 子命令相对于 status 子命令,需要接受任意个 pathspec 参数,因此 add 方法需要增加 *pathspecs 入参。fire 最终传入的是一个元组,我们需要将其转换成 list 以便后续处理。
当我们执行 python3 fire-git.py add --help 时,结果如下:
5.3 commit 子命令
commit 子命令相对于 status 子命令,需要接受 -m 选项,因此 commit 方法需要增加 m 入参。
5.4 push 子命令
push 子命令同 status 子命令一样,不接受任何参数和选项,因此 push 方法无需任何入参。
至此,我们就实现了一个简单的 git 命令行,使用 python fire-git.py status 便可查询项目状态。
非常方便的是,每个命令函数的 docstring 都将作为这个命令的帮助信息,因此,当我们执行 python3 fire-git.py --help 会自动生成如下帮助内容:
想看整个源码,请戳 fire-git.py 。
六、小结
本文简单介绍了日常工作中常用的 git 命令,然后提出实现它的思路,最终一步步地使用 fire 和 gitpython 实现了 git 程序。
对比 argparse、docopt 和 click 的实现版本,你会发现使用 fire 来实现是最简单的:
- 相较于 argparse,子解析器、参数类型什么的统统不需要关心
- 相较于 docopt,参数解析和命令调用处理也不需要关心
- 相较于 click,装饰器所定义的命令行参数信息也必须要关心
无疑,fire 把能简化的都简化了,简直就是懒人福音。
关于 fire 的讲解将告一段落,回顾下 fire 的至简之道,你会深爱上它。这也体现出了 Python 之美。
现在,你已学会了四个特点各异的主流命令行解析库的使用了,再也不需要为命令行程序的实现而烦恼了。
什么,你为要使用哪一个库而发愁?在下一篇也是最后一篇文章中,我们将对这些库做一个横向对比,以对什么场景下使用什么样的命令行库了然于胸~
『讲解开源项目系列』——让对开源项目感兴趣的人不再畏惧、让开源项目的发起者不再孤单。跟着我们的文章,你会发现编程的乐趣、使用和发现参与开源项目如此简单。欢迎留言联系我们、加入我们,让更多人爱上开源、贡献开源~
相关推荐
- 安全教育登录入口平台(安全教育登录入口平台官网)
-
122交通安全教育怎么登录:122交通网的注册方法是首先登录网址http://www.122.cn/,接着打开网页后,点击右上角的“个人登录”;其次进入邮箱注册,然后进入到注册页面,输入相关信息即可完...
- 大鱼吃小鱼经典版(大鱼吃小鱼经典版(经典版)官方版)
-
大鱼吃小鱼小鱼吃虾是于谦跟郭麒麟的《我的棒儿呢?》郭德纲说于思洋郭麒麟作诗的相声,最后郭麒麟做了一首,师傅躺在师母身上大鱼吃小鱼小鱼吃虾虾吃水水落石出师傅压师娘师娘压床床压地地动山摇。...
-
- 哪个软件可以免费pdf转ppt(免费的pdf转ppt软件哪个好)
-
要想将ppt免费转换为pdf的话,我们建议大家可以下一个那个wps,如果你是会员的话,可以注册为会员,这样的话,在wps里面的话,就可以免费将ppt呢转换为pdfpdf之后呢,我们就可以直接使用,不需要去直接不需要去另外保存,为什么格式转...
-
2026-02-04 09:03 off999
- 电信宽带测速官网入口(电信宽带测速官网入口app)
-
这个网站看看http://www.swok.cn/pcindex.jsp1.登录中国电信网上营业厅,宽带光纤,贴心服务,宽带测速2.下载第三方软件,如360等。进行在线测速进行宽带测速时,尽...
- 植物大战僵尸95版手机下载(植物大战僵尸95 版下载)
-
1可以在应用商店或者游戏平台上下载植物大战僵尸95版手机游戏。2下载教程:打开应用商店或者游戏平台,搜索“植物大战僵尸95版”,找到游戏后点击下载按钮,等待下载完成即可安装并开始游戏。3注意:确...
- 免费下载ppt成品的网站(ppt成品免费下载的网站有哪些)
-
1、Chuangkit(chuangkit.com)直达地址:chuangkit.com2、Woodo幻灯片(woodo.cn)直达链接:woodo.cn3、OfficePlus(officeplu...
- 2025世界杯赛程表(2025世界杯在哪个国家)
-
2022年卡塔尔世界杯赛程公布,全部比赛在卡塔尔境内8座球场举行,2022年,决赛阶段球队全部确定。揭幕战于当地时间11月20日19时进行,由东道主卡塔尔对阵厄瓜多尔,决赛于当地时间12月18日...
- 下载搜狐视频电视剧(搜狐电视剧下载安装)
-
搜狐视频APP下载好的视频想要导出到手机相册里方法如下1、打开手机搜狐视频软件,进入搜狐视频后我们点击右上角的“查找”,找到自已喜欢的视频。2、在“浏览器页面搜索”窗口中,输入要下载的视频的名称,然后...
- 永久免费听歌网站(丫丫音乐网)
-
可以到《我爱音乐网》《好听音乐网》《一听音乐网》《YYMP3音乐网》还可以到《九天音乐网》永久免费听歌软件有酷狗音乐和天猫精灵,以前要跳舞经常要下载舞曲,我从QQ上找不到舞曲下载就从酷狗音乐上找,大多...
- 音乐格式转换mp3软件(音乐格式转换器免费版)
-
有两种方法:方法一在手机上操作:1、进入手机中的文件管理。2、在其中选择“音乐”,将显示出手机中的全部音乐。3、点击“全选”,选中所有音乐文件。4、点击屏幕右下方的省略号图标,在弹出菜单中选择“...
- 电子书txt下载(免费的最全的小说阅读器)
-
1.Z-library里面收录了近千万本电子书籍,需求量大。2.苦瓜书盘没有广告,不需要账号注册,使用起来非常简单,直接搜索预览下载即可。3.鸠摩搜书整体风格简洁清晰,书籍资源丰富。4.亚马逊图书书籍...
- 最好免费观看高清电影(播放免费的最好看的电影)
-
在目前的网上选择中,IMDb(互联网电影数据库)被认为是最全的电影网站之一。这个网站提供了各种类型的电影和电视节目的海量信息,包括剧情介绍、演员表、评价、评论等。其还提供了有关电影制作背后的详细信息,...
- 孤单枪手2简体中文版(孤单枪手2简体中文版官方下载)
-
要将《孤胆枪手2》游戏的征兵秘籍切换为中文,您可以按照以下步骤进行操作:首先,打开游戏设置选项,通常可以在游戏主菜单或游戏内部找到。然后,寻找语言选项或界面选项,点击进入。在语言选项中,选择中文作为游...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)
