指定 Python argparse 输入参数的日期格式

Question

我有一个需要一些命令行输入的 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

中是否有一个我不知道可以实现此目的的选项？

Answer 1

根据文档：

type

的

add_argument()

关键字参数允许执行任何必要的类型检查和类型转换...

type

的参数可以是任何接受单个字符串的可调用函数。

你可以这样做：

import argparse
import datetime


def valid_date(s: str) -> datetime.datetime:
    try:
        return datetime.datetime.strptime(s, "%Y-%m-%d")
    except ValueError:
        raise argparse.ArgumentTypeError(f"not a valid date: {s!r}")

然后将其用作

type

：

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

如果用户提供无效值，反馈将如下所示：

error: argument -s/--startdate: not a valid date: 'foo'

Answer 2

补充一下上面的答案，如果你想让它保持一行，你可以使用 lambda 函数。例如：

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

如果用户提供无效值，反馈将如下所示：

error: argument -e/--enddate: invalid <lambda> value: 'foo'

Answer 3

在 Python 3.7 中，您可以使用标准

.fromisoformat

类方法，而不是为符合 ISO-8601 的日期重新发明轮子，例如：

import datetime

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)

如果用户提供了无效的有效值，反馈将如下所示：

error: argument -e/--enddate: invalid fromisoformat value: 'foo'