Python 命令列之旅 —— 深入 argparse （一）
作者：HelloGitHub-Prodesire
HelloGitHub 的《講解開源專案》系列，專案地址：https://github.com/HelloGitHub-Team/Article
前言
在第一篇“初探 argparse”的文章中，我們初步掌握了使用 argparse 的四部曲，對它有了一個基本的體感。
但是它具體支援哪些型別的引數？這些引數該如何配置？本文將帶你深入瞭解 argparse 的引數們。
本系列文章預設使用 Python 3 作為直譯器進行講解。
若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~引數動作
你是否還記得？在上一篇四部曲中的第二步是定義引數，在這個步驟中，我們指定了 action
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the nums (default: find the max)')那麼這裡面的 action，也就是 引數動作，究竟是用來做什麼的呢？
想象一下，當我們在命令列輸入一串引數後，對於不同型別的引數是希望做不同的處理的。
那麼 引數動作 其實就是告訴解析器，我們希望對應的引數該被如何處理。比如，引數值是該被存成一個值呢，還是追加到一個列表中？是當成布林的 True 呢，還是 False？
引數動作 被分成了如下 8 個類別：
store—— 儲存引數的值，這是預設的引數動作。它通常用於給一個引數指定值，如指定名字：
>>> parser.add_argument('--name')
>>> parser.parse_args(['--name', 'Eric'])
Namespace(name='Eric')store_const—— 儲存被const命名的固定值。當我們想通過是否給定引數來起到標誌的作用，給定就取某個值，就可以使用該引數動作，如：
>>> parser.add_argument('--sum', action='store_const', const=sum) >>> parser.parse_args(['--sum']) Namespace(sum=<built-in function sum>) >>> parser.parse_args([]) Namespace(sum=None)
store_true和store_false—— 是store_const的特殊情況，用來分別儲存 True 和 False。如果為指定引數，則其預設值分別為 False 和 True，如：
>>> parser.add_argument('--use', action='store_true')
>>> parser.add_argument('--nouse', action='store_false')
>>> parser.parse_args(['--use', '--nouse'])
Namespace(nouse=False, use=True)
>>> parser.parse_args([])
Namespace(nouse=True, use=False)append—— 將引數值追加儲存到一個列表中。它常常用於命令列中允許多個相同選項，如：
>>> parser.add_argument('--file', action='append')
>>> parser.parse_args(['--file', 'f1', '--file', 'f2'])
Namespace(file=['f1', 'f2'])append_const—— 將const命名的固定值追加儲存到一個列表中（const的預設值為None）。它常常用於將多個引數所對應的固定值都儲存在同一個列表中，相應的需要dest入參來配合，以放在同一個列表中，如：
不指定 dest 入參，則固定值儲存在以引數名命名的變數中
>>> parser.add_argument('--int', action='append_const', const=int)
>>> parser.add_argument('--str', action='append_const', const=str)
>>> parser.parse_args(['--int', '--str'])
Namespace(int=[<class 'int'>], str=[<class 'str'>])指定 dest 入參，則固定值儲存在 dest 命名的變數中
>>> parser.add_argument('--int', dest='types', action='append_const', const=int)
>>> parser.add_argument('--str', dest='types', action='append_const', const=str)
>>> parser.parse_args(['--int', '--str'])
Namespace(types=[<class 'int'>, <class 'str'>])count—— 計算引數出現次數，如：
>>> parser.add_argument('--increase', '-i', action='count')
>>> parser.parse_args(['--increas', '--increase'])
Namespace(increase=2)
>>>parser.parse_args(['-iii'])
Namespace(increase=3)help—— 列印解析器中所有選項和引數的完整幫助資訊，然後退出。version—— 列印命令列版本，通過指定version入參來指定版本，呼叫後退出。如：
>>> parser = argparse.ArgumentParser(prog='CMD')
>>> parser.add_argument('--version', action='version', version='%(prog)s 1.0')
>>> parser.parse_args(['--version'])
CMD 1.0引數類別
如果說 引數動作 定義瞭解析器在接收到引數後該如何處理引數，那麼 引數類別 就是告訴解析器這個引數的元資訊，也就是引數是什麼樣的。比如，引數是字串呢？還是布林型別呢？引數是在幾個值中可選的呢？還是可以給定值，等等。
下面，我們將逐一介紹不同型別的引數。
可選引數
可選引數 顧名思義就是引數是可以加上，或不加上。預設情況下，通過 ArgumentParser.add_argument 新增的引數就是可選引數。
我們可以通過 - 來指定短引數，也就是名稱短的引數；也可以通過 -- 來指定長引數，也就是名稱長的引數。當然也可以兩個都指定。
可選引數通常用於：使用者提供一個引數以及對應值，則使用該值；若不提供，則使用預設值。如：
>>> parser.add_argument('--name', '-n')
>>> parser.parse_args(['--name', 'Eric']) # 通過長引數指定名稱
Namespace(name='Eric')
>>> parser.parse_args(['-n', 'Eric']) # 通過短引數指定名稱
Namespace(name='Eric')
>>> parser.parse_args([]) # 不指定則預設為 None
Namespace(name=None)引數型別
引數型別 就是解析器引數值是要作為什麼型別去解析，預設情況下是 str 型別。我們可以通過 type 入參來指定引數型別。
argparse 所支援的引數型別多種多樣，可以是 int、float、bool等，比如：
>>> parser.add_argument('-i', type=int)
>>> parser.add_argument('-f', type=float)
>>> parser.add_argument('-b', type=bool)
>>> parser.parse_args(['-i', '1', '-f', '2.1', '-b', '0'])
Namespace(b=False, f=2.1, i=1)更厲害的是，type 入參還可以是可呼叫(callable)物件。這就給了我們很大的想象空間，可以指定 type=open 來把引數值作為檔案進行處理，也可以指定自定義函式來進行型別檢查和型別轉換。
作為檔案進行處理：
>>> parser.add_argument('--file', type=open)
>>> parser.parse_args(['--file', 'README.md'])
Namespace(b=None, f=None, file=<_io.TextIOWrapper name='README.md' mode='r' encoding='cp936'>, i=None)使用自定義函式進行處理，入參為引數值，需返回轉換後的結果。
比如，對於引數 --num，我們希望當其值小於 1 時則返回 1，大於 10 時則返回 10：
>>> def limit(string):
... num = int(string)
... if num < 1:
... return 1
... if num > 10:
... return 10
... return num
...
>>> parser.add_argument('--num', type=limit)
>>> parser.parse_args(['--num', '-1']) # num 小於1，則取1
Namespace(num=1)
>>> parser.parse_args(['--num', '15']) # num 大於10，則取10
Namespace(num=10)
>>> parser.parse_args(['--num', '5']) # num 在1和10之間，則取原來的值
Namespace(num=5)引數預設值
引數預設值 用於在命令列中不傳引數值的情況下的預設取值，可通過 default 來指定。如果不指定該值，則引數預設值為 None。
比如：
>>> parser.add_argument('-i', default=0, type=int)
>>> parser.add_argument('-f', default=3.14, type=float)
>>> parser.add_argument('-b', default=True, type=bool)
>>> parser.parse_args([])
Namespace(b=True, f=3.14, i=0)位置引數
位置引數 就是通過位置而非是 - 或 -- 開頭的引數來指定引數值。
比如，我們可以指定兩個位置引數 x 和 y ，先新增的 x 位於第一個位置，後加入的 y 位於第二個位置。那麼在命令列中輸入 1 2的時候，分別對應到的就是 x 和 y：
>>> parser.add_argument('x')
>>> parser.add_argument('y')
>>> parser.parse_args(['1', '2'])
Namespace(x='1', y='2')可選值
可選值 就是限定引數值的內容，通過 choices 入參指定。
有些情況下，我們可能需要限制使用者輸入引數的內容，只能在預設的幾個值中選一個，那麼 可選值 就派上了用場。
比如，指定檔案讀取方式限制為 read-only 和 read-write：
>>> parser.add_argument('--mode', choices=('read-only', 'read-write'))
>>> parser.parse_args(['--mode', 'read-only'])
Namespace(mode='read-only')
>>> parser.parse_args(['--mode', 'read'])
usage: [-h] [--mode {read-only,read-write}]
: error: argument --mode: invalid choice: 'read' (choose from 'read-only', 'read-write')互斥引數
互斥引數 就是多個引數之間彼此互斥，不能同時出現。使用互斥引數首先通過 ArgumentParser.add_mutually_exclusive_group 在解析器中新增一個互斥組，然後在這個組裡新增引數，那麼組內的所有引數都是互斥的。
比如，我們希望通過命令列來告知乘坐的交通工具，要麼是汽車，要麼是公交，要麼是自行車，那麼就可以這麼寫：
>>> group = parser.add_mutually_exclusive_group()
>>> group.add_argument('--car', action='store_true')
>>> group.add_argument('--bus', action='store_true')
>>> group.add_argument('--bike', action='store_true')
>>> parser.parse_args([]) # 什麼都不乘坐
Namespace(bike=False, bus=False, car=False)
>>> parser.parse_args(['--bus']) # 乘坐公交
Namespace(bike=False, bus=True, car=False)
>>> parser.parse_args(['--bike']) # 騎自行車
Namespace(bike=True, bus=False, car=False)
>>> parser.parse_args(['--bike', '--car']) # 又想騎車，又想坐車，那是不行的
usage: [-h] [--car | --bus | --bike]
: error: argument --car: not allowed with argument --bike可變引數列表
可變引數列表 用來定義一個引數可以有多個值，且能通過 nargs 來定義值的個數。
若 nargs=N，N為一個數字，則要求該引數提供 N 個值，如：
>>> parser.add_argument('--foo', nargs=2)
>>> print(parser.parse_args(['--foo', 'a', 'b']))
Namespace(foo=['a', 'b'])
>>> print(parser.parse_args(['--foo', 'a', 'b', 'c']))
usage: [-h] [--foo FOO FOO]
: error: unrecognized arguments: c若 nargs=?，則要求改引數提供 0 或 1 個值，如：
>>> parser.add_argument('--foo', nargs='?')
>>> parser.parse_args(['--foo'])
Namespace(foo=None)
>>> parser.parse_args(['--foo', 'a'])
Namespace(foo='a')
>>> parser.parse_args(['--foo', 'a', 'b'])
usage: [-h] [--foo [FOO]]
: error: unrecognized arguments: b若 nargs=*，則要求改引數提供 0 或多個值，如：
>>> parser.add_argument('--foo', nargs='*')
>>> parser.parse_args(['--foo'])
Namespace(foo=[])
>>> parser.parse_args(['--foo', 'a'])
Namespace(foo=['a'])
>>> parser.parse_args(['--foo', 'a', 'b', 'c', 'd', 'e'])
Namespace(foo=['a', 'b', 'c', 'd', 'e'])若 nargs=?，則要求改引數至少提供 1 個值，如：
>>> parser.add_argument('--foo', nargs='+')
>>> parser.parse_args(['--foo', 'a'])
Namespace(foo=['a'])
>>> parser.parse_args(['--foo'])
usage: [-h] [--foo FOO [FOO ...]]
: error: argument --foo: expected at least one argument小節
在瞭解了引數動作和引數類別後，是不是漸漸開始對使用 argparse 胸有成竹了呢？至少，用現在學到的知識來完成簡單的命令列工具已經不再話下了。
在下一篇文章中，我們來繼續深入瞭解 argparse 的功能，如何修改引數字首，如何定義引數組，如何定義巢狀的解析器，如何編寫自定義動作等，讓我們拭目以待吧~
歡迎關注 HelloGitHub 公眾號，獲取更多開源專案的資料和內容
『講解開源專案系列』啟動——讓對開源專案感興趣的人不再畏懼、讓開源專案的發起者不再孤單。跟著我們的文章，你會發現程式設計的樂趣、使用和發現參與開源專案如此簡單。歡迎聯絡我們給我們投稿，讓更多人愛上開源、貢獻開源