Python Argparse: 如何在“–help”中包含默认值

在本文中，我们将介绍Python中的Argparse模块，并探讨如何在“–help”中包含参数的默认值。

什么是Argparse？

Argparse是Python标准库中用于解析命令行参数和选项的模块。它提供了一个简单且灵活的机制来定义命令行接口，并解析用户提供的输入。

Argparse的基本用法

首先，我们需要导入Argparse模块：

import argparse

然后，我们可以创建一个ArgumentParser对象来定义我们的命令行接口：

parser = argparse.ArgumentParser(description='This is a program that demonstrates the usage of Argparse.')

在上面的代码中，我们使用description参数来提供一个简短的描述，这个描述将会出现在“–help”输出中。

接下来，我们可以添加参数和选项到ArgumentParser对象中：

parser.add_argument('--input', help='Input file path.', required=True)

在上面的代码中，我们使用add_argument方法添加了一个名为input的选项。我们可以使用help参数来提供关于这个选项的帮助信息。required参数表示该选项是否是必需的。

一旦我们定义了我们的参数和选项，我们可以使用parse_args方法来解析用户提供的输入：

args = parser.parse_args()

现在，我们可以使用args对象来访问用户提供的参数和选项的值：

print(args.input)

如何在“–help”中包含默认值？

默认情况下，Argparse会自动生成“–help”输出，并显示所有参数和选项的帮助信息。然而，默认值不会包含在帮助信息中。幸运的是，Argparse提供了一个简单的方法来解决这个问题。

我们可以使用default参数来定义默认值。例如：

parser.add_argument('--input', help='Input file path.', required=True, default='input.txt')

在上面的例子中，我们使用default参数将input选项的默认值设置为’input.txt’。当用户没有提供input选项时，该默认值将被使用。

现在，当我们运行程序并使用“–help”选项时：

$ python program.py --help

我们可以看到“–input”选项的帮助信息中包含了默认值：

--input INPUT       Input file path. (default: input.txt)

示范

让我们以一个更完整的示例来演示如何在“–help”中包含默认值。假设我们正在编写一个程序，用于计算两个数的和。我们想要提供两个命令行参数：num1和num2，并且希望它们的默认值分别为0和10。

import argparse

parser = argparse.ArgumentParser(description='This program calculates the sum of two numbers.')
parser.add_argument('--num1', type=int, help='The first number.', default=0)
parser.add_argument('--num2', type=int, help='The second number.', default=10)

args = parser.parse_args()

sum = args.num1 + args.num2
print('The sum of {} and {} is {}'.format(args.num1, args.num2, sum))

现在，让我们使用“–help”选项来查看帮助信息：

$ python program.py --help

输出结果如下：

usage: program.py [-h] [--num1 NUM1] [--num2 NUM2]

This program calculates the sum of two numbers.

optional arguments:
  -h, --help   show this help message and exit
  --num1 NUM1  The first number. (default: 0)
  --num2 NUM2  The second number. (default: 10)

正如我们所见，帮助信息中包含了num1和num2的默认值。