在Python中,使用argparse,只允许正整数

时间:2013-01-02 05:47:22

标签: python argparse

标题几乎总结了我想要发生的事情。

这是我所拥有的,虽然程序没有在非正整数上爆炸,但我希望用户被告知非正整数基本上是无意义的。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-g", "--games", type=int, default=162,
                    help="The number of games to simulate")
args = parser.parse_args()

输出:

python simulate_many.py -g 20
Setting up...
Playing games...
....................

以负数输出:

python simulate_many.py -g -2
Setting up...
Playing games...

现在,显然我可以添加一个if确定if args.games是否定的,但我很好奇是否有办法将其捕获到argparse级别,以便利用自动使用打印。

理想情况下,它会打印类似于此的内容:

python simulate_many.py -g a
usage: simulate_many.py [-h] [-g GAMES] [-d] [-l LEAGUE]
simulate_many.py: error: argument -g/--games: invalid int value: 'a'

像这样:

python simulate_many.py -g -2
usage: simulate_many.py [-h] [-g GAMES] [-d] [-l LEAGUE]
simulate_many.py: error: argument -g/--games: invalid positive int value: '-2'

现在我正在这样做,我想我很高兴:

if args.games <= 0:
    parser.print_help()
    print "-g/--games: must be positive."
    sys.exit(1)

5 个答案:

答案 0 :(得分:180)

这应该可以利用type。您仍然需要定义一个实际方法来为您做出决定:

def check_positive(value):
    ivalue = int(value)
    if ivalue <= 0:
        raise argparse.ArgumentTypeError("%s is an invalid positive int value" % value)
    return ivalue

parser = argparse.ArgumentParser(...)
parser.add_argument('foo', type=check_positive)

这基本上只是perfect_squareargparse {{1}}函数中的一个改编示例。

答案 1 :(得分:47)

type将是处理条件/检查的推荐选项,如Yuushi的答案。

在您的具体情况下,如果您的上限也已知,您也可以使用choices参数:

parser.add_argument('foo', type=int, choices=xrange(5, 10))

答案 2 :(得分:4)

快速而肮脏的方式,如果你的arg具有可预测的最大值和最小值,则使用范围<{1}}

choices

答案 3 :(得分:4)

更简单的替代方法,特别是在子类化argparse.ArgumentParser时,是从parse_args方法内部启动验证。

在这样的子类中:

def parse_args(self, args=None, namespace=None):
    """Parse and validate args."""
    namespace = super().parse_args(args, namespace)  # super() works in Python 3
    if namespace.games <= 0:
         raise self.error('The number of games must be a positive integer.')
    return namespace

这种技术可能不像自定义可调用那样酷,但它可以完成这项工作。

关于ArgumentParser.error(message)

  

此方法将包含消息的用法消息打印到标准错误,并使用状态代码2终止程序。

信用:answer by jonatan

答案 4 :(得分:4)

如果有人(例如我)在Google搜索中遇到此问题,下面是一个示例,该示例说明了如何使用模块化方法来巧妙地解决更宽泛的问题,即仅在指定范围内允许argparse整数 < / em>:

# Custom argparse type representing a bounded int
class IntRange:

    def __init__(self, imin=None, imax=None):
        self.imin = imin
        self.imax = imax

    def __call__(self, arg):
        try:
            value = int(arg)
        except ValueError:
            raise self.exception()
        if (self.imin is not None and value < self.imin) or (self.imax is not None and value > self.imax):
            raise self.exception()
        return value

    def exception(self):
        if self.imin is not None and self.imax is not None:
            return argparse.ArgumentTypeError(f"Must be an integer in the range [{self.imin}, {self.imax}]")
        elif self.imin is not None:
            return argparse.ArgumentTypeError(f"Must be an integer >= {self.imin}")
        elif self.imax is not None:
            return argparse.ArgumentTypeError(f"Must be an integer <= {self.imax}")
        else:
            return argparse.ArgumentTypeError("Must be an integer")

这使您可以执行以下操作:

parser = argparse.ArgumentParser(...)
parser.add_argument('foo', type=IntRange(1))     # Must have foo >= 1
parser.add_argument('bar', type=IntRange(1, 7))  # Must have 1 <= bar <= 7

变量foo现在仅允许正整数,就像要求的操作一样。

请注意,除了上述形式以外,IntRange最多也只能使用:

parser.add_argument('other', type=IntRange(imax=10))  # Must have other <= 10