python---argparse介紹

1. argparse介紹

是python的一個命令行解析包，很是編寫可讀性很是好的程序

2.基本用法

prog.py是我在Linux的下測試argparse的文件，放在/ TMP目錄下，其內容以下：

#!/usr/bin/env python# encoding: utf-8import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

測試：

yarving@yarving-VirtualBox /tmp $ python prog.py 

yarving@yarving-VirtualBox /tmp $ python prog.py --helpusage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exityarving@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.位置參數

位置參數爲英文定義，中文名叫有翻譯爲定位參數的，用法是不用帶 - 就可用
修改prog.py的內容以下：

#!/usr/bin/env python# encoding: utf-8import 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] echoprog.py: error: too few arguments

yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] echopositional arguments:  echooptional arguments:
  -h, --help  show this help message and exityarving@yarving-VirtualBox /tmp $ python prog.py hahahaha
hahahaha

了定義叫一個echo的參數，默認必選

• 第一個測試爲不帶參數，因爲echo參數爲空，因此報錯，並給出用法（使用）和錯誤信息

• 第二個測試爲打印幫助信息

• 第三個測試爲正經常使用法，回顯了輸入字符串哈哈哈哈

4.可選參數

中文名叫可選參數，有兩種方式：

1. 的英文一種經過一個-來指定的短參數，如-h;

2. 的英文一種經過--來指定的長參數，如--help

這兩種方式能夠同存，也能夠只存在一個，修改prog.py內容以下：

#!/usr/bin/env python# encoding: utf-8import 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-8import 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.類型

默認的參數類型爲STR，若是要進行數學計算，須要對參數進行解析後進行類型轉換，若是不能轉換則須要報錯，這樣比較麻煩
argparse提供了對參數類型的解析，若是類型不符合，則直接報錯。以下是對參數進行平方計算的程序：

#!/usr/bin/env python# encoding: utf-8import argparse


parser = argparse.ArgumentParser()
parser.add_argument('x', type=int, help="the base")
args = parser.parse_args()
answer = args.x ** 2print 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中的動做的例子中定義了默認值爲True和False的方式，若是要限定某個值的取值範圍，好比6中的×××，限定其取值範圍爲0,1,2，該如何進行呢？
修改prog.py文件以下：

#!/usr/bin/env python# encoding: utf-8import 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**2if 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的冗長度值不在可選值範圍內，打印錯誤

• 測試5打印幫助信息

8.自定義幫助信息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

也就是幫助爲何，打印輸出時，就會顯示什麼

9.程序用法幫助

？8中介紹了爲每一個參數定義幫助文檔，給那麼整個程序定義幫助文檔該怎麼進行呢
經過argparse.ArgumentParser(description="calculate X to the power of Y")便可
修改prog.py內容以下：

#!/usr/bin/env python# encoding: utf-8import 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.yif args.quiet:    print answerelif args.verbose:    print "{} to the power {} equals {}".format(args.x, args.y, answer)else:    print "{}^{} == {}".format(args.x, args.y, answer)

打印幫助信息時即顯示計算X到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-8import 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**2if 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，爲了更清楚的看到默認值，也能夠直接打印進行測試。

   

做者：yarving連接：https://www.jianshu.com/p/fef2d215b91d來源：簡書著做權歸做者全部。商業轉載請聯繫做者得到受權，非商業轉載請註明出處。