条件表达式 — Django 文档

条件表达式

条件表达式允许您在过滤器、注释、聚合和更新中使用 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[ X161X]。 结果是使用 then 关键字提供的。

3.0 版更改： 添加了对布尔值 表达式 的支持。

一些例子：

>>> 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'))

请记住，这些值中的每一个都可以是一个表达式。

笔记

由于 then 关键字参数是为 When() 的结果保留的，如果 Model 具有名为 then 的字段，则存在潜在冲突。 这可以通过两种方式解决：

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

Case

class Case(*cases, **extra)

Case() 表达式类似于 Python 中的 if ... elif ... else 语句。 提供的 When() 对象中的每个 condition 都按顺序进行评估，直到评估为真实值。 返回匹配的 When() 对象中的 result 表达式。

一个例子：

>>>
>>> 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() 对象作为单独的参数。 使用关键字参数提供其他选项。 如果没有任何条件计算为 TRUE，则返回带有 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%')]>

笔记

请记住，条件是按顺序计算的，因此在上面的示例中，即使第二个条件与 Jane Doe 和 Jack Black 匹配，我们也会得到正确的结果。 这就像 Python 中的 if ... elif ... else 语句。

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 可能会执行得更好。

条件过滤器

3.0 版中的新功能。

当条件表达式返回布尔值时，可以直接在过滤器中使用它。 这意味着它不会被添加到 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
)