Условные выражения

Условные выражения позволяют использовать логику if … elif … else в фильтрах, аннотациях, агрегациях и обновлениях. Условное выражение оценивает ряд условий для каждой строки таблицы и возвращает соответствующее выражение результата. Условные выражения также можно комбинировать и вкладывать, как и другие выражения.

Классы условных выражений

В последующих примерах мы будем использовать следующую модель:

from django.db import models

class Client(models.Model):
    REGULAR = 'R'
    GOLD = 'G'
    PLATINUM = 'P'
    ACCOUNT_TYPE_CHOICES = [
        (REGULAR, 'Regular'),
        (GOLD, 'Gold'),
        (PLATINUM, 'Platinum'),
    ]
    name = models.CharField(max_length=50)
    registered_on = models.DateField()
    account_type = models.CharField(
        max_length=1,
        choices=ACCOUNT_TYPE_CHOICES,
        default=REGULAR,
    )

When

class When(condition=None, then=None, **lookups)

Объект When() используется для инкапсуляции условия и его результата для использования в условном выражении. Использование объекта When() аналогично использованию метода filter(). Условие можно указать, используя обращения к полям, объекты Q или объекты Expression, имеющие output_field, который является BooleanField. Результат предоставляется с помощью ключевого слова then.

Некоторые примеры:

>>> from django.db.models import F, Q, When
>>> # String arguments refer to fields; the following two examples are equivalent:
>>> When(account_type=Client.GOLD, then='name')
>>> When(account_type=Client.GOLD, then=F('name'))
>>> # You can use field lookups in the condition
>>> from datetime import date
>>> When(registered_on__gt=date(2014, 1, 1),
...      registered_on__lt=date(2015, 1, 1),
...      then='account_type')
>>> # Complex conditions can be created using Q objects
>>> When(Q(name__startswith="John") | Q(name__startswith="Paul"),
...      then='name')
>>> # Condition can be created using boolean expressions.
>>> from django.db.models import Exists, OuterRef
>>> non_unique_account_type = Client.objects.filter(
...     account_type=OuterRef('account_type'),
... ).exclude(pk=OuterRef('pk')).values('pk')
>>> When(Exists(non_unique_account_type), then=Value('non unique'))

Обратите внимание, что каждое из этих значений может быть выражением.

>>> When(then__exact=0, then=1)
>>> When(Q(then=0), then=1)

Case

class Case(*cases, **extra)

Выражение Case() похоже на оператор if … elif … else в Python. Каждое condition в предоставленных объектах When() оценивается в порядке, пока одно не получит истинное значение. Возвращается выражение result из соответствующего объекта When().

Пример:

>>>
>>> from datetime import date, timedelta
>>> from django.db.models import Case, CharField, Value, When
>>> Client.objects.create(
...     name='Jane Doe',
...     account_type=Client.REGULAR,
...     registered_on=date.today() - timedelta(days=36))
>>> Client.objects.create(
...     name='James Smith',
...     account_type=Client.GOLD,
...     registered_on=date.today() - timedelta(days=5))
>>> Client.objects.create(
...     name='Jack Black',
...     account_type=Client.PLATINUM,
...     registered_on=date.today() - timedelta(days=10 * 365))
>>> # Get the discount for each Client based on the account type
>>> Client.objects.annotate(
...     discount=Case(
...         When(account_type=Client.GOLD, then=Value('5%')),
...         When(account_type=Client.PLATINUM, then=Value('10%')),
...         default=Value('0%'),
...         output_field=CharField(),
...     ),
... ).values_list('name', 'discount')
<QuerySet [('Jane Doe', '0%'), ('James Smith', '5%'), ('Jack Black', '10%')]>

Case() принимает любое количество объектов When() в качестве отдельных аргументов. Другие параметры предоставляются с помощью ключевых слов. Если ни одно из условий не получит истинное значение, то возвращается выражение, заданное с помощью ключевого слова default. Если аргумент default не предоставлен, используется None.

Если нам нужно изменить наш предыдущий запрос, чтобы получить скидку на основе того, как долго клиент Client с нами, мы можем сделать это, используя обращения:

