Question

我希望用户能够使用位置或可选参数将强制参数传递给'argparse'。

即，以下两种形式均有效：

my_prog arg
my_prog -m arg

我见过Argparse optional positional arguments?

但那里的建议使两个形成可选的。我希望一个是强制性的。

当然，我可以在解析后添加一个手动检查，其中至少已经设置了其中一个。但我预感到必须有更好的解决方案。

（即使使用我的手动方法，'帮助'部分也将它们都显示为可选项）

Answer 1

mutually exclusive group机制可以采用required参数。它也可以与一个?位置以及可选项（标记参数）一起使用。（不止一个'？'位置没有意义）。

至于help显示，有2个默认组positonal和optional。因此，即使optional（已标记）设置为required，默认情况下也会显示在optional组中。 usage行是关于是否需要参数的更好指南。如果您不喜欢帮助部分中的组标签，请定义您自己的参数组。

In [146]: import argparse
In [147]: parser = argparse.ArgumentParser()
In [148]: gp = parser.add_mutually_exclusive_group(required=True)
In [149]: gp.add_argument('pos', nargs='?', default='foo');
In [150]: gp.add_argument('-f','--foo', default='bar');

In [151]: parser.parse_args('arg'.split())
Out[151]: Namespace(foo='bar', pos='arg')

In [152]: parser.parse_args('-f arg'.split())
Out[152]: Namespace(foo='arg', pos='foo')

In [153]: parser.parse_args('arg -f arg'.split())
usage: ipython3 [-h] [-f FOO] [pos]
ipython3: error: argument -f/--foo: not allowed with argument pos

In [154]: parser.parse_args(''.split())
usage: ipython3 [-h] [-f FOO] [pos]
ipython3: error: one of the arguments pos -f/--foo is required


In [155]: parser.parse_args('-h'.split())
usage: ipython3 [-h] [-f FOO] [pos]

positional arguments:
  pos

optional arguments:
  -h, --help         show this help message and exit
  -f FOO, --foo FOO

糟糕，使用情况并未在相互独立的群组中显示-f和pos。有时usage格式很脆弱。

切换定义参数的顺序可以提供更好的用法

In [156]: parser = argparse.ArgumentParser()
In [157]: gp = parser.add_mutually_exclusive_group(required=True)
In [158]: gp.add_argument('-f','--foo', default='bar');
In [159]: gp.add_argument('pos', nargs='?', default='foo');
In [160]: 
In [160]: parser.parse_args('-h'.split())
usage: ipython3 [-h] (-f FOO | pos)

positional arguments:
  pos

optional arguments:
  -h, --help         show this help message and exit
  -f FOO, --foo FOO

使用用户定义的参数组：

In [165]: parser = argparse.ArgumentParser()
In [166]: gp = parser.add_argument_group('Mutually exclusive')
In [167]: gpm = gp.add_mutually_exclusive_group(required=True)
In [168]: gpm.add_argument('-f','--foo', default='bar');
In [169]: gpm.add_argument('pos', nargs='?', default='foo');
In [170]: 
In [170]: parser.parse_args('-h'.split())
usage: ipython3 [-h] (-f FOO | pos)

optional arguments:
  -h, --help         show this help message and exit

Mutually exclusive:
  -f FOO, --foo FOO
  pos

这是一般规则argument_groups的一个例外，且mutual_exclusive_groups不是为嵌套而设计的。

不需要m-x组，使用[]

usage: ipython3 [-h] [-f FOO | pos]

Python argparse - 强制参数 - 无论是位置还是可选

1 个答案: