194

标题几乎概括了我想要发生的事情。

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

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)
4

6 回答 6

281

这应该可以利用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)

这基本上只是一个改编自docs on中的perfect_square函数的示例。argparse

于 2013-01-02T05:58:04.743 回答
79

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

在您的特定情况下，choices如果您的上限也已知，您也可以使用该参数：

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

注意：使用range而不是xrange用于 python 3.x

于 2013-01-02T06:05:32.780 回答
10

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

parser.add_argument('foo', type=int, choices=xrange(0, 1000))
于 2013-01-02T06:05:19.860 回答
9

一个更简单的替代方法，尤其是在子类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 终止程序。

信用：乔纳坦的回答

于 2016-10-09T19:51:47.960 回答
6

如果有人（像我一样）在 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
于 2020-04-24T15:05:18.707 回答
0

根据 Yuushi 的回答，您还可以定义一个简单的辅助函数，该函数可以检查一个数字对于各种数字类型是否为正：

def positive(numeric_type):
    def require_positive(value):
        number = numeric_type(value)
        if number <= 0:
            raise ArgumentTypeError(f"Number {value} must be positive.")
        return number

    return require_positive

辅助函数可用于注释任何数字参数类型，如下所示：

parser = argparse.ArgumentParser(...)
parser.add_argument("positive-integer", type=positive(int))
parser.add_argument("positive-float", type=positive(float))
于 2021-12-16T16:53:49.200 回答