Python argparse可选的子参数

Question

我希望我的程序有一个参数,它有一些必需的参数和一些可选参数.像这样的东西:

[--print text [color [size]]

所以你可以传递任何这些:

mycommand --print hello
mycommand --print hello blue
mycommand --print hello red 12

可能有多个这样的,所以它必须是一个add_argument.例如:

[--print text [color]] [--output filename [overwrite]]

我可以获得接近我想要的论点:

>>> parser = argparse.ArgumentParser()
>>> act = parser.add_argument('--foo', nargs=3, metavar=('x','y','z'))
>>> act = parser.add_argument('--bar', nargs='?')
>>> act = parser.add_argument('--baz', nargs='*')
>>> parser.print_help()
usage: [-h] [--foo x y z] [--bar [BAR]] [--baz [BAZ [BAZ ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --foo x y z
  --bar [BAR]
  --baz [BAZ [BAZ ...]]

但不完全.有没有办法用argparse做到这一点？我知道我可以创建它们nargs="*"但是--help不会列出可选参数的名称.如果我传递nargs="*"元数据的元组,则argparse会抛出异常.

Answer 1

怎么样

def printText(args):
  print args

parser = argparse.ArgumentParser()
subparser = parser.add_subparsers()
printer = subparser.add_parser('print')
printer.add_argument('text')
printer.add_argument('color', nargs='?')
printer.add_argument('size', type=int, nargs='?')
printer.set_defaults(func=printText)

cmd = parser.parse_args()
cmd.func(cmd)

然后你得到这样的东西:

$ ./test.py -h
usage: test.py [-h] {print} ...

positional arguments:
  {print}

$ ./test.py print -h
usage: test.py print [-h] text [color] [size]

positional arguments:
  text
  color
  size

$ ./test.py print text
Namespace(color=None, func=<function printText at 0x2a96150b90>, size=None, text='text')

$ ./test.py print text red
Namespace(color='red', func=<function printText at 0x2a96150b90>, size=None, text='text')

$ ./test.py print text red 12
Namespace(color='red', func=<function printText at 0x2a96150b90>, size=12, text='text')

Answer 2

阅读源代码(开始take_action),我相信你想要的是不可能的.解析和传递给动作的所有参数都是基于nargs完成的,而nargs可以是数字,OPTIONAL("？"),ZERO_OR_MORE("*"),ONE_OR_MORE("+")PARSER,或REMAINDER.这必须在Action对象(处理输入)之前确定,甚至可以看到它得到的内容,因此它无法动态计算出来nargs.

我想你需要一个解决方法.我可能会--foo-x x,--foo-y y而且--foo-z z,也许也有--foo x y z.