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

4 ответа:

это должно быть возможно с помощью 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)

это в основном просто адаптированный пример из

type было бы рекомендуемым вариантом для обработки условий / проверок, как в ответе Юуши.

в вашем конкретном случае, вы можете также использовать choices параметр, если ваш верхний предел также известен:

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

быстрый и грязный способ, если у вас есть предсказуемый Макс, а также мин для вашего arg, является использование choices ряд

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

более простая альтернатива, особенно если подклассы 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.


кредит: ответ Джонатан