【python】argparse學習(轉)
argparse
argparse 是 Python 內建的一個用於命令項選項與引數解析的模組，通過在程式中定義好我們需要的引數，argparse 將會從 sys.argv 中解析出這些引數，並自動生成幫助和使用資訊。當然，Python 也有第三方的庫可用於命令列解析，而且功能也更加強大，比如 docopt，Click。
argparse 使用
簡單示例
我們先來看一個簡單示例。主要有三個步驟：
- 建立 ArgumentParser() 物件
- 呼叫 add_argument() 方法新增引數
- 使用 parse_args() 解析新增的引數
# -*- coding: utf-8 -*-
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()
print args.integer將上面的程式碼儲存為檔案 argparse_usage.py，在終端執行，結果如下：
$ python argparse_usage.py usage: argparse_usage.py [-h] integer argparse_usage.py: error: too few arguments $ python argparse_usage.py abcd usage: argparse_usage.py [-h] integer argparse_usage.py: error: argument integer: invalid int value: 'abcd' $ python argparse_usage.py -h usage: argparse_usage.py [-h] integer positional arguments: integer display an integer optional arguments: -h, --help show this help message and exit $ python argparse_usage.py 10 10
定位引數
上面的示例，其實就展示了定位引數的使用，我們再來看一個例子 - 計算一個數的平方：
# -*- coding: utf-8 -*-
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將上面的程式碼儲存為檔案 argparse_usage.py，在終端執行，結果如下：
$ python argparse_usage.py 9
81可選引數
現在看下可選引數的用法，所謂可選引數，也就是命令列引數是可選的，廢話少說，看下面例子：
# -*- coding: utf-8 -*-
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)
args = parser.parse_args()
if args.square:
print args.square**2
if args.cubic:
print args.cubic**3將上面的程式碼儲存為檔案 argparse_usage.py，在終端執行，結果如下：
$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
optional arguments:
-h, --help show this help message and exit
--square SQUARE display a square of a given number
--cubic CUBIC display a cubic of a given number
$ python argparse_usage.py --square 8
64
$ python argparse_usage.py --cubic 8
512
$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8
$ python argparse_usage.py # 沒有輸出混合使用
定位引數和選項引數可以混合使用，看下面一個例子，給一個整數序列，輸出它們的和或最大值（預設）：
import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')
args = parser.parse_args()
print args.accumulate(args.integers)結果：
$ python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: too few arguments
$ python argparse_usage.py 1 2 3 4
4
$ python argparse_usage.py 1 2 3 4 --sum
10add_argument() 方法
add_argument() 方法定義如何解析命令列引數：
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])每個引數解釋如下:
- name or flags - 選項字串的名字或者列表，例如 foo 或者 -f, --foo。
- action - 命令列遇到引數時的動作，預設值是 store。
- store_const，表示賦值為const；
- append，將遇到的值儲存成列表，也就是如果引數重複則會儲存多個值;
- append_const，將引數規範中定義的一個值儲存到一個列表；
- count，儲存遇到的次數；此外，也可以繼承 argparse.Action 自定義引數解析；
- nargs - 應該讀取的命令列引數個數，可以是具體的數字，或者是?號，當不指定值時對於 Positional argument 使用 default，對於 Optional argument 使用 const；或者是 * 號，表示 0 或多個引數；或者是 + 號表示 1 或多個引數。
- const - action 和 nargs 所需要的常量值。
- default - 不指定引數時的預設值。
- type - 命令列引數應該被轉換成的型別。
- choices - 引數可允許的值的一個容器。
- required - 可選引數是否可以省略 (僅針對可選引數)。
- help - 引數的幫助資訊，當指定為
argparse.SUPPRESS時表示不顯示該引數的幫助資訊. - metavar - 在 usage 說明中的引數名稱，對於必選引數預設就是引數名稱，對於可選引數預設是全大寫的引數名稱.
- dest - 解析後的引數名稱，預設情況下，對於可選引數選取最長的名稱，中劃線轉換為下劃線.
參考資料
- Argparse Tutorial — Python 2.7.12 documentation
- Argparse – Command line option and argument parsing
- Argparse — Parser for command-line options, arguments and sub-commands
- Python 中的命令列解析工具介紹
在python中，命令列解析的很好用，
首先匯入命令列解析模組
import argparse
import sys
然後建立物件
parse=argparse.ArgumentParser()
然後增加命令列
parse.add_argument("--learning_rate",type=float,default=0.01,help="initial learining rate")
parse.add_argument("--max_steps",type=int,default=2000,help="max")
parse.add_argument("--hidden1",type=int,default=100,help="hidden1")
對於函式add_argumen()第一個是選項，第二個是資料型別，第三個預設值，第四個是help命令時的說明
然後用arg=parse.parse_args(sys.argv[1:])
其中引數sys.argv[1:]是命令列語句中從第一個到最後。如在ubuntu下輸入命令列python gg.py --learning_rate 20 --max_steps 10
則sys.argv[1:0]=--learning_rate 20 --max_steps 10
輸出的arg為namespace空間，結果是Namespace(hidden1=100, learning_rate=20.0, max_steps=10)
但是parse_known_args（）函式輸出結果為
te 20 --max_steps 10
20.0
10
100
程式：
import argparse
import sys
parse=argparse.ArgumentParser()
parse.add_argument("--learning_rate",type=float,default=0.01,help="initial learining rate")
parse.add_argument("--max_steps",type=int,default=2000,help="max")
parse.add_argument("--hidden1",type=int,default=100,help="hidden1")
flags,unparsed=parse.parse_known_args(sys.argv[1:])
print flags.learning_rate
print flags.max_steps
print flags.hidden1
print unparsed
輸出結果：
20.0
10
100
[]
程式：
20.0
10
100
這兩個函式的功能差不多