這次主要記錄python-Parser的用法，以及可能遇到的系列操作。

1 前言

if __name__ == "__main__":
    #Adding necessary input arguments
    parser = argparse.ArgumentParser(description='test')
    parser.add_argument('--input_path',default="input", type=str,help ='input files')
    parser.add_argument('--output_path',default = "output", type=str,help='result dir.')    
    args = parser.parse_args()
run()

代碼解釋：

• 設置python文件的input_path，默認為該目錄下的input文件夾
• 設置python文件的output_path，默認為該目錄下的output文件夾
• 也就是規定了輸入來源和輸出去向。

這個版塊在python文件中還是比較經典的，argparse模塊，其實質就是將相關參數進行設置。相對專業說法：

• argparse 模塊提供輕松編寫用戶友好的命令行接口。
• 程序定義它需要的參數，然后 argparse 將弄清如何從 sys.argv 解析出那些參數。
• argparse 模塊會自動生成幫助和使用手冊，并在用戶給程序傳入無效參數時報出錯誤信息。

2.使用方法

2.1 實例化ArgumentParser

# 實例化
# 創建一個 ArgumentParser 對象
# ArgumentParser 對象包含將命令行解析成 Python 數據類型所需的全部信息。
parser = argparse.ArgumentParser(description = 'test')

• ?description： 大多數對 ArgumentParser 構造方法的調用都會使用 description= 關鍵字參數。這個參數簡要描述這個程度做什么以及怎么做。在幫助消息中，這個描述會顯示在命令行用法字符串和各種參數的幫助消息之間。

2.2 使用add_argument函數添加參數?

parser.add_argument('--input_path',default="input", type=str,help ='input files')
parser.add_argument('--output_path',default = "output", type=str,help='result dir.') 

• 這些調用指定 ArgumentParser 如何獲取命令行字符串并將其轉換為對象。?

2.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 或多個參數。
• const-action 和 nargs 所需要的常量值。
• default： 不指定參數時的默認值。
• type： 命令行參數應該被轉換成的類型。
• choices：參數可允許的值的一個容器。
• required：可選參數是否可以省略 (僅針對可選參數)。
• help：參數的幫助信息，當指定為 argparse.SUPPRESS 時表示不顯示該參數的幫助信息.
• metavar：在 usage 說明中的參數名稱，對于必選參數默認就是參數名稱，對于可選參數默認是全大寫的參數名稱.
• dest： 解析后的參數名稱，默認情況，對于可選參數選取最長的名稱，中劃線轉換為下劃線.

2.4 使用parse_args解析參數

ArgumentParser 通過 parse_args() 方法解析參數。它將檢查命令行，把每個參數轉換為適當的類型然后調用相應的操作。在大多數情況下，這意味著一個簡單的 Namespace 對象將從命令行解析出的屬性構建：

# 解析參數
args = parser.parse_args()
print (args.echo)

3 案例實踐：action的可選參數store_true的作用

parser.add_argument('--R0', action='store_true')
parser.add_argument('--R20', action='store_true')
parser.add_argument('--Final',default=True,action='store_true')
args = parser.parse_args()
if int(args.R0) + int(args.R20) + int(args.Final) == 0:
        assert False, 'Please activate one of the [R0, R20, Final] options using --[R0]'
elif int(args.R0) + int(args.R20) + int(args.Final) > 1:
        assert False, 'Please activate only ONE of the [R0, R20, Final] options'

直接在Vscode運行時，報錯如下，需要指定相關觸發，即輸入python xxx.py --R0 ,則 R0 True?

AssertionError: Please activate one of the [RO，R20，Final] options using --[RO0]

不想在終端輸入控制，則可用default = True，進行控制，得到的結果也是True，主要便于Bebug。

附：python-Parser使用步驟記憶

1.實例化ArgumenParser

2.使用add_argument函數添加參數

3.使用parse_args解析參數

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

總結