Я хочу иметь вариант, который принимает один или два аргумента, в частности метку времени и необязательный допуск.
Я понимаю, что мне нужно просто использовать 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')
--tolerance - это количество минут от отметки времени, поэтому без --timestamp это бессмысленно. Также меньше многословия.
Полагаю, я мог бы просто выдать предупреждение, если --tolerance поставляется без --timestamp, но придумывание альтернативы на самом деле не отвечает на вопрос.
Некоторое время назад был предложен патч, разрешающий диапазон значений nargs, bugs.python.org/issue11354, но так и не запущенный в производство. Лучше всего проводить собственное тестирование на «+» с существующим кодом, но, как вы заметили, help не очень хорош.






Я понимаю, что действительно опаздываю на вечеринку по этому поводу, но мне пришлось сделать то же самое для рабочего проекта. Ниже представлена сильно упрощенная версия того, что я сделал.
ПОЛНОЕ РАСКРЫТИЕ: Это очевидно хакерский метод, поскольку он полагается на частную функцию; это был единственный способ, который я видел для этого, поскольку, похоже, не было встроенной поддержки. Мое решение было частью приложения, которое было упаковано, чтобы включать конкретную версию 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
Очевидно, есть вещи, которые вы, вероятно, захотите решить, например:
Есть ли причина не использовать отдельные аргументы
--timestampи--tolerance?