为 Python argparse 输入参数指定日期格式答案

【问题标题】：Specify date format for Python argparse input arguments为 Python argparse 输入参数指定日期格式
【发布时间】：2014-10-17 17:08:32
【问题描述】：

我有一个 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 argparse

【解决方案1】：

每the documentation:

add_argument() 的 type 关键字参数允许执行任何必要的类型检查和类型转换...type 的参数可以是任何接受单个字符串的可调用对象。

你可以这样做：

def valid_date(s):
    try:
        return datetime.strptime(s, "%Y-%m-%d")
    except ValueError:
        msg = "not a valid date: {0!r}".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
)

【讨论】：

关于您编辑的另一个问题，您能指出我的文档（如果有的话）吗？
valid_date() 是否假定给定参数是字符串？
@StevenVascellaro 是的，但这就是 API 定义的； “采用单个字符串参数” 根据文档中的引用。
我收到了NameError: name 's' is not defined 这个代码。
@GeorgPfolz s 是在valid_date 的参数列表中定义的，所以这似乎不太可能。

【解决方案2】：

只是为了补充上面的答案，如果您想将其保留为单行，则可以使用 lambda 函数。例如：

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

旧线程，但问题至少对我来说仍然相关！

【讨论】：

这是一个不错的技巧，虽然如果你传递了一些无效的东西，错误信息将只是invalid <lambda> value

【解决方案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)

【讨论】：

此外，dateutil's ISO 解析器采用了许多仍然符合 ISO 8601-2004 的附加 fmt。您可以使用import dateutil.parser --> type=dateutil.parser.isoparse 或 type=dateutil.parser.parse
@BradSolomon 确实是一个很好的建议（因此我的 +1），但 dateutil 是第三方软件包。人们必须根据额外安装它的（小）麻烦来判断它的好处。 YMMV。
非常优雅的解决方案！