python argparse

### 聊聊 Python 里的 argparse命令行参数处理那点事1. 它是什么argparse 是 Python 标准库里的一个模块专门用来解析命令行参数。有人可能会说处理参数不就是sys.argv切一切、判断一下吗确实可以但那种方式就像用锤子砸核桃能砸开但到处是碎渣。argparse 提供了一个结构化的方式来声明参数然后自动完成解析和校验。它做的事情很纯粹把你从终端敲进去的字符串转换成 Python 里能用的变量顺带帮你生成一个像样的帮助信息。最早的标准库其实有个optparse后来废弃了argparse 是它的替代者。所以如果你看到老代码还在用optparse心里要有数——那是个已被淘汰的模块。2. 它能做什么想象一下你写了一个脚本要处理一个 CSV 文件用户可能想指定输入文件、输出文件、是否跳过标题行、是否要日志等等。如果全用sys.argv硬解析参数多了会让代码变得像意大利面一样乱。argparse 的主要工作就是自动将短选项比如-f和长选项比如--file对应到同一个参数。处理有类型要求的参数比如--count必须是整数--verbose不需要额外值。支持子命令像git commit、git push那种风格其实每个子命令都有自己的一套参数。缺省值的设置、参数互斥、参数是否必需等等。最实用的当用户输错或者输--help时它会自动打印出排版清晰的帮助信息包括每个参数的说明、默认值以及用法示例。这就像你在银行柜台填单子argparse 就是那个帮你检查表格有没有填错、有没有漏填的柜员。你只需要告诉他表格的格式参数列表和规则类型、默认值等剩下的他替你搞定。3. 怎么使用用法说起来就三步创建解析器、添加参数、解析参数。写出来通常是importargparse# 第一步创建解析器parserargparse.ArgumentParser(description处理CSV文件的工具)# 第二步添加参数parser.add_argument(input_file,help输入的CSV文件路径)# 位置参数parser.add_argument(-o,--output,defaultoutput.csv,help输出文件路径)# 可选参数parser.add_argument(-v,--verbose,actionstore_true,help输出详细信息)# 第三步解析参数argsparser.parse_args()# 使用参数print(f输入:{args.input_file})print(f输出:{args.output})这个例子中的input_file是位置参数用户必须输入且不需要减号开头。-o和--output是可选参数用户不传就取默认值output.csv。-v是布尔开关传了就为 True。更复杂的用法比如参数类型检查可以在add_argument里加typeint需要枚举值用choices需要互斥参数用add_mutually_exclusive_group。argparse 提供了 20 多个关键字参数基本覆盖了你能想到的参数场景。值得一提的是参数的名字对应到args对象的属性名时会自动将减号转为下划线。比如--input-file在args里是args.input_file。4. 最佳实践这些年写了不少脚本总结下来有几个小经验先别急着写大量选项。很多人一开始就把--verbose,--debug,--log-level,--config全都堆上去结果后面真正有用的参数只有一两个。建议先用最少的参数把功能跑通比如只保留位置参数然后再根据实际需要加可选参数。argparse 的好处就在于它可以很方便地逐步添加不像硬解析那样改起来得动结构。帮助信息要写人话。help参数的值不要写成给机器看的比如--output的 help 写成 “输出的文件路径” 没问题但更好的是 “处理后的结果写入哪里默认当前目录的 output.csv”。用户看到帮助就能知道这个参数的含义和效果。用add_argument的metavar让帮助更漂亮。如果不指定metavar帮助信息里的占位符是大写的参数名有时候难看。比如--file FILE比--file FILE_PATH更直观但你可以通过metavar自定义控制。参数尽量使用--长格式。单字母的短选项虽然方便但容易冲突。一个原则只在交互频繁的参数上提供短选项比如-v、-o其他只保留长格式。检查默认值的合理性。默认值不是随便写的比如--output的默认值最好是None而不是某个随机的文件名这样可以区分用户有没有特意指定输出文件。在逻辑里判断if args.output is None再决定默认行为会更清晰。5. 和同类技术对比Python 里处理命令行参数除了 argparse还有几个常见的sys.argv最原始的方式直接操作字符串列表。适合参数极少、固定顺序且没有复杂校验的脚本。比如一天只用一个参数的定时任务脚本。一旦参数超过两个手动解析的错误处理就会变得啰嗦。其实它更像是一个手动挡的汽车能开但对司机要求高。click第三方库用装饰器的方式绑定参数。它的核心思想是把参数和函数绑定起来代码读起来更优雅对大型项目比如有几十个子命令的工具支持更好。不过它引入了间接层调试时追踪参数传递链稍麻烦。而且 click 需要额外安装并不是所有人都愿意在项目里多一个依赖。docopt一个另类它从你写的帮助文本文档字符串里反解析出参数规则。优点是你写了文档就等于写了参数定义但缺点也明显文档和实际代码容易不同步而且顺序依赖限制较多。除非你的脚本参数极少并且希望文档自动更新否则不太推荐生产环境使用。相比而言argparse 是标准库自带的零依赖社区广泛接受很多大型项目包括 Django、Flask 等框架的辅助脚本都在用。它的 API 设计并不算最简洁但用多了会觉得非常稳定出现 bug 的概率极低。如果需要在项目里快速搭建一个健壮的 CLIargparse 是优先选择。只有当你需要的参数结构特别复杂、子命令嵌套很深或者希望代码更“Pythonic”一些才值得考虑 click 这类第三方库。简单来说如果你在写一个工具给别人用或者脚本需要至少三个可选参数直接用 argparse。如果只是自己跑个临时任务sys.argv凑合一下就够。选那不乱的别为了炫技引入不必要的东西。