python包合集-argparse
一、argparse簡介
argparse 是 python 自帶的命令行參數解析包，可以用來方便的服務命令行參數，使用之前需要先導入包 import argparse
二、簡單案例
簡單使用，創建一個名為test.py的文件
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser() # 添加一個接收參數，默認值為Se7eN parser.add_argument("-n", "--name", default="Se7eN") # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
打印結果為：
houlei@houleideMacBook-Pro argparse_demo % python3 test.py # 此時在test.py後面沒有跟上參數， args = Namespace(name='Se7eN') # 所以打印出來的name為默認值 Se7eN
再次驗證：
houlei@houleideMacBook-Pro argparse_demo % python3 test.py -n HOU # 此時後面跟上了 -n 參數，並且賦值HOU args = Namespace(name='HOU') # 打印出來 name 的值為 HOU houlei@houleideMacBook-Pro argparse_demo % python3 test.py --name hou # 此時後面跟上了 --name 參數，並賦值為hou args = Namespace(name='hou') # 打印出來的 name 的值為 hou houlei@houleideMacBook-Pro argparse_demo %
解釋說明
在上述代碼 parser.add_argument(“-n”, “–name”, default=”Se7eN”) 中，有兩個參數 「-n」和「–name」 分別代表什麼？其中-n 和 –name 都是我們自己自定的參數名。至於n和name ,你可以隨便起個變量名都可以，但是要注意，前面的一個 「-」和「–」才是關鍵。
一個「-」的參數，例如：-n, 他其實相當於我們在liunx中使用的指令，一個自定義的指令。
兩個「–」的參數，例如：–name 他就相當於在程序中，用來接收對對應指令值的變量，例如我們在控制台上輸入 python3 test.py -n hou。 其中 -n 就代表使用的 -n 的指令，然後將後面的 hou 的值賦值給對應的變量， -n 對應的變量就是 –name 。所以我們使用print 打印的時候才顯示的name = hou
簡單理解：一個「-」的是指令，兩個「–」的是接收指令內容的變量。
三、ArgumentParser參數
ArgumentParse是解析器對象，在創建一個解析器對象的時候，是有很多參數可以配置，下面就演示一下這些參數的使用
1、prog: 程序的名稱（默認值：sys.argv[0]）
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser() # 添加一個接收參數，默認值為Se7eN parser.add_argument("-n", "--name", default="Se7eN") # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
執行代碼：
修改代碼繼續演示
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname") # 注意這裡添加了prog=testname # 添加一個接收參數，默認值為Se7eN parser.add_argument("-n", "--name", default="Se7eN") # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
2、usage: 用來描述該程序的用途，並且會覆蓋原來的prog的顯示
修改部分程序：
# 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊")
展示結果
3、description:幫助文檔的描述和uasge功能類似，只是顯示的位置不一樣
繼續修改部分代碼：
# 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似")
展示結果
4、epilog:幫助文檔的額外說明，位置在最下面
繼續修改部分代碼：
# 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明")
展示結果：
5、自定義指令的前綴：默認是”-” 和 “–“，這裡如果你不喜歡使用，也可以自通過該參數自己指定前綴，個人覺得沒必要。
代碼演示：
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 ，並通過prefix_chars 指定指令的前綴為 '+' parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明", prefix_chars='+') # 添加一個接收參數，默認值為Se7eN，這裡的指令只能使用+ 表示，否則會報錯 parser.add_argument("+n", "++name", default="Se7eN") # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
執行結果
四、add_argument指令參數解釋
1、action: 的作用比較多，有保存布爾類型，常量類型，數組類型的參數的功能
注意1：使用action = store_true/store_false 時修飾的指令是不能賦值的，其對應的指令的值是布爾類型的
注意2：使用action = store_const 時修飾的指令的是不能賦值，其對應的指令的值常量類型
注意3：使用action = append 是可以複製，其對應的值會將該指令對應的值放在一個數組中
1.1 先來演示：使用action，保存布爾類型的指令的值：store_true/store_false:保存布爾類型的變量：
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n，action = store_true 表示，在使用的時候，如果填寫了該指令，那麼該指令對應的值就是true，如果沒有使用該指令，則為空 parser.add_argument("-n", "--name", action='store_true') # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
執行結果：
1.2、使用action設置常量指令
修改代碼演示：
# 添加一個接收參數 -n，action = store_const 表示，在使用的時候，如果填寫了該指令，那麼該指就等於10 如果沒寫就等於空 parser.add_argument("-n", "--name", action='store_const',const=10)
執行結果：
1.3、使用action設置數組類型的指令
修改代碼演示：
# 添加一個接收參數 -n，action = append， 會把該指令的值放在數組中 parser.add_argument("-n", "--name", action='append')
執行結果
2、nargs參數：表示該指令接收值的個數：
示例1:
import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n, 並且該參數還必須要接收2個值，會放在一個數組中，其中nargs等於幾，就表示要接受幾個參數 parser.add_argument("-n", "--name", nargs=2) # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
運行結果：
示例2：
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n, # nargs = "?" : 表示只接收1個參數，正則表達式的寫法 # nargs = "+" : 表示接收1一個或多個參數 # nargs = "*" : 表示接收0個或者多個參數 parser.add_argument("-n", "--name", nargs="*") # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
打印結果就不演示了
3、required 該指令是必須的
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n, # nargs = "?" : 表示只接收1個參數，正則表達式的寫法 # nargs = "+" : 表示接收1一個或多個參數 # nargs = "*" : 表示接收0個或者多個參數 parser.add_argument("-n", "--name", nargs="*", required=True) # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
演示結果：
4、choices:如有choices選項，則該指令的值只能是choices中的一個
代碼演示
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n, # nargs = "?" : 表示只接收1個參數，正則表達式的寫法 # nargs = "+" : 表示接收1一個或多個參數 # nargs = "*" : 表示接收0個或者多個參數 parser.add_argument("-n", "--name", nargs="*", required=True, choices=['zhangsan', 'lisi']) # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args))
運行結果：
五、vars()
vars()方法可以將parser對象變成字典，方便使用
代碼演示
# 導入 argparse 模塊 import argparse # 創建一個argparse 的對象 parser = argparse.ArgumentParser(prog="testname", usage="這是功能描述模塊", description="這是程序的介紹，和usage的功能模塊描述類似", epilog="額外說明") # 添加一個接收參數 -n, # nargs = "?" : 表示只接收1個參數，正則表達式的寫法 # nargs = "+" : 表示接收1一個或多個參數 # nargs = "*" : 表示接收0個或者多個參數 parser.add_argument("-n", "--name", nargs="*", required=True, choices=['zhangsan', 'lisi']) # 獲取對應的參數的值 args = parser.parse_args() # 控制台打印出來接收到的值 print("args = {}".format(args)) # 將parser 變成字典對象 print('arg_vars = {}'.format(vars(args)))
輸出結果：
