Google 开源的 Python 命令行库:fire 实现 git 命令

简介: 涉及的示例代码和历史文章,已同步更新到 HelloGitHub-Team 仓库一、前言在前面三篇介绍 fire 的文章中,我们全面了解了 fire 强大而不失简洁的能力。按照惯例,我们要像使用 argparse、docopt 和 click 一样使用 fire 来实现 git 命令。本文的关注点并不在 git 的各种命令是如何实现的,而是怎么使用 fire 去打造一个实用命令行程序,代码结构是怎样的。因此,和 git 相关的操作,将会使用 gitpython 库来简单实现。为了让没读过 使用 xxx 实现 git 命令(xxx 指 argparse、docopt 和 click)

涉及的示例代码和历史文章,已同步更新到 HelloGitHub-Team 仓库

一、前言
在前面三篇介绍 fire 的文章中,我们全面了解了 fire 强大而不失简洁的能力。按照惯例,我们要像使用 argparse、docopt 和 click 一样使用 fire 来实现 git 命令。

本文的关注点并不在 git 的各种命令是如何实现的,而是怎么使用 fire 去打造一个实用命令行程序,代码结构是怎样的。因此,和 git 相关的操作,将会使用 gitpython 库来简单实现。

为了让没读过 使用 xxx 实现 git 命令(xxx 指 argparse、docopt 和 click) 的小伙伴也能读明白本文,我们仍会对 git 常用命令和 gitpython 做一个简单介绍。

本系列文章默认使用 Python 3 作为解释器进行讲解。
若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~
复制代码
二、git 常用命令
当你写好一段代码或增删一些文件后,会用如下命令查看文件状态:

git status
复制代码
确认文件状态后,会用如下命令将的一个或多个文件(夹)添加到暂存区:

git add [pathspec [pathspec ...]]
复制代码
然后使用如下命令提交信息:

git commit -m "your commit message"
复制代码
最后使用如下命令将提交推送到远程仓库:

git push
复制代码
我们将使用 fire 和 gitpython 库来实现这 4 个子命令。

三、关于 gitpython
gitpython 是一个和 git 仓库交互的 Python 第三方库。 我们将借用它的能力来实现真正的 git 逻辑。

安装:

pip install gitpython
复制代码
四、思考
在实现前,我们不妨先思考下会用到 fire 的哪些功能?整个程序的结构是怎样的?

fire

git 的 4 个子命令的实现其实对应于四个函数,我们可以都放到一个类中,实现四个实例方法。 而对于 git add 命令,需要接受任意个参数,在实例方法中用 *pathspecs 参数来表达。 对于 git commit 命令,需要接受 -m 选项,在实例方法中用 m 参数来表达。

程序结构

程序结构上:

实例化 Git 对象,供全局使用
在 GitCli 类中定义四个命令对应的实例方法 status、add、commit、push
则基本结构如下:

import os
import fire
from git.cmd import Git

git = Git(os.getcwd())

class GitCli:

def status(self):
    """
    处理 status 命令
    """
    pass

def add(self, *pathspecs):
    """
    处理 add 命令
    """
    pass

def commit(self, m):
    """
    处理 -m <msg> 命令
    """
    pass

def push(self):
    """
    处理 push 命令
    """
    pass

if name == '__main__':

fire.Fire(GitCli())

复制代码
下面我们将一步步地实现我们的 git 程序。

五、实现
假定我们在 fire-git.py 文件中实现我们的 git 程序。

5.1 status 子命令
status 子命令不接受任何参数和选项,因此 status 方法无需任何入参。

class GitCli:

def status(self):
    """
    处理 status 命令
    """
    cmd = ['git', 'status']
    output = git.execute(cmd)
    return output

复制代码
不难看出,我们最后调用了真正的 git status 来实现,并打印了输出。

5.2 add 子命令
add 子命令相对于 status 子命令,需要接受任意个 pathspec 参数,因此 add 方法需要增加 *pathspecs 入参。 fire 最终传入的是一个手机靓号交易元组,我们需要将其转换成 list 以便后续处理。

class GitCli:

def add(self, *pathspecs):
    """
    处理 add 命令
    """
    cmd = ['git', 'add'] + list(pathspecs)
    output = git.execute(cmd)
    return output

复制代码
当我们执行 python3 fire-git.py add --help 时,结果如下:

INFO: Showing help with the command 'fire-git.py add -- --help'.

NAME

fire-git.py add - 处理 add 命令

SYNOPSIS

fire-git.py add [PATHSPECS]...

DESCRIPTION

处理 add 命令

POSITIONAL ARGUMENTS

PATHSPECS

复制代码
5.3 commit 子命令
commit 子命令相对于 status 子命令,需要接受 -m 选项,因此 commit 方法需要增加 m 入参。

class GitCli:

