argparse解析器参数详解

argparse 是 Python 标准库中用于解析命令行参数 的模块,ArgumentParser 是其核心类,用于定义和解析命令行接口。

使用示例

在arg.py脚本中定义

python 复制代码
import argparse

# 创建解析器
parser = argparse.ArgumentParser(description="训练脚本")

# 添加参数
parser.add_argument("--epochs", type=int, default=10, help="训练轮数")
parser.add_argument("--lr", type=float, default=0.001, help="学习率")

# 解析参数
args = parser.parse_args()

# 使用参数
print(f"训练 {args.epochs} 轮,学习率 {args.lr}")

然后运行这个脚本的时候,就可以读取命令里的参数了

bash 复制代码
python arg.py --epochs 20 --lr 0.01

add_argument函数

这里重点讲一下这个函数,下面是这个函数的参数讲解

参数 说明 示例
name 参数名(-- 开头为可选,否则为必需) "--epochs", "input_file"
type 参数类型转换 int, float, str, bool
default 默认值,不管命令里带不带都会被赋值 10, 0.001, "cpu"
help 帮助信息,也就是注释 "训练轮数"
required 是否必需(仅对可选参数有效) True/False
choices 如果是可选值的话,对应的可选值列表 ["cpu", "cuda", "mps"]
nargs 参数个数 "+", "*", 2, 3
action 特殊动作 "store_true", "append", "count"
dest 存储的目标属性名 "num_epochs"

action参数项

Action 说明 典型用途
store 存储参数值(默认) 普通参数
store_const 存储const指定的常量 固定值选项
store_true 存储 True 布尔开关
store_false 存储 False 布尔开关
append 将值添加到列表 多次指定参数
append_const 将 const 常量添加到列表 累积固定值
count 计数参数出现次数 详细程度 -v
help 显示帮助并退出 自动添加
version 显示版本并退出 版本信息
extend 扩展列表(Python 3.8+) 合并多个列表值

1、store_const

python 复制代码
parser.add_argument("--mode", action="store_const", const=42)
bash 复制代码
$ python script.py --mode
42

一般与default进行配合使用

python 复制代码
parser.add_argument("--log", action="store_const", const="DEBUG", default="INFO")
bash 复制代码
$ python script.py
INFO
$ python script.py --log
DEBUG

2、store_true与store_false

一般用于布尔开关

python 复制代码
parser.add_argument("--verbose", action="store_true")
bash 复制代码
$ python script.py
Verbose: False

$ python script.py --verbose
Verbose: True

使用type进行布尔开关一般是错的

python 复制代码
parser.add_argument("--use-cuda", type=bool, default=True)

因为本质上,Python 中 bool("False") 的结果是 True(因为非空字符串都为真)。 命令行传入的参数都是字符串,所以:

  • --use-cuda False → args.use_cuda 是 True (字符串 "False" 转为 bool 为真)
  • --use-cuda True → args.use_cuda 是 True

3、append

python 复制代码
parser.add_argument("--file", action="append")
bash 复制代码
$ python script.py --file a.txt --file b.txt --file c.txt
['a.txt', 'b.txt', 'c.txt']

4、count

python 复制代码
parser.add_argument("-v", "--verbose", action="count", default=0)
bash 复制代码
$ python script.py
Verbose level: 0

$ python script.py -v
Verbose level: 1

$ python script.py -vv
Verbose level: 2

$ python script.py -vvv
Verbose level: 3

一般用于

python 复制代码
if args.verbose == 0:
    log_level = "WARNING"
elif args.verbose == 1:
    log_level = "INFO"
else:
    log_level = "DEBUG"

5、help

python 复制代码
parser.add_argument("--help-custom", action="help")

# 通常不需要手动添加,ArgumentParser 会自动添加 -h/--help
bash 复制代码
$ python script.py --help-custom
# 显示帮助并退出

6、extend

python 复制代码
parser.add_argument("--nums", action="extend", nargs="+", type=int)
bash 复制代码
$ python script.py --nums 1 2 --nums 3 4
[1, 2, 3, 4]

# 对比 append:
# $ python script.py --nums 1 2 --nums 3 4
# [[1, 2], [3, 4]]
相关推荐
TomEval8 小时前
【测AI】第26篇:线上模型监控与告警体系 — 测试不是终点
人工智能·python·功能测试·ai
prince_zxill9 小时前
PEP 751 pylock.toml 实测:pip 26.3 装 6 个包版本全钉死,但 [web] 选不中任何东西
python·pip·依赖管理·pep 751
Thanks_ks10 小时前
Python 的垃圾回收——引用计数撑起日常,分代回收收拾残局
python·内存管理·垃圾回收·循环引用·引用计数·gc 模块·weakref
CyrusYiVPP10 小时前
实测 uv 0.13.7:同一套包,pip 装 94 秒,它只用 19 秒
人工智能·python
yiangL_11 小时前
Python 学习笔记:递归、turtle绘图、字符串与函数
笔记·python·学习
lula88812 小时前
PVC-U、PVC-C、PVC-O 差一个字母,差的是三种增强路线
python
人生!?12 小时前
Linux 从入门到进阶 | 基础语法
linux·笔记·教程
数字工作台13 小时前
给 LangGraph 加一道可审计记忆:替换默认 Checkpointer,实现防篡改 + 崩溃不丢数据
python·agent
DKPT13 小时前
Python 的 Web 框架:选型选错的人,都踩了同一个坑
python
优化Henry13 小时前
LTE 站点 S1 链路反复闪断导致小区频闪退服故障排查
运维·网络·学习·信息与通信·tdd