使用 python jsonschema 验证日期时间值答案

【问题标题】：Validate datetime value using python jsonschema使用 python jsonschema 验证日期时间值
【发布时间】：2018-09-06 18:46:26
【问题描述】：

我正在使用jsonschema 来验证我的python 字典。我正在尝试验证 datetime 值，但我不知道该怎么做。

这是我目前所拥有的，这会导致错误，因为 jsonschema 没有 datetime 类型：

order = {
    "name": "shirt",
    "order_datetime": datetime.datetime(2018, 1, 18)
}

schema = {
    "title": "Order",
    "type": "object",
    "required": ["name", "order_datetime"],
    "properties": {
        "name": {
            "type": "string"
        },
        "order_datetime": {
            "type": "datetime"
        }
    }
}

from jsonschema import validate
validate(order, schema)

错误是jsonschema.exceptions.SchemaError: 'datetime' is not valid under any of the given schemas。如何正确验证？

【问题讨论】：

文档建议用破折号拼写'date-time'。查看one of the schemas，它被描述为“有效的日期时间字符串”，而不是datetime 实例。
@StevenRumbalski 我需要验证一个日期时间实例
按照我评论中的第一个链接到@sobek 的答案，该答案显示了如何扩展类型。您可以扩展 date-time，而不是扩展 number。
如果您实际上并不打算转储到 JSON 并且只想验证您的字典，请使用 schema。

标签： python jsonschema python-jsonschema

【解决方案1】：

以下是使用原生 Python datetime 对象正确验证的方法。假设您有 jsonschema 3.x：

from datetime import datetime
import jsonschema

def validate_with_datetime(schema, instance):
  BaseVal = jsonschema.Draft7Validator

  # Build a new type checker
  def is_datetime(checker, inst):
    return isinstance(inst, datetime)
  date_check = BaseVal.TYPE_CHECKER.redefine('datetime', is_datetime)

  # Build a validator with the new type checker
  Validator = jsonschema.validators.extend(BaseVal, type_checker=date_check)

  # Run the new Validator
  Validator(schema=schema).validate(instance)

【讨论】：

【解决方案2】：

一旦您将rfc3339-validator 或strict-rfc3339 添加到项目依赖项（我可以看到第一个更准确），jsonschema.FormatChecker 类将注册date-time 格式验证器。所以代码将尽可能简单：

from jsonschema import (
    Draft7Validator,
    FormatChecker,
)

schema = {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "datetime": {
      "type": "string",
      "format": "date-time"
    }
  }
}

validator = Draft7Validator(schema, format_checker=FormatChecker())
data_samples = [
    {'datetime': '2021-01-01T00:01:02.003+01:00'},
    {'datetime': '2021-01-01'},
]
assert validator.is_valid(data_samples[0]) is True
assert validator.is_valid(data_samples[1]) is False

您可以在jsonschema documentation page 上查看其他可能使用的格式、它们需要的库以及其他提示。

【讨论】：

【解决方案3】：

在@speedplane 的回答的帮助下，我能够让类型检查器为我的 order_datetime 案例工作。

order = {
    "name": "shirt",
    "order_datetime": "2019-09-13-22.30.00.000000"
}

schema = {
    "title": "Order",
    "type": "object",
    "required": ["name", "order_datetime"],
    "properties": {
        "name": {
            "type": "string"
        },
        "order_datetime": {
            "type": "orderdatetime"
        }
    }
}

Python 代码

import jsonschema
def validate_with_datetime(schema, instance):
  BaseVal = jsonschema.Draft7Validator
  # Build a new type checker
  def is_datetime(checker, inst):
     try:
        datetime.datetime.strptime(inst, '%Y-%m-%d-%H.%M.%S.%f')
        return True
     except ValueError:
        return False
  date_check = BaseVal.TYPE_CHECKER.redefine(u'orderdatetime', is_datetime)
  

  # Build a validator with the new type checker
  Validator = jsonschema.validators.extend(BaseVal, type_checker=date_check)

  # Run the new Validator
  Validator(schema=schema).validate(instance)

validate_with_datetime(schema, order)

但在探索 jsonschema 库时，我遇到了 FormatChecker()。不能用jsonschema.FormatChecker()来验证datetime类型属性的格式吗？

@speedplane 你能发布一个如何使用 FormatChecker() 的例子吗？

【讨论】：