Django 中独特的模型字段和区分大小写（postgres）

Question

考虑以下情况： -

假设我的应用程序允许用户创建他们的州/省 国家。为了清楚起见，我们仅考虑 ASCII 字符 这里。

在美国，用户可以创建名为“德克萨斯州”的州。如果这个应用程序 正在内部使用，假设用户不关心它是否是 拼写为“texas”或“Texas”或“teXas”

但重要的是，系统应该阻止创建“texas”，如果 “德克萨斯州”已在数据库中。

如果模型如下所示：

class State(models.Model):
    name = models.CharField(max_length=50, unique=True)

在 postgres 中唯一性将区分大小写；也就是说，postgres 将允许用户按原样创建“texas”和“Texas” 被认为是独一无二的。

在这种情况下可以采取什么措施来防止这种行为。怎么样 努力为 Django 提供不区分大小写的唯一性 Postgres

现在我正在执行以下操作以防止创建案例- 不敏感的重复项。

class CreateStateForm(forms.ModelForm):
    def clean_name(self):
        name = self.cleaned_data['name']
        try:
            State.objects.get(name__iexact=name)
        except ObjectDoesNotExist:
            return name
        raise forms.ValidationError('State already exists.')

    class Meta:
        model = State

在很多情况下，我必须执行此检查，并且我不热衷于在各处编写类似的 iexact 检查。

只是想知道是否有内置或 更好的方法？也许 db_type 会有帮助？也许存在其他解决方案？

Answer 1

您可以定义从 models.CharField 派生的自定义模型字段。
该字段可以检查重复值，忽略大小写。

自定义字段文档位于http://docs.djangoproject.com/en /dev/howto/custom-model-fields/

查看 http://code.djangoproject.com/browser/django/trunk/django/db/models/fields/files.py 有关如何通过子类化自定义字段的示例现有领域。

您可以使用 PostgreSQL 的 citext 模块 https://www.postgresql.org/docs /current/static/citext.html

如果您使用此模块，自定义字段可以将“db_type”定义为 PostgreSQL 数据库的 CITEXT。

这将导致对自定义字段中的唯一值进行不区分大小写的比较。

Answer 2

或者，您可以更改默认的查询集管理器以在字段上执行不区分大小写的查找。在尝试解决类似的问题时，我遇到了：

http://djangosnippets.org/snippets/305/

为了方便起见，将代码粘贴在这里：

from django.db.models import Manager
from django.db.models.query import QuerySet

class CaseInsensitiveQuerySet(QuerySet):
    def _filter_or_exclude(self, mapper, *args, **kwargs):
        # 'name' is a field in your Model whose lookups you want case-insensitive by default
        if 'name' in kwargs:
            kwargs['name__iexact'] = kwargs['name']
            del kwargs['name']
        return super(CaseInsensitiveQuerySet, self)._filter_or_exclude(mapper, *args, **kwargs)

# custom manager that overrides the initial query set
class TagManager(Manager):
    def get_query_set(self):
        return CaseInsensitiveQuerySet(self.model)

# and the model itself
class Tag(models.Model):
    name = models.CharField(maxlength=50, unique=True, db_index=True)

    objects = TagManager()

    def __str__(self):
        return self.name

Answer 3

一个非常简单的解决方案：

class State(models.Model):
    name = models.CharField(max_length=50, unique=True)

    def clean(self):
        self.name = self.name.capitalize()

Answer 4

Mayuresh 答案的明确步骤：

1. 在 postgres 中执行：CREATE EXTENSION citext;

2. 在你的 models.py 中添加：

   来自 django.db.models 导入字段
   
   类 CaseInsensitiveTextField(fields.TextField):
       def db_type（自身，连接）：
           返回“citext”
   

   参考：https://github.com/zacharyvoase/ django-postgres/blob/master/django_postgres/citext.py

3. 在您的模型中使用： name = CaseInsensitiveTextField(unique=True)

Answer 5

在 Postgres 方面，功能性唯一索引将允许您强制执行不区分大小写的唯一值。 citext 也被指出，但这适用于旧版本的 PostgreSQL，并且通常是一种有用的技术。

例子：

# create table foo(bar text);
CREATE TABLE
# create unique index foo_bar on foo(lower(bar));
CREATE INDEX
# insert into foo values ('Texas');
INSERT 0 1
# insert into foo values ('texas');
ERROR:  duplicate key value violates unique constraint "foo_bar"

Answer 6

除了已经提到的覆盖保存的选项之外，您可以简单地将所有小写文本存储在数据库中并在显示时将它们大写。

class State(models.Model):
    name = models.CharField(max_length=50, unique=True)

    def save(self, force_insert=False, force_update=False):
        self.name = self.name.lower()
        super(State, self).save(force_insert, force_update)

Answer 7

您可以在序列化器上的UniqueValidator中使用lookup='iexact'，如下所示：

class StateSerializer(serializers.ModelSerializer): 
    name = serializers.CharField(validators=[
    UniqueValidator(
        queryset=models.State.objects.all(),lookup='iexact'
    )]

django版本：1.11.6

Answer 8

如果您不想使用 postgres 特定的解决方案，可以使用 upper() 在字段上创建唯一索引，以在数据库级别强制唯一性，然后创建自定义 Field mixin 覆盖 get_lookup() 将区分大小写的查找转换为不区分大小写的版本。 mixin 看起来像这样：

class CaseInsensitiveFieldMixin:
    """
    Field mixin that uses case-insensitive lookup alternatives if they exist.
    """

    LOOKUP_CONVERSIONS = {
        'exact': 'iexact',
        'contains': 'icontains',
        'startswith': 'istartswith',
        'endswith': 'iendswith',
        'regex': 'iregex',
    }

    def get_lookup(self, lookup_name):
        converted = self.LOOKUP_CONVERSIONS.get(lookup_name, lookup_name)
        return super().get_lookup(converted)

你可以这样使用它：

from django.db import models


class CICharField(CaseInsensitiveFieldMixin, models.CharField):
    pass


class CIEmailField(CaseInsensitiveFieldMixin, models.EmailField):
    pass


class TestModel(models.Model):
    name = CICharField(unique=True, max_length=20)
    email = CIEmailField(unique=True)

你可以阅读有关此方法的更多信息 这里。

Answer 9

您可以通过覆盖模型的保存方法来做到这一点 - 请参阅 文档。您基本上会做类似的事情：

class State(models.Model):
    name = models.CharField(max_length=50, unique=True)

    def save(self, force_insert=False, force_update=False):
        if State.objects.get(name__iexact = self.name):
            return
        else:
            super(State, self).save(force_insert, force_update)

另外，我对此可能是错的，但即将推出的模型验证 SoC 分支将使我们能够更轻松地做到这一点。

Answer 10

suhail 的解决方案对我有用，不需要启用 citext，非常简单的解决方案，只有一个干净的函数，而不是大写，我使用了 upper()。 Mayuresh 的解决方案也有效，但将字段从 CharField 更改为 TextField。

class State(models.Model):

    name = models.CharField(max_length=50, unique=True)

    def clean(self):
        self.name = self.name.upper()