def commit(self, m):
    """
    处理 -m <msg> 命令
    """
    cmd = ['git', 'commit', '-m', m]
    output = git.execute(cmd)
    return output

复制代码
5.4 push 子命令
push 子命令同 status 子命令一样,不接受任何参数和选项,因此 push 方法无需任何入参。

class GitCli:

def push(self):
    """
    处理 push 命令
    """
    cmd = ['git', 'push']
    output = git.execute(cmd)
    return output

复制代码
至此,我们就实现了一个简单的 git 命令行,使用 python fire-git.py status 便可查询项目状态。

非常方便的是,每个命令函数的 docstring 都将作为这个命令的帮助信息,因此,当我们执行 python3 fire-git.py --help 会自动生成如下帮助内容:

INFO: Showing help with the command 'fire-git.py -- --help'.

NAME

fire-git.py

SYNOPSIS

fire-git.py COMMAND

COMMANDS

COMMAND is one of the following:

 add
   处理 add 命令

 commit
   处理 -m <msg> 命令

 push
   处理 push 命令

 status
   处理 status 命令

复制代码
想看整个源码,请戳 fire-git.py 。

六、小结
本文简单介绍了日常工作中常用的 git 命令,然后提出实现它的思路,最终一步步地使用 fire 和 gitpython 实现了 git 程序。

对比 argparse、docopt 和 click 的实现版本,你会发现使用 fire 来实现是最简单的:

相较于 argparse,子解析器、参数类型什么的统统不需要关心
相较于 docopt,参数解析和命令调用处理也不需要关心
相较于 click,装饰器所定义的命令行参数信息也必须要关心
无疑,fire 把能简化的都简化了,简直就是懒人福音。

关于 fire 的讲解将告一段落,回顾下 fire 的至简之道,你会深爱上它。这也体现出了 Python 之美。

现在,你已学会了四个特点各异的主流命令行解析库的使用了,再也不需要为命令行程序的实现而烦恼了。

什么,你为要使用哪一个库而发愁?在下一篇也是最后一篇文章中,我们将对这些库做一个横向对比,以对什么场景下使用什么样的命令行库了然于胸~

目录
相关文章
|
1天前
|
JSON Shell 数据格式
第十章 Python常用标准库使用(必会)
第十章 Python常用标准库使用(必会)
|
2天前
|
开发框架 前端开发 数据库
Python从入门到精通:3.3.2 深入学习Python库和框架:Web开发框架的探索与实践
Python从入门到精通:3.3.2 深入学习Python库和框架:Web开发框架的探索与实践
|
1天前
|
数据采集 数据可视化 数据处理
Python从入门到精通的文章3.3.1 深入学习Python库和框架:数据处理与可视化的利器
Python从入门到精通的文章3.3.1 深入学习Python库和框架:数据处理与可视化的利器
|
2天前
|
JSON 测试技术 API
Python的Api自动化测试使用HTTP客户端库发送请求
【4月更文挑战第18天】在Python中进行HTTP请求和API自动化测试有多个库可选:1) `requests`是最流行的选择,支持多种请求方法和内置JSON解析;2) `http.client`是标准库的一部分,适合需要低级别控制的用户;3) `urllib`提供URL操作,适用于复杂请求;4) `httpx`拥有类似`requests`的API,提供现代特性和异步支持。根据具体需求选择,如多数情况`requests`已足够。
8 3
Python
19 0
|
2天前
|
JSON 数据格式 索引
python 又一个点运算符操作的字典库:Munch
python 又一个点运算符操作的字典库:Munch
19 0
|
2天前
|
存储 Linux 开发工具
Git 分布式版本控制系统基本概念和操作命令
Git 分布式版本控制系统基本概念和操作命令
21 0
|
3天前
|
数据挖掘 数据处理 索引
如何使用Python的Pandas库进行数据筛选和过滤?
Pandas是Python数据分析的核心库,提供DataFrame数据结构。基本步骤包括导入库、创建DataFrame及进行数据筛选。示例代码展示了如何通过布尔索引、`query()`和`loc[]`方法筛选`Age`大于19的记录。
10 0
|
4天前
|
数据处理 Python
如何使用Python的Pandas库进行数据排序和排名
【4月更文挑战第22天】Pandas Python库提供数据排序和排名功能。使用`sort_values()`按列进行升序或降序排序,如`df.sort_values(by=&#39;A&#39;, ascending=False)`。`rank()`函数用于计算排名,如`df[&#39;A&#39;].rank(ascending=False)`。多列操作可传入列名列表,如`df.sort_values(by=[&#39;A&#39;, &#39;B&#39;], ascending=[True, False])`和分别对&#39;A&#39;、&#39;B&#39;列排名。
14 2
|
4天前
|
算法 Java BI
云效产品使用报错问题之平台上导出的统计数据和 git 中使用命令导出的数据统计都对不上,如何解决
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。