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 之美。

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

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

目录
相关文章
|
13天前
|
监控 数据可视化 数据挖掘
Python Rich库使用指南:打造更美观的命令行应用
Rich库是Python的终端美化利器,支持彩色文本、智能表格、动态进度条和语法高亮,大幅提升命令行应用的可视化效果与用户体验。
63 0
|
21天前
|
开发工具 git
Git版本控制工具合并分支merge命令操作流程
通过以上步聚焦于技术性和操作层面指南(guidance), 可以有效管理项目版本控制(version control), 并促进团队协作(collaboration).
123 15
|
4月前
|
安全 开发工具 git
git的常用操作命令
git的常用操作命令
299 57
|
2月前
|
存储 缓存 开发工具
Git stash命令的详细使用说明及案例分析。
通过上述案例,我们看到stash命令能够在不丢失进度的情况下,帮助开发者临时切换开发上下文,这在处理多个任务或紧急bug时特别有用。正确使用Git stash可以大大提高开发的灵活性和效率。
737 0
|
5月前
|
存储 项目管理 开发工具
Git常用命令及操作技巧
以上是Git的常用命令及操作技巧,尽管看起来有些繁琐,但实际上只要花费一些时间进行实践,您将很快熟练掌握。随着使用熟练度的提高,您会发现Git对项目管理和协同工作的强大帮助。
130 20
|
7月前
|
人工智能 前端开发 Java
用git rebase命令合并开发阶段中多条commit提交记录
通过 `git rebase`,可以合并多个提交记录,使开发历史更简洁清晰。操作分为 6 步:查看提交历史 (`git log --oneline`)、设置需合并的提交数 (`git rebase -i HEAD~N`)、修改动作标识为 `s`(squash)、保存退出编辑、调整提交信息、强制推送至远程仓库 (`git push -f`)。此方法适合清理本地无关提交,但若有团队协作或冲突风险,需谨慎使用以避免问题。
945 60
|
6月前
|
人工智能 API 开发工具
GitHub官方开源MCP服务!GitHub MCP Server:无缝集成GitHub API,实现Git流程完全自动化
GitHub MCP Server是基于Model Context Protocol的服务器工具,提供与GitHub API的无缝集成,支持自动化处理问题、Pull Request和仓库管理等功能。
1137 2
GitHub官方开源MCP服务!GitHub MCP Server:无缝集成GitHub API,实现Git流程完全自动化
|
6月前
|
Linux 开发工具 git
版本控制工具:Git的安装和基本命令使用指南。
结束这段探险,掌握了Git你就等于掌握了一个宝藏,随时可以瞥见你的编程历程,轻松面对日后的挑战。Git,无疑是编程者的强大武器,开始你的Git探险之旅吧!
213 28
|
7月前
|
人工智能 边缘计算 自然语言处理
Google 发布其开源模型系列最新模型 Gemma 3
Google 发布了其开源模型系列的最新成员 Gemma 3,这是一款轻量级、高性能的 AI 模型,支持多语言和复杂任务。它具备 140+ 语言支持、128K-token 上下文窗口、增强的多模态分析能力以及函数调用功能,适用于聊天 AI、代码生成等多种场景。Gemma 3 在性能上超越 Llama 3-8B 和 Mistral 7B,且仅需单 GPU 即可运行,大幅降低计算成本。提供 1B 至 27B 不同参数规模版本,满足多样化需求,并优化了量化模型以适应边缘计算和移动设备。其多模态设计整合了 SigLIP 图像编码器,扩展上下文窗口至 128k token,显著提升了视觉和文本理解能力。
336 3
Google 发布其开源模型系列最新模型 Gemma 3
|
9月前
|
人工智能 前端开发 API
Gemini Coder:基于 Google Gemini API 的开源 Web 应用生成工具,支持实时编辑和预览
Gemini Coder 是一款基于 Google Gemini API 的 AI 应用生成工具,支持通过文本描述快速生成代码,并提供实时代码编辑和预览功能,简化开发流程。
469 38
Gemini Coder:基于 Google Gemini API 的开源 Web 应用生成工具,支持实时编辑和预览