在 Django Rest Framework 中,我怎样才能 return 来自验证/序列化的错误(警告)而不会使验证失败?
In Django Rest Framework how can I return errors (warnings) from validation / serialization without failing the validation?
我有一个从外部 API 获取数据并更新 Django 模型的导入。执行此操作的代码将现有模型实例和传入数据传递给序列化程序 class 以获取要保存的更新实例。
对于此更新,如果某些传入数据错误,我不想使验证或更新失败,但我想通知错误(警告),以便它们可以在外部记录序列化程序。
是否有 DRF 方法或任何方法来做到这一点?
需要说明的是:我仍然希望序列化程序为其他不那么复杂的字段进行验证和引发,而不是需要额外处理的特殊字段。
我目前正在序列化程序中覆盖 to_internal_value
,以便我可以在让传入数据通过 super().to_internal_value()
之前处理格式奇怪的数据并记录错误消息:https://www.django-rest-framework.org/api-guide/serializers/#overriding-serialization-and-deserialization-behavior
我的解决方法是向序列化程序添加一个 warnings
属性以保存消息。然后 to_internal_value
覆盖可以选择性地从传入数据中删除错误字段并记录警告warnings
列表中的消息。
更新:我认为这会奏效,但我仍然想知道是否有更好的 Django 内置方法。
如果这是一次性导入,您可以:
您可以遍历每个对象,手动使用序列化程序对其进行验证。如果数据有效,您可以更新,否则您会保留一个日志文件,其中包含验证失败的异常对象。
序列化程序不会执行您的要求,如果您不希望它失败,则需要捕获错误或修改验证函数以使字段通过。序列化器的标准用途是它会在无效数据上引发错误。
我要回答我自己的问题,因为我发现我的预期解决方案比我想象的更合理。如果我得到更好的答案,我会select。
为了能够在某些无效字段而不是其他字段上引发,需要拦截传入的序列化以避免标准行为,这就是必须覆盖 to_internal_value
的原因。
为了能够在不引发异常的情况下传回任何警告,我想逻辑上在 Serializer 对象上的某个地方需要一些持久属性,因为一旦我们通过执行,我们就不能依赖处理不在某个地方引发回到 Django ModelSerializer。
回想起来这一切似乎都很可靠,所以我想我只是谨慎因为我以前没有走过这条路。我真的很感激任何提出问题的人。
Django 已经有了 errors
OrderedDict
,它在验证异常中使用它来形式化每个字段的错误消息。问题是,在调用 is_valid()
之前无法访问它,因此需要另一个属性。
这是一个简化的示例实现。
这将像 Django ModelSerializer 一样工作,除了可以在调用 is_valid()
之后引用 warnings
属性以报告发生的事情:
class AnObjectSerializer(serializers.ModelSerializer):
"""
Serialize normal fields using Django ModelSerializer magic to raise when invalid.
Intercept incoming crazy foreign fields and record warnings when invalid without raise.
"""
CRAZY_FIELDS = ('foreign_omicron', 'foreign_delta', 'foreign_crazy')
warnings = {} # Some field failures will not invalidate but are reported here
def to_internal_value(self, data):
"""Try to add incoming foreign crazy fields or warn if not."""
foo = data['foo']
for field in self.CRAZY_FIELDS:
value = data.pop(field, None) or {}
value = value.get('foobar') or '' # Dig crazy field out of the incoming blob
value = value.lower() # Normalize crazy field somewhat
# Do not raise serializers.ValidationError to allow AnObject load to continue
# But report errors back to caller for logging in warnings list
if value:
try:
some_external_validation(value)
except serializers.ValidationError:
self.warnings[field] = f'{foo}: foobar "{value}" has a problem'
value = ''
data[field] = value
validated_data = super().to_internal_value(data)
return validated_data
class Meta:
model = AnObject
fields = (
'foo', 'bar', 'baz', 'qux',
'foreign_omicron', 'foreign_delta', 'foreign_crazy',
)
我有一个从外部 API 获取数据并更新 Django 模型的导入。执行此操作的代码将现有模型实例和传入数据传递给序列化程序 class 以获取要保存的更新实例。
对于此更新,如果某些传入数据错误,我不想使验证或更新失败,但我想通知错误(警告),以便它们可以在外部记录序列化程序。
是否有 DRF 方法或任何方法来做到这一点?
需要说明的是:我仍然希望序列化程序为其他不那么复杂的字段进行验证和引发,而不是需要额外处理的特殊字段。
我目前正在序列化程序中覆盖 to_internal_value
,以便我可以在让传入数据通过 super().to_internal_value()
之前处理格式奇怪的数据并记录错误消息:https://www.django-rest-framework.org/api-guide/serializers/#overriding-serialization-and-deserialization-behavior
我的解决方法是向序列化程序添加一个 warnings
属性以保存消息。然后 to_internal_value
覆盖可以选择性地从传入数据中删除错误字段并记录警告warnings
列表中的消息。
更新:我认为这会奏效,但我仍然想知道是否有更好的 Django 内置方法。
如果这是一次性导入,您可以:
您可以遍历每个对象,手动使用序列化程序对其进行验证。如果数据有效,您可以更新,否则您会保留一个日志文件,其中包含验证失败的异常对象。
序列化程序不会执行您的要求,如果您不希望它失败,则需要捕获错误或修改验证函数以使字段通过。序列化器的标准用途是它会在无效数据上引发错误。
我要回答我自己的问题,因为我发现我的预期解决方案比我想象的更合理。如果我得到更好的答案,我会select。
为了能够在某些无效字段而不是其他字段上引发,需要拦截传入的序列化以避免标准行为,这就是必须覆盖 to_internal_value
的原因。
为了能够在不引发异常的情况下传回任何警告,我想逻辑上在 Serializer 对象上的某个地方需要一些持久属性,因为一旦我们通过执行,我们就不能依赖处理不在某个地方引发回到 Django ModelSerializer。
回想起来这一切似乎都很可靠,所以我想我只是谨慎因为我以前没有走过这条路。我真的很感激任何提出问题的人。
Django 已经有了 errors
OrderedDict
,它在验证异常中使用它来形式化每个字段的错误消息。问题是,在调用 is_valid()
之前无法访问它,因此需要另一个属性。
这是一个简化的示例实现。
这将像 Django ModelSerializer 一样工作,除了可以在调用 is_valid()
之后引用 warnings
属性以报告发生的事情:
class AnObjectSerializer(serializers.ModelSerializer):
"""
Serialize normal fields using Django ModelSerializer magic to raise when invalid.
Intercept incoming crazy foreign fields and record warnings when invalid without raise.
"""
CRAZY_FIELDS = ('foreign_omicron', 'foreign_delta', 'foreign_crazy')
warnings = {} # Some field failures will not invalidate but are reported here
def to_internal_value(self, data):
"""Try to add incoming foreign crazy fields or warn if not."""
foo = data['foo']
for field in self.CRAZY_FIELDS:
value = data.pop(field, None) or {}
value = value.get('foobar') or '' # Dig crazy field out of the incoming blob
value = value.lower() # Normalize crazy field somewhat
# Do not raise serializers.ValidationError to allow AnObject load to continue
# But report errors back to caller for logging in warnings list
if value:
try:
some_external_validation(value)
except serializers.ValidationError:
self.warnings[field] = f'{foo}: foobar "{value}" has a problem'
value = ''
data[field] = value
validated_data = super().to_internal_value(data)
return validated_data
class Meta:
model = AnObject
fields = (
'foo', 'bar', 'baz', 'qux',
'foreign_omicron', 'foreign_delta', 'foreign_crazy',
)