Skip to main content

contenttypes框架

Django包括一个 contenttypes 应用程序,可以跟踪您的Django供电项目中安装的所有模型,提供一个高级的,通用的接口来处理您的模型。

概述

内容类型应用程序的核心是 ContentType 模型,它在 django.contrib.contenttypes.models.ContentTypeContentType 实例表示并存储有关您项目中安装的模型的信息,每当安装新模型时,将自动创建新的 ContentType 实例。

ContentType 的实例具有返回它们表示的模型类和从这些模型查询对象的方法。 ContentType 还具有 定制管理器,其添加用于与 ContentType 一起工作的方法并且用于获得用于特定模型的 ContentType 的实例。

模型和 ContentType 之间的关系也可以用于启用一个模型的实例与已安装的任何模型的实例之间的“通用”关系。

安装contenttypes框架

contenttypes框架包含在 django-admin startproject 创建的默认 INSTALLED_APPS 列表中,但如果您已删除它或者手动设置您的 INSTALLED_APPS 列表,您可以通过将 'django.contrib.contenttypes' 添加到您的 INSTALLED_APPS 设置来启用它。

一般来说,安装contenttypes框架是个好主意;几个Django的其他捆绑应用程序需要它:

  • 管理应用程序使用它来记录通过管理界面添加或更改的每个对象的历史记录。

  • Django的 authentication framework 使用它来将用户权限绑定到特定模型。

ContentType 模型

class ContentType

ContentType 的每个实例都有两个字段,它们一起唯一地描述了一个已安装的模型:

app_label

模型所属应用程序的名称。这取自模型的 app_label 属性,并且只包括应用程序的Python导入路径的 last 部分;例如,django.contrib.contenttypes 变成 contenttypesapp_label

model

模型类的名称。

此外,还提供以下属性:

name

内容类型的人工可读名称。这取自模型的 verbose_name 属性。

让我们看一个例子来看看这是如何工作的。如果您已经安装了 contenttypes 应用程序,然后将 the sites application 添加到您的 INSTALLED_APPS 设置并运行 manage.py migrate 以安装它,则 django.contrib.sites.models.Site 模型将安装到您的数据库中。与此同时,将使用以下值创建 ContentType 的新实例:

  • app_label 将被设置为 'sites' (Python路径 django.contrib.sites 的最后一部分)。

  • model 将设置为 'site'

ContentType 实例上的方法

每个 ContentType 实例都有一些方法允许您从 ContentType 实例获取它所代表的模型,或从该模型中检索对象:

ContentType.get_object_for_this_type(**kwargs)

ContentType 表示的模型获取一组有效的 查找参数,并对该模型执行 a get() lookup,返回相应的对象。

ContentType.model_class()

返回此 ContentType 实例表示的模型类。

例如,我们可以查找 ContentTypeUser 模型:

>>> from django.contrib.contenttypes.models import ContentType
>>> ContentType.objects.get(app_label="auth", model="user")
<ContentType: user>

然后使用它来查询特定的 User,或者访问 User 模型类:

>>> user_type.model_class()
<class 'django.contrib.auth.models.User'>
>>> user_type.get_object_for_this_type(username='Guido')
<User: Guido>

get_object_for_this_type()model_class() 共同支持两个极为重要的用例:

  1. 使用这些方法,您可以编写用于对任何已安装模型执行查询的高级通用代码 - 而不是导入和使用单个特定模型类,您可以在运行时将 app_labelmodel 传递到 ContentType 查找,然后使用模型类或从中检索对象。

  2. 您可以将另一个模型与 ContentType 相关联,作为将其实例绑定到特定模型类的方法,并使用这些方法访问这些模型类。

Django的几个捆绑应用程序使用后一种技术。例如,Django的认证框架中的 the permissions system 使用具有 ContentType 的外键的 Permission 模型;这允许 Permission 表示诸如“可以添加博客条目”或“可以删除新闻故事”的概念。

ContentTypeManager

class ContentTypeManager

ContentType 还有一个自定义管理器 ContentTypeManager,它添加了以下方法:

clear_cache()

清除 ContentType 使用的内部缓存,以跟踪其已创建 ContentType 实例的模型。你可能不需要自己调用这个方法; Django会在需要时自动调用它。

get_for_id(id)

按ID查找 ContentType。由于此方法使用与 get_for_model() 相同的共享缓存,因此优选使用此方法而不是通常的 ContentType.objects.get(pk=id)

