Python里argparse模块

本文介绍了Python标准库argparse的使用,包括命令行参数的定义、位置参数与选项参数的区别、ArgumentParser方法参数的用法,以及add_argument方法中name或flags、required、choices、nargs和dest等参数的详细解释,通过实例演示了如何设置和使用这些参数。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1. 定义:

argparse是python标准库里面用来处理命令行参数的库

2. 命令行参数

分为位置参数选项参数
位置参数就是程序根据该参数出现的位置来确定的
如:[root@kali /]# ls root/ #其中root/是位置参数
选项参数是应用程序已经提前定义好的参数,不是随意指定的
如:[root@kali /]# ls -l # -l 就是ls命令里的一个选项参数

3. 使用步骤:

import argparse    首先导入模块
def init_args():
	parser = argparse.ArgumentParser()    创建一个解析对象
	parser.add_argument()    向该对象中添加你要关注的命令行参数和选项
	return parser.parse_args()    进行解析

4. argparse.ArgumentParser()方法参数须知:一般我们只选择用description

		prog=None     - 程序名
  		description=None,    - help时显示的开始文字
   	epilog=None,     - help时显示的结尾文字
  		parents=[],        -若与其他参数的一些内容一样,可以继承
  		formatter_class=argparse.HelpFormatter,     - 自定义帮助信息的格式
  		prefix_chars='-',    - 命令的前缀,默认是‘-’
  		fromfile_prefix_chars=None,     - 命令行参数从文件中读取
  		argument_default=None,    - 设置一个全局的选项缺省值,一般每个选项单独设置
  		conflict_handler='error',     - 定义两个add_argument中添加的选项名字发生冲突时怎么处理,默认处理是抛出异常
    	add_help=True    - 是否增加-h/--help选项,默认是True)

5. add_argument()方法参数须知:

name or flags… - 必选,指定参数的形式,一般写两个,一个短参数,一个长参数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('echo')     # add_argument()指定程序可以接受的命令行选项
args = parser.parse_args()      # parse_args()从指定的选项中返回一些数据
print(args)
print(args.echo)

结果:
>python demo1.py foo
Namespace(echo=‘foo’)
foo

parser = argparse.ArgumentParser(description = 'this is a description')
parser.add_argument('--ver', '-v', action = 'store_true', help = 'hahaha')
# 将变量以标签-值的字典形式存入args字典
args = parser.parse_args()
if args.ver:
    print("Ture")
else:
    print("False")

结果:
>python demo1.py -v
Ture
>python demo1.py -j
usage: demo1.py [-h] [–ver]
demo1.py: error: unrecognized arguments: -j

required标签就是说–ver参数是必需的,并且类型为int,输入其它类型会报错

	parser.add_argument('--ver', '-v', required = True, type = int)

结果:
>python demo1.py -v 1
Ture
>python demo1.py -v ss
usage: demo1.py [-h] --ver VER
demo1.py: error: argument --ver/-v: invalid int value: ‘ss’

choices - 设置参数的范围,如果choice中的类型不是字符串,要指定type表示该参数能接受的值只能来自某几个值候选值中,除此之外会报错,用choice参数即可

parser.add_argument('file', choices = ['test1', 'test2'])
args = parser.parse_args()
print('read in %s'%(args.file))

结果:
>python demo1.py test1
read in test1

nargs - 指定这个参数后面的value有多少个,默认为1

# 表示脚本可以读入两个整数赋予num键(此时的值为2个整数的数组)
parser.add_argument('filename', nargs = 2, type = int)
args = parser.parse_args()
print('read in %s'%(args.filename))

结果:
>python demo1.py 1 2 3
usage: demo1.py [-h] filename filename
demo1.py: error: unrecognized arguments: 3
分析:nargs还可以’*‘用来表示如果有该位置参数输入的话,之后所有的输入都将作为该位置参数的值;‘+’表示读取至少1个该位置参数。’?'表示该位置参数要么没有,要么就只要一个。(PS:跟正则表达式的符号用途一致。)

dest - 设置这个选项的value解析出来后放到哪个属性中

parser.add_argument('-file', choices = ['test1', 'test2'], dest = 'world')
args = parser.parse_args()
print('read in %s'%(args.world))

结果:
>python demo1.py -file test1
read in test1

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值