Python parser.add_argument

1.Python解析參數

import argparse

parser = argparse.ArgumentParser(description = 'TEST')
parser.add_argument ('--start-epoch', default = 0, type = int, help = 'please input number')

def main():
? ? global args
? ? args = parser.parse_args()

? ? print(args)
? ? print(args.start_epoch)

if __name__ == '__main__':
? ? main()

注：在參數解析時，參數中并不區分字符‘-’和‘_’；如上所述，在添加是使用的是’–start-epoch’，但是在解析時使用的是args.start_epoch。

2.parser.add_argument參數action

在使用parser進行傳參時，遇到參數action，一直不得其解，終有所獲，解釋如下：

parser.add_argument(‘--is_train', action='store_true', default=False)

其中“–is_train”參數在調用時，如下：

python demo1.py ?? ??? ??? ??? ??? ??? ?#無參數傳入時，使用默認值False?
python demo1.py --is_train ?? ??? ?#當使用此參數時，表示該參數是True, 注意在這里并沒有對其賦值，
?? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ?#其作用是作為開關使用，來控制action動作

Python parser.add_argument函數及sys.argv[]

1.argparse

argparse 模塊是 Python 內置的一個用于命令項選項與參數解析的模塊，argparse 模塊可以讓人輕松編寫用戶友好的命令行接口。

通過在程序中定義好我們需要的參數，然后 argparse 將會從 sys.argv 解析出這些參數。

argparse 模塊還會自動生成幫助和使用手冊，并在用戶給程序傳入無效參數時報出錯誤信息。

2.步驟

1、創建一個解析器——創建 ArgumentParser() 對象

parser = argparse.ArgumentParser(description='PyTorch ImageNet Training')

變量名為parser，ArgumentParser 對象包含將命令行解析成 Python 數據類型所需的全部信息。

關鍵詞description：

description= '關鍵字參數'

這個參數簡要描述這個程度做什么以及怎么做。在幫助消息中，這個描述會顯示在命令行用法字符串和各種參數的幫助消息之間。

2、添加參數——調用 add_argument() 方法添加參數

調用 add_argument() 給程序添加參數信息。這些調用指定 ArgumentParser 如何獲取命令行字符串并將其轉換為對象。

常用的有，

parser.add_argument('data', metavar='DIR',help='path to dataset') ?# 設置數據路徑
parser.add_argument('--epochs', default=200, type=int, metavar='N', ?# 訓練循環最高次數
? ? ? ? ? ? ? ? ? ? help='number of total epochs to run')
parser.add_argument('--lr', '--learning-rate', default=0.03, type=float, ?# 學習率
? ? ? ? ? ? ? ? ? ? metavar='LR', help='initial learning rate', dest='lr')
parser.add_argument('--seed', default=None, type=int,
? ? ? ? ? ? ? ? ? ? help='seed for initializing training. ') ?# 用于指定隨機數生成時所用算法開始的整數值

3、解析參數——使用 parse_args() 解析添加的參數

ArgumentParser 通過 parse_args() 方法解析參數。它將檢查命令行，把每個參數轉換為適當的類型然后調用相應的操作。

在大多數情況下，這意味著一個簡單的 Namespace 對象將從命令行解析出的屬性構建。

args = parser.parse_args()

3.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 或多個參數。
• default - 不指定參數時的默認值。
• type - 命令行參數應該被轉換成的類型。
• choices - 參數可允許的值的一個容器。
• required - 可選參數是否可以省略 (僅針對可選參數)。
• help - 參數的幫助信息，當指定為 argparse.SUPPRESS 時表示不顯示該參數的幫助信息.
• metavar - 在 usage 說明中的參數名稱，對于必選參數默認就是參數名稱，對于可選參數默認是全大寫的參數名稱。用來控制部分命令行參數的顯示，注意：它只是影響部分參數的顯示信息，不影響代碼內部獲取命令行參數的對象。
• dest - 解析后的參數名稱，默認情況下，對于可選參數選取最長的名稱，中劃線轉換為下劃線.

4.sys.argv[]

是一個從程序外部獲取參數的橋梁，獲得的是一個列表（list)，其第一個元素是程序本身，隨后才依次是外部給予的參數。

sys.argv[0]

對應的是程序本身，即xxx.py，xxx表示程序的名稱。

sys.argv[1]

表示命令行外部輸入的第一個參數。

sys.argv[1:]

表示遍歷外部輸入參數的所有。

總結