Python命令行参数解析模块argparse

前言

以前 optparse 比较火,但是在python2.7版本后,官方不再维护这个模块,转而大力支持 argparse

argparse 模块可以让人轻松编写用户友好的命令行接口。她可以从 sys.argv 中解析出参数,并自动生成帮助和使用手册,还能在传入无效参数时报出错误信息。

基础用法

由于是标准库,所以不需要安装,直接使用:

1
2
3
4
5
import argparse
parser = argparse.ArgumentParser()
# parser.add_argument("-i", "--info", action = "store", type = "string", dest = "sample_info", help = "the sample information")
args = parser.parse_args()
# print(args.sample_info)

运行以上代码,如下:

  • 不输入参数,也没有输出结果:

    1
    $ python3 test.py
  • 输入默认参数 --help (也可缩写为 -h ),会输出自动生成的帮助信息:

    1
    2
    3
    4
    5
    6
    7
    $ python3 test.py --help

    # 输出:
    usage: test.py [-h]

    optional arguments:
    -h, --help show this help message and exit
  • 输入错误参数,会输出报错信息:

    1
    2
    3
    4
    5
    $ python3 test.py -verbose

    # 输出:
    usage: test.py [-h]
    test.py: error: unrecognized arguments: --verbose

创建解析器

使用 argparse 的第一步是创建一个 ArgumentParser 对象,如下:

1
2
3
4
5
import argparse

parser = 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)
prog

默认情况下, ArgumentParser 对象在帮助消息中显示的程序名称是 sys.argv[0] 。若要自定义程序名,则使用 prog ,如下:

1
2
3
4
5
6
>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.print_help()
usage: myprogram [-h]

optional arguments:
-h, --help show this help message and exit

无论是从 sys.argv[0] 或是从 prog= 参数确定的程序名称,都可以在帮助消息里通过 %(prog)s 格式串来引用,如下:

1
2
3
4
5
6
7
8
>>> 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

usage

构建用法消息,如下:

1
2
3
4
5
6
7
8
9
10
11
12
>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
>>> parser.add_argument('--foo', nargs='?', help='foo help')
>>> parser.add_argument('bar', nargs='+', help='bar help')
>>> parser.print_help()
usage: PROG [options]

positional arguments:
bar bar help

optional arguments:
-h, --help show this help message and exit
--foo [FOO] foo help

description

简要描述这个程度做什么以及怎么做。在帮助消息中,这个描述会显示在命令行用法字符串和各种参数的帮助消息之间,如下:

1
2
3
4
5
6
7
8
>>> parser = argparse.ArgumentParser(description='A foo that bars')
>>> parser.print_help()
usage: argparse.py [-h]

A foo that bars

optional arguments:
-h, --help show this help message and exit

epilog

一些程序喜欢在 description 参数后显示额外的对程序的描述,如下:

1
2
3
4
5
6
7
8
9
10
11
12
>>> parser = argparse.ArgumentParser(
... description='A foo that bars',
... epilog="And that's how you'd foo a bar")
>>> parser.print_help()
usage: argparse.py [-h]

A foo that bars

optional arguments:
-h, --help show this help message and exit

And that's how you'd foo a bar

add_help

是否关闭自动生成的帮助信息,如下:

1
2
3
4
5
6
7
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> parser.add_argument('--foo', help='foo help')
>>> parser.print_help()
usage: PROG [--foo FOO]

optional arguments:
--foo FOO foo help

添加参数

使用 add_argument() 方法添加参数。其中,部分参数在下面都有它更详细的描述,但简而言之,它们是:

  • name or flags - 一个命名或者一个选项字符串的列表,例如 foo 或 -f, –foo。
  • action - 当参数在命令行中出现时使用的动作基本类型。
  • nargs - 命令行参数应当消耗的数目。
  • const - 被一些 action 和 nargs 选择所需求的常数。
  • default - 当参数未在命令行中出现时使用的值。
  • type - 命令行参数应当被转换成的类型。
  • choices - 可用的参数的容器。
  • required - 此命令行选项是否可省略 (仅选项可用)。
  • help - 一个此选项作用的简单描述。
  • metavar - 在使用方法消息中使用的参数值示例。
  • dest - 被添加到 parse_args() 所返回对象上的属性名。
name or flags

第一个传递给 add_argument() 的参数必须是一系列 flags 或者是一个简单的参数名,如下:

1
2
3
4
5
>>> parser.add_argument('-f', '--foo')

or

>>> parser.add_argument('bar')

action
  • store - 存储参数的值。这是默认的动作。如下:

    1
    2
    3
    4
    >>> parser = argparse.ArgumentParser()
    >>> parser.add_argument('--foo')
    >>> parser.parse_args('--foo 1'.split())
    Namespace(foo='1')
  • store_const - 存储被 const 命名参数指定的值。 store_const 动作通常用在选项中来指定一些标志。如下:

    1
    2
    3
    4
    >>> parser = argparse.ArgumentParser()
    >>> parser.add_argument('--foo', action='store_const', const=42)
    >>> parser.parse_args(['--foo'])
    Namespace(foo=42)
  • store_truestore_false - 这些是 store_const 分别用作存储 TrueFalse 值的特殊用例。另外,它们的默认值分别为 FalseTrue。如下:

    1
    2
    3
    4
    5
    6
    >>> parser = argparse.ArgumentParser()
    >>> parser.add_argument('--foo', action='store_true')
    >>> parser.add_argument('--bar', action='store_false')
    >>> parser.add_argument('--baz', action='store_false')
    >>> parser.parse_args('--foo --bar'.split())
    Namespace(foo=True, bar=False, baz=True)
  • append - 存储一个列表,并且将每个参数值追加到列表中。在允许多次使用选项时很有用。如下:

    1
    2
    3
    4
    >>> parser = argparse.ArgumentParser()
    >>> parser.add_argument('--foo', action='append')
    >>> parser.parse_args('--foo 1 --foo 2'.split())
    Namespace(foo=['1', '2'])
  • count - 计算一个关键字参数出现的数目或次数。例如,对于一个增长的详情等级来说有用。如下:

    1
    2
    3
    4
    >>> parser = argparse.ArgumentParser()
    >>> parser.add_argument('--verbose', '-v', action='count')
    >>> parser.parse_args(['-vvv'])
    Namespace(verbose=3)
  • version - 期望有一个 version= 命名参数在 add_argument() 调用中,并打印版本信息并在调用后退出。如下:

    1
    2
    3
    4
    5
    >>> 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

-------------已经触及底线  感谢您的阅读-------------
潘高 wechat
公众号:潘高陪你学编程
如果你觉得这篇文章对你有帮助,或者想给我微小的工作一点点资瓷,请随意打赏。

本文标题:Python命令行参数解析模块argparse

文章作者:潘高

发布时间:2019年06月03日 - 14:24:22

最后更新:2019年06月03日 - 15:43:03

原始链接:https://blog.pangao.vip/Python命令行参数解析模块argparse/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。