python之Argparse模块
argparse 模塊可以輕松編寫(xiě)用戶(hù)友好的命令行接口。程序定義它需要的參數(shù),然后 argparse 將弄清如何從 sys.argv 解析出那些參數(shù)。 argparse 模塊還會(huì)自動(dòng)生成幫助和使用手冊(cè),并在用戶(hù)給程序傳入無(wú)效參數(shù)時(shí)報(bào)出錯(cuò)誤信息。
argparse簡(jiǎn)單使用流程
主要有三個(gè)步驟:
- 創(chuàng)建 ArgumentParser() 對(duì)象
- 調(diào)用 add_argument() 方法添加參數(shù)
- 使用 parse_args() 解析添加的參數(shù)
創(chuàng)建解析器對(duì)象
parser = argparse.ArgumentParser()一般這樣即可,全部可選參數(shù)如下。
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, allow_abbrev=True)詳細(xì)解釋參考官方文檔:https://docs.python.org/zh-cn/3/library/argparse.html#argparse.ArgumentParser
添加參數(shù)
分為添加位置參數(shù)-positional arguments和可選參數(shù)-optional arguments
添加位置參數(shù)聲明的參數(shù)名前綴不帶-或--,按照順序進(jìn)行解析,在命令中必須出現(xiàn),否則報(bào)錯(cuò),命令通常為:
添加可選參數(shù)聲明的參數(shù)名前綴帶-或--,前綴是-的為短參數(shù),前綴是--是長(zhǎng)參數(shù),兩者可以都有,也可以只有一個(gè),短參數(shù)和長(zhǎng)參數(shù)效果一樣。可選參數(shù)的值接在位置參數(shù)的后面,不影響位置參數(shù)的解析順序。
以深度學(xué)習(xí)訓(xùn)練中經(jīng)常出現(xiàn)的為例:
其中action參數(shù)的'store_true'指的是:觸發(fā)action時(shí)為真,不觸發(fā)則為假。即儲(chǔ)存了一個(gè)bool變量,默認(rèn)為false,觸發(fā)不用賦值即變?yōu)閠rue
type:指定參數(shù)類(lèi)別,默認(rèn)是str,傳入數(shù)字要定義
help:是一些提示信息
default:是默認(rèn)值
metavar: 在 usage 說(shuō)明中的參數(shù)名稱(chēng),對(duì)于必選參數(shù)默認(rèn)就是參數(shù)名稱(chēng),對(duì)于可選參數(shù)默認(rèn)是全大寫(xiě)的參數(shù)名稱(chēng).
其它詳細(xì)用法文檔介紹:https://docs.python.org/zh-cn/3/library/argparse.html#argparse.ArgumentParser.add_argument
解析參數(shù)
args = parser.parse_args()這樣args就有了參數(shù)屬性,可以用args了。
示例:
# 導(dǎo)入包 import argparse # 創(chuàng)建解析器 parser = argparse.ArgumentParser() #添加位置參數(shù)(positional arguments) parser.add_argument('-a', type=int,help='input a int') args = parser.parse_args() print(args.a)轉(zhuǎn)載于:https://www.cnblogs.com/cuhm/p/10643765.html
總結(jié)
以上是生活随笔為你收集整理的python之Argparse模块的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。