>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> # Get the discount for each Client based on the registration date
>>> Client.objects.annotate(
...     discount=Case(
...         When(registered_on__lte=a_year_ago, then=Value('10%')),
...         When(registered_on__lte=a_month_ago, then=Value('5%')),
...         default=Value('0%'),
...         output_field=CharField(),
...     )
... ).values_list('name', 'discount')
<QuerySet [('Jane Doe', '5%'), ('James Smith', '0%'), ('Jack Black', '10%')]>

Case() также работает в фразе filter(). Например, чтобы найти золотых клиентов, которые зарегистрировались более месяца назад, и платиновых клиентов, которые зарегистрировались более года назад:

>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> Client.objects.filter(
...     registered_on__lte=Case(
...         When(account_type=Client.GOLD, then=a_month_ago),
...         When(account_type=Client.PLATINUM, then=a_year_ago),
...     ),
... ).values_list('name', 'account_type')
<QuerySet [('Jack Black', 'P')]>

Расширенные запросы

Условные выражения могут использоваться в аннотациях, агрегациях, фильтрах, обращениях и обновлениях. Их также можно комбинировать и вкладывать с другими выражениями. Это позволяет создавать мощные условные запросы.

Условное обновление

Предположим, мы хотим изменить account_type для наших клиентов, чтобы они соответствовали дате регистрации. Мы можем сделать это, используя условное выражение и метод update():

>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> # Update the account_type for each Client from the registration date
>>> Client.objects.update(
...     account_type=Case(
...         When(registered_on__lte=a_year_ago,
...              then=Value(Client.PLATINUM)),
...         When(registered_on__lte=a_month_ago,
...              then=Value(Client.GOLD)),
...         default=Value(Client.REGULAR)
...     ),
... )
>>> Client.objects.values_list('name', 'account_type')
<QuerySet [('Jane Doe', 'G'), ('James Smith', 'R'), ('Jack Black', 'P')]>

Условная агрегация

А что, если мы хотим узнать, сколько клиентов у нас для каждого account_type? Мы можем использовать аргумент filter функций агрегации, чтобы этого добиться:

>>> # Create some more Clients first so we can have something to count
>>> Client.objects.create(
...     name='Jean Grey',
...     account_type=Client.REGULAR,
...     registered_on=date.today())
>>> Client.objects.create(
...     name='James Bond',
...     account_type=Client.PLATINUM,
...     registered_on=date.today())
>>> Client.objects.create(
...     name='Jane Porter',
...     account_type=Client.PLATINUM,
...     registered_on=date.today())
>>> # Get counts for each value of account_type
>>> from django.db.models import Count
>>> Client.objects.aggregate(
...     regular=Count('pk', filter=Q(account_type=Client.REGULAR)),
...     gold=Count('pk', filter=Q(account_type=Client.GOLD)),
...     platinum=Count('pk', filter=Q(account_type=Client.PLATINUM)),
... )
{'regular': 2, 'gold': 1, 'platinum': 3}

Эта агрегация создает запрос с синтаксисом SQL 2003 FILTER WHERE на базах данных, которые его поддерживают:

SELECT count('id') FILTER (WHERE account_type=1) as regular,
       count('id') FILTER (WHERE account_type=2) as gold,
       count('id') FILTER (WHERE account_type=3) as platinum
FROM clients;

На других базах данных это эмулируется с помощью оператора CASE:

SELECT count(CASE WHEN account_type=1 THEN id ELSE null) as regular,
       count(CASE WHEN account_type=2 THEN id ELSE null) as gold,
       count(CASE WHEN account_type=3 THEN id ELSE null) as platinum
FROM clients;

Два оператора SQL функционально эквивалентны, но более явный FILTER может работать лучше.

Условный фильтр

Когда условное выражение возвращает булевое значение, его можно напрямую использовать в фильтрах. Это означает, что оно не будет добавлено к столбцам SELECT, но вы все равно можете использовать его для фильтрации результатов:

>>> non_unique_account_type = Client.objects.filter(
...     account_type=OuterRef('account_type'),
... ).exclude(pk=OuterRef('pk')).values('pk')
>>> Client.objects.filter(~Exists(non_unique_account_type))

В терминах SQL это эквивалентно:

SELECT ...
FROM client c0
WHERE NOT EXISTS (
  SELECT c1.id
  FROM client c1
  WHERE c1.account_type = c0.account_type AND NOT c1.id = c0.id
)