Вкажіть формат для вхідних аргументів 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. Чи є варіант у аргументації, який я не знаю, який це досягає.

Відповіді:


235

Відповідно до документації :

Аргумент 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()вважаємо, що наведений аргумент є рядком?
Стевойсяк

1
@StevenVascellaro так, але саме це визначає API; "бере аргумент єдиного рядка" за цитатою з документів.
jonrsharpe

71

Просто для доповнення до відповіді, наведеної вище, ви можете використовувати лямбда-функцію, якщо ви хочете зберегти її до однолінійного. Наприклад:

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

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


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
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.