如何使用argparse堆叠子命令并配置隐含默认命令?
解决argparse中隐含默认子命令的问题
你的问题核心在于:当给plants子命令添加了add子parser后,argparse默认要求必须指定下一级子命令,所以直接运行myapp.py flowers plants会提示参数不足。要实现“无额外子命令时自动执行list操作”的需求,这里有两种可行方案:
方法一:Python 3.7+ 直接设置required=False
在Python 3.7及以上版本中,add_subparsers新增了required参数,将其设为False后,即使不指定下一级子命令,parser也不会报错,而是执行你预先设置的默认函数。
修改代码中创建plants子命令的子parser部分:
# myapp.py flowers plants [-h] parser_flowers_plants = subparsers_flowers.add_parser("plants") parser_flowers_plants.add_argument("--format", default='plain', choices=['plain', 'json'], help="what format should the result be in") parser_flowers_plants.set_defaults(func=_flowers_plants_list) # 关键修改:允许不指定子命令 subparsers_flowers_plants = parser_flowers_plants.add_subparsers(required=False)
方法二:兼容旧版本Python(手动判断)
如果需要适配Python 3.7之前的版本(旧版本add_subparsers不支持required参数,默认强制要求子命令),可以在解析参数后手动检查是否触发了子命令,若没有则调用list函数:
修改main函数的参数解析后逻辑:
args = parser_main.parse_args() # 若未选中任何子命令(即未触发add的func),则默认执行list操作 if not hasattr(args, 'func'): args.func = _flowers_plants_list r = args.func(args) return r
完整可运行代码(方法一示例)
import sys import argparse def _flowers_plants_list(args): print('if this were real, the output format would be %s' % (args.format)) print('Here are all the flowers:') print('flower 1: rose') print('flower 2: tulip') print('flower 3: daisy') def _flowers_plants_add(args): print('Adding flowers... The input format is expected to be %s' % (args.format)) def main(): # myapp.py parser_main = argparse.ArgumentParser() subparsers_main = parser_main.add_subparsers() # myapp.py flowers [-h] parser_flowers = subparsers_main.add_parser("flowers") subparsers_flowers = parser_flowers.add_subparsers() # myapp.py flowers plants [-h] parser_flowers_plants = subparsers_flowers.add_parser("plants") parser_flowers_plants.add_argument("--format", default='plain', choices=['plain', 'json'], help="what format should the result be in") parser_flowers_plants.set_defaults(func=_flowers_plants_list) # 允许不指定子命令的关键设置 subparsers_flowers_plants = parser_flowers_plants.add_subparsers(required=False) # myapp.py flowers plants add [-h] parser_flowers_plants_add = subparsers_flowers_plants.add_parser("add") parser_flowers_plants_add.add_argument("--format", default='plain', choices=['plain', 'json'], help="what format will the input be in") parser_flowers_plants_add.set_defaults(func=_flowers_plants_add) args = parser_main.parse_args() r = args.func(args) return r if __name__ == "__main__": sys.exit(main())
测试效果
现在运行对应命令会得到你期望的结果:
$ python myapp.py flowers plants:自动执行list操作,输出花卉列表$ python myapp.py flowers plants --format json:以json格式输出列表$ python myapp.py flowers plants add:执行添加逻辑
内容的提问来源于stack exchange,提问作者101010
相关产品推荐
相关产品推荐

