Python 命令行之旅：使用 click 實現 git 命令
掃描二維碼
隨時隨地手機看文章
一、前言
在前面五篇介紹 click的文章中，我們全面了解了 click的強大能力。按照慣例，我們要像使用 argparse和 docopt一樣使用 click來實現 git 命令。
本文的關注點并不在 git的各種命令是如何實現的，而是怎么使用 click去打造一個實用命令行程序，代碼結構是怎樣的。因此，和 git相關的操作，將會使用 gitpython庫來簡單實現。
為了讓沒讀過 使用 xxx 實現 git 命令（xxx指 argparse和 docopt） 的小伙伴也能讀明白本文，我們仍會對 git常用命令和 gitpython做一個簡單介紹。
本系列文章默認使用 Python 3 作為解釋器進行講解。
若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~
二、git 常用命令
當你寫好一段代碼或增刪一些文件后，會用如下命令查看文件狀態(tài)：
git status
確認文件狀態(tài)后，會用如下命令將的一個或多個文件（夾）添加到暫存區(qū)：
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)
當我們執(zhí)行 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便可查詢項目狀態(tài)。
非常方便的是，每個命令函數的 docstring都將作為這個命令的幫助信息，因此，當我們執(zhí)行 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的實現版本，你會發(fā)現使用 click來實現變得特定簡單：
-
相較于 argparse，子解析器、參數類型什么的統統不需要關心
-
相較于 docopt，參數解析和命令調用處理也不需要關心
這無疑是 click最大的優(yōu)勢了。
關于 click的講解將告一段落，回顧下 click的至簡之道，你會愛上它。
現在，你已學會了三個命令行解析庫的使用了。但你以為這就夠了嗎？click已經夠簡單了吧，夠直接了吧？但它仍然不是最簡單的。
在下篇文章中，將為大家介紹一個由谷歌出品的在 Python 界很火的命令行庫 —— fire。
下載文檔
