Python命令行脚本教程_argparse参数解析实战

argparse是Python标准库中最常用、最可靠的命令行参数解析工具,支持自动帮助生成、类型校验、默认值、子命令等功能,比手动解析sys.argv更清晰健壮。

Python命令行脚本中,argparse 是标准库中最常用、最可靠的参数解析工具。它能自动处理帮助信息、类型校验、默认值、子命令等,比手动解析 sys.argv 清晰、健壮得多。

基础用法:定义和解析最简参数

从一个打印问候语的脚本开始:

  • 导入 argparse,创建 ArgumentParser 实例
  • add_argument() 声明参数(位置参数或可选参数)
  • 调用 parse_args() 获取命名空间对象,直接访问属性

示例:

import argparse
parser = argparse.ArgumentParser(description="打招呼小工具")
parser.add_argument("name", help="要问候的人名")
parser.add_argument("--greeting", "-g", default="Hello", help="自定义问候语")
args = parser.parse_args()
print(f"{args.greeting}, {args.name}!")

运行 python greet.py Alice 输出 Hello, Alice!;加 -g Hi 则输出 Hi, Alice!

常用参数控制:类型、必需性与多值

argparse 支持细粒度控制,避免在代码里重复做类型转换或空值检查:

  • type=int 自动转整型,输入非数字会报错并提示
  • required=True 标记位置参数以外的必填项(如某些 --flag 必须提供)
  • nargs=2 表示该参数需接收两个值(如 --range 10 20
  • nargs="*" 接收零个或多个值,结果为列表;nargs="+" 表示至少一个

例如:parser.add_argument("--scores", type=float, nargs="+", help="输入多个分数"),运行时可写 --scores 85.5 92 78args.scores 就是 [85.5, 92.0, 78.0]

进阶技巧:互斥组、子命令与动作定制

复杂脚本常需分功能模块,或限制参数组合:

  • add_mutually_exclusive_group() 创建互斥组,比如 --verbose--quiet 不能同时出现
  • add_subparsers() 实现类似 git commitgit push 的子命令结构
  • action="store_true" 把布尔开关参数(如 --dry-run)直接转为 True/False,无需赋值
  • 自定义 action 类可实现更复杂逻辑,比如自动读取文件内容、校验路径是否存在等

子命令示例片段:

subparsers = parser.add_subparsers(dest="command", required=True)
# 定义 'start' 子命令
start = subparsers.add_parser("start", help="启动服务")
start.add_argument("--port", type=int, default=8000)
# 定义 'stop' 子命令
stop = subparsers.add_parser("stop", help="停止服务")
args = parser.parse_args()
if args.command == "start":
    print(f"Starting on port {args.port}")
elif args.command == "stop":
    print("Stopping...")

实用建议:错误友好与用户习惯

好脚本不仅要功能正确,还要对用户友好:

  • ArgumentParser 加上 prog="mytool",让帮助页显示正确的命令名
  • 使用 epilogformatter_class=argparse.RawDescriptionHelpFormatter 展示多行示例
  • 对路径类参数,用 type=pathlib.Path 并在 action 中检查 .exists(),提前报错更清晰
  • 避免把所有逻辑塞进 parse_args() 后立刻执行——先解析,再根据参数决定行为,利于测试和复用

不复杂但容易忽略。写命令行脚本时,花十分钟搭好 argparse 结构,后面省去大量手工判断和文档同步成本。