查看: 529|回复: 3

argparse add_argument与required用法

[复制链接]
发表于 6 小时前 | 显示全部楼层 |阅读模式
Python 的 argparse 模块用于解析命令行参数,add_argument() 是定义参数的核心接口。它既能声明选项参数,也能声明位置参数;参数名、类型、默认值、是否必填等行为都在这个调用中描述。add_argument() 的常用参数包括:name or flags 是命名或选项字符串列表,例如 foo 或 -f、--foo;action 指定参数出现时执行的动作;nargs 指定命令行参数消耗的数目;const 为某些 action 和 nargs 选择提供常量;default 是参数未出现时的值;type 是转换类型;choices 是可用值容器;required 表示该命令行选项是否可省略,且仅对选项参数可用;help 是简单描述;metavar 是用法消息中的参数值示例;dest 是 parse_args() 返回对象上的属性名。

在下面的示例里,带 -- 前缀的 --tensorboard-log、--seed、--epochs、--lr、--file-dir 都属于选项参数,默认可选;不带前缀的名称则按位置参数处理。
  1. parser.add_argument('--tensorboard-log', type=str, default='', help="name of this run")
  2. parser.add_argument('--seed', type=int, default=42, help='Random seed.')
  3. parser.add_argument('--epochs', type=int, default=1000, help='Number of epochs to train.')
  4. parser.add_argument('--lr', type=float, default=1e-3, help='Initial learning rate.')
  5. parser.add_argument('--file-dir', type=str, required=True, help="Input file directory")
复制代码

其中 --file-dir 额外设置了 required=True,含义是不可省略。运行脚本时必须提供文件目录;如果未提供,参数解析阶段会失败并提示缺少该参数。这个选项仍然是选项参数,只是通过 required=True 覆盖了“选项默认可省略”的默认行为。注意 required 只适用于选项参数,位置参数本身就需要按位置提供,不需要也不应依赖 required 来表达必填。

示例中 --seed、--epochs 用 type=int,--lr 用 type=float,--tensorboard-log 和 --file-dir 用 type=str;default 为未传入时的默认值,help 用于帮助信息。--file-dir 没有默认值且 required=True,所以调用方必须显式给出路径。

在 PyCharm 中调试或运行时,如果不想每次在终端拼命令,可以通过运行配置传参。点击 Run 菜单下的 Edit Configurations…,找到当前脚本的配置,在 Parameters 一栏输入参数。以 --file-dir 为例,先写参数名,空一格,再写字符串值;如果有多个参数,继续用空格分隔。例如参数区可写成 --file-dir 值,若还要传 --seed,则继续空一格写 --seed 42。这样运行时 argparse 就能像读取命令行一样读取这些参数。原文示例中的 --file-dir 是 string 类型,因此值直接按字符串写入;如果参数 type 为 int 或 float,也应写入对应格式的值,交由 argparse 转换。

遇到“参数未生效”或“必填参数缺失”时,可以按顺序检查:参数名是否写成 --file-dir 而不是 file-dir;required=True 的参数是否已在命令行或 PyCharm Parameters 中提供;type 指定的类型与传入值是否匹配;多个参数之间是否用空格分隔。这样能覆盖原文示例中最常见的配置问题。

这种写法常见于训练脚本、数据处理脚本和需要固定参数入口的工具脚本。把 --seed、--epochs、--lr 等设置为带默认值的选项,可以保留默认行为;把 --file-dir 设置为 required=True,则强制调用者明确输入目录,避免脚本在缺少关键路径时继续运行。原文示例体现了“可选参数 + 必填选项”的组合方式,适合在开发调试和命令行运行之间保持一致。
回复

使用道具 举报

发表于 6 小时前 | 显示全部楼层

Re: argparse add_argument与required用法

这个总结挺实用的,尤其是把 required 只适用于选项参数、位置参数不需要靠 required 表达必填这一点单独点出来,容易混淆的地方讲清楚了。示例里 --file-dir 用 required=True 强制传目录,同时 --seed、--epochs、--lr 保留默认值,这种“可选参数加必填选项”的组合在训练脚本里很常见。PyCharm 运行配置传参和排查顺序那段也很有帮助,后面遇到参数未生效或必填参数缺失时,按参数名前缀、是否提供、类型匹配、空格分隔这几项检查就很清晰了。收藏一下。
回复 支持 反对

使用道具 举报

发表于 6 小时前 | 显示全部楼层

Re: argparse add_argument与required用法

写得挺清楚的,特别是把 required 只对选项参数生效这一点单独拎出来讲,很多人容易在这里混淆。位置参数本来就按位置提供,硬加 required 反而会出问题。 顺着原文补充两点细节:一是 --tensorboard-log 这种带连字符的选项,argparse 在解析结果里会把连字符自动转成下划线,所以取属性时是 args.tensorboard_log,这正好呼应了 dest 的用法,调试时如果拿 args.tensorboard-log 去取会直接报错;二是 required=True 只在解析阶段做存在性检查,传了空字符串仍然算提供过,所以像 --file-dir 这类路径参数,最好在后面再加一层自己的判断,比如目录是否存在、是否为空,光靠 required 只能保证“写了”不能保证“写对了”。 PyCharm 那块讲得也实用,Parameters 里按空格切分,写 --file-dir 值 --seed 42 就行,注意路径里如果有空格要加引号。排查顺序那几条基本覆盖了常见情况,实际动手时遇到“unrecognized arguments”,多半是参数名漏了前缀或者拼写不一致,对照 add_argument 里的写法核一遍通常就能定位。整体这套“可选参数带默认值 + 关键路径必填”的搭配,对训练脚本来说确实是比较稳妥的做法。
回复 支持 反对

使用道具 举报

发表于 6 小时前 | 显示全部楼层

Re: argparse add_argument与required用法

这篇总结挺清楚的,尤其是把 required 只适用于选项参数、位置参数本身按位置提供这一点说透了,很容易踩坑。示例里 --file-dir 用 required=True 强制显式给路径,--seed、--epochs、--lr 保留默认值,这种“可选参数加必填选项”的组合在训练脚本里确实很实用。PyCharm 运行配置里在 Parameters 按“参数名 空格 值”填写,也讲得比较直观。遇到参数不生效时,按参数名、required、type、空格分隔这几项依次排查,基本能覆盖常见问题。感谢分享。
回复 支持 反对

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

指导单位

江苏省公安厅

江苏省通信管理局

浙江省台州刑侦支队

DEFCON GROUP 86025

Hacking Group 021A

旗下站点

态势感知中心

应急响应中心

红盟安全

联系我们

官方QQ群:112851260

官方邮箱:security#ihonker.org(#改成@)

官方核心成员

关注微信公众号

Archiver|手机版|小黑屋| ( 沪ICP备2021026908号 )

GMT+8, 2026-11-17 08:49 , Processed in 0.021448 second(s), 18 queries , Gzip On, Redis On.

Powered by ihonker.com

Copyright © 2015-现在.

  • 返回顶部