我如何需要两个 jsonschema 属性之一,但也设置默认值?

How do I require one of two jsonschema properties, but also set a default?

我尝试验证一个 jsonschema,它用 radiusdiameter 或两者都不定义一个圆,然后只设置一个默认半径。这是我的架构:

{
  "properties": {
    "position": {},
    "radius": {
      { "type": "number" }
    },
    "diameter": {
      { "type": "number" }
    }
  },
  "oneOf": [
    {
      "required": ["radius"]
    },
    {
      "required": ["diameter"]
    },
    {
      "properties": {
        "radius": {
          "default": 16
        }
      }
    }
  ],
  "additionalProperties": false
}

这是设置默认值的验证器(如 JSON schema FAQ 所述):

from jsonschema import Draft7Validator, validators

def extend_with_default(validator_class):
  validate_properties = validator_class.VALIDATORS['properties']

  def set_defaults(validator, properties, instance, schema):
    for property, subschema in properties.items():
      if 'default' in subschema:
        instance.setdefault(property, subschema['default'])

    for error in validate_properties(
      validator, properties, instance, schema,
    ):
      yield error

  return validators.extend(
    validator_class, {'properties' : set_defaults},
  )
Validator = extend_with_default(Draft7Validator)

此验证程序在我验证模式之前设置了默认值,因此我只能设置半径或两者都不设置,但设置直径总是会引发错误。 如果我将其更改为先验证并稍后设置默认值(我宁愿不这样做,但没关系),那么它会设置默认半径,尽管所需的直径已经存在。

有没有办法通过在 python 中设置默认半径来实现这一点而无需硬编码?

不需要更改验证器。这是一个可能的解决方案:

{
  "properties": {
    "position": {},
    "radius": {
      { "type": "number" }
    },
    "diameter": {
      { "type": "number" }
    }
  },
  "if": {
    "not": {
      "anyOf": [
        {
          "required": ["radius"]
        },
        {
          "required": ["diameter"]
        }
      ]
    }
  },
  "then": {
    "properties": {
      "radius": {
        "default": 16
      }
    }
  },
  "oneOf": [
    {
      "required": ["radius"]
    },
    {
      "required": ["diameter"]
    }
  ],
  "additionalProperties": false
}

if 只有在既没有设置半径也没有设置直径的情况下才为真。只有这样才会设置默认半径。之后oneOf检查,是否同时设置了其中一个参数。