我应该如何在Python中实现“嵌套”子命令?

时间:2011-12-14 21:56:57

标签: python command-line subcommand

使用cmdln在Python中实现“嵌套”子命令。

我不确定我在这里使用的是正确的术语。我正在尝试使用允许“嵌套”子命令的cmdln来实现命令行工具。这是一个真实世界的例子:

git svn rebase

实现此目的的最佳方法是什么?我一直在doc,这里和整个网络上搜索关于这方面的更多信息,但是空洞了。 (也许我正在用错误的术语进行搜索。)

如果没有自动执行此操作的未记录的功能,我最初的想法是让前一个子命令处理程序确定有另一个子命令并再次调度命令调度程序。我查看了cmdln的内部结构,调度程序是一个私有方法,_dispatch_cmd。我的下一个想法是创建我自己的子子命令调度程序,但这似乎不太理想和混乱。

任何帮助都将不胜感激。

4 个答案:

答案 0 :(得分:6)

argparse使子命令非常简单。

答案 1 :(得分:6)

来到这里的派对已经很晚了,但我已经做了相当多的事情并且发现argparse非常笨重地做到这一点。这促使我编写一个名为arghandlerargparse扩展,它明确支持这一点 - 可以实现子命令,基本上没有代码行。

以下是一个例子:

from arghandler import *

@subcmd
def push(context,args):
    print 'command: push'

@subcmd
def pull(context,args):
    print 'command: pull'

# run the command - which will gather up all the subcommands
handler = ArgumentHandler()
handler.run()

答案 2 :(得分:4)

我觉得argparse中的sub_parsers有一点点限制,如果说,你有一套工具可能有类似的选项,可能分布在不同的级别。这种情况可能很少见,但如果您正在编写可插拔/模块化代码,则可能会发生这种情况。

我有以下示例。这是一个牵强附会,目前还没有得到很好的解释,因为它已经很晚了,但在这里它是:

Usage: tool [-y] {a, b}
  a [-x] {create, delete}
    create [-x]
    delete [-y]
  b [-y] {push, pull}
    push [-x]
    pull [-x]
from argparse import ArgumentParser

parser = ArgumentParser()
parser.add_argument('-x', action = 'store_true')
parser.add_argument('-y', action = 'store_true')

subparsers = parser.add_subparsers(dest = 'command')

parser_a = subparsers.add_parser('a')
parser_a.add_argument('-x', action = 'store_true')
subparsers_a = parser_a.add_subparsers(dest = 'sub_command')
parser_a_create = subparsers_a.add_parser('create')
parser_a_create.add_argument('-x', action = 'store_true')
parser_a_delete = subparsers_a.add_parser('delete')
parser_a_delete.add_argument('-y', action = 'store_true')

parser_b = subparsers.add_parser('b')
parser_b.add_argument('-y', action = 'store_true')
subparsers_b = parser_b.add_subparsers(dest = 'sub_command')
parser_b_create = subparsers_b.add_parser('push')
parser_b_create.add_argument('-x', action = 'store_true')
parser_b_delete = subparsers_b.add_parser('pull')
parser_b_delete.add_argument('-y', action = 'store_true')

print parser.parse_args(['-x', 'a', 'create'])
print parser.parse_args(['a', 'create', '-x'])
print parser.parse_args(['b', '-y', 'pull', '-y'])
print parser.parse_args(['-x', 'b', '-y', 'push', '-x'])

输出

Namespace(command='a', sub_command='create', x=True, y=False)
Namespace(command='a', sub_command='create', x=True, y=False)
Namespace(command='b', sub_command='pull', x=False, y=True)
Namespace(command='b', sub_command='push', x=True, y=True)

正如您所看到的,很难区分每个参数的链接位置。 您可以通过更改每个变量的名称来解决此问题。例如,你可以将'dest'设置为'x','a_x','a_create_x','b_push_x'等等,但这很难分开。

另一种方法是让ArgumentParser在到达子命令后停止并将其余参数传递给另一个独立的解析器,这样它就可以生成单独的对象。 您可以尝试使用'parse_known_args()'来实现它,而不是为每个子命令定义参数。但是,这不会很好,因为之前的任何未解析的参数仍然存在并且可能会混淆程序。

我觉得稍微便宜但有用的解决方法是让argparse将以下参数解释为列表中的字符串。这可以通过将前缀设置为空终止符'\ 0'(或其他一些“难以使用”的字符)来完成 - 如果前缀为空,代码将抛出错误,至少在Python 2.7中。 3。

示例:

parser = ArgumentParser()
parser.add_argument('-x', action = 'store_true')
parser.add_argument('-y', action = 'store_true')
subparsers = parser.add_subparsers(dest = 'command')
parser_a = subparsers.add_parser('a' prefix_chars = '\0')
parser_a.add_argument('args', type = str, nargs = '*')

print parser.parse_args(['-xy', 'a', '-y', '12'])

输出:

Namespace(args=['-y', '12'], command='a', x=True, y=True)

请注意,它不会使用第二个-y选项。 然后,您可以将结果'args'传递给另一个ArgumentParser。

缺点:

  • 帮助可能无法妥善处理。必须使用此
  • 进行更多解决方法
  • 遇到错误可能很难追查,需要一些额外的工作来确保错误消息被正确链接。
  • 与多个ArgumentParsers相关的更多开销。

如果有人对此有更多意见,请告诉我。

答案 3 :(得分:0)

2020年更新!
Click库使用起来更容易
Fire是一个很棒的库,用于使您的应用程序命令行具有特色!