django - django 中的 "output_field"是什么

Question

Django 文档 says对于聚合函数:

output_field - An optional argument that represents the model field of the return value

所以我预计下面的代码会返回“True”。

MyModel.objects.annotate(foo=Max(Value("yes"), output_field=BooleanField())).first().foo

或

MyModel.objects.annotate(foo=Max("id", output_field=BooleanField())).first().foo

但是在第一种情况下返回字符串“yes”，在第二种情况下返回一些整数。

我知道我可以使用“Cast”，但有人可以告诉我，在这种情况下“output_field”有什么用？

Answer 1

搜索有关表达式的文档页面以查看许多示例:https://docs.djangoproject.com/en/3.2/ref/models/expressions/

• output_field 参数用于解决表达式中冲突或不明确的类型，如果 Django 没有足够的启发式来自行确定的话。
• Django 提供了 output_field 作为您告诉它您实际想要的输出类型的途径。
• output_field 参数并不是让您可以转换值的类型，而是帮助 Django 在竞争选项中解析输出类型。
• output_field 参数并不总是必需的，但有时它会解决歧义，否则会导致 Django 引发异常。

查看您的示例，我只能假设 Django 在这些情况下会忽略您的 output_field。

针对两者的不同输出，Django 将裸字符串"id" 视为字段名。如果你用 Value("id") 包装 "id" 字符串，就像你为 "yes"做的那样，你会看到返回 "id" 代替。如果您从 "yes" 示例中删除了 Value 包装器，您将看到:FieldError:无法将关键字“yes”解析为字段。选择是:...

作为一个更复杂的示例来说明 output_field 参数如何有用，请考虑 MS SQL Server，它没有正确的 bool 类型，而是使用位字段来实现这一目的。

正在尝试queryset = queryset.annotate( foo=Case(When(name__icontains='XYZ', then=Value(True)), default=Value(False)) )给django.core.exceptions.FieldError:无法解析表达式类型，未知 output_field即使您提交了两个明确的 bool 值，Django 也找不到要返回的正确类型。

这就是 output_field 的用途。您可以通过提供要使用的类型来解决 Django 的歧义:queryset = queryset.annotate( foo=Case(When(name__icontains='XYZ', then=Value(True)), default=Value(False), output_field=BooleanField()) )显然 Django 很乐意尝试，但无法在 MS SQL Server 下完成它:django.db.utils.ProgrammingError: ('42000', '[42000] [FreeTDS][SQL Server]Statement(s) 无法准备。(8180) (SQLExecDirectW)')

所以要真正帮助 Django，你需要比 Django 了解更多 [原文如此] 并提供:queryset = queryset.annotate( foo=Case(When(name__icontains='XYZ', then=Value(True)), default=Value(False), output_field=BinaryField()) )(作品)。

将此应用于您的示例:MyModel.objects.annotate(foo=Max(False, output_field=BooleanField())).first().foo 返回 False.

即使使用数值，Django 也能够根据您提供的 output_field 解释该值:MyModel.objects.annotate(foo=Max(0, output_field=BooleanField() )).first().foo 返回 False。

但是正如我们所见，尽管 Django 可以处理这个问题，但 MS SQL Server 不会容忍 bool 值，因为它没有它们；因此您可能会发现在 MS SQL Server 的特定情况下需要执行此操作:MyModel.objects.annotate(foo=Max(0, output_field=BinaryField())).first().foo返回 0。

因此 output_field 参数提供了这种额外的控制。