Python中最好用的命令行參數解析工具

Python 作爲一個腳本語言，能夠很方便地寫各類工具。當你在服務端要運行一個工具或服務時，輸入參數彷佛是一種硬需（固然你也能夠經過配置文件來實現）。

若是要以命令行執行，那你須要解析一個命令行參數解析的模塊來幫你作這個苦力活。

Python 自己就提供了三個命令行參數解析模塊，我這裏羅列一下它們的大體狀況供你瞭解。

• getopt，只能簡單的處理命令行參數
• optparse，功能強大，易於使用，能夠方便地生成標準的、符合Unix/Posix 規範的命令行說明。
• argparse，使其更加容易的編寫用戶友好的命令行接口。它所需的程序進程了參數定義，argparse將更好的解析sys.argv。同時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, --help  show 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：一旦指定了 -d 或者 --debug ，其值就爲 True，store_false則相反
• default=False：未指定 -d 或者 --debug，其值就默認爲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 ~]# 
複製代碼

可選參數

有兩種方式：

1. 單下劃線 - 來指定的短參數，如-h；
2. 雙下劃線 -- 來指定的長參數，如--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 工具的使用方法，你學會了嗎？

---