argparse模块使用说明

argparse 是 Python 标准库中的一个模块，它提供了一个简单的方式来为 Python 程序添加命令行参数。以下是 argparse 的详细说明及使用指南：

导入模块

首先，你需要在你的 Python 脚本中导入 argparse 模块：

import argparse

创建解析器

接下来，你需要创建一个 ArgumentParser 对象。这个对象将包含你的程序所接受的命令行参数的信息：

parser = argparse.ArgumentParser(description="你的程序描述")

description 参数是一个字符串，用于描述你的程序是做什么的。这个描述将在用户运行你的程序并添加 -h 或 --help 标志时显示。

添加参数

使用 add_argument() 方法向解析器添加命令行参数。你可以指定参数名称、是否必要、类型、默认值、帮助信息等：

parser.add_argument("echo", help="回显输入的字符串")
parser.add_argument("--count", type=int, help="回显的次数", default=1)
parser.add_argument("--verbose", action="store_true", help="增加输出的详细程度")

 在这个例子中：

• echo 是一个位置参数，用户在命令行中必须提供这个值。
• --count 是一个可选参数，用户可以指定一个整数作为回显的次数，默认值为 1。
• --verbose 是一个标志参数，如果用户指定了这个参数，action="store_true" 会将其值设为 True。

解析参数

调用 parse_args() 方法来解析命令行中提供的参数。这会返回一个包含所有解析后参数值的命名空间对象：

args = parser.parse_args()

使用参数

现在，你可以通过访问 args 对象的属性来使用这些参数了：

for _ in range(args.count):
    if args.verbose:
        print(f"VERBOSE: {args.echo}")
    else:
        print(args.echo)

完整示例

以下是一个完整的示例脚本，它接受一个位置参数和两个可选参数：

import argparse

parser = argparse.ArgumentParser(description="回显输入的字符串指定次数，可选地增加详细输出。")
parser.add_argument("echo", help="要回显的字符串")
parser.add_argument("--count", type=int, help="回显的次数", default=1)
parser.add_argument("--verbose", action="store_true", help="增加输出的详细程度")

args = parser.parse_args()

for _ in range(args.count):
    if args.verbose:
        print(f"VERBOSE: {args.echo}")
    else:
        print(args.echo)

将上述代码保存为 echo.py，然后在命令行中运行：

python echo.py hello

输出将是：

hello

若添加 --count 和 --verbose 标志：

python echo.py --count 3 --verbose hello

 

输出将是：

VERBOSE: hello
VERBOSE: hello
VERBOSE: hello

其他功能

argparse 还提供了许多其他功能，比如：

• 添加子命令（通过 argparse.ArgumentDefaultsHelpFormatter 和 set_defaults() 方法）。
• 为参数设置自定义类型和动作。
• 处理互斥参数（使用 add_mutually_exclusive_group() 方法）。
• 生成帮助和使用信息（自动处理 -h 和 --help 标志）。

你可以查阅 Python 的官方文档来了解更多关于 argparse 的高级用法和功能。