在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)
99020 次浏览
小开
最佳答案

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

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

小开

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

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

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

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

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

对于python 3.x，使用range代替xrange

小开

一个更简单的替代方法，特别是在继承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终止程序。

信贷:jonatan的回答

小开

如果有人(像我)在谷歌搜索中遇到这个问题，这里有一个如何使用模块化方法巧妙解决更普遍的问题，允许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
小开

根据Yuushi的回答，你还可以定义一个简单的helper函数，它可以检查一个数字对于各种数字类型是否为正数:

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

helper函数可以像这样注释任何数字参数类型:

parser = argparse.ArgumentParser(...)
parser.add_argument("positive-integer", type=positive(int))
parser.add_argument("positive-float", type=positive(float))

提交答案