调度Python的argparse子命令的最佳方式

时间:2017-09-03 10:32:17

标签: python argparse

我正在使用Python的argparse模块来获得一个相当复杂和庞大的子命令结构。到目前为止,参数解析相当顺利,一切正常,但我正在寻找一种更好的方法来管理子命令的执行方式。

以下是我的虚拟/游戏应用程序示例:

def a_func(cmd_args):
    print(cmd_args)


def b_func(cmd_args):
    print(cmd_args)


CMD_DISPATCHER = {
    'a': a_func,
    'b': b_func
}


def parse_commands():
    # Create top-level parser
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers(dest='subcmd_name')

    # Create parser for the "a" sub-command
    parser_a = subparsers.add_parser('a')
    parser_a.add_argument('-bar', type=int)

    # Create parser for the "b" sub-command
    parser_b = subparsers.add_parser('b')
    parser_b.add_argument('-foo', type=int)

    args = parser.parse_args()

    CMD_DISPATCHER[args.subcmd_name](args)


def main():
    parse_commands()


if __name__ == '__main__':
    main()

如您所见,这里我使用简单的dictCMD_DISPATCHER)作为将子命令名称与其功能相关联的映射。

正如我所说,这只是我想要实现的一个简单示例,但真正的项目将有许多嵌套的子命令,所以我想要一种更好的方法来管理这些子命令。

你知道更好/更专业的方法吗?

1 个答案:

答案 0 :(得分:1)

好的,经过一些研究后,我发现了一种符合我需求的好方法:set_defaults。我之前使用过这个函数但始终设置默认的现有默认参数值。我没有注意到argparse documentation提供的明确示例:

>>> # sub-command functions
>>> def foo(args):
...     print(args.x * args.y)
...
>>> def bar(args):
...     print('((%s))' % args.z)
...
>>> # create the top-level parser
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers()
>>>
>>> # create the parser for the "foo" command
>>> parser_foo = subparsers.add_parser('foo')
>>> parser_foo.add_argument('-x', type=int, default=1)
>>> parser_foo.add_argument('y', type=float)
>>> parser_foo.set_defaults(func=foo)
>>>
>>> # create the parser for the "bar" command
>>> parser_bar = subparsers.add_parser('bar')
>>> parser_bar.add_argument('z')
>>> parser_bar.set_defaults(func=bar)
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('foo 1 -x 2'.split())
>>> args.func(args)
2.0
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('bar XYZYX'.split())
>>> args.func(args)
((XYZYX))

如您所见,行parser_bar.set_defaults(func=bar)将新变量设置为parser_bar个参数。在这种情况下,bar是一个函数,最终用作行args.func(args)中的子命令执行程序。

我希望将来可以帮助某人。