get_for_model(model, for_concrete_model=True)

使用模型类或模型的实例,并返回表示该模型的 ContentType 实例。 for_concrete_model=False 允许获取代理模型的 ContentType

get_for_models(*models, for_concrete_models=True)

获取可变数量的模型类,并返回将模型类映射到表示它们的 ContentType 实例的字典。 for_concrete_models=False 允许获取代理模型的 ContentType

get_by_natural_key(app_label, model)

返回由给定应用程序标签和模型名唯一标识的 ContentType 实例。此方法的主要目的是允许在反序列化期间通过 natural key 引用 ContentType 对象。

get_for_model() 方法尤其有用,当您知道您需要使用 ContentType,但不想去获取模型的元数据执行手动查找:

>>> from django.contrib.auth.models import User
>>> ContentType.objects.get_for_model(User)
<ContentType: user>

通用关系

将外键从您自己的模型之一添加到 ContentType 允许您的模型有效地绑定到另一个模型类,如在上面的 Permission 模型的示例。但是有可能进一步,使用 ContentType 来实现模型之间的真正的通用(有时称为“多态”)关系。

一个简单的例子是标记系统,它可能看起来像这样:

from django.db import models
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType

class TaggedItem(models.Model):
    tag = models.SlugField()
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    content_object = GenericForeignKey('content_type', 'object_id')

    def __str__(self):              # __unicode__ on Python 2
        return self.tag

正常的 ForeignKey 只能“指向”另一个模型,这意味着如果 TaggedItem 模型使用 ForeignKey,它将必须选择一个并且只有一个模型来存储标签。 contenttypes应用程序提供了一个特殊的字段类型(GenericForeignKey),它可以解决这个问题,并允许与任何模型的关系:

class GenericForeignKey

设置 GenericForeignKey 有三个部分:

  1. 给你的模型一个 ForeignKeyContentType。此字段的常用名称为“content_type”。

  2. 为您的模型提供一个字段,可以存储您将要关联的模型中的主键值。对于大多数型号,这意味着 PositiveIntegerField。此字段的常用名称为“object_id”。

  3. 给你的模型一个 GenericForeignKey,并传递上面两个字段的名称。如果这些字段命名为“content_type”和“object_id”,您可以省略 - 这是 GenericForeignKey 将查找的默认字段名称。

for_concrete_model

如果 False,该字段将能够引用代理模型。默认值为 True。这反映了 get_for_model()for_concrete_model 参数。

主键类型兼容性

“object_id”字段不必是与相关模型上的主键字段相同的类型,但是它们的主键值必须通过其 get_db_prep_value() 方法强制为与“object_id”字段相同的类型。

例如,如果要允许与 IntegerFieldCharField 主键字段的模型的泛型关系,则可以对模型中的“object_id”字段使用 CharField,因为整数可以通过 get_db_prep_value() 强制转换为字符串。

为了最大的灵活性,您可以使用没有定义最大长度的 TextField,但是这可能会导致显着的性能损失,具体取决于您的数据库后端。

没有一个适合所有解决方案的字段类型是最好的。您应该评估期望指向的模型,并确定哪种解决方案对您的用例最有效。

序列化对 ContentType 对象的引用

如果你从实现通用关系的模型中序列化数据(例如,当生成 fixtures 时),则应该使用自然键来唯一标识相关的 ContentType 对象。有关详细信息,请参阅 natural keysdumpdata --natural-foreign

这将启用类似于用于正常 ForeignKey 的API;每个 TaggedItem 都将有一个 content_object 字段,它返回与其相关的对象,您还可以分配给该字段或在创建 TaggedItem 时使用它:

>>> from django.contrib.auth.models import User
>>> guido = User.objects.get(username='Guido')
>>> t = TaggedItem(content_object=guido, tag='bdfl')
>>> t.save()
>>> t.content_object
<User: Guido>

由于 GenericForeignKey 的实现方式,您不能通过数据库API直接使用这些字段与过滤器(例如 filter()exclude())。因为 GenericForeignKey 不是正常的字段对象,这些例子将 not 工作:

# This will fail
>>> TaggedItem.objects.filter(content_object=guido)
# This will also fail
>>> TaggedItem.objects.get(content_object=guido)

同样,GenericForeignKey 不出现在 ModelForm 中。

反向通用关系

class GenericRelation
related_query_name

默认情况下不存在回到此对象的相关对象上的关系。设置 related_query_name 创建从相关对象回到此对象的关系。这允许从相关对象进行查询和过滤。

