腳本之家服務器常用軟件

快捷導航

Python中最好用的命令行參數(shù)解析工具(argparse)

更新時間：2019年08月23日 09:31:06 作者：Python編程時光

這篇文章主要介紹了Python中最好用的命令行參數(shù)解析工具(argparse)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

Python 做為一個腳本語言，可以很方便地寫各種工具。當你在服務端要運行一個工具或服務時，輸入?yún)?shù)似乎是一種硬需（當然你也可以通過配置文件來實現(xiàn)）。

如果要以命令行執(zhí)行，那你需要解析一個命令行參數(shù)解析的模塊來幫你做這個苦力活。

Python 本身就提供了三個命令行參數(shù)解析模塊，我這里羅列一下它們的大致情況供你了解。

getopt，只能簡單的處理命令行參數(shù)
optparse，功能強大，易于使用，可以方便地生成標準的、符合Unix/Posix 規(guī)范的命令行說明。
argparse，使其更加容易的編寫用戶友好的命令行接口。它所需的程序進程了參數(shù)定義，argparse將更好的解析sys.argv。同時argparse模塊還能自動生成幫助及用戶輸入錯誤參數(shù)時的提示信息。

很多初學者可能會使用getopt，上手簡單功能也簡單。比如說optget無法解析一個參數(shù)多個值的情況，如 --file file1 file2 file3，而 optparse 實際上我沒有用過，但是考慮到它在Python2.7后就已經(jīng)棄用不再維護，我們通常也不會使用它。

接下來只剩下 argparse 這一神器，它幾乎能滿足我對命令解析器的所有需求。它支持解析一參數(shù)多值，可以自動生成help命令和幫助文檔，支持子解析器，支持限制參數(shù)取值范圍等等功能。

0. HelloWorld

不管學習什么東西，首先第一步都應該是掌握它的大體框架。

而使用 argparse 前，框架很簡單，你只需要記住這三行。

# mytest.py
import argparse
parser = argparse.ArgumentParser(description="used for test")

args = parser.parse_args()

現(xiàn)在可以嘗試一下

[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 ~]#

已經(jīng)可以使用了。

1. 入門配置

這里先講一下，比較常用的參數(shù)配置。

調(diào)試：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 的作用和區(qū)別

store_true：一旦指定了 -d 或者 --debug ，其值就為 True，store_false則相反
default=False：未指定 -d 或者 --debug，其值就默認為False

當我們執(zhí)行 python mytest.py -v，就會打印 version 里的內(nèi)容。

[root@localhost ~]# python mytest.py -v
mytest.py version : v 0.01
[root@localhost ~]#

一旦執(zhí)行時，指定了參數(shù) -v ，執(zhí)行到 parser.parse_args() 就會退出程序，不會打印最后的 === end ===

2. 參數(shù)種類

參數(shù)可分為必選參數(shù)（positional arguments）和可選參數(shù)（optional arguments）。

在argsparse 里如何實現(xiàn)呢？

必選參數(shù)

用單詞做參數(shù)，默認就為必選參數(shù)

# mytest.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("name")

args = parser.parse_args()

print(args.name)

不指定name參數(shù)運行一下：python mytest.py

[root@localhost ~]# python mytest.py 
usage: mytest.py [-h] name
mytest.py: error: too few arguments
[root@localhost ~]#

如預期一樣，報錯了，說缺少參數(shù)。那我們指定一下：python mytest.py name wangbm

[root@localhost ~]# python mytest.py wangbm
wangbm
[root@localhost ~]#

可選參數(shù)

有兩種方式：

單下劃線 - 來指定的短參數(shù)，如-h；
雙下劃線 -- 來指定的長參數(shù)，如--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. 參數(shù)類型

有的參數(shù)，是字符串，有的參數(shù)，是數(shù)值。

為了對命令行中的參數(shù)進行有效的約束，我們可以事先對參數(shù)的類型進行聲明。argparse 會對參數(shù)進行校驗，不通過時，會直接拋出錯誤。

# 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. 互斥參數(shù)

有些參數(shù)，是互斥的，有你無我。比如，性別。

在 argparse 中如何實現(xiàn)？

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()

如果同時指定了這兩個參數(shù)，就會報錯。

[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. 可選值

如果是性別，可以像上面那樣放在兩個參數(shù)里然后用互斥組來約束，也可以放在一個參數(shù)里，在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)

試著執(zhí)行一下，發(fā)現(xiàn)性別只能是男或女，不能為人妖。

[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. 指定文件

經(jīng)常會有那種要在腳本中指定配置文件或者其他文件的需求?？梢允褂孟旅娴呐渲?br />

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 的參數(shù)值賦值給變量files，你可以用args.files訪問。

action=append，由于我們會有指定多個文件的需求，那就指定多次--file ，argparse會將其放在一個list里。

type=argparse.FileType('rb')，既然是指定文件，那么參數(shù)應該為路徑，并指定打開模式為rb，如果如果要取得文件內(nèi)容，可以用 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 函數(shù)。
parser_single.set_defaults(action=('single', main_single))

# require=True，是說如果命令行指定了single解析器，就必須帶上 --name 的參數(shù)。
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)

執(zhí)行命令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

以上就是關(guān)于 argparse 工具的使用方法，你學會了嗎？希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: