Argparse: опция, принимающая один или два аргумента

Я хочу иметь вариант, который принимает один или два аргумента, в частности метку времени и необязательный допуск.

Я понимаю, что мне нужно просто использовать nargs='+' и вывести ошибку, если я получаю более двух значений, что я и делаю.

Я также использую metavar=('timestamp', 'tolerance'), чтобы можно было назвать два значения.

Однако справочное сообщение по-прежнему выглядит так:
usage: foo.py [-h] [-t timestamp [tolerance ...]]
Из чего следует, что -t может принимать более двух аргументов.

Как я могу заставить его просто сказать [-t timestamp [tolerance]]? Мой фактический код ниже:

import argparse
import sys

parser = argparse.ArgumentParser()
parser.add_argument('-t', '--timestamp', nargs='+', metavar=('timestamp', 'tolerance'))
args = parser.parse_args()
if args.timestamp and len(args.timestamp) > 2:
    sys.exit('Argument --timestamp takes one or two values')

Есть ли причина не использовать отдельные аргументы --timestamp и --tolerance?

0x5453 17.07.2018 22:40
--tolerance - это количество минут от отметки времени, поэтому без --timestamp это бессмысленно. Также меньше многословия.
Barry McNamara 17.07.2018 23:12

Полагаю, я мог бы просто выдать предупреждение, если --tolerance поставляется без --timestamp, но придумывание альтернативы на самом деле не отвечает на вопрос.

Barry McNamara 17.07.2018 23:14

Некоторое время назад был предложен патч, разрешающий диапазон значений nargs, bugs.python.org/issue11354, но так и не запущенный в производство. Лучше всего проводить собственное тестирование на «+» с существующим кодом, но, как вы заметили, help не очень хорош.

hpaulj 18.07.2018 01:06
Почему в Python есть оператор "pass"?
Почему в Python есть оператор "pass"?
Оператор pass в Python - это простая концепция, которую могут быстро освоить даже новички без опыта программирования.
Некоторые методы, о которых вы не знали, что они существуют в Python
Некоторые методы, о которых вы не знали, что они существуют в Python
Python - самый известный и самый простой в изучении язык в наши дни. Имея широкий спектр применения в области машинного обучения, Data Science,...
Основы Python Часть I
Основы Python Часть I
Вы когда-нибудь задумывались, почему в программах на Python вы видите приведенный ниже код?
LeetCode - 1579. Удаление максимального числа ребер для сохранения полной проходимости графа
LeetCode - 1579. Удаление максимального числа ребер для сохранения полной проходимости графа
Алиса и Боб имеют неориентированный граф из n узлов и трех типов ребер:
Оптимизация кода с помощью тернарного оператора Python
Оптимизация кода с помощью тернарного оператора Python
И последнее, что мы хотели бы показать вам, прежде чем двигаться дальше, это
Советы по эффективной веб-разработке с помощью Python
Советы по эффективной веб-разработке с помощью Python
Как веб-разработчик, Python может стать мощным инструментом для создания эффективных и масштабируемых веб-приложений.
2
4
1 306
1

Ответы 1

Я понимаю, что действительно опаздываю на вечеринку по этому поводу, но мне пришлось сделать то же самое для рабочего проекта. Ниже представлена ​​сильно упрощенная версия того, что я сделал.

ПОЛНОЕ РАСКРЫТИЕ: Это очевидно хакерский метод, поскольку он полагается на частную функцию; это был единственный способ, который я видел для этого, поскольку, похоже, не было встроенной поддержки. Мое решение было частью приложения, которое было упаковано, чтобы включать конкретную версию python (3.x), которая мне была нужна (поскольку я получаю доступ к частному API для этого), и мой проект имеет значительное автоматическое тестирование, чтобы выявить любые поломки в будущем. . Вы были предупреждены.

import argparse
import re as _re

class CustomParser(argparse.ArgumentParser):

    def _match_argument(self, action, arg_strings_pattern):
        if action.dest == 'name':
            # Account for flexible number of arguments. The pattern is copied from the parent class'
            # _get_nargs_pattern() function. 
            narg_pattern = '(-*A{1,2})'
            match = _re.match(narg_pattern , arg_strings_pattern)

            if match:
                return len(match.group(1))
            else:
                raise argparse.ArgumentError(action, "expected {} or {} arguments".format(1, 2))
        else:
            return super()._match_argument(action, arg_strings_pattern)

if __name__ == '__main__':
    parser = CustomParser("Flexible argument number test")
    # nargs must be 2 so that the help output properly formats the metavar argument.
    # Notice that I added '[]' around the optional argument to be consistent with argparse.
    parser.add_argument("--name", nargs=2, metavar=("FIRST", "[LAST]"),
                        help = "Your name: FIRST LAST. The last name is optional.")

    args = parser.parse_args()
    print(args)

Пример вывода:

SCRIPT --help
usage: Flexible argument number test [-h] [--name FIRST [LAST]]

optional arguments:
  -h, --help           show this help message and exit
  --name FIRST [LAST]  Your name: FIRST LAST. The last name is optional.

SCRIPT --name John
Namespace(name=['John'])

SCRIPT --name John Smith
Namespace(name=['John', 'Smith'])

SCRIPT --name
usage: Flexible argument number test [-h] [--name FIRST [LAST]]
Flexible argument number test: error: argument --name: expected 1 or 2 arguments

Очевидно, есть вещи, которые вы, вероятно, захотите решить, например:

  • Параметризация имени опции, которую вы ищете, чтобы значение 'name' не дублировалось
  • Имейте словарь аргументов, для которых количество аргументов может варьироваться, и ищите параметр вместо оператора if, который работает только для одного аргумента.

Другие вопросы по теме