Унікальне значення BooleanField у Django?

Припустимо, мій models.py виглядає так:

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField()

Я хочу, Characterщоб мав лише один із моїх випадків, is_the_chosen_one == Trueа всі інші is_the_chosen_one == False. Як я можу найкраще забезпечити дотримання цього обмеження унікальності?

Найкращі оцінки відповідей, які враховують важливість дотримання обмежень на рівні бази даних, моделі та форми (адміністратора)!

Кожного разу, коли мені потрібно було виконати це завдання, зроблене мною перевизначає метод збереження для моделі і перевіряє, чи не встановлено прапорець будь-якої іншої моделі (і вимкніть його).

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField()

    def save(self, *args, **kwargs):
        if self.is_the_chosen_one:
            try:
                temp = Character.objects.get(is_the_chosen_one=True)
                if self != temp:
                    temp.is_the_chosen_one = False
                    temp.save()
            except Character.DoesNotExist:
                pass
        super(Character, self).save(*args, **kwargs)

Я б замінив метод збереження моделі, і якщо ви встановили для логічного значення значення True, переконайтеся, що для всіх інших встановлено значення False.

from django.db import transaction

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField()

    def save(self, *args, **kwargs):
        if not self.is_the_chosen_one:
            return super(Character, self).save(*args, **kwargs)
        with transaction.atomic():
            Character.objects.filter(
                is_the_chosen_one=True).update(is_the_chosen_one=False)
            return super(Character, self).save(*args, **kwargs)

Я спробував відредагувати подібну відповідь Адама, але вона була відхилена через занадто багато змін до початкової відповіді. Цей спосіб є більш стислим та ефективним, оскільки перевірка інших записів здійснюється в одному запиті.

Замість того, щоб використовувати очищення / збереження власної моделі, я створив спеціальне поле, яке перевизначає pre_saveметод django.db.models.BooleanField. Замість того, щоб викликати помилку, якщо було інше поле True, я створив усі інші поля, Falseякщо воно було True. Крім того, замість того, щоб викликати помилку, якщо поле було Falseі жодного іншого поля не було True, я зберег це поле якTrue

fields.py

from django.db.models import BooleanField


class UniqueBooleanField(BooleanField):
    def pre_save(self, model_instance, add):
        objects = model_instance.__class__.objects
        # If True then set all others as False
        if getattr(model_instance, self.attname):
            objects.update(**{self.attname: False})
        # If no true object exists that isnt saved model, save as True
        elif not objects.exclude(id=model_instance.id)\
                        .filter(**{self.attname: True}):
            return True
        return getattr(model_instance, self.attname)

# To use with South
from south.modelsinspector import add_introspection_rules
add_introspection_rules([], ["^project\.apps\.fields\.UniqueBooleanField"])

models.py

from django.db import models

from project.apps.fields import UniqueBooleanField


class UniqueBooleanModel(models.Model):
    unique_boolean = UniqueBooleanField()

    def __unicode__(self):
        return str(self.unique_boolean)

Наступне рішення трохи потворне, але може працювати:

class MyModel(models.Model):
    is_the_chosen_one = models.NullBooleanField(default=None, unique=True)

    def save(self, *args, **kwargs):
        if self.is_the_chosen_one is False:
            self.is_the_chosen_one = None
        super(MyModel, self).save(*args, **kwargs)

Якщо ви встановите для is_the_chosen_one значення False або None, це завжди буде NULL. Ви можете мати NULL скільки завгодно, але ви можете мати лише один True.

Намагаючись звести кінці з кінцями з відповідями тут, я виявляю, що деякі з них успішно вирішують одне і те ж питання, і кожна з них підходить у різних ситуаціях:

Я б вибрав:

• @semente : Поважає обмеження на рівні бази даних, моделі та форми адміністратора, в той час як воно перекриває Django ORM якнайменше. Більше того, це можеймовірноможна використовувати всередині throughтаблиці ManyToManyFieldв unique_togetherситуації.(Я перевірю це і повідомлю)

  class MyModel(models.Model):
      is_the_chosen_one = models.NullBooleanField(default=None, unique=True)
  
      def save(self, *args, **kwargs):
          if self.is_the_chosen_one is False:
              self.is_the_chosen_one = None
          super(MyModel, self).save(*args, **kwargs)
  

• @Ellis Percival : Переглядає базу даних лише один додатковий час і приймає поточний запис як вибраний. Чисто та елегантно.

  from django.db import transaction
  
  class Character(models.Model):
      name = models.CharField(max_length=255)
      is_the_chosen_one = models.BooleanField()
  
  def save(self, *args, **kwargs):
      if not self.is_the_chosen_one:
          # The use of return is explained in the comments
          return super(Character, self).save(*args, **kwargs)  
      with transaction.atomic():
          Character.objects.filter(
              is_the_chosen_one=True).update(is_the_chosen_one=False)
          # The use of return is explained in the comments
          return super(Character, self).save(*args, **kwargs)  
  

Інші рішення, які не підходять для мого випадку, але життєздатні:

@nemocorp перевизначає cleanметод для перевірки. Однак він не повідомляє, яка модель є "тією", і це не зручно для користувачів. Незважаючи на це, це дуже приємний підхід, особливо якщо хтось не збирається бути таким агресивним, як @Flyte.

@ saul.shanabrook та @Thierry J. створили б власне поле, яке або змінило б будь-який інший запис "is_the_one", Falseабо зробило б ValidationError. Я просто не хочу вводити нові функції для моєї інсталяції Django, якщо це абсолютно не потрібно.

