Argparse Python用法解析

  • argparse — 命令行选项、参数和子命令解析器 官方文档

argparse是一个Python库,用于编写用户友好的命令行接口,程序定义它需要的参数,然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。

简单实例:

# py文件
import argparse   #调用模块
#必须加载的类
parser = argparse.ArgumentParser(description='Process some integers.')
#添加参数
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')
#解析参数
args = parser.parse_args()
print(args.accumulate(args.integers))


# 命令行
$ python prog.py -h      #argparse自动生成的帮助
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

optional arguments:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)
  • Step1: 创建一个解析器

使用argparse的第一步是创建一个ArgumentParser对象,ArgumentParser对象包含将命令行解析成python数据类型所需要的全部信息。

parser =  argparse.ArgumentParser(description='Process some integers.')
说明:ArgumentParser对象
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

创建一个新的ArgumentParser对象,所有的参数都应当最为关键字参数传入,参数总结如下:

参数说明
prog程序的名称(默认:sys.argv[0])
usage描述程序用途的字符串(默认值:从添加到解析器的参数生成)
description在参数帮助文档之前显示的文本(默认值:无)
epilog在参数帮助文档之后显示的文本(默认值:无)
parents一个 ArgumentParser 对象的列表,它们的参数也应包含在内
formatter_class用于自定义帮助文档输出格式的类
prefix_chars可选参数的前缀字符集合(默认值:’-’)
fromfile_prefix_chars当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)
argument_default参数的全局默认值(默认值: None)
conflict_handler解决冲突选项的策略(通常是不必要的)
add_help为解析器添加一个 -h/–help 选项(默认值: True)
allow_abbrev如果缩写是无歧义的,则允许缩写长选项 (默认值:True)
  • Step2: 添加参数

给一个ArgumentParser添加程序参数信息是通过调用add_argument()方法完成的。通常,这些调用指定ArgumentParser如何获取命令行字符串并将其转换为对象。

parse.add_argument('--sum', dest='accumulate', action='store_const', const=sum, default=max,
help='sum the integers(default:find the max)')
说明:add_argument()方法

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述。

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
参数说明备注
name or flags一个命名或者一个选项字符串的列表,例如 foo 或 -f, --foo。位置参数不加杠
action当参数在命令行中出现时使用的动作基本类型store’(默认) ‘store_const’, etc.
nargs命令行参数应当消耗的数目若不提供则由action决定消耗参数数目
const被一些 action 和 nargs 选择所需求的但不从命令行读取的常数使用store_const append_const时须给出
default当参数未在命令行中出现时使用的值默认None
type命令行参数(默认被当作字符)应当被转换成的类型
choices可用的参数的容器使得检查更方便的检查一个范围的值
required此命令行选项是否可省略 (仅选项可用)
help一个此选项作用的简单描述
metavar- 在使用方法消息中使用的参数值示例
dest被添加到 parse_args() 所返回对象上的属性名
  • Step3: 解析参数

ArgumentParser通过parse_args()方法解析参数。它将检查命令行,把每个参数转换为适当的类型然后调用相应的操作。

parser.parse_args()

参考:

[1] argparse官方文档
[2] argparse.ArgumentParser()用法解析

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值