在 Argparse 中如何显式标示必需的参数？

python

2024-03-24 18:50:20

在 Argparse 中显式标示必需的参数

问题

在使用 Argparse 解析命令行参数时，你可能希望某些参数是必需的，但默认情况下，Argparse 不会明确指出哪些参数是必需的。这可能会导致用户混淆，因为他们可能不会意识到某些参数是必需的，从而导致脚本运行错误。

解决方案

为了解决这个问题，我们需要使用 add_argument() 方法的 required 参数。此参数接受布尔值，表示参数是否是必需的。对于必需的参数，应将 required 设置为 True。

代码示例

以下是修改后的代码示例，其中指示 -i 参数是必需的：

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description='Foo')
    parser.add_argument('-i','--input', help='Input file name', required=True)
    parser.add_argument('-o','--output', help='Output file name', default="stdout")
    args = parser.parse_args()
    print ("Input file: %s" % args.input )
    print ("Output file: %s" % args.output )

现在，当用户尝试在不提供 -i 参数的情况下运行脚本时，他们将看到以下错误消息：

usage: foo.py [-h] -i INPUT [-o OUTPUT]

Foo

positional arguments:
  INPUT                Input file name

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output file name