HelloGitHub 的《讲解开源项目》系列，项目地址：https://github.com/HelloGitHub-Team/Article

前言

在前面三篇介绍 argparse 的文章中，我们全面了解了 argparse 的能力，相信不少小伙伴们都已经摩拳擦掌，想要打造一个属于自己的命令行工具。

本文将以我们日常工作中最常见的 git 命令为例，讲解如何使用 argparse 库来实现一个真正可用的命令行程序。

本系列文章默认使用 Python 3 作为解释器进行讲解。 若你仍在使用 Python 2，请注意两者之间语法和库的使用差异哦~

git 常用命令

大家不妨回忆一下，平时最常使用 git 子命令都有哪些？

当你写好一段代码或增删一些文件后，会用如下命令查看文件状态：

git status

确认文件状态后，会用如下命令将的一个或多个文件（夹）添加到暂存区：

git add [pathspec [pathspec ...]]

然后使用如下命令提交信息：

git commit -m "your commit message"

最后使用如下命令将提交推送到远程仓库：

git push

我们将使用 argparse 和 gitpython 库来实现这 4 个子命令。

关于 gitpython

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

安装：

pip install gitpython

思考

在实现前，我们不妨先思考下会用到 argparse 的哪些功能？整个程序的结构是怎样的？

argparse

• 要实现子命令，那么之前介绍到的 嵌套解析器 必不可少
• 当用户键入子命令时，子命令所对应的子解析器需要作出响应，那么需要用到子解析器的 set_defaults 功能
• 针对 git add [pathspec [pathspec ...]]，我们需要实现位置参数，而且数量是任意个
• 针对 git commit --message msg 或 git commit -m msg，我们需要实现选项参数，且即可长选项，又可短选项

程序结构

• 命令行程序需要一个 cli 函数来作为统一的入口，它负责构建解析器，并解析命令行参数
• 我们还需要四个 handle_xxx 函数响应对应的子命令

则基本结构如下：