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

Question

我的用例是多个可选的位置参数，取自一组受限的 choices，default 值是包含其中两个选项的列表。由于向后兼容问题，我无法更改界面。我还必须保持与 Python 3.4 的兼容性。

这是我的代码。您可以看到，我希望我的默认值是 choices 集合中的两个值的列表。

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

所有这些都是正确的:

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

这是不正确的:

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

我发现了很多类似的问题，但没有一个是针对这个特定用例的。我发现(在不同的上下文中)最有希望的建议是编写自定义操作并使用它代替 choices:

• https://stackoverflow.com/a/8624107/7660197

这并不理想。我希望有人能指出我错过的选项。

如果没有，我打算使用以下解决方法:

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

只要我保持向后兼容性，我就可以添加参数。

谢谢!

---

更新:我最终采用了自定义操作。我很抗拒，因为这不像是一个需要自定义任何东西的用例。然而，这似乎或多或少是子类化 argparse.Action 的预期用例，它使意图非常明确，并提供了我发现的最干净的面向用户的结果。

class TestsArgAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        all_tests = ['a', 'b', 'c', 'd']
        default_tests = ['a', 'd']

        if not values:
            setattr(namespace, self.dest, default_tests)
            return

        # If no argument is specified, the default gets passed as a
        # string 'default' instead of as a list ['default']. Probably
        # a bug in argparse. The below gives us a list.
        if not isinstance(values, list):
            values = [values]

        tests = set(values)

        # If 'all', is found, replace it with the tests it represents.
        # For reasons of compatibility, 'all' does not actually include
        # one of the tests (let's call it 'e'). So we can't just do
        # tests = all_tests.
        try:
            tests.remove('all')
            tests.update(set(all_tests))
        except KeyError:
            pass

        # Same for 'default'
        try:
            tests.remove('default')
            tests.update(set(default_tests))
        except KeyError:
            pass

        setattr(namespace, self.dest, sorted(list(tests)))

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']

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

但是，调用 -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，这可能代表消除不兼容检查的最少附加代码(根据问题指定用例):

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