它是一个用于解析命令行参数的库。

基本用法

import argparse
parser = argparse.ArgumentParser(description="Some Description")
parser.add_argument(
	'--arg', type=str, default='example', help='Some help'
)
args = parser.parse_args()
print(args.arg)

参数设置

参数项说明示例
type自动转换数据类型(默认是字符串)type=int, type=float
default如果用户没传,则使用这个默认值default=42
required强制让可选参数变成必填项required=True
choices限制用户只能从特定列表中选择choices=['easy', 'hard']
action触发特定行为。最常用的是 store_trueaction='store_true'
  • store_true: 用户输入这个参数则设置为 True,否则设置为 False
  • argparse 库会自动生成 -h--help

互斥组

如果希望两个参数不能同时出现,可以使用互斥组:

group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")