Python Argparse，如何正确组织ArgParse代码

Question

我已经有10年没有使用argparse了，但是我理解它，并且下面的内容确实可以正常工作……但是随着我继续添加命令，解析器和子解析器，这将变得更加复杂。 我想知道最好的组织方式是什么？ 在我的脑海中，我应该能够像在图表中一样清晰地看到文本中的命令序列...但是，每次我查看它时，只要走了一会儿，我的脑子都会游动，因为我试图跟随它它。 必须有更好的方法来组织这项权利吗？

import argparse
from modules import cli_tools

#LVL 1: create the top-level parser for the "sacs" command.
sacs_parser = argparse.ArgumentParser(prog = 'sacs', description = 'Master Command For Controlling SACS.')
sacs_subparsers = sacs_parser.add_subparsers(help='Management Module Selector.')

#LVL 2: create the second-level parsers for the "sacs [module]" commands.
csv_parser = sacs_subparsers.add_parser('csv', help='Generic CSV Management Module.')
am_parser = sacs_subparsers.add_parser('am', help='SACS Asset Management Module.')
mm_parser = sacs_subparsers.add_parser('mm', help='SACS Metric Management Module.')

#LVL 3: create the third-level subparser for the "sacs [module] [action]" commands.
csv_action_subparser = csv_parser.add_subparsers(help='The action to perform.')
mm_action_subparser = mm_parser.add_subparsers(help='The action to perform.')

#LVL 4: create the fourth-level subparser for the "sacs [module] [action] [type]" commands.
mm_create_parser = mm_action_subparser.add_parser('create', help='Used to Create a new event/asset input file.')
mm_create_type_parser = mm_create_parser.add_subparsers(help='The type of file to create.')

#LVL 5: create the fifth-level parser for the "sacs [module] [action] [type]" commands.
csv_reconcile_parser = csv_action_subparser.add_parser('reconcile', help='reconcile two csvs.')
mm_create_asset_parser = mm_create_type_parser.add_parser('assets', help='Create an Asset File.')
mm_create_asset_subtype_parser = mm_create_asset_parser.add_subparsers(help='The type of file to create.')
mm_create_event_parser = mm_create_type_parser.add_parser('events', help='Create an Event File.')

#LVL 6: create the sixth-level parser for the "sacs [module] [action] [type] [subtype]" commands.
mm_create_asset_uaid_parser = mm_create_asset_subtype_parser.add_parser('uaid', help='Create an Asset File with UAID as the primary key.')
mm_create_asset_vid_parser = mm_create_asset_subtype_parser.add_parser('vid', help='Create an Asset File with Vulnerability ID as the primary key.')

#COMMAND ARGS: Add Arguments to the final command "sacs csv reconcile [args]"
csv_reconcile_parser.add_argument('key', help='The name of the field that holds the unique ID to compare against.')
csv_reconcile_parser.add_argument('inputfile1', help='The master file (used when same record exists in both files).')
csv_reconcile_parser.add_argument('inputfile2', help='The secondary file, which is trumped by the master file.')
csv_reconcile_parser.add_argument('outputfile', help='The output file; note it will be overwritten if it exists.')
csv_reconcile_parser.set_defaults(func=cli_tools.csv_reconcile)

#COMMAND ARGS: Add Arguments to the final command "sacs mm create assets uaid [args]"
mm_create_asset_uaid_parser.add_argument('appmapp_file', help='The input file.')
mm_create_asset_uaid_parser.add_argument('output_file', help='The output file.')
mm_create_asset_uaid_parser.set_defaults(func=cli_tools.asset_create_uaid)

#COMMAND ARGS: Add Arguments to the final command "sacs mm create assets vid [args]"
mm_create_asset_vid_parser.add_argument('vulnerability_file', help='The input file.')
mm_create_asset_vid_parser.add_argument('appmapp_file', help='The output file.')
mm_create_asset_vid_parser.add_argument('output_file', help='The output file.')
mm_create_asset_vid_parser.set_defaults(func=cli_tools.asset_create_vid)

args = sacs_parser.parse_args()
args.func(args)

更好的方法的潜在途径：

1. 解析器/子解析器重命名。
2. 更改语句的顺序。
3. 缩进而不弄乱python的某种方法。

所有想法都摆在桌面上，我想看看其他人在设计复杂命令时如何处理。

Answer 1

提高Python代码清晰度的通常方法是将步骤封装在函数甚至类中。 argparse本身是一组类。 您的每个解析器（包括子解析器）都是argparse.ArgumentParser对象。 每个add_argument创建一个argparse.Action子类对象。 add_subparsers创建（并返回）处理子解析器的专用Action子类。 最后， parse_args返回argparse.Namespace对象。

我不知道这是否适用于您的情况。 您的代码可读，因此我可以轻松了解您的操作。 我从未见过有人使用这么多级别的子解析器。 实际上，使用多个级别是新颖的（从一些早期的SO问题判断）。

我想强调， argparse的第一项工作就是弄清楚您的用户想要什么。 解析是第一要务。 其次，它应该使表达他们想要的东西变得容易。 我想知道这种多级细分是否易于使用。 argparse在子解析器之间分配help的方式使得很难显示出大的概览。

在某些时候，大型程序包开始编写自己的帮助，甚至自定义解析器以适合其需求。

您可能会在CodeReview上得到更好的答案。 那里的常客似乎对代码组织和命名问题更感兴趣。 SO更着重于解决问题。 如果主题过于专业化，我不建议转用CR，但这更多的是Python的一般问题，而不是argparse特定问题。 但是，请仔细阅读CR在问题中的期望。

多级argparse子解析器

带有所需子解析器的Argparse

argparse次解析器整体帮助输出

Python argparser重复子解析