Cerberus - 仅在满足依赖性时才需要字段
Cerberus - Field required only when dependency is met
考虑以下模式
schema = {
"value_type":{
"type": "string", "required": True
},
"units": {
"type": "string",
"dependencies": {"value_type": ["float", "integer"]},
"required": True
}
}
当 value_type
字段的值为 float
或 [=17= 时,我希望 仅 需要 units
字段].
这是我想要实现的行为
v = Validator(schema)
v.validate({"value_type": "float", "units": "mm"}) # 1.
True
v.validate({"value_type": "boolean", "units": "mm"}) # 2.
False
v.validate({"value_type": "float"}) # 3.
False
v.validate({"value_type": "boolean"}) # 4.
True
以上模式returns 仅前 3 种情况的预期结果。
如果我将 units
的定义(通过省略 "required": True
)更改为
"units": {"type": "string", "dependencies": {"value_type": ["float", "integer"]}}
然后验证
v.validate({"value_type": "float"}) # 3.
True
returns True
这不是我想要的。
我查看了 documentation 中的 oneof
规则,但找不到仅将其应用于 required
属性.[=25 的方法=]
我希望 required 的值仅在满足依赖关系时才为 True
。
我应该如何修改我的模式来实现这一点?
由于您的变体跨越多个字段,*of
规则并不完全适用,尤其是因为这些似乎是文档中的顶级字段。
我通常会建议仍然存在 Python 并且并非所有内容都必须用模式表示,因此您可以简单地定义两个有效模式并针对这些模式进行测试:
schema1 = {...}
schema2 = {...}
if not any(validator(document, schema=x) for x in (schema1, schema2)):
boom()
这也比您最终得到的任何模式都更容易理解。
或者,您可以使用 check_with
规则。该示例显示了两种不同的错误提交方式,当错误仅呈现给人类时,后者是可预知的,因为它们允许针对不同情况的自定义消息,同时缺少有关错误的结构信息:
class MyValidator(Validator):
def _check_with_units_required(self, field, value):
if value in ("float", "integer"):
if "units" not in self.document:
self._error("units", errors.REQUIRED_FIELD, "check_with")
else:
if "units" in self.document:
self._error(
"units", "The 'units' field must not be provided for value "
"types other than float or integer."
)
schema = {
"value_type": {
"check_with": "units_required",
"required": True,
"type": "string"
},
"units": {
"type": "string",
}
}
validator = MyValidator(schema)
assert validator({"value_type": "float", "units": "mm"})
assert not validator({"value_type": "boolean", "units": "mm"})
assert not validator({"value_type": "float"})
assert validator({"value_type": "boolean"})
考虑以下模式
schema = {
"value_type":{
"type": "string", "required": True
},
"units": {
"type": "string",
"dependencies": {"value_type": ["float", "integer"]},
"required": True
}
}
当 value_type
字段的值为 float
或 [=17= 时,我希望 仅 需要 units
字段].
这是我想要实现的行为
v = Validator(schema)
v.validate({"value_type": "float", "units": "mm"}) # 1.
True
v.validate({"value_type": "boolean", "units": "mm"}) # 2.
False
v.validate({"value_type": "float"}) # 3.
False
v.validate({"value_type": "boolean"}) # 4.
True
以上模式returns 仅前 3 种情况的预期结果。
如果我将 units
的定义(通过省略 "required": True
)更改为
"units": {"type": "string", "dependencies": {"value_type": ["float", "integer"]}}
然后验证
v.validate({"value_type": "float"}) # 3.
True
returns True
这不是我想要的。
我查看了 documentation 中的 oneof
规则,但找不到仅将其应用于 required
属性.[=25 的方法=]
我希望 required 的值仅在满足依赖关系时才为 True
。
我应该如何修改我的模式来实现这一点?
由于您的变体跨越多个字段,*of
规则并不完全适用,尤其是因为这些似乎是文档中的顶级字段。
我通常会建议仍然存在 Python 并且并非所有内容都必须用模式表示,因此您可以简单地定义两个有效模式并针对这些模式进行测试:
schema1 = {...}
schema2 = {...}
if not any(validator(document, schema=x) for x in (schema1, schema2)):
boom()
这也比您最终得到的任何模式都更容易理解。
或者,您可以使用 check_with
规则。该示例显示了两种不同的错误提交方式,当错误仅呈现给人类时,后者是可预知的,因为它们允许针对不同情况的自定义消息,同时缺少有关错误的结构信息:
class MyValidator(Validator):
def _check_with_units_required(self, field, value):
if value in ("float", "integer"):
if "units" not in self.document:
self._error("units", errors.REQUIRED_FIELD, "check_with")
else:
if "units" in self.document:
self._error(
"units", "The 'units' field must not be provided for value "
"types other than float or integer."
)
schema = {
"value_type": {
"check_with": "units_required",
"required": True,
"type": "string"
},
"units": {
"type": "string",
}
}
validator = MyValidator(schema)
assert validator({"value_type": "float", "units": "mm"})
assert not validator({"value_type": "boolean", "units": "mm"})
assert not validator({"value_type": "float"})
assert validator({"value_type": "boolean"})