Python命令行參數(shù)解析包argparse的使用詳解
更新時間：2022年09月14日 10:22:46 作者：Se7eN_HOU
argparse?是?python?自帶的命令行參數(shù)解析包，可以用來方便的服務命令行參數(shù)。本文將通過示例和大家詳細講講argparse的使用，需要的可以參考一下
一、argparse簡介
argparse 是 python 自帶的命令行參數(shù)解析包，可以用來方便的服務命令行參數(shù)，使用之前需要先導入包 import argparse
二、簡單案例
簡單使用，創(chuàng)建一個名為test.py的文件
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser()
# 添加一個接收參數(shù)，默認值為Se7eN
parser.add_argument("-n", "--name", default="Se7eN")
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))打印結果為：
houlei@houleideMacBook-Pro argparse_demo % python3 test.py # 此時在test.py后面沒有跟上參數(shù)， args = Namespace(name='Se7eN') # 所以打印出來的name為默認值 Se7eN
再次驗證：
houlei@houleideMacBook-Pro argparse_demo % python3 test.py -n HOU # 此時后面跟上了 -n 參數(shù)，并且賦值HOU args = Namespace(name='HOU') # 打印出來 name 的值為 HOU houlei@houleideMacBook-Pro argparse_demo % python3 test.py --name hou # 此時后面跟上了 --name 參數(shù)，并賦值為hou args = Namespace(name='hou') # 打印出來的 name 的值為 hou houlei@houleideMacBook-Pro argparse_demo %
解釋說明
在上述代碼 parser.add_argument("-n", "--name", default="Se7eN") 中，有兩個參數(shù) “-n”和“--name” 分別代表什么？其中-n 和 --name 都是我們自己自定的參數(shù)名。至于n和name ,你可以隨便起個變量名都可以，但是要注意，前面的一個 “-”和“--”才是關鍵。
一個“-”的參數(shù)，例如：-n, 他其實相當于我們在liunx中使用的指令，一個自定義的指令。
兩個“--”的參數(shù)，例如：--name 他就相當于在程序中，用來接收對對應指令值的變量，例如我們在控制臺上輸入 python3 test.py -n hou。 其中 -n 就代表使用的 -n 的指令，然后將后面的 hou 的值賦值給對應的變量， -n 對應的變量就是 --name 。所以我們使用print 打印的時候才顯示的name = hou
簡單理解：一個“-”的是指令，兩個“--”的是接收指令內容的變量。
三、ArgumentParser參數(shù)
ArgumentParse是解析器對象，在創(chuàng)建一個解析器對象的時候，是有很多參數(shù)可以配置，下面就演示一下這些參數(shù)的使用
1、prog: 程序的名稱（默認值：sys.argv[0]）
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser()
# 添加一個接收參數(shù)，默認值為Se7eN
parser.add_argument("-n", "--name", default="Se7eN")
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))執(zhí)行代碼：
修改代碼繼續(xù)演示
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname") # 注意這里添加了prog=testname
# 添加一個接收參數(shù)，默認值為Se7eN
parser.add_argument("-n", "--name", default="Se7eN")
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))
2、usage: 用來描述該程序的用途，并且會覆蓋原來的prog的顯示
修改部分程序：
# 創(chuàng)建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊")
展示結果
3、description:幫助文檔的描述和uasge功能類似，只是顯示的位置不一樣
繼續(xù)修改部分代碼：
# 創(chuàng)建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似")
展示結果
4、epilog:幫助文檔的額外說明，位置在最下面
繼續(xù)修改部分代碼：
# 創(chuàng)建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
展示結果：
5、自定義指令的前綴
默認是"-" 和 "--"，這里如果你不喜歡使用，也可以自通過該參數(shù)自己指定前綴，個人覺得沒必要。
代碼演示：
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象 ，并通過prefix_chars 指定指令的前綴為 '+'
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明", prefix_chars='+')
# 添加一個接收參數(shù)，默認值為Se7eN，這里的指令只能使用+ 表示，否則會報錯
parser.add_argument("+n", "++name", default="Se7eN")
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))執(zhí)行結果
四、add_argument指令參數(shù)解釋
1、action: 的作用比較多，有保存布爾類型，常量類型，數(shù)組類型的參數(shù)的功能
注意1：使用action = store_true/store_false 時修飾的指令是不能賦值的，其對應的指令的值是布爾類型的
注意2：使用action = store_const 時修飾的指令的是不能賦值，其對應的指令的值常量類型
注意3：使用action = append 是可以復制，其對應的值會將該指令對應的值放在一個數(shù)組中
1.1 先來演示
使用action，保存布爾類型的指令的值：store_true/store_false:保存布爾類型的變量：
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n，action = store_true 表示，<strong>在使用的時候，如果填寫了該指令，那么該指令對應的值就是true，如果沒有使用該指令，則為空</strong>
parser.add_argument("-n", "--name", action='store_true')
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))執(zhí)行結果：
1.2、使用action設置常量指令
修改代碼演示：
# 添加一個接收參數(shù) -n，action = store_const 表示，在使用的時候，如果填寫了該指令，那么該指就等于10 如果沒寫就等于空
parser.add_argument("-n", "--name", action='store_const',const=10)執(zhí)行結果：
1.3、使用action設置數(shù)組類型的指令
修改代碼演示：
# 添加一個接收參數(shù) -n，action = append， 會把該指令的值放在數(shù)組中
parser.add_argument("-n", "--name", action='append')執(zhí)行結果
2、nargs參數(shù)：表示該指令接收值的個數(shù)
示例1:
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n, 并且該參數(shù)還必須要接收2個值，會放在一個數(shù)組中，其中nargs等于幾，就表示要接受幾個參數(shù)
parser.add_argument("-n", "--name", nargs=2)
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))運行結果：
示例2：
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n,
# nargs = "?" : 表示只接收1個參數(shù)，正則表達式的寫法
# nargs = "+" : 表示接收1一個或多個參數(shù)
# nargs = "*" : 表示接收0個或者多個參數(shù)
parser.add_argument("-n", "--name", nargs="*")
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))打印結果就不演示了
3、required 該指令是必須的
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n,
# nargs = "?" : 表示只接收1個參數(shù)，正則表達式的寫法
# nargs = "+" : 表示接收1一個或多個參數(shù)
# nargs = "*" : 表示接收0個或者多個參數(shù)
parser.add_argument("-n", "--name", nargs="*", required=True)
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))演示結果：
4、choices:如有choices選項，則該指令的值只能是choices中的一個
代碼演示
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n,
# nargs = "?" : 表示只接收1個參數(shù)，正則表達式的寫法
# nargs = "+" : 表示接收1一個或多個參數(shù)
# nargs = "*" : 表示接收0個或者多個參數(shù)
parser.add_argument("-n", "--name", nargs="*", required=True, choices=['zhangsan', 'lisi'])
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))運行結果：
五、vars()
vars()方法可以將parser對象變成字典，方便使用
代碼演示
# 導入 argparse 模塊
import argparse
# 創(chuàng)建一個argparse 的對象
parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
# 添加一個接收參數(shù) -n,
# nargs = "?" : 表示只接收1個參數(shù)，正則表達式的寫法
# nargs = "+" : 表示接收1一個或多個參數(shù)
# nargs = "*" : 表示接收0個或者多個參數(shù)
parser.add_argument("-n", "--name", nargs="*", required=True, choices=['zhangsan', 'lisi'])
# 獲取對應的參數(shù)的值
args = parser.parse_args()
# 控制臺打印出來接收到的值
print("args = {}".format(args))
# 將parser 變成字典對象
print('arg_vars = {}'.format(vars(args)))輸出結果：
以上就是Python命令行參數(shù)解析包argparse的使用詳解的詳細內容，更多關于Python argparse的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了numpy.random.seed()的使用實例解析，分享了相關代碼示例，小編覺得還是挺不錯的，具有一定借鑒價值，需要的朋友可以參考下2018-02-02
這篇文章主要給大家介紹了關于python如何調用php文件中函數(shù)的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
在本篇內容里小編給大家整理的是一篇關于python縮進長度是否統(tǒng)一的相關知識點，需要的朋友們可以學習下。2020-08-08
本文主要介紹了pandas對齊運算的實現(xiàn)示例，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-10-10
自己寫的一個爬蟲，模仿了python核心編程書里的程序，有詳細的注釋。 是我一個理解學習的過程吧。 有需要的小伙伴可以參考下2015-11-11
Django的settings文件包含Django應用的所有配置項。接下來通過本文給大家介紹django settings.py 配置文件的相關知識，感興趣的朋友跟隨小編一起看看吧2019-07-07
這篇文章主要介紹了python線程池（threadpool）模塊使用筆記詳解，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-11-11
這篇文章主要為大家介紹了如何用Python制作一個迷宮游戲，文中的示例代碼講解詳細，對大家更好的理解和學習python有一定幫助，感興趣的朋友可以了解下2022-02-02
今天小編就為大家分享一篇TensorFlow2.0:張量的合并與分割實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-01-01
這篇文章主要為大家詳細介紹了python實現(xiàn)學生通訊錄管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-02-02