argparse是 Python 标准库中用于解析命令行参数的模块它能将你在终端输入的文字自动转换成 Python 代码可以使用的变量。相比于手动处理sys.argvargparse的优势非常明显它会自动生成帮助信息(-h)进行类型转换与验证并在用户输入错误时给出友好的错误提示。️ 核心概念与基本用法使用argparse主要遵循一个“三步走”的流程创建解析器实例化argparse.ArgumentParser对象。添加参数使用add_argument()方法定义你希望程序接受的参数。解析参数调用parse_args()解析命令行输入获取包含所有参数值的对象。import argparse # 1. 创建解析器 parser argparse.ArgumentParser(description一个简单的示例程序) # 2. 添加参数 parser.add_argument(filename, help要处理的文件名) # 位置参数 parser.add_argument(-v, --verbose, actionstore_true, help显示详细信息) # 可选参数 # 3. 解析参数 args parser.parse_args() # 使用参数 print(f正在处理文件: {args.filename}) if args.verbose: print(详细模式已开启) 详解add_argument()add_argument()是argparse的核心它通过不同的参数来定制解析行为。1. 参数类型位置参数 vs 可选参数这是理解argparse的基础。类型特征是否必须示例 (add_argument)命令行调用位置参数参数名不以-或--开头是parser.add_argument(filename)python script.py data.txt可选参数参数名以-(短选项) 或--(长选项) 开头否parser.add_argument(-v, --verbose)python script.py -v或python script.py --verbose2. 核心参数详解add_argument()支持多种参数来精确控制解析行为。action: 定义当参数被触发时的行为。store_true/store_false: 常用于开关/标志。如果命令行中出现了该参数则将其值设为True或False。store: 默认行为存储一个值。append: 允许同一个选项出现多次并将所有值存储在一个列表中。count: 统计选项出现的次数。type: 指定参数的数据类型argparse会自动进行类型转换和校验。默认为字符串(str)。parser.add_argument(--age, typeint, help你的年龄)如果用户输入--age abcargparse会直接报错。default: 为参数设置默认值。如果命令行未提供则使用此值。parser.add_argument(--city, defaultShanghai, help城市名)required: 将某个可选参数变为必须提供的。通常不推荐过度使用因为它违背了“可选”的初衷。parser.add_argument(--mode, requiredTrue, help运行模式)help: 为该参数添加帮助信息当用户使用-h或--help时显示。parser.add_argument(--output, help输出文件路径)nargs: 指定一个参数可以接受值的数量。N(一个整数): 要求恰好 N 个值。?: 接受 0 个或 1 个值。*: 接受 0 个或多个值结果是一个列表。: 接受 1 个或多个值结果是一个列表。# 可以接受一个或多个文件 parser.add_argument(files, nargs, help一个或多个文件)choices: 将参数的值限制在一个预定义的集合内。parser.add_argument(--color, choices[red, green, blue], help选择颜色)metavar: 在帮助信息中为参数值提供一个不同的显示名称。# 帮助信息会显示为: --output OUTPUT_FILE parser.add_argument(--output, metavarOUTPUT_FILE, help输出文件路径)dest: 自定义解析后在args对象中访问该参数值的属性名。默认情况下对于可选参数--my-option属性名是my_option。 进阶用法与实用技巧掌握了基础后这些进阶技巧能让你的 CLI 程序更加强大和易用。1. 参数分组 (add_argument_group)当参数很多时将它们逻辑分组可以显著提高帮助信息的可读性。import argparse parser argparse.ArgumentParser(description模型训练脚本) # 创建两个参数组 io_group parser.add_argument_group(输入/输出参数) train_group parser.add_argument_group(训练参数) io_group.add_argument(--input, requiredTrue, help输入数据路径) io_group.add_argument(--output, default./output, help输出目录) train_group.add_argument(--epochs, typeint, default10, help训练轮数) train_group.add_argument(--batch-size, typeint, default32, help批次大小) args parser.parse_args()2. 子命令 (subparsers)对于复杂的工具如git它有git clone,git commit等子命令argparse提供了子命令的支持。import argparse parser argparse.ArgumentParser(description一个支持子命令的工具) subparsers parser.add_subparsers(destcommand, requiredTrue, help子命令) # 创建 greet 子命令 parser_greet subparsers.add_parser(greet, help打招呼) parser_greet.add_argument(name, help名字) # 创建 goodbye 子命令 parser_goodbye subparsers.add_parser(goodbye, help说再见) parser_goodbye.add_argument(--formal, actionstore_true, help正式地说) args parser.parse_args() if args.command greet: print(fHello, {args.name}!) elif args.command goodbye: if args.formal: print(Farewell.) else: print(Bye!)命令行调用方式python script.py greet Alice python script.py goodbye --formal3. 互斥选项 (add_mutually_exclusive_group)确保用户只能从一组选项中选择一个-。group parser.add_mutually_exclusive_group(requiredTrue) group.add_argument(--sum, actionstore_true, help求和) group.add_argument(--max, actionstore_true, help求最大值) # 用户必须且只能选择 --sum 或 --max 中的一个4. 从文件读取参数 (fromfile_prefix_chars)在某些时候如在处理一个特别长的参数列表时把参数列表保存在一个文件中而不是在命令行中打印出来会更有意义。如果提供fromfile_prefix_chars参数给 ArgumentParser 构造器则任何以指定字符打头的参数都将被当作文件来处理并将被它们包含的参数所替代。举例来说:with open(args.txt, w, encodingsys.getfilesystemencoding()) as fp: fp.write(-f\nbar) parser argparse.ArgumentParser(fromfile_prefix_chars) parser.add_argument(-f) parser.parse_args([-f, foo, args.txt])从文件读取的参数在默认情况下必须一个一行 (但是可参见 convert_arg_line_to_args()) 并且它们被视为与命令行上的原始文件引用参数位于同一位置。所以在以上例子中[-f, foo, args.txt]的表达式和[-f, foo, -f, bar]的表达式相同。fromfile_prefix_chars参数默认为None意味着参数不会被当作文件对待。更多细节可参考官方文档https://docs.python.org/3/library/argparse.html#fromfile-prefix-chars。5. 自定义类型转换除了int,float等内置类型你可以传入任何可调用对象如函数来进行自定义转换。def positive_int(value): ivalue int(value) if ivalue 0: raise argparse.ArgumentTypeError(f{value} 不是正整数) return ivalue parser.add_argument(--count, typepositive_int, help一个正整数) 最佳实践与常见陷阱总是提供help参数为每个参数添加清晰的帮助信息这能极大提升工具的易用性-1。善用description和epilog为你的程序提供更丰富的上下文说明-10。定义prog名称在ArgumentParser中设置prog可以覆盖程序名使帮助信息更专业-1-10。捕获解析异常如果你不希望argparse在出错时直接退出程序可以捕获SystemExit异常-4。避免在可选参数上滥用requiredTrue这通常意味着你的接口设计可能需要重新思考。注意nargs*与可选参数的交互当位置参数使用nargs*时它后面的可选参数可能无法被正确解析。通常的解决方案是强制所有可选参数出现在位置参数之前。