8.12 argparse 模块

前言

本文主要介绍什么是 argparse模块、argparse模块快速入门以及argparse模块的核心功能详解。

一、argparse 模块简介

1.1 什么是 argparse？

argparse 是 Python 内置的命令行参数解析模块。它能自动生成帮助文档，验证用户输入，让你的脚本拥有专业级的命令行界面。

• 主要功能：
  📝 解析命令行参数和选项
  📖 自动生成帮助文档
  ❌ 参数验证和错误提示
  🎯 支持参数类型转换

简单示例：

pythonimportargparse# 创建参数解析器parser=argparse.ArgumentParser(description="一个简单的示例程序")parser.add_argument('name',help="你的名字")args=parser.parse_args()print(f"你好，{args.name}!")运行方式： bash python script.py 小明# 输出：你好，小明！python script.py--help# 显示帮助文档

二、快速入门

2.1 最简单的 argparse 程序

python# simplest.py - 最简单的示例importargparse# 1. 创建解析器parser=argparse.ArgumentParser()# 2. 添加参数parser.add_argument('name')# 3. 解析参数args=parser.parse_args()# 4. 使用参数print(f"欢迎，{args.name}!")运行测试： bash# 正常运行python simplest.py Alice# 输出：欢迎，Alice!# 查看帮助python simplest.py--help# 输出：# usage: simplest.py [-h] name## positional arguments:# name## optional arguments:# -h, --help show this help message and exit# 缺少参数时报错python simplest.py# 输出：error: the following arguments are required: name

2.2 参数类型：位置参数 vs 可选参数

python# args_demo.pyimportargparse parser=argparse.ArgumentParser(description="演示位置参数和可选参数")# 位置参数（必须提供）parser.add_argument('input_file',help="输入文件路径")# 可选参数（短选项 -v，长选项 --verbose）parser.add_argument('-v','--verbose',action='store_true',help="显示详细输出")args=parser.parse_args()print(f"输入文件:{args.input_file}")print(f"详细模式:{args.verbose}")

三、核心功能详解

3.1 ArgumentParser 参数配置

pythonimportargparse# 创建配置完善的解析器parser=argparse.ArgumentParser(prog='myapp',# 程序名（默认sys.argv[0]）usage='%(prog)s [选项] 文件名',# 用法字符串description='这是一个文件处理工具',# 描述（帮助文档开头）epilog='感谢使用！',# 结尾文本（帮助文档末尾）add_help=True,# 自动添加 -h/--helpprefix_chars='-/',# 可选参数前缀（默认'-'）)# 示例：使用前缀字符parser.add_argument('/v','//verbose',action='store_true')args=parser.parse_args(['/v'])# 支持 /v 和 //verbose

3.2 add_argument 参数详解

python# arg_demo.py - 演示各种参数选项importargparse parser=argparse.ArgumentParser()# 1. 基本参数（位置参数）parser.add_argument('filename',help="要处理的文件")# 2. 可选参数（短选项和长选项）parser.add_argument('-o','--output',dest='output_file',help="输出文件路径")# 3. 带类型的参数parser.add_argument('-n','--number',type=int,default=1,help="重复次数（默认: %(default)s）")# 4. 选择列表参数parser.add_argument('-m','--mode',choices=['fast','normal','slow'],default='normal',help="运行模式")# 5. 布尔标志参数parser.add_argument('-v','--verbose',action='store_true',help="启用详细输出")# 6. 必须的可选参数parser.add_argument('--config',required=True,help="配置文件路径（必须）")args=parser.parse_args()print(f"参数解析结果:{args}")

常用参数选项说明：

3.3 action 参数动作

python# action_demo.pyimportargparse parser=argparse.ArgumentParser()# store - 存储值（默认）parser.add_argument('--input',action='store')# store_true/false - 布尔标志parser.add_argument('--enable',action='store_true')parser.add_argument('--disable',action='store_false')# append - 收集多个值parser.add_argument('--add',action='append')# count - 计数出现次数parser.add_argument('--verbose','-v',action='count',default=0)args=parser.parse_args(['--enable','--add','A','--add','B','-vv'])print(f"启用:{args.enable}")print(f"添加列表:{args.add}")print(f"详细级别:{args.verbose}")

3.4 nargs 参数数量

python# nargs_demo.pyimportargparse parser=argparse.ArgumentParser()# ? - 0或1个参数parser.add_argument('--optional',nargs='?')# * - 0或多个参数parser.add_argument('--files',nargs='*')# + - 1或多个参数parser.add_argument('--required',nargs='+')# 数字 - 固定数量参数parser.add_argument('--coords',nargs=2)# 解析示例args=parser.parse_args(['--optional','value','--files','a.txt','b.txt','--required','x','y','z','--coords','10','20'])print(f"可选:{args.optional}")print(f"文件:{args.files}")print(f"必需:{args.required}")print(f"坐标:{args.coords}")