Укажите формат для входных аргументов argparse python

111

У меня есть скрипт python, который требует ввода некоторых данных в командной строке, и я использую argparse для их анализа. Я нашел документацию немного запутанной и не смог найти способ проверить формат во входных параметрах. То, что я имею в виду под проверкой формата, объясняется этим примером сценария:

parser.add_argument('-s', "--startdate", help="The Start Date - format YYYY-MM-DD ", required=True)
parser.add_argument('-e', "--enddate", help="The End Date format YYYY-MM-DD (Inclusive)", required=True)
parser.add_argument('-a', "--accountid", type=int, help='Account ID for the account for which data is required (Default: 570)')
parser.add_argument('-o', "--outputpath", help='Directory where output needs to be stored (Default: ' + os.path.dirname(os.path.abspath(__file__)))

Мне нужно проверить вариант -sи убедиться, -eчто ввод пользователя находится в формате YYYY-MM-DD. Есть ли в argparse опция, которую я не знаю, которая выполняет это.

python python-2.7 argparse Сохаиб
источник

236

Согласно документации :

typeКлючевое слово аргумент add_argument()позволяет любые необходимые преобразования типов проверки и типа должны быть выполнены ... type=может принимать любое отозваны , который принимает один строковый аргумент и возвращает преобразованное значение

Вы можете сделать что-то вроде:

def valid_date(s):
    try:
        return datetime.strptime(s, "%Y-%m-%d")
    except ValueError:
        msg = "Not a valid date: '{0}'.".format(s)
        raise argparse.ArgumentTypeError(msg)

Затем используйте это как type:

parser.add_argument("-s", 
                    "--startdate", 
                    help="The Start Date - format YYYY-MM-DD", 
                    required=True, 
                    type=valid_date)

Джонршарп
источник

Что касается другого вопроса, который вы отредактировали, можете ли вы указать мне на документацию (если есть) по этому поводу?

Sohaib

valid_date()Предполагает ли, что данный аргумент является строкой?

Stevoisiak

1

@StevenVascellaro: да, но это то, что определяет API; "принимает единственный строковый аргумент" согласно цитате из документации.

jonrsharpe

71

Чтобы добавить к ответу выше, вы можете использовать лямбда-функцию, если хотите, чтобы она была однострочным. Например:

parser.add_argument('--date', type=lambda d: datetime.strptime(d, '%Y%m%d'))

Старая ветка, но вопрос по крайней мере для меня был актуален!

Эван V
источник

6

Это хороший трюк, хотя если вы передадите что-то недопустимое, сообщение об ошибке будет простоinvalid <lambda> value

Брэд Соломон

38

Для других, кто попал в эту задачу через поисковые системы: в Python 3.7 вы можете использовать стандартный .fromisoformatметод класса вместо того, чтобы изобретать колесо для дат, соответствующих ISO-8601, например:

parser.add_argument('-s', "--startdate",
    help="The Start Date - format YYYY-MM-DD",
    required=True,
    type=datetime.date.fromisoformat)
parser.add_argument('-e', "--enddate",
    help="The End Date format YYYY-MM-DD (Inclusive)",
    required=True,
    type=datetime.date.fromisoformat)

Михал Горный
источник

5

Кроме того, dateutil«s анализатор ISO принимает ряд дополнительных fmts, которые до сих пор ISO 8601-2004 требований. Вы можете использовать import dateutil.parser-> type=dateutil.parser.isoparseилиtype=dateutil.parser.parse

Брэд Соломон

@BradSolomon Действительно хорошее предложение (отсюда и мой +1), но dateutilэто сторонний пакет. Можно было бы судить о его преимуществах относительно (небольших) хлопот, связанных с его дополнительной установкой. YMMV.

Laryx Decidua,

Укажите формат для входных аргументов argparse python

Ответы: