python argparse模块简介

最新推荐文章于 2024-08-21 08:56:34 发布
最新推荐文章于 2024-08-21 08:56:34 发布
阅读量527 收藏 1
点赞数 2
分类专栏： 笔记 argparse Python ArgumentParser
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xff1994/article/details/79525160
版权
笔记 同时被 3 个专栏收录
15 篇文章 2 订阅
订阅专栏
Python
2 篇文章 0 订阅
订阅专栏
argparse
1 篇文章 0 订阅
订阅专栏

argparse

​ argparse模块可以用来方便地处理命令行参数。

基本使用示例

  1. 创建一个ArgumentParse对象，ArgumentParser对象可以将命令行参数转变为Python数据。

    >>> parser = argparse.ArgumentParser(description='Process some integers.')

  2. 添加参数

    >>> 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)')

  3. 解析参数。parse_args()会扫描命令行，将命令行参数转换为Python数据并激活相应action。通常，这会建立一个namespace对象。

    >>> parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

使用详解

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)

  1. 常用参数

    • prog ：定义在帮助信息中显示的程序名，默认使用sys.argv[0]。无论是使用自定义的程序名还是sys.argv[0]，在帮助信息都可以使用%(prog)s引用。

      >>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.add_argument('--foo', help='foo of the %(prog)s program')
>>> parser.print_help()
usage: myprogram [-h] [--foo FOO]
​
optional arguments:
 -h, --help  show this help message and exit
 --foo FOO   foo of the myprogram program

    • description和epilog： description用于定义程序的简短描述，epilog定义程序的其他额外信息。

    • prefix_chars：用于自定义命令行参数前缀。默认为'-'，可以使用-h/--help这种参数形式。可以改变为其他字符或者增加其他字符，比如prefix_chars='-*+'。

    • fromfile_prefix_chars：定义文件起始符，这些字符后的参数会被当做文件。

      >>> with open('args.txt', 'w') as fp:
...     fp.write('-f\nbar')
>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
>>> parser.add_argument('-f')
>>> parser.parse_args(['-f', 'foo', '@args.txt'])
Namespace(f='bar')

      ​

  2. 其他参数

    • usage：用于自定义usage信息的显示格式。

    • parents：接受一个由ArgumentParser对象组成的列表，列表中每个ArgumentParser的参数都会被添加到当前ArgumentParser对象。

    • formatter_class：用于自定义帮助信息显示格式。

    • allow_abbrev：允许参数简写。

    • conflict_handler：解决参数冲突(不同action有相同的选项字符串)。

    • add_help：设置为false时，不会自动添加-h/--help选项。

add_argument()方法

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

  1. 常用参数

    • name or flags：add_argument()可以添加optional参数或positional参数，传递给add_argument()的第一个参数必须是一系列flags(optional argument)或者一个name(optional argument)。注意，添加positional参数后命令行必须输入该参数，否则会报错。optional参数会通过前缀识别，剩余的都被认为是positional参数。

      >>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args(['BAR'])
Namespace(bar='BAR', foo=None)
>>> parser.parse_args(['--foo', 'FOO', 'BAR'])
Namespace(bar='BAR', foo='FOO')
>>> parser.parse_args(['--foo', 'FOO'])
usage: PROG [-h] [-f FOO] bar
PROG: error: too few arguments

    • action：定义怎样处理命令行参数。常用的actions有：

      • store：store是默认值，只会存储命令行参数的值。store_const存储由const指定的参数值。

      • store_const、store_true和store_false：用于指定命令行参数的缺省值。store_const缺省值由const关键字指定，后两者指定布尔值。

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_const', const=42)
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=42, bar=False, baz=True)

        注意最后一行的输出，baz确实是True。这三种store只是指定了当命令行出现了相应选项而没有指定参数值时应采用的缺省值，而不是命令行参数的默认值。

      • append：存储一个列表，将每个参数值追加到列表中。这将允许对一个选项进行多次赋值。

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='append')
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['1', '2'])

      • append_const：存储一个列表，并将const关键字参数指定的值添加到列表中。这将允许多个选项将值存到同一个列表中。

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--str', dest='types', action='append_const', const=str)
>>> parser.add_argument('--int', dest='types', action='append_const', const=int)
>>> parser.parse_args('--str --int'.split())
Namespace(types=[<class 'str'>, <class 'int'>])

      • version：用于显示版本信息。

        >>> import argparse
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')
>>> parser.parse_args(['--version'])
PROG 2.0

      • 其他action：count、help以及自定义的action。

    • nargs：通常，ArgumentParser对象会将一个命令行参数与一个单独的action关联，nargs允许将多个命令行参数关联到一个动作。支持的取值有：

      • N(an integer)：N个命令行参数值会被收集到一个列表

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs=2)
>>> parser.add_argument('bar', nargs=1)
>>> parser.parse_args('c --foo a b'.split())
Namespace(bar=['c'], foo=['a', 'b'])

      • '?'：会从命令行参数中推测一个值，如果没有，会采用默认值或缺省值。

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs='?', const='c', default='d')
>>> parser.add_argument('bar', nargs='?', default='d')
>>> parser.parse_args(['XX', '--foo', 'YY'])
Namespace(bar='XX', foo='YY')
>>> parser.parse_args(['XX', '--foo'])
Namespace(bar='XX', foo='c')
>>> parser.parse_args([])
Namespace(bar='d', foo='d')

        这通常被用于输入输出：

        >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
default=sys.stdin)
>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
default=sys.stdout)
>>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,
outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)
>>> parser.parse_args([])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,
outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)

      • 其他取值：'*'、'+'、'argparse.REMAINDER'。

    • type：通常，命令行参数会被读为字符串，type允许进行类型检查和转换。

      >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', type=int)
>>> parser.add_argument('bar', type=open)
>>> parser.parse_args('2 temp.txt'.split())
Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2)

      还可以用来处理文件读写。argparse模块提供了FileType factory。可以接受open()函数的参数，比如mode=、bufsize=、encoding=以及errors=。

      >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar', type=argparse.FileType('w'))
>>> parser.parse_args(['out.txt'])
Namespace(bar=<_io.TextIOWrapper name='out.txt' encoding='UTF-8'>)

    • choices：限定命令行参数的在一定范围内取值。

      >>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args(['rock'])
Namespace(move='rock')
>>> parser.parse_args(['fire'])
usage: game.py [-h] {rock,paper,scissors}
game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')

    • dest：通常，ArgumentParser的actions会将命令行参数的值转化为parse_args()返回对象的属性值。对于positional参数，属性名由第一个参数决定。对于optional参数，属性名由第一个长参数去掉'--'后进行一些其他处理产生；如果没有长参数，则由第一个短参数去掉'-'后产生。

      >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar')
>>> parser.parse_args(['XXX'])
Namespace(bar='XXX')
​
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-f', '--foo-bar', '--foo')
>>> parser.add_argument('-x', '-y')
>>> parser.parse_args('-f 1 -x 2'.split())
Namespace(foo_bar='1', x='2')
>>> parser.parse_args('--foo 1 -y 2'.split())
Namespace(foo_bar='1', x='2')

      dest关键字参数可以为属性指定其他名称。

      >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')

    • metavar：当ArgumentParser产生帮助信息时，需要引用命令行参数。默认情况下，对positional参数，会直接使用dest值；对optional参数，会使用dest的大写值。metavar参数允许指定为其他值。注意，这只改变命令行选项在帮助信息中的显示名，不改变对象中的属性名。

      >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', metavar='YYY')
>>> parser.add_argument('bar', metavar='XXX')
>>> parser.parse_args('X --foo Y'.split())
Namespace(bar='X', foo='Y')
>>> parser.print_help()
usage:  [-h] [--foo YYY] XXX
​
positional arguments:
 XXX
​
optional arguments:
 -h, --help  show this help message and exit
 --foo YYY

  2. 其他参数

    • const：用法见前文。

    • default：设置默认值。

    • required：可以使optional参数成为必选参数。

    • help：选项的简短介绍，显示在帮助信息中。

parse_args()方法

ArgumentParser.parse_args(args=None, namespace=None)

  1. args参数接受以下形式：

    • 选项与值分开：

      >>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')
>>> parser.parse_args(['--foo', 'FOO'])
Namespace(foo='FOO', x=None)

    • 对于长参数(选项名不止一个字符)，可以由=连接选项和值：

      >>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)

    • 对于短选项，可以将选项和值连在一起：

      >>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')

    • 当多个短选项中只有最后一个需要参数值的话，可以合并在一起：

      >>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x', action='store_true')
>>> parser.add_argument('-y', action='store_true')
>>> parser.add_argument('-z')
>>> parser.parse_args(['-xyzZ'])
Namespace(x=True, y=True, z='Z')

  2. Namespace对象

    parse_args()返回的namespace对象只是一个简单的对象(object的子类)。也可以将属性值添加到一个已经存在的其他对象上：

    >>> class C:
...     pass
...
>>> c = C()
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)
>>> c.foo
'BAR'


xff1994
关注
专栏目录
python中argparse模块简介
aoanng的博客
11-14 1063
Python解析命令行读取参数 – argparse模块 前言： 在多个文件或者不同语言协同的项目中，python脚本经常需要从命令行直接读取参数。万能的python就自带了argprase包使得这一工作变得简单而规范。PS：optparse包是类似的功能，只不过写起来更麻烦一些。 argparse模块： argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optp...
Python | 使用argparse解析命令行参数
TechFlow的博客
09-08 1916
今天是Python专题第27篇文章，我们来聊聊Python当中的命令行参数工具argparse。 命令行参数工具是我们非常常用的工具，比如当我们做实验希望调节参数的时候，如果参数都是通过硬编码写在代码当中的话，我们每次修改参数都需要修改对应的代码和逻辑显然这不太方便。比较好的办法就是把必要的参数设置成通过命令行传入的形式，这样我们只需要在运行的时候修改参数就可以了。 sys.argv 解析命令行传入参数最简单的办法就是通过sys.argv，sys.argv可以获取到我们通过命令行传入的参数。 import
Python中的argparse模块
weixin_30625691的博客
08-05 268
简介 argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数. 如果你想详细的了解它的功能.建议阅读这个,或者这个 本篇文章只对其基本功能进行介绍,并对TensorFlow的examples中argarse使用进行详细的介绍 功能 原本的功能是命令行解析模块 使用argp...
Python中的Argparse：构建强大命令行工具的基石
最新发布
这家伙很懒，什么都没有留下
08-21 1167
在Python编程中，创建能够处理命令行参数的程序是提升脚本灵活性和可复用性的关键步骤。argparse模块是Python标准库中的一个强大工具，它允许程序开发者轻松编写用户友好的命令行接口。本文将深入介绍argparse的使用，包括其基本功能、高级特性、常见陷阱以及通过实际案例展示如何构建功能丰富的命令行应用程序。适合希望从基础开始，逐步掌握命令行参数解析技术的Python新手及进阶开发者。
Python argparse 简介
qq_52852138的博客
03-07 423
前言 在运行python程序时，我们或许需要一些可选参数。对于这些参数，我们可以通过命令行输入。 最简单情况下，我们通过命令行运行python程序，使用的命令如下所示 python demo.py # demo是程序的名字,可以自由选择 我现在想加入一个参数 name，应该怎么做呢。其中一种方式如下所示 python demo.py --name Trump 这种方式我见到过很多次，那这种功能是怎么实现的呢？通过argparse包就能实现。 argparse 现在假定，python文件名为
Python argparse模块详解
qq_42855293的博客
03-11 6014
argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。 官方文档中讲到的，本文基本都提到了，但只是简要记录，如果需要深入理解，可查看原文。 https://docs.python.org/3/library/argparse.html 使用步骤 import argparse # 导入模板 parser = argparse.ArgumentParser() # 创建parser parser.add_argu
Python argparse 模块介绍
qq_457728163的博客
06-27 352
Python argparse 模块介绍 argparse argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，可以方便程序执行的时候传递参数，下面将介绍一下具体的用法： 模块导入 由于是python内置的模块，直接import即可： import argparse 简单例子 import argparse parse = argparse.ArgumentParser...
python argparse模块详解多级_Python argparse模块详解
weixin_31445091的博客
02-02 806
一、作用当用户使用命令行执行Python脚本时，或者在shell文件中执行python文件，经常在python xxx.py后跟参数，argparse模块就是为了解析这些参数。二、样例import argparse#创建命令解析器parser = argparse.ArgumentParser()#添加一个参数parser.add_argument('--foo', action='store_c...
【Python】argparse模块详解
zzy_NIC的博客
08-20 6581
Python argparse模块详解 argparse 是一个用来解析命令行参数的 Python 库，它是 Python 标准库的一部分。基于 python 2.7 的 stdlib 代码。argparse 模块使编写用户友好的命令行界面变得容易。程序定义了所需的参数，而 argparse 将找出如何从 sys.argv 中解析这些参数。argparse 模块还会自动生成帮助和使用消息，并在用户为程序提供无效参数时发出错误。 简单实现圆柱体体积的计算 为了便于对argparse命令行参数解析模块的理解，我
Python argparse模块详解
Running Snail
08-29 1147
文章目录前言简单介绍argparseargparse使用基本步骤add_argument() 方法示例     前言 在很多论文的源码中，会有以下这种代码: parser = argparse.ArgumentParser(description="Run NGCF.") parser.add_argument('--weights_path', nargs='?', default='',help='Store model path.') parser.add_argument('--data_pat
Python argparse模块使用方法解析
09-17
#### 二、argparse模块的基本概念 1. **ArgumentParser对象**：这是使用 `argparse` 的起点，所有的命令行解析都是基于 `ArgumentParser` 对象完成的。 2. **add_argument 方法**：用于向 `ArgumentParser` 添加...
python argparse
Claroja
07-01 335
https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser 初始化对象 class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=No
Python命令行解析argparse常用语法使用简介
zhaoluruoyan89的博客
09-03 460
下面介绍下例子代码。 1、导入argparse模块 2、创建解析器对象ArgumentParser，可以添加参数。 description：描述程序 parser=argparse.ArgumentParser(description="This is a example program ") add_help：默认是True，可以设置False禁用 3、add_argument()方...
Python的argparse
从零开始的教程世界
07-15 2147
Python argparse module is the preferred way to parse command line arguments. Parsing command-line arguments is a very common task, which Python scripts do and behave according to the passed values. Py...
Python之argparse
magices的博客
07-06 9397
定义：argparse是python标准库里面用来处理命令行参数的库 命令行参数分为位置参数和选项参数： 位置（必选）参数：前面不需要-或者–； 可选参数：通过一个-来指定的短参数，如-h；通过–来指定的长参数，如- -help 使用步骤： （1）import argparse 首先导入模块 （2）parser = argparse.ArgumentParser（） 创建一个解析对象 （3）parser.add_argument() 向该对象中添加你要关注的命令行参数和选项 （4）args
python之argparse
qq_44632658的博客
06-28 212
当你在服务端要运行一个工具或服务时，输入参数似乎是一种硬需（当然你也可以通过配置文件来实现）。这样的标志 指示可选参数，这些参数在命令行中始终可以省略。值是一个字符串，包含参数的简要说明。值是一个字符串，则解析器会将该值视为 是一个命令行参数 特别是，分析器应用任何。关键字参数将一个 不同数量的命令行参数。关键字参数将一个 不同数量的命令行参数。将收集来自命令行的参数 一起列成一个清单。将收集来自命令行的参数 一起列成一个清单。- 要添加到返回的对象的属性的名称。- 应该使用的命令行参数的数量。
Python中的argparse
木盏
04-15 1417
在脚本化python程序的过程中，经常需要解析args。例如： python download.py --url https://abc.bcd.io/tiq.mp4 –url这个玩意儿就叫args。使用args可以不需要修改.py文件的代码就可以完成脚本配置。 在python中，最常见的args工具就是argparse。 直接看一段代码： import argparse parser = argparse.ArgumentParser('demo', add_help=False) parser.ad
python中的argparse
回首愁的博客
08-20 2566
因为平常用python命令行给不多，所以也只是知道有argparse这个库，现在遇到了看了下。实现基本的功能还是比较简单的。 一、argparse介绍 argparse是python的一个用于命令行选项和参数解析的模块。本质上是用sys.argv从命令行语句中解析出命令行参数，然后自动生成帮助和使用信息。 参考官方链接：Argparse Tutorial — Python 3.9.6 documentation 二、 argparse简单使用 1、argparse使用流程： 导入argparse imp
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值