Python中Parser的超詳細用法範例

2022-07-26 14:02:23

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

總結

到此這篇關於Python中Parser的超詳細用法的文章就介紹到這了,更多相關Python Parser用法內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！