python - 将自定义类型与argparse一起使用时出现常规参数错误

我需要基于给定的字符串创建自定义对象的实例（在下面的示例中为Bar）。如果我没有将类型更改为Bar并运行以下代码：

import argparse

VALID_BAR_NAMES = ['alfa', 'beta', 'gamma', 'delta']


class Bar:

    def __init__(self, name):
        if not name in VALID_BAR_NAMES:
            raise RuntimeError('Bar can not be {n}, '
                               'it must be one of {m}'.format(
                                    n=name, m=', '.join(VALID_BAR_NAMES)))
        self.name = name


if __name__ == '__main__':
    parser = argparse.ArgumentParser()

    parser.add_argument('foo', help='Specify the foo!')

    parser.add_argument('-b', '--bar', nargs='*',
                        choices=VALID_BAR_NAMES,
                        type=str,  # SELECTED TYPE
                        help=('Specify one or many valid bar(s)'))
    parsed_arguments = parser.parse_args()

当将无效参数hello传递给-b时，我得到以下输出：

usage: Example.py [-h]
                  [-b [{alfa,beta,gamma,delta} [{alfa,beta,gamma,delta} ...]]]
                  foo
Example.py: error: argument -b/--bar: invalid choice: 'hello' (choose from 'alfa', 'beta', 'gamma', 'delta')

但是，如果将type=str更改为type=Bar并再次运行示例，则会得到以下输出：

Traceback (most recent call last):
  File "C:\PyTest\Example.py", line 25, in <module>
    parsed_arguments = parser.parse_args()
  File "C:\Python27\lib\argparse.py", line 1688, in parse_args
    args, argv = self.parse_known_args(args, namespace)
  File "C:\Python27\lib\argparse.py", line 1720, in parse_known_args
    namespace, args = self._parse_known_args(args, namespace)
  File "C:\Python27\lib\argparse.py", line 1926, in _parse_known_args
    start_index = consume_optional(start_index)
  File "C:\Python27\lib\argparse.py", line 1866, in consume_optional
    take_action(action, args, option_string)
  File "C:\Python27\lib\argparse.py", line 1778, in take_action
    argument_values = self._get_values(action, argument_strings)
  File "C:\Python27\lib\argparse.py", line 2218, in _get_values
    value = [self._get_value(action, v) for v in arg_strings]
  File "C:\Python27\lib\argparse.py", line 2233, in _get_value
    result = type_func(arg_string)
  File "C:\PyTest\Example.py", line 12, in __init__
    n=name, m=', '.join(VALID_BAR_NAMES)))
RuntimeError: Bar can not be hello, it must be one of alfa, beta, gamma, delta

看起来很糟糕。我了解这是由于在对可用选项进行检查之前发生了类型转换。最好的解决方法是什么？

最佳答案

您需要创建一个自定义操作（未测试）：

class Bar:
    ...


class BarAction(argparse.Action):
    def __call__(self,parser,namespace,values,option_string=None):
        try:  #Catch the runtime error if it occures.
           l=[Bar(v) for v in values] #Create Bars, raise RuntimeError if bad arg passed.
        except RuntimeError as E:
           #Optional:  Print some other error here.  for example: `print E; exit(1)`
           parser.error()

        setattr(namespace,self.dest,l) #add the list to the namespace

...
parser.add_argument('-b', '--bar', nargs='*',
                    choices=VALID_BAR_NAMES,
                    action=BarAction,  # SELECTED TYPE -- The action does all the type conversion instead of the type keyword.
                    help=('Specify one or many valid bar(s)'))

...

关于python - 将自定义类型与argparse一起使用时出现常规参数错误，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/10297973/