@daigorocub : використовує сигнали Django. Я вважаю це унікальним підходом і дає підказку про те, як використовувати сигнали Django . Однак я не впевнений, чи це - строго кажучи - "правильне" використання сигналів, оскільки я не можу розглядати цю процедуру як частину "роз'єднаної програми".

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField()

    def save(self, *args, **kwargs):
        if self.is_the_chosen_one:
            qs = Character.objects.filter(is_the_chosen_one=True)
            if self.pk:
                qs = qs.exclude(pk=self.pk)
            if qs.count() != 0:
                # choose ONE of the next two lines
                self.is_the_chosen_one = False # keep the existing "chosen one"
                #qs.update(is_the_chosen_one=False) # make this obj "the chosen one"
        super(Character, self).save(*args, **kwargs)

class CharacterForm(forms.ModelForm):
    class Meta:
        model = Character

    # if you want to use the new obj as the chosen one and remove others, then
    # be sure to use the second line in the model save() above and DO NOT USE
    # the following clean method
    def clean_is_the_chosen_one(self):
        chosen = self.cleaned_data.get('is_the_chosen_one')
        if chosen:
            qs = Character.objects.filter(is_the_chosen_one=True)
            if self.instance.pk:
                qs = qs.exclude(pk=self.instance.pk)
            if qs.count() != 0:
                raise forms.ValidationError("A Chosen One already exists! You will pay for your insolence!")
        return chosen

Ви також можете скористатися наведеною вище формою для адміністратора, просто використовуйте

class CharacterAdmin(admin.ModelAdmin):
    form = CharacterForm
admin.site.register(Character, CharacterAdmin)

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField()

    def clean(self):
        from django.core.exceptions import ValidationError
        c = Character.objects.filter(is_the_chosen_one__exact=True)  
        if c and self.is_the_chosen:
            raise ValidationError("The chosen one is already here! Too late")

Це зробило перевірку доступною у базовій формі адміністратора

Додати такий тип обмежень до вашої моделі простіше після Django версії 2.2. Ви можете безпосередньо використовувати UniqueConstraint.condition. Документи Django

Просто перевизначте свої моделі class Metaтаким чином:

class Meta:
    constraints = [
        UniqueConstraint(fields=['is_the_chosen_one'], condition=Q(is_the_chosen_one=True), name='unique_is_the_chosen_one')
    ]

І це все.

def save(self, *args, **kwargs):
    if self.default_dp:
        DownloadPageOrder.objects.all().update(**{'default_dp': False})
    super(DownloadPageOrder, self).save(*args, **kwargs)

Використовуючи подібний підхід, як Саул, але дещо іншої мети:

class TrueUniqueBooleanField(BooleanField):

    def __init__(self, unique_for=None, *args, **kwargs):
        self.unique_for = unique_for
        super(BooleanField, self).__init__(*args, **kwargs)

    def pre_save(self, model_instance, add):
        value = super(TrueUniqueBooleanField, self).pre_save(model_instance, add)

        objects = model_instance.__class__.objects

        if self.unique_for:
            objects = objects.filter(**{self.unique_for: getattr(model_instance, self.unique_for)})

        if value and objects.exclude(id=model_instance.id).filter(**{self.attname: True}):
            msg = 'Only one instance of {} can have its field {} set to True'.format(model_instance.__class__, self.attname)
            if self.unique_for:
                msg += ' for each different {}'.format(self.unique_for)
            raise ValidationError(msg)

        return value

Ця реалізація підніме a ValidationErrorпри спробі зберегти інший запис зі значенням True.

Крім того, я додав unique_forаргумент, який можна встановити в будь-яке інше поле моделі, щоб перевірити справжню унікальність лише для записів з однаковим значенням, таких як:

class Phone(models.Model):
    user = models.ForeignKey(User)
    main = TrueUniqueBooleanField(unique_for='user', default=False)

Чи отримую я бали за відповідь на своє запитання?

проблема полягала в тому, що він опинився в циклі, виправлений:

    # is this the testimonial image, if so, unselect other images
    if self.testimonial_image is True:
        others = Photograph.objects.filter(project=self.project).filter(testimonial_image=True)
        pdb.set_trace()
        for o in others:
            if o != self: ### important line
                o.testimonial_image = False
                o.save()

Я спробував деякі з цих рішень і в кінцевому підсумку отримав інше, лише задля короткості коду (не потрібно перевизначати форми або метод збереження). Щоб це працювало, поле не може бути унікальним у своєму визначенні, але сигнал гарантує, що це відбувається.

# making default_number True unique
@receiver(post_save, sender=Character)
def unique_is_the_chosen_one(sender, instance, **kwargs):
    if instance.is_the_chosen_one:
        Character.objects.all().exclude(pk=instance.pk).update(is_the_chosen_one=False)

Оновлення 2020 року, щоб зробити речі менш складними для початківців:

class Character(models.Model):
    name = models.CharField(max_length=255)
    is_the_chosen_one = models.BooleanField(blank=False, null=False, default=False)

    def save(self):
         if self.is_the_chosen_one == True:
              items = Character.objects.filter(is_the_chosen_one = True)
              for x in items:
                   x.is_the_chosen_one = False
                   x.save()
         super().save()

Звичайно, якщо ви хочете, щоб унікальний логічний тип був False, ви просто поміняєте кожен екземпляр True на False і навпаки.