1. argparse介紹
是python的一個命令行解析包，用于編寫可讀性非常好的程序
2. 基本用法
prog.py是我在linux下測試argparse的文件，放在/tmp目錄下，其內容如下：
#!/usr/bin/env python
# encoding: utf-8
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
測試：
yarving@yarving-VirtualBox /tmp $ python prog.py
yarving@yarving-VirtualBox /tmp $ python prog.py --help
usage: prog.py [-h]
optional arguments:
-h, --help show this help message and exit
yarving@yarving-VirtualBox /tmp $ python prog.py -v
usage: prog.py [-h]
prog.py: error: unrecognized arguments: -v
yarving@yarving-VirtualBox /tmp $ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
- 第一個沒有任何輸出和出錯
- 第二個測試為打印幫助信息，argparse會自動生成幫助文檔
- 第三個測試為未定義的-v參數，會出錯
- 第四個測試為未定義的參數foo，出錯
3. positional arguments
positional arguments為英文定義，中文名叫有翻譯為定位參數的，用法是不用帶-就可用
修改prog.py的內容如下：
#!/usr/bin/env python
# encoding: utf-8
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo
執行測試如下
yarving@yarving-VirtualBox /tmp $ python prog.py
usage: prog.py [-h] echo
prog.py: error: too few arguments
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] echo
positional arguments:
echo
optional arguments:
-h, --help show this help message and exit
yarving@yarving-VirtualBox /tmp $ python prog.py hahahaha
hahahaha
定義了一個叫echo的參數，默認必選
- 第一個測試為不帶參數，由于
echo參數為空，所以報錯，并給出用法（usage）和錯誤信息 - 第二個測試為打印幫助信息
- 第三個測試為正常用法，回顯了輸入字符串hahahaha
4. optional arguments
中文名叫可選參數，有兩種方式：
- 一種是通過一個
-來指定的短參數，如-h； - 一種是通過
--來指定的長參數，如--help
這兩種方式可以同存，也可以只存在一個，修改prog.py內容如下：
#!/usr/bin/env python
# encoding: utf-8
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"
注意這一行：parser.add_argument("-v", "--verbosity", help="increase output verbosity")
定義了可選參數-v或--verbosity，通過解析后，其值保存在args.verbosity變量中
用法如下：
yarving@yarving-VirtualBox /tmp $ python prog.py -v 1
verbosity turned on
yarving@yarving-VirtualBox /tmp $ python prog.py --verbosity 1
verbosity turned on
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v VERBOSITY]
optional arguments:
-h, --help show this help message and exit
-v VERBOSITY, --verbosity VERBOSITY
increase output verbosity
yarving@yarving-VirtualBox /tmp $ python prog.py -v
usage: prog.py [-h] [-v VERBOSITY]
prog.py: error: argument -v/--verbosity: expected one argument
- 測試1中，通過
-v來指定參數值 - 測試2中，通過
--verbosity來指定參數值 - 測試3中，通過
-h來打印幫助信息 - 測試4中，沒有給
-v指定參數值，所以會報錯
5. action='store_true'
上一個用法中-v必須指定參數值，否則就會報錯，有沒有像-h那樣，不需要指定參數值的呢，答案是有，通過定義參數時指定action="store_true"即可，用法如下
#!/usr/bin/env python
# encoding: utf-8
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"
測試：
yarving@yarving-VirtualBox /tmp $ python prog.py -v
verbosity turned on
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v]
optional arguments:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
第一個例子中，-v沒有指定任何參數也可，其實存的是True和False，如果出現，則其值為True，否則為False
6. 類型 type
默認的參數類型為str，如果要進行數學計算，需要對參數進行解析后進行類型轉換，如果不能轉換則需要報錯，這樣比較麻煩
argparse提供了對參數類型的解析，如果類型不符合，則直接報錯。如下是對參數進行平方計算的程序：
#!/usr/bin/env python
# encoding: utf-8
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('x', type=int, help="the base")
args = parser.parse_args()
answer = args.x ** 2
print answer
測試
yarving@yarving-VirtualBox /tmp $ python prog.py 2
4
yarving@yarving-VirtualBox /tmp $ python prog.py two
usage: prog.py [-h] x
prog.py: error: argument x: invalid int value: 'two'
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] x
positional arguments:
x the base
optional arguments:
-h, --help show this help message and exit
- 第一個測試為計算2的平方數，類型為int，正常
- 第二個測試為一個非int數，報錯
- 第三個為打印幫助信息
7. 可選值choices=[]
5中的action的例子中定義了默認值為True和False的方式，如果要限定某個值的取值范圍，比如6中的整形，限定其取值范圍為0， 1， 2，該如何進行呢？
修改prog.py文件如下：
#!/usr/bin/env python
# encoding: utf-8
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
測試如下：
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 0
16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 1
4^2 == 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 2
the square of 4 equals 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.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
- 測試1， 2， 3 為可選值范圍，通過其值，打印不同的格式輸出；
- 測試4的verbosity值不在可選值范圍內，打印錯誤
- 測試5打印幫助信息
8. 自定義幫助信息help
上面很多例子中都為help賦值，如
parser.add_argument("square", type=int, help="display a square of a given number")
在打印輸出時，會有如下內容
positional arguments:
square display a square of a given number
也就是help為什么，打印輸出時，就會顯示什么
9. 程序用法幫助
8中介紹了為每個參數定義幫助文檔，那么給整個程序定義幫助文檔該怎么進行呢？
通過argparse.ArgumentParser(description="calculate X to the power of Y")即可
修改prog.py內容如下：
#!/usr/bin/env python
# encoding: utf-8
import argparse
parser = argparse.ArgumentParser(description="calculate X to the power of Y")
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="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y
if args.quiet:
print answer
elif args.verbose:
print "{} to the power {} equals {}".format(args.x, args.y, answer)
else:
print "{}^{} == {}".format(args.x, args.y, answer)
打印幫助信息時即顯示calculate X to the power of Y
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v | -q] x y
calculate X to the power of Y
positional arguments:
x the base
y the exponent
optional arguments:
-h, --help show this help message and exit
-v, --verbose
-q, --quiet
10. 互斥參數
在上個例子中介紹了互斥的參數
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
第一行定義了一個互斥組，第二、三行在互斥組中添加了-v和-q兩個參數，用上個例子中的程序進行如下測試：
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2
4^2 == 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -v
4 to the power 2 equals 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -q
16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -q -v
可以看出，-q和-v不出現，或僅出現一個都可以，同時出現就會報錯。
可定義多個互斥組
11.參數默認值
介紹了這么多，有沒有參數默認值該如何定義呢？
修改prog.py內容如下：
#!/usr/bin/env python
# encoding: utf-8
import argparse
parser = argparse.ArgumentParser(description="calculate X to the power of Y")
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], default=1,
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
測試結果如下
yarving@yarving-VirtualBox /tmp $ python prog.py 8
8^2 == 64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 0
64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 1
8^2 == 64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 2
the square of 8 equals 64
可以看到如果不指定-v的值，args.verbosity的值默認為1，為了更清楚的看到默認值，也可以直接打印進行測試。
