允许带有nargs的位置命令行参数由标志分隔

Question

我有一个使用argparse的程序.它需要1个必需的位置参数,1个可选的位置参数和1个标志参数.

就像是:

usage: test.py [-h] [-a A] b [c]

所以,我试过用这个:

parser = argparse.ArgumentParser()

parser.add_argument('-a')
parser.add_argument('b')
parser.add_argument('c', nargs='?', default=None)
print(parser.parse_args())

哪个适合test.py B C -a A和test.py -a A B C.

但是当我这样做时test.py B -a A C,它会抛出一个错误:

$ python3 test.py B -a A C
usage: test.py [-h] [-a A] b [c]
test.py: error: unrecognized arguments: C

那么,即使两者之间有标志,我如何才能接受可选的位置参数？

请注意,如果我删除nargs='?', default=None它,这是有效的,但它不是可选的.这个问题也有发生nargs='*',但这种情况不会发生的nargs=N(例如nargs=1,nargs=2),并不会发生了nargs='+'.nargs=argparse.REMAINDER使它解析标志作为c(c = ['-a', 'A', 'C'],a = None)的一部分

Answer 1

这是一个已知的问题,在这里都有关于SO和Python的bug /问题,并且没有一个简单的修复. https://bugs.python.org/issue15112

这是基本解析算法的结果.这可以解析位置到下一个可选的标志.然后解析标记的选项(无论它需要多少参数).然后解析下一批职位等.

当解析器处理时b,它也可以处理c,即使只有一个字符串. c不需要什么.这意味着c第一次处理位置时会"用完".

In [50]: parser.parse_args(['one'])
Out[50]: Namespace(a=None, b='one', c=None)
In [51]: parser.parse_args(['one','two'])
Out[51]: Namespace(a=None, b='one', c='two')
In [52]: parser.parse_args(['one','-a','1','two'])
usage: ipython3 [-h] [-a A] b [c]
ipython3: error: unrecognized arguments: two
An exception has occurred, use %tb to see the full traceback.

SystemExit: 2

/home/paul/.local/lib/python3.6/site-packages/IPython/core/interactiveshell.py:2971: UserWarning: To exit: use 'exit', 'quit', or Ctrl-D.
  warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
In [53]: parser.parse_known_args(['one','-a','1','two'])
Out[53]: (Namespace(a='1', b='one', c=None), ['two'])

随着c使用了(即使它只是获取默认的),没有什么消耗最后一个字符串.这是一个'额外'.

parse_intermixed_args

Python 3.7添加了解决此问题的解析方法parse_intermixed_args. https://docs.python.org/3/library/argparse.html#intermixed-parsing

In [447]: import argparse37
In [448]: p = argparse37.ArgumentParser()
In [449]: p.add_argument('pos1');
In [450]: p.add_argument('-a');
In [451]: p.add_argument('pos2', nargs='?');

In [453]: p.parse_args('1 2 -a foo'.split())
Out[453]: Namespace(a='foo', pos1='1', pos2='2')

In [454]: p.parse_args('1 -a foo 2'.split())
usage: ipython3 [-h] [-a A] pos1 [pos2]
ipython3: error: unrecognized arguments: 2
...

In [455]: p.parse_intermixed_args('1 -a foo 2'.split())
Out[455]: Namespace(a='foo', pos1='1', pos2='2')

In [456]: p.parse_intermixed_args('1 2 -a foo'.split())
Out[456]: Namespace(a='foo', pos1='1', pos2='2')

它被添加为允许在'*'位置中间标记Action的方法.但最终在这种情况下用'？'工作 动作.请注意文档中的注意事项; 它可能无法处理所有argparse功能.

实际上它会取消激活positionals,执行a parse_known_args以获取所有内容optionals,然后extras仅使用它来解析positonals.有关parse_known_intermixed_args详细信息,请参阅代码.