技术咨询
代买器件
商务客服
研发客服一、前言
在前面五篇介绍 click的文章中，我们全面了解了 click的强大能力。按照惯例，我们要像使用 argparse和 docopt一样使用 click来实现 git 命令。
本文的关注点并不在 git的各种命令是如何实现的，而是怎么使用 click去打造一个实用命令行程序，代码结构是怎样的。因此，和 git相关的操作，将会使用 gitpython库来简单实现。
为了让没读过 使用 xxx 实现 git 命令（xxx指 argparse和 docopt） 的小伙伴也能读明白本文，我们仍会对 git常用命令和 gitpython做一个简单介绍。
本系列文章默认使用 Python 3 作为解释器进行讲解。
若你仍在使用 Python 2，请注意两者之间语法和库的使用差异哦~
二、git 常用命令
当你写好一段代码或增删一些文件后，会用如下命令查看文件状态：
git status
确认文件状态后，会用如下命令将的一个或多个文件（夹）添加到暂存区：
git add [pathspec [pathspec ...]]
然后使用如下命令提交信息：
git commit -m "your commit message"
最后使用如下命令将提交推送到远程仓库：
git push
我们将使用 click和 gitpython库来实现这 4 个子命令。
三、关于 gitpython
gitpython 是一个和 git 仓库交互的 Python 第三方库。我们将借用它的能力来实现真正的 git 逻辑。
安装：
pip install gitpython
四、思考
在实现前，我们不妨先思考下会用到 click的哪些功能？整个程序的结构是怎样的？
click
git的 4 个子命令的实现其实对应于四个函数，每个函数使用 click的 command来装饰。而对于 git add和 git commit，则分别需要表示参数的 click.argument和表示选项的 click.option来装饰。
程序结构
程序结构上：
-
实例化 Git对象，供全局使用
-
定义 cli函数作为命令组，也就是整个命令程序的入口
-
定义四个命令对应的实现函数 status、add、commit、push
则基本结构如下：
import os import click from git.cmd import Git
git = Git(os.getcwd()) @click.group() def cli(): """
git 命令行
""" pass @cli.command() def status(): """
处理 status 命令
""" pass @cli.command() @click.argument('pathspec', nargs=-1) def add(pathspec): """
处理 add 命令
""" pass @cli.command() @click.option('-m', 'msg') def commit(msg): """
处理 -m命令
""" pass @cli.command() def push(): """
处理 push 命令
""" pass if __name__ == '__main__':
cli()
下面我们将一步步地实现我们的 git程序。
五、实现
假定我们在 click-git.py 文件中实现我们的 git程序。
5.1 status 子命令
status子命令不接受任何参数和选项，因此其实现函数只需 cli.command()装饰。
@cli.command() def status(): """
处理 status 命令
""" cmd = ['git', 'status']
output = git.execute(cmd)
click.echo(output)
不难看出，我们最后调用了真正的 git status来实现，并打印了输出。
5.2 add 子命令
add子命令相对于 status子命令，需要接受任意个 pathspec 参数，因此增加一个 click.argument装饰器，并且在 add函数中需要增加同名的 pathspec入参。经 click处理后的 pathspec其实是个元组，和列表相加前，需要先转换为列表。
@cli.command() @click.argument('pathspec', nargs=-1) def add(pathspec): """
处理 add 命令
""" cmd = ['git', 'add'] + list(pathspec)
output = git.execute(cmd)
click.echo(output)
当我们执行 python3 click-git.py add --help时，结果如下：
Usage: click-git.py add [OPTIONS] [PATHSPEC]...
处理 add 命令
Options:
--help Show this message and exit.
既然 git add能接受任意多个 pathspec，那么 add(pathspec)的参数其实改为复数形式更为合适，但我们又希望帮助信息中是单数形式，这就需要额外指定 metavar，则有：
@cli.command() @click.argument('pathspecs', nargs=-1, metavar='[PATHSPEC]...') def add(pathspecs): """
处理 add 命令
""" cmd = ['git', 'add'] + list(pathspecs)
output = git.execute(cmd)
click.echo(output)
5.3 commit 子命令
add子命令相对于 status子命令，需要接受 -m选项，因此增加一个 click.option装饰器，指定选项名称 msg，并且在 commit函数中增加同名入参。
@cli.command() @click.option('-m', 'msg') def commit(msg): """
处理 -m命令
""" cmd = ['git', 'commit', '-m', msg]
output = git.execute(cmd)
click.echo(output)
5.4 push 子命令
push子命令同 status子命令一样，不接受任何参数和选项，因此其实现函数只需 cli.command()装饰。
@cli.command() def push(): """
处理 push 命令
""" cmd = ['git', 'push']
output = git.execute(cmd)
click.echo(output)
至此，我们就实现了一个简单的 git命令行，使用 python click-git.py status便可查询项目状态。
非常方便的是，每个命令函数的 docstring都将作为这个命令的帮助信息，因此，当我们执行 python3 click-git.py --help会自动生成如下帮助内容：
Usage: click-git.py [OPTIONS] COMMAND [ARGS]...
git 命令行
Options:
--help Show this message and exit.
Commands:
add 处理 add 命令
commit 处理 -m命令
push 处理 push 命令
status 处理 status 命令
想看整个源码，请戳 click-git.py 。
六、小结
本文简单介绍了日常工作中常用的 git命令，然后提出实现它的思路，最终一步步地使用 click和 gitpython实现了 git程序。
对比 argparse和 click的实现版本，你会发现使用 click来实现变得特定简单：
-
相较于 argparse，子解析器、参数类型什么的统统不需要关心
-
相较于 docopt，参数解析和命令调用处理也不需要关心
这无疑是 click最大的优势了。
关于 click的讲解将告一段落，回顾下 click的至简之道，你会爱上它。
现在，你已学会了三个命令行解析库的使用了。但你以为这就够了吗？click已经够简单了吧，够直接了吧？但它仍然不是最简单的。
文章来源于:21IC 原文链接
本站所有转载文章系出于传递更多信息之目的，且明确注明来源，不希望被转载的媒体或个人可与我们联系，我们将立即进行删除处理。
相关文章
单片机STM32可以用python写吗？可以的开发板有哪些？(2023-03-14)
器和库
要想单片机能够支持Python语言进行开发，需要有适用于单片机的Python解释器和库。
例如，MicroPython就是一种专为微控制器设计的Python解释器，适用于一些高端单片机。
4.适当的工具......
盘点那些常见的单片机编程框架！(2023-03-24)
成了代码生成器、配置工具和性能分析器等工具。STM32Cube支持多种编程语言，包括C、C++和Python。
3. PlatformIO
PlatformIO是一个跨平台的开源IDE，支持多种单片机开发板和编程......
泰克重新设计混合信号示波器(2024-01-10)
包括随着用户开始采用自动化和远程访问，拥抱并满足这一趋势，以及满足他们在编程方面的所有需求，无论是 Python 还是 SCPI。
其他功能包括多达六个输入通道，使其非常适合三相功率分析，以及独特的 Spectrum......
Altair推出 Altair RapidMiner 2023 平台，提供生成式 AI 功能(2023-12-05 09:52)
编程功能等
将 LLM（大语言模型） 集成到业务应用程序的全新工具Altair RapidMiner内置提供生成式 AI 功能，用户能够简化工作流程并使用自己的数据构建像 ChatGPT 等独......
STM32常用的一些开发工具汇总(2023-06-06)
：
Eclipse
VS Code GCC 顺便推荐几款非常优秀且常用的代码编辑器。
关于IDE，可以参看：开发单片机的常见IDE有哪些？
下载编程工具
针对STM32的下载编程工具很多，有官方的工具......
《HelloGitHub》第 45 期(2024-12-13)
新手、热爱编程、对开源社区感兴趣 人群的月刊，月刊的内容包括：各种编程语言的项目、让生活变得更美好的工具、书籍、学习笔记、教程等，这些开源项目大多都是非常容易上手，而且非常 Cool。主要......
Python又登顶了，它能成为嵌入式未来吗？(2023-09-04)
Python又登顶了，它能成为嵌入式未来吗？;8月29日，IEEE Spectrum发布2023年顶级编程语言排行榜，在排行中，Python愈加拥有统治地位，一度成为嵌入式的得力竞争者，嵌入......
STM32常用的开发工具有哪些(2022-12-15)
://code.visualstudio.com/
下载编程工具
针对STM32的下载编程工具很多，有官方的工具，也有第三方的工具，同时有硬件工具，也有软件工具。
硬件：下载器
能对STM32下载程序的下载器，还是主推官方的ST-Link......
STM32常用的一些开发工具(2024-03-22)
参看：开发单片机的常见IDE有哪些？
下载编程工具
针对STM32的下载编程工具很多，有官方的工具，也有第三方的工具，同时有硬件工具，也有软件工具。
硬件：下载器
能对STM32下载程序的下载器，还是......
英特尔亮剑，加速创新拥抱开发者(2021-10-30)
Catalog），其中包含英特尔关键软件产品，以及一个优化的英特尔 DevCloud开发环境，用于测试和运行在各类英特尔最新硬件（包括CPU、图形处理器（GPU）、现场可编程逻辑门阵列（FPGA）和加速器）的工作负载和多种软件工具......