Python 命令行之旅:使用 docopt 实现 git 命令
Python 命令行之旅:使用 docopt 实现 git 命令
原文发表于 Prodesire 博客。
一、前言
在前面两篇介绍 docopt
的文章中,我们全面了解了 docopt
的能力。按照惯例,我们要像使用 argparse
一样使用 docopt
来实现 git 命令。
为了让没读过 使用 argparse 实现 git 命令
的小伙伴也能读明白本文,我们仍会对 git 常用命令和 gitpython 做一个简单介绍。
本系列文章默认使用 Python 3 作为解释器进行讲解。 若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~
二、git 常用命令
当你写好一段代码或增删一些文件后,会用如下命令查看文件状态:
git status
确认文件状态后,会用如下命令将的一个或多个文件(夹)添加到暂存区:
git add [pathspec [pathspec ...]]
然后使用如下命令提交信息:
git commit -m "your commit message"
最后使用如下命令将提交推送到远程仓库:
git push
我们将使用 docopt
和 gitpython
库来实现这 4 个子命令。
三、关于 gitpython
gitpython 是一个和 git
仓库交互的 Python 第三方库。
我们将借用它的能力来实现真正的 git
逻辑。
安装:
pip install gitpython
四、思考
在实现前,我们不妨先思考下会用到 docopt
的哪些功能?整个程序的结构是怎样的?
docopt
不同于使用 argparse
时需要考虑嵌套解析器、各类参数等问题,在使用 docopt
只需将我们要实现的 git 命令用接口描述先定义清楚即可。
程序结构
程序结构上,除了开头处定义接口描述外,其余和使用 argparse
实现 git 命令的结构是一样的:
- 命令行程序需要一个
cli
函数来作为统一的入口,它负责构建解析器,并解析命令行参数 - 我们还需要四个
handle_xxx
函数响应对应的子命令
则基本结构如下:
import os import docopt from git.cmd import Git def cli(): """ git 命名程序入口 """ pass def handle_status(git): """ 处理 status 命令 """ pass def handle_add(git, pathspec): """ 处理 add 命令 """ pass def handle_commit(git, msg): """ 处理 -m <msg> 命令 """ pass def handle_push(git): """ 处理 push 命令 """ pass if __name__ == '__main__': cli()
下面我们将一步步地实现我们的 git
程序。
五、实现
假定我们在 docopt-git.py 文件中实现我们的 git
程序。
5.1 定义接口描述
根据我们的要求,可以很容易的定义出接口描述:
Usage: git status git add [<pathspec>...] git commit -m msg git push Options: -h --help Show help. -m --message msg Commit with message.
进而就可以在 cli()
中解析命令行:
def cli(): """ git 命名程序入口 """ args = docopt(__doc__) git = Git(os.getcwd())
5.2 status 子命令
如果 args['status']
为 True
,说明输入了 status 子命令,那么就调用 handle_status
函数进行处理。
def cli(): ... if args['status']: handle_status(git) def handle_status(git): """ 处理 status 命令 """ cmd = ['git', 'status'] output = git.execute(cmd) print(output)
不难看出,我们最后调用了真正的 git status
来实现,并打印了输出。
5.3 add 子命令
如果 args['add']
为 True
,说明输入了 add 子命令,那么就调用 handle_add
函数进行处理,需要传入 args['<pathspec>']
表示添加的路径。
def cli(): ... elif args['add']: handle_add(git, args['<pathspec>']) def handle_add(git, pathspec): """ 处理 add 命令 """ cmd = ['git', 'add'] + pathspec output = git.execute(cmd) print(output)
5.4 commit 子命令
如果 args['commit']
为 True
,说明输入了 commit 子命令,那么就调用 handle_commit
函数进行处理,需要传入 args['--message']
表示提交的信息。
def cli(): ... elif args['commit']: handle_commit(git, args['--message']) def handle_commit(git, msg): """ 处理 -m <msg> 命令 """ cmd = ['git', 'commit', '-m', msg] output = git.execute(cmd) print(output)
5.5 push 子命令
如果 args['push']
为 True
,说明输入了 commit 子命令,那么就调用 handle_push
函数进行处理。
def cli(): ... elif args['push']: handle_push(git) def handle_push(git): """ 处理 push 命令 """ cmd = ['git', 'push'] output = git.execute(cmd) print(output)
至此,我们就实现了一个简单的 git
命令行,使用 python docopt-git.py status
便可查询项目状态。
想看整个源码,请戳 docopt-git.py 。
六、小结
本文简单介绍了日常工作中常用的 git
命令,然后提出实现它的思路,最终一步步地使用 docopt
和 gitpython
实现了 git
程序。
对比 argparse
的实现版本,你会发现使用 docopt
来实现变得非常简单,子解析器、参数类型什么的统统不需要关心!这可以说是 docopt
最大的优势了。
关于 docopt
的讲解将告一段落,回顾下 docopt
的三步曲,加上今天的内容,感觉它的使用方式还是比 argparse
简单不少的。
现在,你已学会了两个命令行解析库的使用了。但你以为这就够了吗?
但人类的智慧是多么璀璨呀,有些人并不喜欢这两个库的使用方式,于是他们有开辟了一个全新的思路。
在下篇文章中,将为大家介绍一个在 Python 界十分流行的命令行库 —— click
。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
Python 命令行之旅:初探 docopt
Python 命令行之旅:初探 docopt 原文发表于 Prodesire 博客。 一、前言 在本系列前面四篇文章中,我们介绍了 argparse 的方方面面。它无疑是强大的,但使用方式上略显麻烦。需要先设置解析器,再定义参数,再解析命令行,最后实现业务逻辑。 而今天要介绍的 docopt 则是站在一个全新的视角来审视命令行。你可曾想过,一个命令行程序的帮助信息其实已然包含了这个命令行的完整元信息,那么是否可以通过定义帮助信息来定义命令行呢?docopt 就是基于这样的想法去设计的。 本系列文章默认使用 Python 3 作为解释器进行讲解。 若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~ 二、介绍 docopt 基于长久以来在帮助信息和手册中描述程序接口的约定,其接口描述是形式化的帮助信息。它能够根据命令行程序中定义的接口描述,来自动生成解析器。 三、快速开始 3.1 定义接口描述/帮助信息 第一步要做的就是命令行程序的定义接口描述或者是帮助信息,这样 docopt 就能知道命令行的元信息,从而自动解析。 接口描述通常定义在一个模块的文档字符串中,我们仍然以在...
- 下一篇
Python 命令行之旅:初探 click
Python 命令行之旅:初探 click 原文发表于 Prodesire 博客。 一、前言 在本系列前面几篇文章中,我们分别介绍了 argparse 和 docopt 的主要功能和用法。它们各具特色,都能出色地完成命令行任务。argparse 是面向过程的,需要先设置解析器,再定义参数,再解析命令行,最后实现业务逻辑。而 docopt 先用声明式的语法定义出参数,再过程式地解析命令行和实现业务逻辑。在一些人看来,这些方式都不够优雅。 而今天要介绍的 click 则是用一种你很熟知的方式来玩转命令行。命令行程序本质上是定义参数和处理参数,而处理参数的逻辑一定是与所定义的参数有关联的。那可不可以用函数和装饰器来实现处理参数逻辑与定义参数的关联呢?而 click 正好就是以这种方式来使用的。 本系列文章默认使用 Python 3 作为解释器进行讲解。 若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~ 二、介绍 click 是一个以尽可能少的代码、以组合的方式创建优美的命令行程序的 Python 包。它有很高的可配置性,同时也能开箱即用。 它旨在让编写命令行工具的过程既快...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- Docker安装Oracle12C,快速搭建Oracle学习环境
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- CentOS6,CentOS7官方镜像安装Oracle11G
- CentOS关闭SELinux安全模块
- CentOS7设置SWAP分区,小内存服务器的救世主
- CentOS7,CentOS8安装Elasticsearch6.8.6
- CentOS7编译安装Cmake3.16.3,解决mysql等软件编译问题
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装