如何argparse用1-3指定的范围并返回列表

Question

hi基本上我想在我的参数中添加一个--cid参数，当在命令行--cid 1-3 7 22中给出时，解析的参数是一个列表[1,2,3,7,22]。

当前尝试：

from argparse import ArgumentParser, ArgumentTypeError
import re
def parseNumList(string):
    print 'in string:',string
    if '-' in string:
        m = re.match(r'(d+)(?:-(d+))?$', string)
        # ^ (or use .split('-'). anyway you like.)
        if not m:
            raise ArgumentTypeError("'" + string + "' is not a range of number. Expected forms like '0-5' or '2'.")
        start = m.group(1)
        end = m.group(2) or start
        return list(range(int(start,10), int(end,10)+1))
    else:
        return string
parser = ArgumentParser()
parser.add_argument('--cid', type=parseNumList,nargs='*')
args = parser.parse_args()
print(args)

但结果是，我不想要嵌套列表，我该怎么做？（我知道我可以再次手动解析args.cid并重新分配它，但我可以在argparse中完成所有这些吗？使用自定义操作或自定义类型？）

> python testArgs.py --cid 1-3 7 22
in string: 1-3
in string: 7
in string: 22
Namespace(cid=[[1, 2, 3], '7', '22'])

编辑：让它与自定义操作一起工作，但有一种感觉，这不是最好的方法。有什么建议吗？

from argparse import ArgumentParser, ArgumentTypeError,Action
import re
class CustomRangeAction(Action):
    def __call__(self, parser, namespace, values, option_string=None):
        print 'running action for ' + repr(values)
        flatten = []
        for v in values:
            try:
                m = re.match(r'(d+)(?:-(d+))?$', v)  
                if m:
                    start = m.group(1)
                    end = m.group(2) or start
                    flatten.extend(list(range(int(start,10), int(end,10)+1)))
                else:
                    flatten.append(int(v))
            except:
                continue
        flatten = sorted(list(set(flatten)))
        flatten.reverse()
        setattr(namespace, self.dest, flatten)

parser = ArgumentParser()
parser.add_argument('--cid', action=CustomRangeAction,nargs='*')
args = parser.parse_args()
print(args)

Answer 1

正确的方法是在add_argument中使用action=而不是type=来定义特殊行为。当每个参数都是特殊类型时（例如，每个参数是表示数字的十六进制字符串），应该使用类型。在这种情况下，你的一些论点需要被夸大为不止一个。

为了定义一个操作，您需要定义一个新类（源自argparse.Action）并实现__call__(self, parser, namespace, values, option_string=None)方法：

from argparse import ArgumentParser, ArgumentTypeError, Action
import re
class InflateRange(Action):
    def __call__(self, parser, namespace, values, option_string=None):
        print('%r %r %r' % (namespace, values, option_string))
        lst = []
        for string in values:
            print 'in string:',string
            if '-' in string:
                m = re.match(r'(d+)(?:-(d+))?$', string)
                # ^ (or use .split('-'). anyway you like.)
                if not m:
                    raise ArgumentTypeError("'" + string + "' is not a range of number. Expected forms like '0-5' or '2'.")
                start = m.group(1)
                end = m.group(2) or start
                lst.extend(list(range(int(start,10), int(end,10)+1)))
            else:
                 lst.append(int(string))
            setattr(namespace, self.dest, lst)
parser = ArgumentParser()
parser.add_argument('--cid', action=InflateRange, nargs='*')
args = parser.parse_args()
print(args)

这样你就会得到：

> python test.py --cid 1-3 7 22
Namespace(cid=None) ['1-3', '7', '22'] '--cid'
in string: 1-3
in string: 7
in string: 22
Namespace(cid=[1, 2, 3, 7, 22])

有关更多信息，请查看文档

Answer 2

您可以将以下代码用于parseNumList方法。我假设input_string是该方法的输入。

>>> input_string = '1-3 7 22'
>>> input_list = input_string.split()
>>> alist = []
>>> for item in input_list:
...     if '-' in item:
...             a, b = item.split('-')
...             alist.extend(range(int(a), int(b) + 1))
...     else:
...             alist.append(int(item))
...
>>> alist
[1, 2, 3, 7, 22]

您可以在任何您认为合适的地方添加错误和边界检查。

Answer 3

答案"正确的方法…"是正确的，但我必须更改InflateRange类的代码才能使其真正工作。

此外，为了保持argparse中包含的错误，引发的异常需要是ArgumentError类型（请参阅此答案）。

自定义操作的代码如下所示：

class InflateRange(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        lst = []
        limits = values.split('-')
        if len(limits) > 2:
            raise argparse.ArgumentError(self, "%r is not a range of numbers." % part )
        start = limits[0]
        if start == '': start = '1'
        end = limits[-1]
        try:
            lst.extend(list(range(int(start), int(end)+1)))
        except ValueError:
            raise argparse.ArgumentError(self, "%r is not a range of numbers." % part )
        setattr(namespace, self.dest, lst)