argparse
模塊可以讓人輕松編寫用戶友好的命令行接口。程序定義它需要的參數,然后 argparse
將弄清如何從 sys.argv
解析出那些參數。 argparse
模塊還會自動生成幫助和使用手冊,并在用戶給程序傳入無效參數時報出錯誤信息。
示例
import argparse
parser = argparse.ArgumentParser(description='test')
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
'''
_StoreTrueAction(option_strings=['--sparse'], dest='sparse', nargs=0, const=True, default=False, type=None, choices=None, help='GAT with sparse version or not.', metavar=None)
'''
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
'''
_StoreAction(option_strings=['--seed'], dest='seed', nargs=None, const=None, default=72, type=<class 'int'>, choices=None, help='Random seed.', metavar=None)
'''
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
'''
_StoreAction(option_strings=['--epochs'], dest='epochs', nargs=None, const=None, default=10000, type=<class 'int'>, choices=None, help='Number of epochs to train.', metavar=None)
'''
args = parser.parse_args()
print(args.sparse)
print(args.seed)
print(args.epochs)
'''
False
72
10000
'''
步驟
1. 實例化ArgumentParser
# 實例化
# 創(chuàng)建一個 ArgumentParser 對象
# ArgumentParser 對象包含將命令行解析成 Python 數據類型所需的全部信息。
parser = argparse.ArgumentParser(description = 'test')
描述description
大多數對 ArgumentParser 構造方法的調用都會使用 description= 關鍵字參數。這個參數簡要描述這個程度做什么以及怎么做。在幫助消息中,這個描述會顯示在命令行用法字符串和各種參數的幫助消息之間。
2. 使用add_argument函數添加參數
這些調用指定 ArgumentParser 如何獲取命令行字符串并將其轉換為對象。
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
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
—將參數規(guī)范中定義的一個值保存到一個列表;
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
— 解析后的參數名稱,默認情況下,對于可選參數選取最長的名稱,中劃線轉換為下劃線.
使用parse_args解析參數
ArgumentParser 通過 parse_args() 方法解析參數。它將檢查命令行,把每個參數轉換為適當的類型然后調用相應的操作。在大多數情況下,這意味著一個簡單的 Namespace 對象將從命令行解析出的屬性構建:
# 解析參數
args = parser.parse_args()
print (args.echo)
以上就是Python argparse的用法,希望能對小伙伴有所幫助,也希望大家以后多多支持W3Cschool!