首页 > 脚本专栏 > python > Python argparse命令行参数

深入解析 Python 的 argparse命令行参数的实战案例

2025-08-08 10:38:22 作者：萧鼎

argparse是开发Python命令行工具不可或缺的标准模块,它功能全面、文档丰富、学习曲线平缓,只要掌握了它,你就可以轻松将任何 Python 脚本变成一个强大、优雅、可维护的命令行工具,本文带领深入解析Python的argparse命令行参数,需要的朋友跟随小编一起看看吧

在日常的 Python 开发中，我们常常希望脚本能够像命令行工具一样运行，能够接受不同的参数或选项，灵活控制程序行为。Python 的标准库 argparse 就为我们提供了一个强大、灵活且易用的命令行参数解析工具。

本文将带你系统了解 argparse 的核心功能、常用模式、进阶用法，以及开发命令行工具的最佳实践。

一、什么是 argparse？

argparse 是 Python 标准库中用于处理命令行参数的模块。它允许我们通过命令行传递参数和选项，并在脚本中方便地进行解析和处理。相较于 sys.argv 的手动解析，argparse 提供了更加结构化、用户友好和可维护的方式。

✅ argparse 的优点：

支持位置参数和可选参数；
自动生成 --help 帮助信息；
类型检查和自动转换；
多个子命令支持（如 git commit、git push）；
良好的错误提示机制。

二、基本用法

我们从一个简单的例子开始：

import argparse
parser = argparse.ArgumentParser(description="这是一个演示脚本")
parser.add_argument("name", help="你的名字")
parser.add_argument("--age", type=int, help="你的年龄", default=18)
args = parser.parse_args()
print(f"你好, {args.name}！你今年 {args.age} 岁。")

运行：

python demo.py Alice --age 25

输出：

你好, Alice！你今年 25 岁。

解析代码说明：

ArgumentParser()：创建参数解析器。
add_argument()：添加一个参数，第一个是参数名，-- 开头的是“可选参数”，否则为“位置参数”。
parse_args()：从命令行获取参数并解析为对象。
args.name / args.age：通过属性访问解析结果。

三、常用参数详解

1. 类型转换

parser.add_argument("--count", type=int)

自动将输入转换为整数，如果输入错误会报错。

2. 设置默认值

parser.add_argument("--city", default="Shanghai")

如果不传 --city，默认值为 "Shanghai"。

3. 布尔开关参数（action）

parser.add_argument("--verbose", action="store_true")

使用方式：

python demo.py --verbose

则 args.verbose == True，否则为 False。

4. 选择参数（choices）

parser.add_argument("--mode", choices=["train", "test", "eval"])

只有传入 "train"、"test" 或 "eval" 才会通过验证。

5. 多值参数（nargs）

parser.add_argument("--nums", nargs='+', type=int)

支持：

python demo.py --nums 1 2 3 4

结果：args.nums = [1, 2, 3, 4]

四、位置参数与可选参数

位置参数

位置参数必须按顺序输入，例如：

parser.add_argument("filename")

则必须调用时传入：

python demo.py input.txt

否则会报错。

可选参数

使用 -- 或 - 开头的是可选参数，如：

parser.add_argument("-o", "--output")

可以这样传入：

python demo.py -o result.txt

五、子命令支持（subparsers）

想实现类似 Git 命令那样的子命令结构：

python tool.py train --epochs 10
python tool.py test --model model.pth

可以使用 subparsers：

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest="command")
# 子命令 train
train_parser = subparsers.add_parser("train")
train_parser.add_argument("--epochs", type=int)
# 子命令 test
test_parser = subparsers.add_parser("test")
test_parser.add_argument("--model")
args = parser.parse_args()
if args.command == "train":
    print(f"开始训练，共 {args.epochs} 个 epoch")
elif args.command == "test":
    print(f"使用模型 {args.model} 进行测试")

六、进阶技巧与使用建议

1. 添加参数分组（group）

group = parser.add_argument_group("训练参数")
group.add_argument("--batch_size", type=int)

这在帮助信息中会将参数分组显示，提高可读性。

2. 使用metavar优化帮助提示

parser.add_argument("--output", metavar="FILE", help="输出文件路径")

metavar 会在 help 中显示为 --output FILE，更清晰。

3. 打印默认值ArgumentDefaultsHelpFormatter

parser = argparse.ArgumentParser(
    description="示例",
    formatter_class=argparse.ArgumentDefaultsHelpFormatter
)

这样在 --help 中会显示每个参数的默认值。

七、错误处理与帮助信息

默认情况下，argparse 自动生成：

python demo.py --help

会打印出所有参数说明和用法。

错误参数会自动提示：

error: argument --age: invalid int value: 'abc'

你还可以自定义错误处理逻辑：

try:
    args = parser.parse_args()
except SystemExit:
    print("请检查命令行参数是否正确")

八、实战案例：批量图像处理工具

一个用于图像缩放的 CLI 工具：

import argparse
from PIL import Image
import os
parser = argparse.ArgumentParser(description="批量图像缩放工具")
parser.add_argument("input_dir", help="输入文件夹路径")
parser.add_argument("output_dir", help="输出文件夹路径")
parser.add_argument("--scale", type=float, default=0.5, help="缩放比例")
args = parser.parse_args()
if not os.path.exists(args.output_dir):
    os.makedirs(args.output_dir)
for file in os.listdir(args.input_dir):
    if file.lower().endswith((".png", ".jpg", ".jpeg")):
        img = Image.open(os.path.join(args.input_dir, file))
        new_size = (int(img.width * args.scale), int(img.height * args.scale))
        resized_img = img.resize(new_size)
        resized_img.save(os.path.join(args.output_dir, file))
print("处理完成！")