Python内置模块之argparse详细功能介绍及示例

Python 的 argparse 库是一个用于解析命令行参数的标准库，能够轻松创建用户友好的命令行接口。以下详细介绍其核心方法及实际应用场景。

---

一、核心类与方法

1. ArgumentParser 类

• 作用：创建命令行解析器对象，管理所有参数和子命令。
• 常用参数：
  • description：程序的简要描述（显示在帮助信息开头）。
  • epilog：帮助信息的结尾文本。
  • formatter_class：自定义帮助信息的格式。

2. add_argument() 方法

• 作用：为解析器添加命令行参数。
• 关键参数：
  • dest：参数的变量名（默认为选项字符串或位置参数名）。
  • type：参数类型（如 int, float，默认为 str）。
  • required：是否必须提供（针对可选参数）。
  • help：参数的帮助说明。
  • choices：限制参数的取值范围（如 [1, 2, 3]）。
  • default：默认值。
  • action：参数动作（如 'store_true'、'store_const'）。
  • nargs：参数的数量（如 '+' 表示至少一个，'?' 表示可选）。

3. add_subparsers() 方法

• 作用：添加子命令解析器（类似 git commit 中的 commit）。
• 常用参数：
  • title：子命令分组的标题。
  • dest：存储子命令名称的属性名。

4. add_mutually_exclusive_group() 方法

• 作用：添加互斥参数组，组内参数不能同时使用。

5. parse_args() 方法

• 作用：解析命令行参数，返回 Namespace 对象。
• 返回值：包含所有参数值的对象，可通过属性访问（如 args.input）。

6. parse_known_args() 方法

• 作用：解析已知参数，返回 Namespace 和未解析的参数列表。

7. add_argument_group() 方法

• 作用：将参数分组显示在帮助信息中。

---

二、实际应用场景与示例

场景 1：基础参数解析

需求：编写一个脚本，接受输入文件并可选指定输出文件和详细模式。

import argparse

parser = argparse.ArgumentParser(description="处理文件的工具")
parser.add_argument('input', help='输入文件路径')
parser.add_argument('--output', '-o', help='输出文件路径')
parser.add_argument('--verbose', '-v', action='store_true', help='启用详细模式')

args = parser.parse_args()
print(f"输入文件: {args.input}")
print(f"输出文件: {args.output if args.output else '未指定'}")
print(f"详细模式: {'开启' if args.verbose else '关闭'}")

运行示例：

$ python script.py data.txt --output result.txt -v
输入文件: data.txt
输出文件: result.txt
详细模式: 开启

---

场景 2：子命令（Subparsers）

需求：创建一个支持 compress 和 decompress 子命令的工具。

import argparse

parser = argparse.ArgumentParser(description="文件压缩工具")
subparsers = parser.add_subparsers(title='子命令', dest='command', required=True)

# 压缩子命令
compress_parser = subparsers.add_parser('compress', help='压缩文件')
compress_parser.add_argument('input', help='输入文件')
compress_parser.add_argument('--level', type=int, choices=range(1, 10), default=9, help='压缩级别 (1-9)')

# 解压子命令
decompress_parser = subparsers.add_parser('decompress', help='解压文件')
decompress_parser.add_argument('input', help='输入压缩文件')
decompress_parser.add_argument('--output', help='输出路径')

args = parser.parse_args()

if args.command == 'compress':
    print(f"压缩 {args.input}，级别 {args.level}")
elif args.command == 'decompress':
    print(f"解压 {args.input} 到 {args.output if args.output else '默认路径'}")

运行示例：

$ python tool.py compress data.txt --level 5
压缩 data.txt，级别 5

$ python tool.py decompress data.gz --output result.txt
解压 data.gz 到 result.txt

---

场景 3：互斥参数

需求：用户只能选择快速模式或高质量模式，不能同时使用。

import argparse

parser = argparse.ArgumentParser(description="处理任务")
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('--fast', action='store_true', help='快速模式')
group.add_argument('--best', action='store_true', help='高质量模式')

args = parser.parse_args()
print(f"模式: {'快速' if args.fast else '高质量'}")

运行示例：

$ python task.py --fast
模式: 快速

$ python task.py --best
模式: 高质量

---

场景 4：参数分组

需求：在帮助信息中将参数分组显示。

import argparse

parser = argparse.ArgumentParser(description="数据处理器")
input_group = parser.add_argument_group('输入选项')
input_group.add_argument('--input', required=True, help='输入文件')
input_group.add_argument('--format', choices=['csv', 'json'], help='输入格式')

output_group = parser.add_argument_group('输出选项')
output_group.add_argument('--output', help='输出文件')
output_group.add_argument('--overwrite', action='store_true', help='覆盖现有文件')

args = parser.parse_args()

帮助信息输出：

$ python processor.py -h
数据处理器

输入选项:
  --input INPUT         输入文件
  --format {csv,json}   输入格式

输出选项:
  --output OUTPUT       输出文件
  --overwrite           覆盖现有文件

---

三、总结

argparse 提供了灵活的命令行参数解析功能，涵盖位置参数、可选参数、子命令、互斥参数、参数分组等复杂场景。通过合理设计参数逻辑，可以构建清晰易用的命令行工具。核心方法包括：

• ArgumentParser() 创建解析器。
• add_argument() 定义参数规则。
• add_subparsers() 支持子命令。
• add_mutually_exclusive_group() 处理互斥参数。
• parse_args() 解析参数。