python命令行參數argparse模塊基本用法詳解

更新時間：2023年01月30日 08:48:26 作者：啊哈彭

argparse?是python自帶的命令行參數解析包，可以用來方便地讀取命令行參數，這篇文章主要介紹了python命令行參數-argparse模塊基本用法,需要的朋友可以參考下

一、傳入一個參數

import argparse

# 創(chuàng)建一個命令行參數解析器 
parser = argparse.ArgumentParser(description='命令行中傳入一個數字')
# 往解析器里面添加參數
parser.add_argument('integer', type=str, help='傳入的數字')
# 得到命令行傳入的參數
args = parser.parse_args()
print(args.integer)

二、傳入多個參數

import argparse

# 創(chuàng)建一個命令行參數解析器 
parser = argparse.ArgumentParser(description='命令行中傳入一個數字')
# 往解析器里面添加參數
parser.add_argument('integer', type=str, nargs='+', help='傳入的數字')
# 得到命令行傳入的參數
args = parser.parse_args()
print(args.integer)  # 以列表形式返回
注：
- nargs='+': 傳入一個或多個參數
- nargs='*': 傳入零個或多個參數
- nargs='?': 傳入零個或一個參數

三、改變數據類型

# 可通過更改type參數修改數據類型
parser.add_argument('integer', type=str, nargs='+', help='傳入的數字')

四、可選參數（關鍵字參數）

注：參數前面加雙橫杠"- -"表示這個參數是可選參數，即在命令行中可以以鍵值得形式指定，順序可以打亂。

import argparse

parser = argparse.ArgumentParser(description='姓名')
parser.add_argument('--family', type=str, help='姓')
parser.add_argument('--name', type=str, help='名')
args = parser.parse_args()
#打印姓名
print(args.family+args.name)

命令行命令：
python XXX.py --family 張 --name 三 or
python XXX.py --name 三 --family 張

五、參數默認值

通過default指定默認值。

parser.add_argument('--family', default='李', type=str, help='姓')
parser.add_argument('--name', type=str, help='名')

六、參數解析

parse_args()只能解析已知參數，parse_known_args()兼容未知參數并返回。

import argparse

parser = argparse.ArgumentParser(description='姓名')
parser.add_argument('--family', type=str,help='姓')
parser.add_argument('--name', type=str,help='名')

args = parser.parse_args()
# args, dynamic_args = parser.parse_known_args()

print(args)
print(dynamic_args)

命令行示例：
python XXX.py --family 張 --name 三 --test hello
結果：
args = parser.parse_args() # 報錯， error: unrecognized arguments: --test 5
args, dynamic_args = parser.parse_known_args() # 成功返回

在這里插入圖片描述

補充：python中的argparse基本用法

1、argparse是一個python模塊，用途是：命令行選項、參數和子命令的解釋。

2、使用步驟：

導入argparse模塊，并創(chuàng)建解釋器
添加所需參數
解析參數

3、用法示例：

import argparse

# 1.創(chuàng)建解釋器
parser = argparse.ArgumentParser(description="可寫可不寫，只是在命令行參數出現錯誤的時候，隨著錯誤信息打印出來。")
# 2.添加需要的參數
parser.add_argument('-gf', '--girlfriend', choices=['jingjing', 'lihuan'])
# 參數解釋
# -gf 代表短選項，在命令行輸入-gf和--girlfriend的效果是一樣的，作用是簡化參數輸入
#--girlfriend 代表完整的參數名稱，可以盡量做到讓人見名知意，需要注意的是如果想通過解析后的參數取出該值，必須使用帶--的名稱
# choices 代表輸入參數的只能是這個choices里面的內容，其他內容則會保錯
parser.add_argument('--house', type=int, default=0)
# 參數解釋
# --house 代表參數名稱
# type  代表輸入的參數類型，從命令行輸入的參數，默認是字符串類型
# default 代表如果該參數不輸入，則會默認使用該值
parser.add_argument('food')
# 參數解釋
# 該種方式則要求必須輸入該參數
# 輸入該參數不需要指定參數名稱，指定反而報錯，解釋器會自動將輸入的參數賦值給food

# 3.進行參數解析
args = parser.parse_args() 
print('------args---------',args)
print('-------gf-------', args.girlfriend)

4、命令行運行方式
假設上述文件的名字是gf.py
在命令行運行時，則有以下幾種情況：