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 都属于选项参数,默认可选;不带前缀的名称则按位置参数处理。
- parser.add_argument('--tensorboard-log', type=str, default='', help="name of this run")
- parser.add_argument('--seed', type=int, default=42, help='Random seed.')
- parser.add_argument('--epochs', type=int, default=1000, help='Number of epochs to train.')
- parser.add_argument('--lr', type=float, default=1e-3, help='Initial learning rate.')
- 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,则强制调用者明确输入目录,避免脚本在缺少关键路径时继续运行。原文示例体现了“可选参数 + 必填选项”的组合方式,适合在开发调试和命令行运行之间保持一致。 |