如果您知道最常用的模型,您还可以添加“反向”通用关系以启用其他API。例如:

from django.db import models
from django.contrib.contenttypes.fields import GenericRelation

class Bookmark(models.Model):
    url = models.URLField()
    tags = GenericRelation(TaggedItem)

Bookmark 实例将各自具有 tags 属性,其可以用于检索其相关联的 TaggedItems:

>>> b = Bookmark(url='https://www.djangoproject.com/')
>>> b.save()
>>> t1 = TaggedItem(content_object=b, tag='django')
>>> t1.save()
>>> t2 = TaggedItem(content_object=b, tag='python')
>>> t2.save()
>>> b.tags.all()
<QuerySet [<TaggedItem: django>, <TaggedItem: python>]>

使用 related_query_name 集定义 GenericRelation 允许从相关对象进行查询:

tags = GenericRelation(TaggedItem, related_query_name='bookmarks')

这使得能够从 TaggedItemBookmark 进行过滤,排序和其他查询操作:

>>> # Get all tags belonging to bookmarks containing `django` in the url
>>> TaggedItem.objects.filter(bookmarks__url__contains='django')
<QuerySet [<TaggedItem: django>, <TaggedItem: python>]>

当然,如果不添加反向关系,您可以手动执行相同类型的查找:

>>> b = Bookmark.objects.get(url='https://www.djangoproject.com/')
>>> bookmark_type = ContentType.objects.get_for_model(b)
>>> TaggedItem.objects.filter(content_type__pk=bookmark_type.id, object_id=b.id)
<QuerySet [<TaggedItem: django>, <TaggedItem: python>]>

正如 GenericForeignKey 接受内容类型和对象ID字段的名称作为参数一样,GenericRelation 也是如此;如果具有通用外键的模型对这些字段使用非默认名称,则必须在向其设置 GenericRelation 时传递字段的名称。例如,如果上面提到的 TaggedItem 模型使用名为 content_type_fkobject_primary_key 的字段来创建其通用外键,则 GenericRelation 回到它需要被如此定义:

tags = GenericRelation(
    TaggedItem,
    content_type_field='content_type_fk',
    object_id_field='object_primary_key',
)

还请注意,如果删除具有 GenericRelation 的对象,任何具有 GenericForeignKey 指向的对象也将被删除。在上面的例子中,这意味着如果一个 Bookmark 对象被删除,指向它的任何 TaggedItem 对象将被同时删除。

ForeignKey 不同,GenericForeignKey 不接受 on_delete 参数来自定义此行为;如果需要,您可以避免简单地通过不使用 GenericRelation 的级联删除,并且交替行为可以通过 pre_delete 信号提供。

通用关系和聚合

Django数据库聚合API 使用 GenericRelation。例如,您可以找到所有书签都有多少个标签:

>>> Bookmark.objects.aggregate(Count('tags'))
{'tags__count': 3}

表单中的通用关系

django.contrib.contenttypes.forms 模块提供:

class BaseGenericInlineFormSet
generic_inlineformset_factory(model, form=ModelForm, formset=BaseGenericInlineFormSet, ct_field="content_type", fk_field="object_id", fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None, validate_max=False, for_concrete_model=True, min_num=None, validate_min=False)

使用 modelformset_factory() 返回 GenericInlineFormSet

如果 ct_fieldfk_field 分别与默认值 content_typeobject_id 不同,则必须提供 ct_fieldfk_field。其他参数与 modelformset_factory()inlineformset_factory() 中记录的参数类似。

for_concrete_model 参数对应于 GenericForeignKey 上的 for_concrete_model 参数。

管理员中的通用关系

django.contrib.contenttypes.admin 模块提供 GenericTabularInlineGenericStackedInlineGenericInlineModelAdmin 的亚类)

这些类和函数允许在表单和管理员中使用通用关系。有关详细信息,请参阅 模型形式管理员 文档。

class GenericInlineModelAdmin

GenericInlineModelAdmin 类继承了 InlineModelAdmin 类中的所有属性。但是,它添加了一些自己的工作与通用关系:

ct_field

模型上的 ContentType 外键字段的名称。默认为 content_type

ct_fk_field

表示相关对象的ID的整数字段的名称。默认为 object_id

class GenericTabularInline
class GenericStackedInline

GenericInlineModelAdmin 的子类分别具有堆叠和表格布局。