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


164

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

这就是我所拥有的,虽然程序不会在非正整数上崩溃,但我希望通知用户非正整数基本上是无稽之谈。

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)

Answers:


244

这应该是可以利用的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_square在函数文档argparse


1
您的函数可以有多个值吗?这是如何运作的?
汤姆

2
如果转换int失败,是否还会有可读的输出?还是您应该try raise为此手动进行转换?
NOhs

4
@MrZ它会给类似的东西error: argument foo: invalid check_positive value: 'foo=<whatever>'。您只需在它周围添加一个try:... 即可except ValueError:重新引发带有更好错误消息的异常。
Yuushi

59

type 就像Yuushi的回答一样,将是处理条件/检查的推荐选项。

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

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

注:使用range的,而不是xrange为Python 3.X


3
我想这将是相当低效的,因为您将生成一个范围,然后在其范围内循环以验证您的输入。快速if快得多。
TravisThomas 2014年

2
@ trav1th确实可以,但这只是文档中的示例用法。另外,我在回答中说,Yuushi的回答是一个不错的选择。很好的选择。就argparse而言,它每次执行一次,使用一个generator(xrange),不需要其他代码。可以进行权衡。由每个人决定要走的路。
aneroid 2014年

16
为了更清楚地了解jgritty关于本作者答案的观点,choices = xrange(0,1000)将导致每次使用--help或如果无效参数为时,将整数列表(从1到999)(包括1到999)写入控制台。提供。在大多数情况下不是一个好的选择。
biomiker '16

9

如果您有一个可预测的最大值和最小值,则快速而肮脏的方法是使用choices范围

parser.add_argument('foo', type=int, choices=xrange(0, 1000))

24
不利的一面是可怕的输出。
jgritty

6
我想强调肮脏
ben作者

4
为了更清楚地了解jgritty的观点,choices = xrange(0,1000)会导致每次使用--help或提供无效参数时,会将从1到999的整个整数列表(包括1到999)写入控制台。在大多数情况下不是一个好的选择。
biomiker '16

8

一个更简单的替代方法(尤其是在子类化的情况下argparse.ArgumentParser)是从parse_args方法内部启动验证。

在这样的子类中:

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

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


关于ArgumentParser.error(message)

此方法打印一条包括标准错误消息的用法消息,并以状态代码2终止程序。


信用:乔纳丹回答


或者至少,用print "-g/--games: must be positive."; sys.exit(1)just 代替parser.error("-g/--games: must be positive.")(用法像jonatan的答案一样。)
无液型

3

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

# 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现在只允许使用正整数,就像要求的OP一样。

请注意,除了上述形式以外,使用以下形式还可以设置最大值IntRange

parser.add_argument('other', type=IntRange(imax=10))  # Must have other <= 10
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.