在 Python 命令行脚本里,argparse 用来把用户输入的命令行参数解析成可访问的对象。实际开发中,required 和 default 最容易混淆:前者控制参数是否必须出现,后者控制参数缺省时的取值。下面以一段上传/打包类脚本的参数定义为例,说明这两个参数的行为和常见排查方式。
示例代码:- import argparse
- if __name__ == "__main__":
- parser = argparse.ArgumentParser(description="this is a description.")
- parser.add_argument("--url", required=True, help="Target upload URL")
- parser.add_argument("--svg", default="poc.svc", help="SVG filename")
- parser.add_argument("--zip", default="exploit.zip", help="Name of the output zip file")
- args = parser.parse_args()
- print(args.svg)
复制代码
这段代码先创建 ArgumentParser 对象,再通过 add_argument 注册三个命令行参数,最后调用 parse_args() 得到 Namespace 对象。参数值通过 args.svg、args.zip、args.url 这样的属性读取,示例中的 print(args.svg) 输出的是解析后的 SVG 文件名。
required=True 用在 --url 上,表示该参数是必填项。用户运行脚本时必须显式传入 --url,否则 parse_args() 会输出用法和错误信息并退出,程序不会继续执行到 print(args.svg)。这也是 required 的典型用途:某个参数没有合理的默认值,缺省时无法继续处理。
default 用在 --svg 和 --zip 上,表示用户没有传入对应参数时使用的默认值。用户不传 --svg 时,args.svg 为 "poc.svc";不传 --zip 时,args.zip 为 "exploit.zip"。如果用户显式传入了参数,则以用户输入为准,默认值不会覆盖用户值。也就是说,default 只在参数缺省时生效。
add_argument 还可以配合 choices 做取值限制。例如 choices=["GET","POST"] 会把参数限制在 GET 和 POST 两个可选值中。用户传入列表之外的值时,argparse 会在解析阶段报错。help 参数则用于生成帮助信息,方便通过命令行查看参数用途。
ArgumentParser 本身也有几个常用配置。description 用于描述程序;prog 用于指定程序名称,影响帮助信息和错误提示中的显示名;formatter_class=argparse.RawTextHelpFormatter 会保留原始文本格式,包括换行符,适合 help 内容包含多行文本或代码示例的场景。需要注意,formatter_class 主要影响帮助信息的显示格式,不改变参数解析逻辑。
常见问题可以按以下思路排查:先运行脚本并传入 --help,查看自动生成的参数列表和帮助文本;再检查 add_argument 中 required 和 default 是否放在正确的参数上;随后分别测试“缺少必填参数”和“不传可选参数”两种情况,确认 required 是否触发报错、default 是否按预期生效;如果参数有 choices 限制,还要检查传入值是否在允许范围内。
另一个容易忽略的点是 required 与 default 的语义冲突。如果一个参数已经用 required=True 声明为必须传入,那么用户不传时解析会直接失败,default 通常没有机会生效。因此,必填项和可选项应分开设计:需要用户明确提供的参数用 required=True,可省略的参数用 default 提供兜底值。
总结来说,argparse 中 required 负责强制用户输入,default 负责缺省值,choices 负责取值范围校验,formatter_class 负责帮助文本的格式保留。把这些参数放在正确的 add_argument 和 ArgumentParser 配置中,再结合 parse_args() 的返回对象读取属性,就能写出参数行为清晰、便于排查的命令行脚本。 |