argparse 是python标准库中用于解析命令行参数的模块。基本使用import argparse # 创建解析器 ## description: 程序说明 ## prog: 程序名, 默认为脚本名 ## epilog: 帮助信息末尾附加文本 ## formatter_class: 控制帮助信息的展示样式 parser argparse.ArgumentParser( prog/my_tool, descriptionA simple command-line tool., epilogExample usage: /my_tool Hello World --verbose ) # 使用add_argument() 添加参数 # echo1和echo2为位置参数使用时必需按顺序提供 # type 指定类型转换函数 # help 设置帮助说明 parser.add_argument(echo1, typestr, helpecho something) parser.add_argument(echo2, typestr, helpecho something) # -x 或 --xx 为可选参数 # default 设置默认值 parser.add_argument(--sftp_ip,typestr,default127.0.0.1, helpsftp服务的IP地址) # 自动转换类型成int # metavar 修改帮助信息中显示的占位名 parser.add_argument(--sftp_port, metavarPORT, typeint, default22) # dest 指定解析后属性名, 解析后使用 args.username 访问 parser.add_argument(--user-name, destusername) # required 让可选参数变成必须提供 # required 只适用于可选参数 parser.add_argument(--name, requiredTrue) # choice 限制可选值范围 parser.add_argument(-H,--host,typestr, choices[127.0.0.1, 192.168.0.10]) # nargs 控制参数个数 ## nargs2, 必须 2 个参数 ## nargs*, 0个或多个参数 ## nargs, 1个或多个参数 ## nargs?, 0个或1个参数 parser.add_argument(--nums, nargs3, typeint) # 创建互斥组-v和-q不能同时使用 group parser.add_mutually_exclusive_group() # action 定义参数行为 group.add_argument(-v, --verbose, actionstore_true) group.add_argument(-q, --quiet, actionstore_true) # 解析参数 # 返回的是一个 Namespace 对象 args parser.parse_args() # 使用命令参数 print(fecho1: {args.echo1}, echo2: {args.echo2}) print(fsftp服务的IP为: {args.sftp_ip}, 端口号: {args.sftp_port}) print(fhost is {args.host})argparse会自动生成帮助选项-h和--help。action参数add_argument()中的action参数用来定义参数行为。默认值为store.actionstore_true, 常用于布尔开关, 不传则为Falseparser.add_argument(--verbose, actionstore_true) # 运行 python app.py --verbose # 解析后 args.verbose Trueactionstore_false, 反向布尔开关actionappend, 每出现一次就追加到列表parser.add_argument(--tag, actionappend) # 使用 python app.py --tag a --tag b # 得到 args.tag [a, b]actioncount, 统计出现次数parser.add_argument(-v, --verbose, actioncount, default0) # 使用 python app.py -vvv # 得到 args.verbose 3actionversion, 打印版本parser.add_argument(--version, actionversion, versionv1.0.0, default0) # 使用 python app.py --version # 输出 v1.0.0 # 也可以写个函数来动态获取 def get_version() - str: return v1.0.0 # help 不传的话默认为 show programs version number and exit parser.add_argument( --version, actionversion, versionget_version(), # helpShow the version of the tool and exit., )actionstore_const, 设置为指定值parser.add_argument(--json, actionstore_const, constjson, destformat) # 运行 python app.py --json # 得到 args.format json互斥参数创建互斥组group parser.add_mutually_exclusive_group()使用group.add_argument设置的命令行选项将互斥不能同时使用简单例子:import argparse parser argparse.ArgumentParser() # 创建互斥组 # 传入 requiredTrue 的话用户必须从互斥组参数中选一个; 默认用户可以不选可选组参数 group parser.add_mutually_exclusive_group() group.add_argument(--verbose, actionstore_true) group.add_argument(--quiet, actionstore_true) args parser.parse_args() print(args) # 这样同时调用会报错 python app.py --verbose --quiet子命令当命令行工具包含多种操作时可能就会需要子命令了例如python tool.py add user1 python tool.py delete user1 python tool.py list这里add,delete,list都是子命令, 这时候最适合用parser.add_subparsers()add_subparsers()用来给一个命令行程序添加多个子解析器subparsers每个子解析器对应一个子命令。基本用法import argparse parser argparse.ArgumentParser(progusercli, description用户管理工具) # requiredTrue, 强制用户使用子命令 # 建议总是显式写 destcommand subparsers parser.add_subparsers(destcommand, requiredTrue) # add 子命令 parser_add subparsers.add_parser(add, help添加用户) parser_add.add_argument(username, help用户名) parser_add.add_argument(--age, typeint, default18, help年龄) # delete 子命令 parser_delete subparsers.add_parser(delete, help删除用户) parser_delete.add_argument(username, help用户名) # list 子命令 parser_list subparsers.add_parser(list, help列出用户) parser_list.add_argument(--verbose, actionstore_true, help显示详细信息) args parser.parse_args() if args.command add: print(f添加用户: {args.username}, 年龄: {args.age}) elif args.command delete: print(f删除用户: {args.username}) elif args.command list: print(f列出用户, verbose{args.verbose})子命令绑定处理函数上面基本用法中用if/elif来分发逻辑简单场景下还凑合但是当命令多功能复杂时代码会显得非常混乱这种情况下就可以为子命令绑定处理函数。示例代码import argparse def handle_add(args): print(f添加用户: {args.username}, 年龄: {args.age}) def handle_delete(args): print(f删除用户: {args.username}) def handle_list(args): print(f列出用户, verbose{args.verbose}) def create_parser() - argparse.ArgumentParser: parser argparse.ArgumentParser(progusercli) subparsers parser.add_subparsers(destcommand, requiredTrue) parser_add subparsers.add_parser(add, help添加用户) parser_add.add_argument(username) parser_add.add_argument(--age, typeint, default18) parser_add.set_defaults(funchandle_add) parser_delete subparsers.add_parser(delete, help删除用户) parser_delete.add_argument(username) parser_delete.set_defaults(funchandle_delete) parser_list subparsers.add_parser(list, help列出用户) parser_list.add_argument(--verbose, actionstore_true) parser_list.set_defaults(funchandle_list) return parser def main() - None: parser create_parser() args parser.parse_args() # 如果用了 args.func(args) # 一定要确保每个子命令都执行了 parser_xxx.set_defaults(func...) # 否则报错: AttributeError: Namespace object has no attribute func args.func(args) if __name__ __main__: main()子命令共享公共参数如果多个子命令都需要同一组参数可以抽一个“父解析器”。import argparse def main(): common_parser argparse.ArgumentParser(add_helpFalse) common_parser.add_argument(--config, help配置文件路径) parser argparse.ArgumentParser(progtool) subparsers parser.add_subparsers(destcommand, requiredTrue) parser_a subparsers.add_parser(start, parents[common_parser]) parser_a.add_argument(--port, typeint) parser_b subparsers.add_parser(stop, parents[common_parser]) parser_b.add_argument(--force, actionstore_true) # 解析命令行参数 # common_parser 是一个共享参数模板, 不需要参与参数解析 args parser.parse_args() if args.command start: print(fStarting with config: {args.config} on port: {args.port}) elif args.command stop: print(fStopping with config: {args.config} {forcefully if args.force else }) else: print(Unknown command) if __name__ __main__: main()子命令设置别名parser_remove subparsers.add_parser(remove, aliases[rm])这样两种命令都可以python tool.py remove file.txt python tool.py rm file.txt嵌套子命令复杂 CLI 可能有多级命令比如tool user add alice tool user delete bob可以嵌套add_subparsers()import argparse parser argparse.ArgumentParser(progtool) subparsers parser.add_subparsers(destentity, requiredTrue) user_parser subparsers.add_parser(user) user_subparsers user_parser.add_subparsers(destaction, requiredTrue) user_add user_subparsers.add_parser(add) user_add.add_argument(name) user_delete user_subparsers.add_parser(delete) user_delete.add_argument(name) args parser.parse_args() print(args)运行python tool.py user add alice得到Namespace(entityuser, actionadd, namealice)