Система типов содержимого¶

Быстрый обзор¶

В основе приложения contenttypes лежит модель ContentType, которая живет по адресу django.contrib.contenttypes.models.ContentType. Экземпляры ContentType представляют и хранят информацию о моделях, установленных в вашем проекте, а новые экземпляры ContentType автоматически создаются всякий раз, когда устанавливаются новые модели.

Экземпляры ContentType имеют методы для возврата классов моделей, которые они представляют, и для запроса объектов из этих моделей. ContentType также имеет custom manager, который добавляет методы для работы с ContentType и для получения экземпляров ContentType для определенной модели.

Отношения между вашими моделями и ContentType также могут быть использованы для включения «общих» отношений между экземпляром одной из ваших моделей и экземплярами любой установленной вами модели.

Установка фреймворка contenttypes¶

Фреймворк contenttypes включен в список по умолчанию INSTALLED_APPS, созданный django-admin startproject, но если вы удалили его или вручную настроили свой список INSTALLED_APPS, вы можете включить его, добавив 'django.contrib.contenttypes' в настройки INSTALLED_APPS.

Вообще, неплохо иметь установленный фреймворк contenttypes; некоторые другие приложения Django требуют его наличия:

• Приложение администратора использует его для регистрации истории каждого объекта, добавленного или измененного через интерфейс администратора.
• В Django authentication framework используется для привязки разрешений пользователей к конкретным моделям.

Модель ContentType¶

class ContentType¶

Каждый экземпляр ContentType имеет два поля, которые, взятые вместе, уникально описывают установленную модель:

app_label¶

Имя приложения, частью которого является модель. Оно берется из атрибута app_label модели и включает только последнюю часть пути импорта Python приложения; django.contrib.contenttypes, например, становится app_label из contenttypes.

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

Принимает набор допустимых lookup arguments для модели, которую представляет ContentType, и выполняет a get() lookup на этой модели, возвращая соответствующий объект.

ContentType.model_class()¶

Возвращает класс модели, представленный данным экземпляром ContentType.

Например, мы можем искать ContentType для модели User:

>>> from django.contrib.contenttypes.models import ContentType
>>> user_type = ContentType.objects.get(app_label="auth", model="user")
>>> user_type
<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_label и model в поиск ContentType во время выполнения, а затем работать с классом модели или извлекать из него объекты.
2. Вы можете связать другую модель с ContentType как способ привязки ее экземпляров к определенным классам моделей, и использовать эти методы для получения доступа к этим классам моделей.

Несколько приложений, входящих в комплект Django, используют последнюю технику. Например, the permissions system в системе аутентификации Django использует модель Permission с внешним ключом к ContentType; это позволяет Permission представлять такие понятия, как «может добавлять записи в блог» или «может удалять новости».

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

Общие отношения¶

Добавление внешнего ключа из одной из ваших собственных моделей в ContentType позволяет вашей модели эффективно связать себя с другим классом моделей, как в примере модели Permission выше. Но можно пойти на шаг дальше и использовать ContentType для обеспечения действительно общих (иногда называемых «полиморфными») отношений между моделями.

Например, его можно использовать для системы тегов, например, так:

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


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):
        return self.tag

    class Meta:
        indexes = [
            models.Index(fields=["content_type", "object_id"]),
        ]

Обычный ForeignKey может «указывать» только на одну другую модель, что означает, что если модель TaggedItem использует ForeignKey, то ей придется выбрать одну и только одну модель для хранения тегов. Приложение contenttypes предоставляет специальный тип поля (GenericForeignKey), который позволяет обойти эту проблему и установить связь с любой моделью:

class GenericForeignKey¶

Настройка GenericForeignKey состоит из трех частей:

1. Дайте вашей модели значение от ForeignKey до ContentType. Обычное название этого поля - «content_type».
2. Дайте вашей модели поле, которое может хранить значения первичного ключа из моделей, с которыми вы будете связываться. Для большинства моделей это означает PositiveIntegerField. Обычное название этого поля - «object_id».
3. Дайте вашей модели GenericForeignKey, и передайте ей имена двух полей, описанных выше. Если эти поля имеют имена «content_type» и «object_id», вы можете опустить это - это имена полей по умолчанию, которые будет искать GenericForeignKey.

В отличие от ForeignKey, индекс базы данных не автоматически создается для GenericForeignKey, поэтому рекомендуется использовать Meta.indexes для добавления собственного индекса нескольких столбцов. Это поведение may change в будущем.

for_concrete_model¶

Если False, поле будет иметь возможность ссылаться на прокси-модели. По умолчанию True. Это зеркально отражает аргумент for_concrete_model для get_for_model().

Это позволит использовать API, аналогичный тому, который используется для обычных ForeignKey; каждый 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>

Если связанный объект удаляется, то поля content_type и object_id остаются установленными в исходные значения, а GenericForeignKey возвращает значение None:

>>> guido.delete()
>>> t.content_object  # returns None

Из-за того, что GenericForeignKey реализовано так, что такие поля нельзя использовать напрямую с фильтрами (filter() и exclude(), например) через API базы данных. Поскольку GenericForeignKey не является обычным объектом поля, эти примеры не будут работать:

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

Аналогично, GenericForeignKeys не появляется в ModelForms.

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


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

>>> 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>]>

>>> t3 = TaggedItem(tag="Web development")
>>> b.tags.add(t3, bulk=False)
>>> b.tags.create(tag="Web framework")
<TaggedItem: Web framework>
>>> b.tags.all()
<QuerySet [<TaggedItem: django>, <TaggedItem: python>, <TaggedItem: Web development>, <TaggedItem: Web framework>]>
>>> b.tags.set([t1, t3])
>>> b.tags.all()
<QuerySet [<TaggedItem: django>, <TaggedItem: Web development>]>

>>> b.tags.remove(t3)
>>> b.tags.all()
<QuerySet [<TaggedItem: django>]>
>>> TaggedItem.objects.all()
<QuerySet [<TaggedItem: django>]>

>>> b.tags.clear()
>>> b.tags.all()
<QuerySet []>
>>> TaggedItem.objects.all()
<QuerySet []>

tags = GenericRelation(TaggedItem, related_query_name="bookmark")

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

>>> bookmarks = Bookmark.objects.filter(url__contains="django")
>>> bookmark_type = ContentType.objects.get_for_model(Bookmark)
>>> TaggedItem.objects.filter(content_type__pk=bookmark_type.id, object_id__in=bookmarks)
<QuerySet [<TaggedItem: django>, <TaggedItem: python>]>

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

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

>>> from django.contrib.contenttypes.prefetch import GenericPrefetch
>>> bookmark = Bookmark.objects.create(url="https://www.djangoproject.com/")
>>> animal = Animal.objects.create(name="lion", weight=100)
>>> TaggedItem.objects.create(tag="great", content_object=bookmark)
>>> TaggedItem.objects.create(tag="awesome", content_object=animal)
>>> prefetch = GenericPrefetch(
...     "content_object", [Bookmark.objects.all(), Animal.objects.only("name")]
... )
>>> TaggedItem.objects.prefetch_related(prefetch).all()
<QuerySet [<TaggedItem: Great>, <TaggedItem: Awesome>]>