當遇到需要參數的情況時,往往有以下三種處理方法[1]:
* 直接給定
這種方法實現起來方便,但是靈活性稍差,每次都需要開啟源碼修改。
* 手動解析
這種方法也算是比較常用,但是當參數過多時就顯示出來不方便了,因為每次輸入的格式以及參數的個數都必須一點不差。舉個簡單的小例子說明這種方法如何使用:
# python 代碼-手動解析參數 # 檔案名稱test.py import sys if __name__ == '__main__': print sys.argv[0] print "end"
$python test.py 1 test.py end
自動解析
相比上述兩種方法,這種自動解析的方法更加靈活,且參數可以選擇,順序可以不確定,因此建議使用這種方法。其主要依賴python包argparse。
接下來主要介紹python命令列解析模組argpars [2][3]:
1 簡介
argparse 模組使得方便使用的命令列編程更加方便。首先定義程式中需要什麼參數,然後argparse會自動從sys.argv中解析之前定義的參數。
argparse還可以自動產生協助文檔,並且當使用者輸入錯誤的參數時自動報錯。
1.1 來個例子
# python代碼 - argparse 樣本# 代碼名稱: prog.pyimport argparseparser = 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 prog.py -husage: prog.py [-h] [--sum] N [N ...]Process some integers.positional arguments: N an integer for the accumulatoroptional arguments: -h, --help show this help message and exit --sum sum the integers (default: find the max)
使用合適的參數運行程式,可以得到輸入參數的max或者sum,如果輸入不合適的參數,則程式會直接報錯,如下:
$ python prog.py 1 2 3 44$ python prog.py 1 2 3 4 --sum10$ python prog.py a b cusage: prog.py [-h] [--sum] N [N ...]prog.py: error: argument N: invalid int value: 'a'
1.1.1 建立一個解譯器
>>>parser = argparse.ArgumentParser(description='Process some integers.')
ArgumentParserObject Storage Service瞭解析命令列參數所需的所有資訊。
1.1.2 添加參數
add_argument()函數實現了將需要的參數添加到ArgumentParser對象中。
這些調用告訴ArgumentParse對象怎樣提取命令列中的參數,並如何將其轉化為所需的對象。This information is stored and used when parse_args()is called. For example:
>>>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)')
調用完parse_args()函數後會返回兩個對象,integers和accumulate。
integers是一個或多個(list)int型的數;
accumulate是一個sum()函數(--sum已調用),或者max()(--sum沒調用)
1.1.3 解析參數
>>> parser.parse_args(['--sum', '7', '-1', '42'])Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])
注意: 在一個script中,parse_args()函數一般不帶參數直接調用,而參數是直接在命令列中給出,然後ArgumentParser會在sys.argv中自動解析相應的參數。
2 ArgumentParser對象
ArgumentParser對象定義如下:
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)
其每一個參數的定義如下:
* prog - The name of the program (default: sys.argv[0])
預設情況下, ArgumentParser對象根據sys.argv[0]的值(不包括路徑名)產生協助資訊中的程式名。
usage - The string describing the program usage (default: generated from arguments added to parser)
預設情況下,ArgumentParser對象可以根據參數自動產生用法資訊
description - Text to display before the argument help (default: none)
description 用於展示程式的簡要介紹資訊,通常包括:這個程式可以做什麼、怎麼做。在協助資訊中 description位於用法資訊與參數說明之間
epilog - Text to display after the argument help (default: none)
與description類似,程式的額外描述資訊,位於參數說明之後
parents - A list of ArgumentParser objects whose arguments should also be included
有時多個解析器可能有相同的參數集,為了實現代碼複用,我們可以將這些相同的參數集提取到一個單獨的解析器中,在建立其它解析器時通過parents指定父解析器,這樣新建立的解析器中就包含了相同的參數集。
formatter_class - A class for customizing the help output
通過 formatter_class 可以定製協助資訊
prefix_chars - The set of characters that prefix optional arguments (default: ‘-‘)
一般情況下,我們使用’-‘作為選項首碼,ArgumentParser也支援自訂選項首碼,通過prefix_chars
fromfile_prefix_chars - The set of characters that prefix files from which additional arguments should be read (default: None)
argument_default - The global default value for arguments (default: None)
conflict_handler - The strategy for resolving conflicting optionals (usually unnecessary)
add_help - Add a -h/–help option to the parser (default: True)
是否禁用-h –help選項
*個人認為常用的參數使用黑體標出,基本上如果沒有特別需求就指定一下description就可以了。
官網和一些參考文獻中都給出了每個參數的詳細定義和具體使用方法,這裡不在贅述。*
3 add_argument()方法
ArgumentParser.add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
各個參數含義如下:
* name or flags - Either a name or a list of option strings, e.g. foo or -f, –foo.
指定一個選擇性參數或者位置參數。其中選擇性參數以-開頭,剩下的是位置參數
action - The basic type of action to be taken when this argument is encountered at the command line.
指定如何處理命令列參數
nargs - The number of command-line arguments that should be consumed.
指定多個命令列參數和一個arcion相關聯,具體見官方文檔
const - A constant value required by some action and nargs selections.
constant value,不是從命令列中讀取,在某些特定action中需要指定。
default - The value produced if the argument is absent from the command line.
如果參數可以預設,default指定命令列參數不存在時的參數值。
type - The type to which the command-line argument should be converted.
預設情況下,ArgumentParser對象將命令列參數儲存為字串。但通常命令列參數應該被解釋為另一種類型,如 float或int。通過指定type,可以對命令列參數執行類型檢查和類型轉換
choices - A container of the allowable values for the argument.
將命令列參數的值限定在一個範圍內,超出範圍則報錯
required - Whether or not the command-line option may be omitted (optionals only).
指定命令列參數是否必需,預設通過-f –foo指定的參數為選擇性參數。
help - A brief description of what the argument does.
協助文檔
metavar - A name for the argument in usage messages.
寫協助文檔時可選的參數
dest - The name of the attribute to be added to the object returned by parse_args().
dest 允許自訂ArgumentParser的參數屬性名稱
4 最後來個例子看一下用法
常用的參數基本都列出來了,接下來用Pytorch源碼中的一個小例子示範用法:
parser = argparse.ArgumentParser(description='PyTorch MNIST Example')parser.add_argument('--batch-size', type=int, default=64, metavar='N', help='input batch size for training (default: 64)')parser.add_argument('--test-batch-size', type=int, default=1000, metavar='N', help='input batch size for testing (default: 1000)')parser.add_argument('--epochs', type=int, default=10, metavar='N', help='number of epochs to train (default: 10)')parser.add_argument('--lr', type=float, default=0.01, metavar='LR', help='learning rate (default: 0.01)')parser.add_argument('--momentum', type=float, default=0.5, metavar='M', help='SGD momentum (default: 0.5)')parser.add_argument('--no-cuda', action='store_true', default=False, help='disables CUDA training')parser.add_argument('--seed', type=int, default=1, metavar='S', help='random seed (default: 1)')parser.add_argument('--log-interval', type=int, default=10, metavar='N', help='how many batches to wait before logging training status')args = parser.parse_args()
參考:
1. python 中的argparse
2. python命令列解析模組argparse
3. 官方文檔