本教程旨在簡(jiǎn)要介紹Python標(biāo)準(zhǔn)庫(kù)中推薦的命令行解析模塊
Argparse教程
argparse是Python內(nèi)置的一個(gè)用于命令項(xiàng)選項(xiàng)與參數(shù)解析的模塊解总，通過在程序中定義好我們需要的參數(shù)，argparse 將會(huì)從sys.argv中解析出這些參數(shù)姐仅，并自動(dòng)生成幫助和使用信息花枫。
基礎(chǔ)
讓我們從一個(gè)簡(jiǎn)單的例子開始，這個(gè)例子沒有進(jìn)行添加參數(shù)：
import argparse #導(dǎo)入模塊
parser = argparse.ArgumentParser() #創(chuàng)建對(duì)象
parser.parse_args() #解析添加的參數(shù)
#測(cè)試結(jié)果
E:\vscode\test>python test_2.py --help
usage: test_2.py [-h]
optional arguments:
-h, --help show this help message and exit
E:\vscode\test>python test_2.py --verbose
usage: test_2.py [-h]
test_2.py: error: unrecognized arguments: --verbose
E:\vscode\test>python test_2.py foo
usage: test_2.py [-h]
test_2.py: error: unrecognized arguments: foo
分析：
- 在沒有任何選項(xiàng)的情況下運(yùn)行腳本不會(huì)顯示任何標(biāo)準(zhǔn)輸出
- 打印幫助信息掏膏，該--help選項(xiàng)也可以縮短為-h劳翰，該項(xiàng)無需指定
- 無法識(shí)別的參數(shù)，因沒有添加該參數(shù)項(xiàng)
- 同上
位置參數(shù)
一個(gè)例子：
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo") #添加參數(shù)
args = parser.parse_args()
print(args.echo)
#測(cè)試
E:\vscode\test>python test_2.py
usage: test_2.py [-h] echo
test_2.py: error: the following arguments are required: echo
E:\vscode\test>python test_2.py --help
usage: test_2.py [-h] echo
positional arguments:
echo
optional arguments:
-h, --help show this help message and exit
E:\vscode\test>python test_2.py bozhou
bozhou
分析：
我們添加了add_argument（）方法馒疹，這是我們用來指定程序愿意接受哪些命令行選項(xiàng)佳簸。將它命名為echo
- 該參數(shù)是必需的：echo
- parse_args()方法實(shí)際上從指定的選項(xiàng)中返回一些數(shù)據(jù)涮坐，在本例中為echo
- 可以看到這些操作不需要指定值保存在哪個(gè)變量中棚亩，而且還能根據(jù)參數(shù)名稱和輔助信息來進(jìn)行介紹
但請(qǐng)注意，雖然幫助顯示屏看起來不錯(cuò)邦马，但它目前并不像它那樣有幫助腥刹。例如马胧，我們看到我們得到了echo一個(gè)位置參數(shù)，但除了通過猜測(cè)或通過閱讀源代碼之外衔峰，我們不知道它的作用佩脊。所以，讓我們更有用一點(diǎn)：
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here") #對(duì)參數(shù)進(jìn)行介紹
args = parser.parse_args()
print(args.echo)
#測(cè)試
E:\vscode\test>python test_2.py -h
usage: test_2.py [-h] echo
positional arguments:
echo echo the string you use here
optional arguments:
-h, --help show this help message and exit
進(jìn)一步
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
#測(cè)試
E:\vscode\test>python test_2.py 7
Traceback (most recent call last):
File "test_2.py", line 6, in <module>
print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
#argarse將我們提供的值看作為字符串垫卤，所以報(bào)錯(cuò)
#所以需要指定參數(shù)類型
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
type=int)
args = parser.parse_args()
print(args.square**2)
#測(cè)試
E:\vscode\test>python test_2.py 10
100
可選參數(shù)
以上介紹的是位置參數(shù)威彰，下面介紹一下如何添加可選參數(shù)：
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
print("verbosity turned on")
#測(cè)試
E:\vscode\test>python test_2.py --verbosity 1
verbosity turned on
E:\vscode\test>python test_2.py -h
usage: test_2.py [-h] [--verbosity VERBOSITY]
optional arguments:
-h, --help show this help message and exit
--verbosity VERBOSITY
increase output verbosity
E:\vscode\test>python test_2.py --verbosity
usage: test_2.py [-h] [--verbosity VERBOSITY]
test_2.py: error: argument --verbosity: expected one argument
- --verbosity作用是在寫入程序時(shí)指定顯示某些內(nèi)容，如果沒有使用可選參數(shù)穴肘，情況下args.verbosity歇盼，相關(guān)變量將None作為值給出
- 當(dāng)使用參數(shù)時(shí)，必需指定一些值梢褐，否則報(bào)錯(cuò)
進(jìn)一步：
#如上所述旺遮，當(dāng)使用參數(shù)時(shí)，必需要指定一些值盈咳。但也可以通過action='store_true'設(shè)置耿眉，運(yùn)行使用參數(shù)時(shí)，也可以不傳入值
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
action="store_true")
args = parser.parse_args()
if args.verbose:
print("verbosity turned on")
#測(cè)試
#不指定參數(shù)也不報(bào)錯(cuò)鱼响，請(qǐng)注意鸣剪，我們現(xiàn)在指定一個(gè)新的關(guān)鍵字action，并為其指定值“store_true”。 這意味著筐骇，如果指定了該選項(xiàng)债鸡，則將值True指定給args.verbose。 不指定它意味著False铛纬。
E:\vscode\test>python test_2.py --verbose
verbosity turned on
#It complains when you specify a value, in true spirit of what flags actually are.
E:\vscode\test>python test_2.py --verbose 1
usage: test_2.py [-h] [--verbose]
test_2.py: error: unrecognized arguments: 1
短期選項(xiàng)
-+名稱
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
action="store_true")
args = parser.parse_args()
if args.verbose:
print("verbosity turned on")
#測(cè)試
E:\vscode\test>python test_2.py -v
verbosity turned on
結(jié)合位置參數(shù)和可選參數(shù)
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
print("the square of {} equals {}".format(args.square, answer))
else:
print(answer)
#測(cè)試
E:\vscode\test>python test_2.py 10
100 #不指定--verbose時(shí)厌均，為False
E:\vscode\test>python test_2.py 10 --verbose
the square of 10 equals 100
如何讓程序擁有多個(gè)verbosity值，如下：
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
print("{}^2 == {}".format(args.square, answer))
else:
print(answer)
#測(cè)試
E:\vscode\test>python test_2.py 10 -v 1
10^2 == 100
E:\vscode\test>python test_2.py 10 -v 2
the square of 10 equals 100
E:\vscode\test>python test_2.py 10 -v 3
100
可以看到最后一個(gè)是不嚴(yán)謹(jǐn)?shù)母嫠簦M(jìn)一修改棺弊，讓我們通過限制--verbosity選項(xiàng)可以接受的值來修復(fù)它：
#添加choices限制
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
print("{}^2 == {}".format(args.square, answer))
else:
print(answer)
#測(cè)試結(jié)果
E:\vscode\test>python test_2.py 10 -v 3
usage: test_2.py [-h] [-v {0,1,2}] square
test_2.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
E:\vscode\test>python test_2.py 10 -h
usage: test_2.py [-h] [-v {0,1,2}] square
positional arguments:
square display a square of a given number
optional arguments:
-h, --help show this help message and exit
-v {0,1,2}, --verbosity {0,1,2}
increase output verbosity
實(shí)現(xiàn)多個(gè)verbosity值的另一種方法實(shí)現(xiàn)，引入了另一個(gè)操作“count”來計(jì)算特定可選參數(shù)的出現(xiàn)次數(shù)擒悬，很有意思：
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
print("{}^2 == {}".format(args.square, answer))
else:
print(answer)
#測(cè)試
E:\vscode\test>python test_2.py 10 -vv
the square of 10 equals 100
E:\vscode\test>python test_2.py 10 -v
10^2 == 100
E:\vscode\test>python test_2.py 10 --verbosity --verbosity
the square of 10 equals 100
default參數(shù)：
#沒有default設(shè)置模她，示例
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count")
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
print("Running '{}'".format(__file__))
if args.verbosity >= 1:
print("{}^{} == ".format(args.x, args.y), end="")
print(answer)
#測(cè)試
E:\vscode\test>python test_2.py 10 2
Traceback (most recent call last):
File "test_2.py", line 8, in <module>
if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'
#當(dāng)不使用-v可選參數(shù)時(shí)會(huì)報(bào)錯(cuò)，因?yàn)榉祷氐臅r(shí)None懂牧，解決辦法設(shè)置default=0
parser.parse_known_args()和parser.parse_args()的區(qū)別
使用parser.parse_known_args()時(shí)侈净，在接受多余的命令行參數(shù)時(shí)不報(bào)錯(cuò)，并對(duì)多余的命令行參數(shù)信息和值進(jìn)行保存
import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
'--flag_int',
type=float,
default=0.01,
help='flag_int.'
)
FLAGS, unparsed = parser.parse_known_args()
print(FLAGS)
print(unparsed)
#輸出
E:\vscode\test>python test_2.py --flag_int 0.02 --double 0.03 a 1
Namespace(flag_int=0.02)
['--double', '0.03', 'a', '1']
待續(xù)````````````````````````````````````````````有時(shí)間再整理
