argparse 使用指南
argparse是Python標準庫中推薦使用的命令行解析模塊,
其前身是optparse庫,從Python 2.7開始,optparse庫被棄用,
替代它的就是argparse庫,除此之外,標準庫中的getopt庫也提供了相似的功能。
一個命令行的工具應該滿足以下幾個要求:
命令可以不帶任何可選參數運行,即提供默認可選參數
可以提供指定可選參數覆蓋默認值
提供一小段幫助文檔,可以通過命令直接獲取
基本使用
首先從一個不帶任何參數的腳本開始,新建一個腳本,輸入以下內容:
# argtest1.py
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
# ----------------
# 測試腳本
# ----------------
# 直接執行命令沒有任何作用
$ python argtest1.py
# --help參數顯示基本用法
$ python argtest1.py --help
usage: argtest1.py [-h]
optional arguments:
-h, --help show this help message and exit
# 提供錯誤的可選參數
$ python argtest1.py --verbose
usage: argtest1.py [-h]
argtest1.py: error: unrecognized arguments: --verbose
# 提供錯誤的位置參數
$ python argtest1 foo
usage: argtest1.py [-h]
argtest1.py: error: unrecognized arguments: foo
從上面可以看出,argparse模塊提供了兩個個基本功能:
--help或-h參數顯示基本用法
對于錯誤的位置參數或可選參數給出提示
注:這里的位置參數就相當于函數中的位置參數和關鍵字參數
參數添加
為命令行工具添加參數可以使用ArgumentParser.add_argument方法,
然后可以在腳本中調用ArgumentParser.parse_args方法獲取腳本執行時設置的參數值
ArgumentParser.add_argument(name or flags...
[, action][, nargs][, const][, default][, type]
[, choices][, required][, help][, metavar][, dest])
函數原型如上,參數含義分別為(其中加粗的參數為將會涉及到的):
name or flags: 位置參數的名稱(如:foo)或可選參數的標識(如:-f, --foo)
action: 參數出現在命令行中所要執行的操作類型,可以理解為如何讀取參數
nargs: 當前參數可以從命令行中讀取幾個參數值,如為一個參數指定多個值
const: action或nargs所使用的一個常量值
default: 當參數在命令行中不存在時的默認值,注意,這里是不存在時的默認值,而不是沒有指定值時的默認值
type: 參數的數據類型,可以用來對命令行參數進行數據檢查,默認讀取的參數值都是字符串
choices: 參數的可選值列表
required: 參數是否必須,對于位置參數來說,默認為True,而可選參數默認值為False
help: 參數簡介,會在-h/--help指令下顯示出來
metavar: 在用法簡介幫助信息里的參數名稱
dest: 參數在ArgumentParser.parse_args方法返回值中的屬性名
接下來就來分別看一下位置參數與可選參數的使用方法
位置參數
# argtest2.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('square', help='計算給定值的平方值', type=int)
args = parser.parse_args()
print(args.square**2)
# ----------------
# 測試腳本
# ----------------
$ python argtest2.py -h
usage: argtest2.py [-h] square
positional arguments:
square 計算給定值的平方值
optional arguments:
-h, --help show this help message and exit
$ python argtest2.py 4
16
# 給出錯誤類型的參數
$ python argtest2.py four
usage: argtest2.py [-h] square
argtest2.py: error: argument square: invalid int value: 'four'
可選參數
# argtest3.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-v', '--verbose',
help='控制輸出的可見性', action='store_true')
args = parser.parse_args()
if args.verbose:
print('可見性打開')
# ----------------
# 測試腳本
# ----------------
$ python argtest3.py -v
可見性打開
$ python argtest3.py
添加可選參數的時候,可以提供一個短參數選項(-v)和一個長參數選項(--verbose),也可以省略短參數
action='store_true表示參數值儲存為True,即在命令行中提供參數時parser.parse_args獲取的參數值為True,否則為False
同時使用位置參數、可選參數
# argtest4.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('square', type=int, help="計算給定值的平方值")
parser.add_argument('-v', '--verbose', type=int, choices=[0, 1, 2],
default=0, help="如何顯示輸出結果")
args = parser.parse_args()
answer = args.square**2
if args.verbose >= 2:
print('{}的平方值是{}'.format(args.square, answer))
elif args.verbose >=1:
print('{}^2 = {}'.format(args.square, answer))
else:
print(answer)
# ----------------
# 測試腳本
# ----------------
$ python argtest4.py --help
usage: argtest4.py [-h] [-v {0,1,2}] square
positional arguments:
square 計算給定值的平方值
optional arguments:
-h, --help show this help message and exit
-v {0,1,2}, --verbose {0,1,2}
如何顯示輸出結果
$ python argtest4.py -v 0 4
16
$ python argtest4.py 4
16
$ python argtest4.py -v 1 4
4^2 = 16
$ python argtest4.py -v 2 4
4的平方值是16
沖突選項
有些選項的作用相反,不可以同時使用,為了加上這樣的限制,
可以使用ArgumentParser.add_mutually_exclusive_group方法
# argtest5.py
import argparse
parser = argparse.ArgumentParser(description='計算給定基數的冪')
group = parser.add_mutually_exclusive_group()
group.add_argument('-v', '--verbose', action='store_true')
group.add_argument('-q', '--quiet', action='store_true')
parser.add_argument('x', type=int, help='基數')
parser.add_argument('y', type=int, help='冪數')
args = parser.parse_args()
answer = args.x**args.y
if args.quiet:
print(answer)
elif args.verbose:
print('{}的{}次冪等于{}'.format(args.x, args.y, answer))
else:
print('{}^{} = {}'.format(args.x, args.y, answer))
# ----------------
# 測試腳本
# ----------------
$ python argtest5.py -h
usage: argtest5.py [-h] [-v | -q] x y
計算給定基數的冪
positional arguments:
x 基數
y 冪數
optional arguments:
-h, --help show this help message and exit
-v, --verbose
-q, --quiet
$ python argtest5.py 4 2
16
$ python argtest5.py 4 2 -q
16
$ python argtest5.py 4 2 -v
4的2次冪等于16
$ python argtest5.py 4 2 -qv
usage: argtest5.py [-h] [-v | -q] x y
argtest5.py: error: argument -v/--verbose: not allowed with argument -q/--quiet
參考鏈接: https://docs.python.org/3/howto/argparse.html
總結
以上是生活随笔為你收集整理的argparse 使用指南的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 银行现在都很缺钱吗,为什么给的利息比以前
- 下一篇: nRF52832之硬件I2C