Django：“unique_together”和“空白=真”

Question

我有一个看起来像这样的 Django 模型：

class MyModel(models.Model):
    parent = models.ForeignKey(ParentModel)
    name   = models.CharField(blank=True, max_length=200)
    ... other fields ...

    class Meta:
        unique_together = ("name", "parent")

这按预期工作；如果同一个 name 在同一个 parent 中不止一次出现相同的 name，那么我会收到错误消息：“具有此名称和父级的 MyModel 已存在。”

但是，当我使用相同的 parent 保存多个 MyModel 但 name 字段为空白时，我也会收到错误消息，但这应该是允许的。所以基本上我不想在name 字段为空白时出现上述错误。这有可能吗？

Answer 1

首先，空白（空字符串）与 null ('' != None) 不同。

其次，当您将字段留空时，通过表单使用 Django CharField 将存储 空字符串。

因此，如果您的字段不是 CharField，您只需添加 null=True 即可。 但在这种情况下，您需要做的还不止这些。您需要创建 forms.CharField 的子类并覆盖它的 clean 方法以在空字符串上返回 None，如下所示：

class NullCharField(forms.CharField):
    def clean(self, value):
        value = super(NullCharField, self).clean(value)
        if value in forms.fields.EMPTY_VALUES:
            return None
        return value

然后在你的 ModelForm 中使用它：

class MyModelForm(forms.ModelForm):
    name = NullCharField(required=False, ...)

这样，如果您将其留空，它将在数据库中存储 null 而不是空字符串 ('')

Answer 2

使用unique_together，您是在告诉 Django 您不希望任何两个具有相同parent 和name 属性的MyModel 实例——即使name 是一个空字符串也适用。

这是在数据库级别使用相应数据库列上的unique 属性强制执行的。因此，要对此行为进行任何例外处理，您必须避免在模型中使用 unique_together。

相反，您可以通过覆盖模型上的save 方法并在那里强制执行独特的约束来获得所需的内容。当您尝试保存模型的实例时，您的代码可以检查是否存在具有相同 parent 和 name 组合的任何现有实例，如果存在则拒绝保存该实例。但是，如果name 是空字符串，您也可以允许保存实例。其基本版本可能如下所示：

class MyModel(models.Model):
    ...

    def save(self, *args, **kwargs):

        if self.name != '':
            conflicting_instance = MyModel.objects.filter(parent=self.parent, \
                                                          name=self.name)
            if self.id:
                # This instance has already been saved. So we need to filter out
                # this instance from our results.
                conflicting_instance = conflicting_instance.exclude(pk=self.id)

            if conflicting_instance.exists():
                raise Exception('MyModel with this name and parent already exists.')

        super(MyModel, self).save(*args, **kwargs)

希望对您有所帮助。

Answer 3

这个解决方案与@bigmattyh 给出的解决方案非常相似，但是，我发现下面的页面描述了应该在哪里进行验证：

http://docs.djangoproject.com/en/1.3/ref/models/instances/#validating-objects

我最终使用的解决方案如下：

from django    import forms

class MyModel(models.Model):
...

def clean(self):
    if self.name != '':
        instance_exists = MyModel.objects.filter(parent=self.parent,
                                                 name=self.name).exists()
        if instance_exists:
            raise forms.ValidationError('MyModel with this name and parent already exists.')

请注意，引发了 ValidationError 而不是一般异常。该方案的好处是，在验证ModelForm时，使用.is_valid()，会自动调用上面的models.clean()方法，并将ValidationError字符串保存在.errors中，以便在html模板中显示。

如果您不同意此解决方案，请告诉我。

Answer 4

您可以使用约束来设置部分索引，如下所示：

class MyModel(models.Model):
    parent = models.ForeignKey(ParentModel)
    name   = models.CharField(blank=True, max_length=200)
    ... other fields ...

    class Meta:    
      constraints = [
        models.UniqueConstraint(
          fields=['name', 'parent'],
          condition=~Q(name='')
          name='unique_name_for_parent'
        )
      ]

这允许像 UniqueTogether 这样的约束仅适用于某些行（基于您可以使用 Q 定义的条件）。

顺便说一句，这恰好也是 Django 推荐的前进路径：https://docs.djangoproject.com/en/3.2/ref/models/options/#unique-together

更多文档：https://docs.djangoproject.com/en/3.2/ref/models/constraints/#django.db.models.UniqueConstraint

Answer 5

bigmattyh 对正在发生的事情给出了很好的解释。我将添加一个可能的save 方法。

def save(self, *args, **kwargs):
    if self.parent != None and MyModels.objects.filter(parent=self.parent, name=self.name).exists():
        raise Exception('MyModel with this name and parent exists.')
    super(MyModel, self).save(*args, **kwargs)

我想我选择通过覆盖模型的 clean 方法来做类似的事情，它看起来像这样：

from django.core.exceptions import ValidationError
def clean(self):
    if self.parent != None and MyModels.objects.filter(parent=self.parent, name=self.name).exists():
        raise ValidationError('MyModel with this name and parent exists.')