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

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

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

目录
相关文章
|
4天前
|
数据采集 JavaScript Android开发
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
29 7
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
|
10天前
|
缓存 Shell 开发工具
[oeasy]python064_命令行工作流的总结_vim_shell_python
本文总结了命令行工作流中的关键工具和操作,包括vim、shell和Python。主要内容如下: 1. **上次回顾**:完成了输入输出的代码编写,并再次练习了vim的使用。 2. **shell基础**:介绍了shell环境及其基本命令,如`pwd`、`cd`、`ll -l`等。 3. **Python游乐场**:通过`python3`命令进入Python交互环境,可以进行简单计算和函数调用,常用函数有`help`、`ord`、`chr`等。 4. **vim编辑器**:详细讲解了vim的三种模式(正常模式、插入模式、底行命令模式)及其切换方法,以及常用的底行命令如`:w`、`:q`、`
57 15
|
27天前
|
Java 网络安全 开发工具
Git进阶笔记系列(01)Git核心架构原理 | 常用命令实战集合
通过本文,读者可以深入了解Git的核心概念和实际操作技巧,提升版本管理能力。
|
28天前
|
网络安全 开发工具 git
mac git clone命令提示git@gitee.com: Permission denied (publickey).问题修复
mac git clone命令拉取gitee上项目代码时提示密钥问题
|
28天前
|
测试技术 Python
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
106 31
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
|
1月前
|
机器学习/深度学习 存储 数据挖掘
Python图像处理实用指南:PIL库的多样化应用
本文介绍Python中PIL库在图像处理中的多样化应用,涵盖裁剪、调整大小、旋转、模糊、锐化、亮度和对比度调整、翻转、压缩及添加滤镜等操作。通过具体代码示例,展示如何轻松实现这些功能,帮助读者掌握高效图像处理技术,适用于图片美化、数据分析及机器学习等领域。
73 20
|
1月前
|
人工智能 前端开发 API
Gemini Coder:基于 Google Gemini API 的开源 Web 应用生成工具,支持实时编辑和预览
Gemini Coder 是一款基于 Google Gemini API 的 AI 应用生成工具,支持通过文本描述快速生成代码,并提供实时代码编辑和预览功能,简化开发流程。
143 38
Gemini Coder:基于 Google Gemini API 的开源 Web 应用生成工具,支持实时编辑和预览
|
2月前
|
XML JSON 数据库
Python的标准库
Python的标准库
185 77
|
2月前
|
XML JSON 数据库
Python的标准库
Python的标准库
71 11
|
2月前
|
数据可视化 Python
以下是一些常用的图表类型及其Python代码示例,使用Matplotlib和Seaborn库。
通过这些思维导图和分析说明表,您可以更直观地理解和选择适合的数据可视化图表类型,帮助更有效地展示和分析数据。
105 8

热门文章

最新文章