python之argparse 模块

python之argparse 模块,第1张

argparse 模块主要用于处理 Python 命令行参数和选项,程序定义好所需参数后,该模块会通过 sys.argv 解析出那些参数;除此之外,argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。使用 argparse 模块,我们可以轻松的编写出用户友好的命令行接口。

我们先来看一个简单示例:

文件名为 test.py,在控制输入命令:python test.py --help,执行结果:

通过上面的执行结果,我们可以看出 Python 的可选参数包括:--help 和其简写 -h,Python 使用 - 来指定短参数,使用 -- 来指定长参数 ,我们执行一下 python test.py -h,执行结果:

如果使用未定义的参数会报错,如:执行命令 python test.py -a,执行结果:

接下来我们看一下如何自定义参数,因为上面示例中 ArgumentParser() 和 parse_args() 函数,我们还没有详细说,所以这里我们也具体看一下:

这个方法是用来创建解析器对象的,看一下方法中每一个参数的含义:

parse_args(args=None, namespace=None)

用来解析参数,看一下参数说明:

add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义单个的命令行参数应当如何解析,看一下参数说明:

下面我们通过具体示例看一下:

先在控制台执行命令 python test.py -h,执行结果:

我们可以看到参数已经添加进来了,接着执行命令 python test.py -n Jhon 或 python test.py --name Jhon,执行结果:

从结果可以看出我们已经获取了控制台中输入的参数值了。

参考:

https://docs.python.org/zh-cn/3/library/argparse.html

什么是argparse? argparse是Python原生自带的用于解析命令行参数的工具包,它可以帮助用户快速的编写用户友好的命令行界面。

基本来说,argparse的用法只需要按照下面的范例程序来将参数修改自己所需即可:

argparse是用于脚本带参数使用的,假设你有如下脚本名为prog.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即可获得帮助说明

$ python prog.py -h

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)

在再终端带参数输入命令行中,即可求得值

$ python prog.py 1 2 3 4

4

$ python prog.py 1 2 3 4 --sum

10


欢迎分享,转载请注明来源:夏雨云

原文地址:https://www.xiayuyun.com/zonghe/27917.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2023-02-18
下一篇2023-02-18

发表评论

登录后才能评论

评论列表(0条)

    保存