Python中最好用的命令列引數解析工具
Python 做為一個指令碼語言，可以很方便地寫各種工具。當你在服務端要執行一個工具或服務時，輸入引數似乎是一種硬需（當然你也可以通過配置檔案來實現）。
如果要以命令列執行，那你需要解析一個命令列引數解析的模組來幫你做這個苦力活。
Python 本身就提供了三個命令列引數解析模組，我這裡羅列一下它們的大致情況供你瞭解。
getopt optparse argparse
很多初學者可能會使用 getopt ，上手簡單功能也簡單。比如說 optget 無法解析一個引數多個值的情況，如 --file file1 file2 file3 ，而 optparse 實際上我沒有用過，但是考慮到它在Python2.7後就已經棄用不再維護，我們通常也不會使用它。
接下來只剩下 argparse 這一神器，它幾乎能滿足我對命令解析器的所有需求。它支援解析一引數多值，可以自動生成help命令和幫助文件，支援子解析器，支援限制引數取值範圍等等功能。
0. HelloWorld
不管學習什麼東西，首先第一步都應該是掌握它的大體框架。
而 使用 argparse 前，框架很簡單，你只需要記住這三行。
# mytest.py import argparse parser = argparse.ArgumentParser(description="used for test") args = parser.parse_args() 複製程式碼
現在可以嘗試一下
[root@localhost ~]# python mytest.py -h usage: mytest.py [-h] used for test optional arguments: -h, --helpshow this help message and exit [root@localhost ~]# [root@localhost ~]# [root@localhost ~]# python mytest.py [root@localhost ~]# 複製程式碼
已經可以使用了。
1. 入門配置
這裡先講一下，比較常用的引數配置。
- 除錯：debug
- 版本號：version
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--version', '-v', action='version',
version='%(prog)s version : v 0.01', help='show the version')
parser.add_argument('--debug', '-d', action='store_true',
help='show the version',
default=False)
args = parser.parse_args()
print("=== end ===")
複製程式碼
上面debug處的配置，需要講一下的是 action='store_true' 和 default = False 的作用和區別
store_true default=False
當我們執行 python mytest.py -v ，就會列印 version 裡的內容。
[root@localhost ~]# python mytest.py -v mytest.py version : v 0.01 [root@localhost ~]# 複製程式碼
一旦執行時，指定了引數 -v ，執行到 parser.parse_args() 就會退出程式，不會列印最後的 === end ===
2. 引數種類
引數可分為 必選引數（positional arguments） 和 可選引數（optional arguments）。
在argsparse 裡如何實現呢？
必選引數
用單詞做引數，預設就為必選引數
# mytest.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("name")
args = parser.parse_args()
print(args.name)
複製程式碼
不指定name引數執行一下： python mytest.py
[root@localhost ~]# python mytest.py usage: mytest.py [-h] name mytest.py: error: too few arguments [root@localhost ~]# 複製程式碼
如預期一樣，報錯了，說缺少引數。那我們指定一下： python mytest.py name wangbm
[root@localhost ~]# python mytest.py wangbm wangbm [root@localhost ~]# 複製程式碼
可選引數
有兩種方式：
- 單下劃線 - 來指定的短引數，如
-h； - 雙下劃線
--來指定的長引數，如--help
# mytest.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
print("verbosity turned on")
else:
print("verbosity turned off")
複製程式碼
試著執行一下 python mytest.py ，不會報錯。
[root@localhost ~]# python mytest.py verbosity turned off [root@localhost ~]# 複製程式碼
3. 引數型別
有的引數，是字串，有的引數，是數值。
為了對命令列中的引數進行有效的約束，我們可以事先對引數的型別進行宣告。argparse 會對引數進行校驗，不通過時，會直接丟擲錯誤。
# mytest.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("age", type=int)
args = parser.parse_args()
print(args.name)
print(args.age)
複製程式碼
測試一下唄。
[root@localhost ~]# python mytest.py wangbm eighteen usage: mytest.py [-h] name age mytest.py: error: argument age: invalid int value: 'eighteen' [root@localhost ~]# [root@localhost ~]# python mytest.py wangbm 18 wangbm 18 [root@localhost ~]# 複製程式碼
你看，寫 eighteen 就不行，提示型別不合法，只有寫 18 才行。
4. 互斥引數
有些引數，是互斥的，有你無我。比如，性別。
在 argparse 中如何實現？
import argparse
parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-m", "--male", action="store_true")
group.add_argument("-f", "--female", action="store_true")
args = parser.parse_args()
複製程式碼
如果同時指定了這兩個引數，就會報錯。
[root@localhost ~]# python mytest.py -f [root@localhost ~]# python mytest.py -m [root@localhost ~]# python mytest.py -m -f usage: mytest.py [-h] [-m | -f] mytest.py: error: argument -f/--female: not allowed with argument -m/--male [root@localhost ~]# 複製程式碼
5. 可選值
如果是性別，可以像上面那樣放在兩個引數裡然後用互斥組來約束，也可以放在一個引數裡，在argparse裡限制再在外層做判斷。
# mytest.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-g", "--gender", default='male',
choices=['male', 'female'])
args = parser.parse_args()
print(args.gender)
複製程式碼
試著執行一下，發現性別只能是男或女，不能為人妖。
[root@localhost ~]# python mytest.py --gender male
male
[root@localhost ~]# python mytest.py --gender female
female
[root@localhost ~]#
[root@localhost ~]#
[root@localhost ~]# python mytest.py --gender other
usage: mytest.py [-h] [-g {male,female}]
mytest.py: error: argument -g/--gender: invalid choice: 'other' (choose from 'male', 'female')
[root@localhost ~]#
複製程式碼
6. 指定檔案
經常會有那種要在指令碼中指定配置檔案或者其他檔案的需求。可以使用下面的配置
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--file', '-f', action='append',
dest='files',
help=('additional yaml configuration files to use'),
type=argparse.FileType('rb'))
args = parser.parse_args()
複製程式碼
dest=files ，是說將命令列中， --file 的引數值賦值給變數files，你可以用args.files訪問。
action=append ，由於我們會有指定多個檔案的需求，那就指定多次 --file ，argparse會將其放在一個list裡。
type=argparse.FileType('rb') ，既然是指定檔案，那麼引數應該為路徑，並指定開啟模式為rb，如果如果要取得檔案內容，可以用 args.files[0].read()
7. 子解析器
如果你對命令列，有過足夠多的接觸，就會知道有些情況下會有子解析器。
這裡我以自己工作中，碰到的例子來舉個例子。
cloud-init --debug single -name mymodule 複製程式碼
其中 single 後面是一個子解析器。
# cloud-init.py
def main_single(name, args):
print("name: ", name)
print("args: ", args)
print("I am main_single")
# 新增一個子解析器
subparsers = parser.add_subparsers()
parser_single = subparsers.add_parser('single',help='run a single module')
# 對single 子解析器新增 action 函式。
parser_single.set_defaults(action=('single', main_single))
# require=True，是說如果命令列指定了single解析器，就必須帶上 --name 的引數。
parser_single.add_argument("--name", '-n', action="store",
help="module name to run",
required=True)
args = parser.parse_args()
(name, functor) = args.action
if name in ["single"]:
functor(name, args)
複製程式碼
執行命令 cloud-init single -name mymodule ，輸出如下
name:single
args:Namespace(action=('single', <function main_single at 0x0000000003F161E0>), debug=False, file=None, name='mymodule')
I am main_single
複製程式碼
以上就是關於 argparse 工具的使用方法，你學會了嗎？
