[每天一个python技巧]argparse.ArgumentParser()用法解析+action的使用分析

argparse.ArgumentParser()用法解析

**首先我们要搞清楚的问题： **
1.什么是argparse?
2.为什么要用argparse?

1. argparse 模块

argparse是一个Python模块：命令行选项、参数和子命令解析器

1. argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数
2. 其次，argparse 将弄清如何从 sys.argv 解析出那些参数。
3. argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

2. 使用流程

1. 创建解析器

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

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

2.添加参数

parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')

给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。

3.解析参数

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

ArgumentParser 通过 parse_args() 方法解析参数。

4.举例说明 example

以下代码是一个 Python 程序，它获取一个整数列表并计算总和或者最大值：

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 的文件中，它可以在命令行运行并提供有用的帮助消息：

$ 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

如果传入无效参数，则会报出错误：

$ python prog.py a b c
usage: prog.py [-h] [--sum] N [N ...]
prog.py: error: argument N: invalid int value: 'a'

3.开始介绍主角：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,
exit_on_error=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）
exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)
在 3.5 版更改: 添加 allow_abbrev 参数。
在 3.8 版更改: 在之前的版本中，allow_abbrev 还会禁用短旗标分组，例如 -vv 表示为 -v -v。
在 3.9 版更改: 添加了 exit_on_error 形参。

4.主要讲讲action

主要还是以查询到的一个例子来解释一下：

例如如下代码

# test.py
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument("--test_action", action='store_true')

    args = parser.parse_args()
    action_val = args.test_action

    print(action_val)

以上面的代码为例，若触发 test_action，则为 True， 否则为 False：

• $ python test.py，输出为 False
• $ python test.py --test_action，输出为 True

若在上面的代码中加入default，设为 False 时:

parser.add_argument("--test_action", default='False', action='store_true')

• $ python test.py，输出为 False
• $ python test.py --test_action，输出为 True

default 设为 True 时：

parser.add_argument("--test_action", default='True', action='store_true')

• $ python test.py，输出为 True
• $ python test.py --test_action，输出为 True

5.相关参考

https://blog.csdn.net/tsinghuahui/article/details/89279152
https://blog.csdn.net/the_time_runner/article/details/97941409

以及

官方中文-文档[https://docs.python.org/zh-cn/3/library/argparse.html#argumentparser-objects]