快捷導(dǎo)航

python命令行參數(shù)argparse模塊基本用法詳解

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

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

一、傳入一個(gè)參數(shù)

import argparse

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

二、傳入多個(gè)參數(shù)

import argparse

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

三、改變數(shù)據(jù)類型

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

四、可選參數(shù)（關(guān)鍵字參數(shù)）

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

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 張

五、參數(shù)默認(rèn)值

通過(guò)default指定默認(rèn)值。

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

六、參數(shù)解析

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

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
結(jié)果：
args = parser.parse_args() # 報(bào)錯(cuò)， error: unrecognized arguments: --test 5
args, dynamic_args = parser.parse_known_args() # 成功返回

在這里插入圖片描述

補(bǔ)充：python中的argparse基本用法

1、argparse是一個(gè)python模塊，用途是：命令行選項(xiàng)、參數(shù)和子命令的解釋。

2、使用步驟：

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

3、用法示例：

import argparse

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

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

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