【Python进阶】关于argparse库的使用：便捷参数读取，解析，编写

本文链接：https://blog.csdn.net/Q52099999/article/details/136790771

文章目录

1 实例化参数类，增加参数
2 解析命令行参数
3 处理参数
4 综合示例

在Python中， parser包通常指的是 argparse模块，它是Python标准库中的一部分，用于解析命令行参数。 argparse模块使得编写命令行接口变得更加简单和灵活。

下面是argparse模块的一些主要功能和用法：

1 实例化参数类，增加参数

使用argparse.ArgumentParser()创建一个参数解析器对象，并使用add_argument()方法定义需要的命令行参数。你可以定义参数的名称、类型、默认值、帮助信息等。

argparse.ArgumentParser对象的add_argument方法用于向解析器添加命令行参数。该方法允许你指定程序所期望的命令行参数的各种属性，例如参数名称、类型、帮助信息等。下面是add_argument方法的一般语法和参数说明：

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

参数说明：

name or flags：参数名称或者标志。如果是单个字符串，它表示一个位置参数的名称；如果是多个字符串，它们表示可选参数的不同标志，例如'-f', '--foo'表示可选参数--foo。
action：参数的动作。常见的动作包括'store'（存储参数值）、'store_const'（存储常量值）、'store_true'（如果指定则存储True，否则存储False）、'store_false'（如果指定则存储False，否则存储True'）、'append'（将多个参数值存储为列表）、'append_const'（将常量值追加到列表）、'count'（计算参数出现的次数）等。
nargs：参数的个数。指定参数应该消耗的命令行参数的个数。常用值包括'?'（0个或1个参数）、'*'（0个或多个参数）、'+'（1个或多个参数）、一个整数值（固定个数的参数）。
const：const参数用于指定一个常量值，当命令行参数存在但没有提供值时，将使用该常量值作为参数的值。
default：参数的默认值。
type：参数的类型。
choices：参数值的可选值。
required：是否必须提供该参数。
help：参数的帮助信息。
metavar：在帮助信息中显示的参数值的名称。
dest：存储解析结果的属性名称。

下面是一个简单的示例

import argparse

parser = argparse.ArgumentParser(description='Example')
parser.add_argument('positional_arg', type=int, help='A required positional argument')
parser.add_argument('--optional_arg', type=str, default='default_value', help='An optional argument')
parser.add_argument('--flag', action='store_true', help='A flag, if present, sets the value to True')

这里要格外注意const和default的区别

如下面我这个代码所示

import argparse
parser=argparse.ArgumentParser()
parser.add_argument(
    "--input",
    const="const",
    nargs="?",如果使用const的话必须加上"nargs"，否则会报错ValueError: nargs must be '?' to supply const
    default="default",
)
prgs=parser.parse_args()
print(prgs.input)

如果我们执行Python test.py 不给任何命令参数

则会调用default，输出为default

如果我们执行 python test.py --input 给参数，但是不给参数的值

这时候会调用const，input会被赋值为const，输出为const

2 解析命令行参数

一旦定义了需要的命令行参数，可以调用parse_args()方法来解析命令行参数。这个方法会根据定义的参数来解析命令行输入，并返回一个命名空间对象，其中包含了解析后的参数值。

3 处理参数

一旦解析了命令行参数，你可以通过命名空间对象的属性来访问每个参数的值，并根据这些值执行相应的操作。

自动生成帮助信息： argparse会根据你定义的参数自动生成帮助信息。当用户在命令行输入-h或--help时，会显示包含参数名称、帮助信息等的帮助文档。

4 综合示例

下面是一个简单的示例，演示如何使用argparse模块来解析命令行参数：

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

# 处理参数
result = args.accumulate(args.integers)
print(result)