Django REST框架:Serializer上的Unique_together验证

时间:2014-03-24 21:34:37

标签: django django-rest-framework

如果序列化程序实例在模型端出现serializer.is_valid()约束,则True返回unique_together会出现问题。

我有没有办法在序列化程序中指定强制执行unique_together约束?

6 个答案:

答案 0 :(得分:16)

ModelSerializer类至少在djangorestframework>=3.0.0内置了此功能内置,但是如果您使用的serializer并未包含所有unique_together约束影响的字段,在保存违反该实例的实例时,您将获得IntegrityError。例如,使用以下模型:

class Foo(models.Model):
    class Meta:
        unique_together = ('foo_a', 'foo_b')

    a = models.TextField(blank=True)
    b = models.TextField(blank=True)
    foo_a = models.IntegerField()
    foo_b = models.IntegerField(default=2)

以及以下序列化程序和ViewSet:

class FooSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Foo
        fields = ('a', 'b', 'foo_a')

class FooViewSet(viewsets.ModelViewSet):
    queryset = models.Foo.objects.all()
    serializer_class = FooSerializer


routes = routers.DefaultRouter()
routes.register(r'foo', FooViewSet)

如果您尝试使用相同的foo_afoo_b设置保存两个实例,那么您将获得IntegrityError。但是,如果我们像这样修改序列化器:

class FooSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Foo
        fields = ('a', 'b', 'foo_a', 'foo_b')

然后,您将获得正确的HTTP 400 BAD REQUEST状态代码,以及响应正文中相应的JSON描述性消息:

HTTP 400 BAD REQUEST
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS

{
    "non_field_errors": [
        "The fields foo_a, foo_b must make a unique set."
    ]
}

我希望这对你有帮助,即使这是一个有点陈旧的问题; - )

答案 1 :(得分:11)

我需要这个来覆盖默认消息。由this解决。

from django.utils.translation import ugettext_lazy as _
from rest_framework import serializers


class SomeSerializer(serializers.ModelSerializer):
  """
  Demostrating How to Override DRF UniqueTogetherValidator Message
  """

    class Meta:
        model = Some
        validators = [
            serializers.UniqueTogetherValidator(
                queryset=model.objects.all(),
                fields=('field1', 'field2'),
                message=_("Some custom message.")
            )
        ]

Similarly you can specify fields

答案 2 :(得分:8)

不幸的是,Andreas的答案并不完整,因为在更新的情况下它不起作用。

相反,你会想要更像的东西:

def validate(self, attrs):
    field1 = attrs.get('field1', self.object.field1)
    field2 = attrs.get('field2', self.object.field2)

    try:
        obj = Model.objects.get(field1=field1, field2=field2)
    except StateWithholdingForm.DoesNotExist:
        return attrs
    if self.object and obj.id == self.object.id:
        return attrs
    else:
        raise serializers.ValidationError('field1 with field2 already exists')

这适用于PUT,PATCH和POST。

答案 3 :(得分:2)

是的,您可以在序列化程序的.validate()方法中执行此操作。

def validate(self, attrs):
    try:
        Model.objects.get(field1=attrs['field1'], field2=attrs['field2'])
    except Model.DoesNotExist:
        pass
    else:
        raise serializers.ValidationError('field1 with field2 already exists')

    return attrs

您在模型中设置的唯一约束是用于创建数据库约束,而不是用于验证。

答案 4 :(得分:1)

遇到同样的问题,从这个答案https://stackoverflow.com/a/26027788/6473175开始,我能够让它工作,但必须使用self.instance代替self.object

def validate(self, data):
    field1 = data.get('field1',None)
    field2 = data.get('field2',None)

    try:
        obj = self.Meta.model.objects.get(field1=field1, field2=field2)
    except self.Meta.model.DoesNotExist:
        return data
    if self.instance and obj.id == self.instance.id:
        return data
    else:
        raise serializers.ValidationError('custom error message')

答案 5 :(得分:0)

嗯这有点愚蠢,除了我以外的任何人都不会犯这个错误,但是我把相同的模型放在两个序列化器类中,结果我遇到了这个问题

希望我的错误帮助某人!