简单易懂的add_argument()函数用法说明

add_argument() 是 Python 中 argparse 模块中的一个函数，用于向命令行解析器添加参数。它可以定义命令行中需要接受的参数，包括参数的名称、类型、默认值、帮助信息等。下面是对 add_argument() 函数的详细说明，并给出一个使用实例。

add_argument() 函数的用法：

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

参数说明：

- name or flags: 参数的名称或者命令行选项。

- action: 指定参数的动作，包括 store（存储参数值）、store_const（存储常量值）、store_true（存储 True）、store_false（存储 False）等。

- nargs: 指定参数接受的数量，可以是 "*"（接受任意数量的参数）、"+"（接受至少一个参数）、"?"（接受 0 或 1 个参数）或者一个具体的数字。

- const: 当参数使用了 store_const 动作时的常量值。

- default: 参数的默认值。

- type: 指定参数的类型，比如 int、float、str 等。

- choices: 参数的允许值的列表。

- required: 参数是否是必需的。

- help: 参数的帮助信息。

- metavar: 在帮助信息中显示的参数名称。

- dest: 参数的目标名称，当这个参数没有设置时，使用 name 的值。

使用实例：

假设我们要实现一个命令行程序，通过命令行参数传入两个整数，然后计算它们的和。以下是一个使用 add_argument() 函数的示例代码：

import argparse

def add_numbers(args):
    result = args.number1 + args.number2
    print("The sum of {} and {} is {}".format(args.number1, args.number2, result))

def main():
    parser = argparse.ArgumentParser(description="Add two numbers")
    parser.add_argument("number1", type=int, help="The first number")
    parser.add_argument("number2", type=int, help="The second number")
    args = parser.parse_args()
    add_numbers(args)

if __name__ == "__main__":
    main()

在上述示例代码中，我们首先导入 argparse 模块，然后定义了一个用于计算两个数字之和的函数 add_numbers()。在 main() 函数中，我们创建了一个 ArgumentParser 对象，并设置了命令的描述信息。然后，我们通过调用 add_argument() 函数来添加两个需要接受的参数 number1 和 number2。在 add_argument() 函数中，我们指定了参数的类型为整数，并提供了帮助信息。

最后，我们调用 parse_args() 函数解析命令行参数，并将结果传递给 add_numbers() 函数进行计算和输出。

通过在命令行中运行该脚本，并传入两个整数作为参数，就可以得到它们的和。

$ python script.py 5 3
The sum of 5 and 3 is 8

从以上示例中可以看出，add_argument() 函数使得在命令行程序中处理参数变得非常简单。它提供了丰富的选项来定义每个参数的类型、默认值、帮助信息等，使得程序的使用更加灵活和友好。