python - 允许带有 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 = 无)

Answer 1

这是一个已知问题，在 SO 和 Python 错误/问题上都有，并且没有简单的修复方法。 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')

添加它是为了允许在“*”位置中间标记操作。但最终在这种情况下使用“？”行动。注意文档中的警告；它可能无法处理所有 argparse 功能。

实际上它停用了 positionals，执行 parse_known_args 以获取所有 optionals，然后解析 extras 仅使用 positonals。详情见parse_known_intermixed_args的代码。