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

在本文中，我们将介绍如何通过使用Python的Argparse模块，在命令行解析中包含参数的默认值，并在“–help”中显示这些默认值。

Argparse模块简介

Argparse是Python的一个内置模块，用于处理命令行参数和选项的解析。它提供了一个简单而灵活的方法来解析命令行参数，并生成用户友好的帮助信息。Argparse可以帮助我们构建具有实用特性的命令行程序。

如何定义默认值

当我们使用Argparse模块解析命令行参数时，可以通过添加“default”参数来指定一个参数的默认值。这样，在命令行中如果没有为这个参数提供值，它将使用默认值。

下面是一个例子，演示了如何在Argparse中定义一个带有默认值的参数：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--name', default='World', help='The name to greet')

args = parser.parse_args()

print(f'Hello, {args.name}!')

在这个例子中，我们定义了一个名为“name”的参数，并将其默认值设置为“World”。如果我们在命令行中不指定“–name”参数的值，它将使用默认值“World”。

显示默认值的帮助信息

要在Argparse生成的帮助信息中包含参数的默认值，可以使用一些技巧。我们可以通过修改Argparse的帮助文本生成函数来实现这个目标。

下面是一个示例，演示了如何修改Argparse生成的帮助信息，以显示参数的默认值：

import argparse

class DefaultHelpFormatter(argparse.HelpFormatter):
    def _get_help_string(self, action):
        help = action.help
        if '%(default)' not in action.help:
            if action.default is not argparse.SUPPRESS:
                help += f' (default: {action.default})'
        return help

parser = argparse.ArgumentParser(formatter_class=DefaultHelpFormatter)
parser.add_argument('--name', default='World', help='The name to greet')

args = parser.parse_args()

print(f'Hello, {args.name}!')

在这个例子中，我们创建了一个名为“DefaultHelpFormatter”的自定义帮助文本生成类，继承自Argparse的默认帮助文本生成类。在自定义类中，我们重写了“_get_help_string”方法来修改帮助信息。如果帮助信息中不包含“%(default)”，并且指定了参数的默认值，我们将在帮助信息后面添加一个括号，显示参数的默认值。

示例：显示默认值的帮助信息

让我们通过一个例子来演示如何使用Argparse和自定义帮助文本生成类来显示默认值的帮助信息。

import argparse

class DefaultHelpFormatter(argparse.HelpFormatter):
    def _get_help_string(self, action):
        help = action.help
        if '%(default)' not in action.help:
            if action.default is not argparse.SUPPRESS:
                help += f' (default: {action.default})'
        return help

parser = argparse.ArgumentParser(formatter_class=DefaultHelpFormatter)
parser.add_argument('--name', default='World', help='The name to greet')

args = parser.parse_args()

print(f'Hello, {args.name}!')

在这个例子中，我们定义了一个名为“name”的参数，并将其默认值设置为“World”。通过使用自定义的帮助文本生成类“DefaultHelpFormatter”，在帮助信息中包含参数的默认值。

现在，当我们运行这个脚本时，如果不提供“–name”参数的值，将会在帮助信息中显示默认值：

$ python greet.py --help
usage: greet.py [-h] [--name NAME]

optional arguments:
  -h, --help   show this help message and exit
  --name NAME  The name to greet (default: World)

如上所示，帮助信息会明确提示参数“–name”的默认值是“World”。