有没有办法将 python argparse 与 nargs=\'*\'、选择和默认值一起使用？

Answer 1

标记为不正确的行为是由于原始默认值['a', 'd'] 不在指定的choices 内（请参阅：relevant code as found in Python 3.4.10；此检查方法自Python 3.10.3 起实际上未更改）。我将从 Python argparse.py 源代码复制代码：

    def _check_value(self, action, value):
        # converted value must be one of the choices (if specified)
        if action.choices is not None and value not in action.choices:
            args = {'value': value,
                    'choices': ', '.join(map(repr, action.choices))}
            msg = _('invalid choice: %(value)r (choose from %(choices)s)')
            raise ArgumentError(action, msg % args)

当一个默认值被指定为一个列表时，整个值将被传递给_check_value 方法，因此它将失败（因为任何给定的列表都不会匹配另一个列表中的任何字符串）。您实际上可以通过在该方法中使用pdb 设置断点并通过逐行遍历值来验证这一点，或者使用以下代码测试和验证所述限制：

import argparse
DEFAULT = ['a', 'd']
parser = argparse.ArgumentParser()
parser.add_argument('tests', nargs='*', choices=['a', 'b', 'c', 'd', DEFAULT],
                    default=DEFAULT)
args = parser.parse_args()
print(args.tests)

然后运行python test.py

$ python test.py
['a', 'd']

这显然通过了，因为在choices 列表中存在相同的DEFAULT 值。

但是，调用 -h 或传递任何不受支持的值将导致：

$ python test.py z
usage: test.py [-h] [{a,b,c,d,['a', 'd']} ...]
test.py: error: argument tests: invalid choice: 'z' (choose from 'a', 'b', 'c', 'd', ['a', 'd'])
$ python test.py -h
usage: test.py [-h] [{a,b,c,d,['a', 'd']} ...]

positional arguments:
  {a,b,c,d,['a', 'd']}
...

根据用例，这可能是理想的，也可能不是理想的，因为如果不混淆，输出看起来很奇怪。如果这个输出是面向用户的，它可能并不理想，但如果这是为了维护一些不会泄露给用户的内部系统调用仿真，那么消息可能是不可见的，所以这可能是一个可以接受的解决方法。因此，如果生成的选择消息的清晰度至关重要（超过 99% 的典型用例），我不推荐这种方法。

但是，鉴于自定义操作被认为不理想，我将假设覆盖 ArgumentParser 类可能是一个可能的选择，并且鉴于 _check_value 在 3.4 和 3.10 之间没有变化，这可能代表了要 nip 的最低限度的附加代码排除不兼容的检查（根据问题使用指定的用例）：

class ArgumentParser(argparse.ArgumentParser):
    def _check_value(self, action, value):
        if value is action.default:
            return
        return super()._check_value(action, value)

这将确保在使用不适合问题中概述的要求的默认实现之前，默认值被视为有效选择（如果该值是操作的默认值，则返回 None，否则返回默认检查）；请注意，这会阻止对action.default 提供的有效内容进行更深入的检查（如果有必要，自定义 Action 类肯定是要走的路）。

不妨展示自定义类的示例用法（即复制/粘贴原始代码，删除 argparse. 以使用新的自定义类）：

parser = ArgumentParser()
parser.add_argument('tests', nargs='*', choices=['a', 'b', 'c', 'd'],
                    default=['a', 'd'])
args = parser.parse_args()
print(args.tests)

用法：

$ python test.py
['a', 'd']
$ python test.py a z
usage: test.py [-h] [{a,b,c,d} ...]
test.py: error: argument tests: invalid choice: 'z' (choose from 'a', 'b', 'c', 'd')
$ python test.py -h
usage: test.py [-h] [{a,b,c,d} ...]

positional arguments:
  {a,b,c,d}

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