Фреймворк contenttypes

Менеджер ContentTypeManager

class ContentTypeManager [source]

У ContentType также есть специализированный менеджер, ContentTypeManager, который добавляет следующие методы:

clear_cache() [source]

Очищает внутренний кэш, используемый ContentType для отслеживания моделей, для которых были созданы экземпляры ContentType. Скорее всего, вам не придётся вызывать этот метод самостоятельно; Django будет вызывать его автоматически, когда это необходимо.

get_for_id(id) [source]

Ищет ContentType по ID. Поскольку этот метод использует тот же общий кэш, что и get_for_model(), предпочтительнее использовать этот метод, чем обычный ContentType.objects.get(pk=id)

get_for_model(model, for_concrete_model=True) [source]

Принимает класс модели или экземпляр модели и возвращает экземпляр ContentType, представляющий эту модель. for_concrete_model=False позволяет извлекать ContentType прокси-модели.

get_for_models(*models, for_concrete_models=True) [source]

Принимает переменное количество классов моделей и возвращает словарь, сопоставляющий классы моделей с экземплярами ContentType, которые их представляют. for_concrete_models=False позволяет извлекать ContentType прокси-моделей.

get_by_natural_key(app_label, model) [source]

Возвращает экземпляр ContentType, однозначно идентифицированный заданным именем приложения и именем модели. Основное назначение этого метода — позволить ссылкам на объекты ContentType через естественный ключ во время десериализации.

Метод get_for_model() особенно полезен, когда вам нужно работать с ContentType, но вы не хотите тратить время на получение метаданных модели для выполнения ручного поиска:

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

Обратные общие отношения

class GenericRelation [source]

related_query_name

Связь с объектом, ссылающимся на этот объект, по умолчанию отсутствует. Установка related_query_name создает связь от связанного объекта обратно к этому, что позволяет выполнять запросы и фильтрацию от связанного объекта.

Если вам известно, какие модели вы будете чаще всего использовать, вы также можете добавить «обратное» общее отношение для активации дополнительного API. Например:

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


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

Также можно использовать add(), create() или set() для создания отношений:

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

Вызов remove() будет массово удалять указанные объекты модели:

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

Метод clear() можно использовать для массового удаления всех связанных объектов для экземпляра:

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

Определение GenericRelation с установленным related_query_name позволяет выполнять запросы от связанного объекта:

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

Это позволяет выполнять фильтрацию, сортировку и другие операции запроса на Bookmark из TaggedItem:

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

Если вы не добавляете related_query_name, вы можете выполнять те же типы запросов вручную:

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

Так же как GenericForeignKey принимает имена полей типа контента и идентификатора объекта в качестве аргументов, то и GenericRelation делает то же самое; если модель, имеющая общий внешний ключ, использует имена полей, отличные от стандартных, вам необходимо передать имена полей при настройке GenericRelation. Например, если модель TaggedItem, о которой говорилось выше, использовала поля с именами content_type_fk и object_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.

Общие отношения и агрегация

API Django для агрегации данных в базе данных работает с GenericRelation. Например, вы можете узнать, сколько тегов есть у всех закладок:

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

Общие отношения в формах

Модуль django.contrib.contenttypes.forms предоставляет:

• BaseGenericInlineFormSet
• Фабрику наборов форм, generic_inlineformset_factory(), для использования с GenericForeignKey.

class BaseGenericInlineFormSet [source]

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, absolute_max=None, can_delete_extra=True) [source]

Возвращает набор форм GenericInlineFormSet, используя modelformset_factory().

Вы должны предоставить ct_field и fk_field, если они отличаются от значений по умолчанию, content_type и object_id соответственно. Другие параметры аналогичны тем, которые описаны в modelformset_factory() и inlineformset_factory().

Аргумент for_concrete_model соответствует аргументу for_concrete_model в GenericForeignKey.

Общие отношения в админке

Модуль django.contrib.contenttypes.admin предоставляет GenericTabularInline и GenericStackedInline (подклассы GenericInlineModelAdmin)

Эти классы и функции позволяют использовать общие отношения в формах и админке. Для получения дополнительной информации см. документацию по формам моделей и админке.

class GenericInlineModelAdmin [source]

Класс GenericInlineModelAdmin наследует все свойства от класса InlineModelAdmin. Однако он добавляет несколько своих собственных для работы с общим отношением:

ct_field

Имя поля внешнего ключа ContentType в модели. По умолчанию content_type.

ct_fk_field

Имя целочисленного поля, представляющего идентификатор связанного объекта. По умолчанию object_id.

class GenericTabularInline [source]

class GenericStackedInline [source]

Подклассы GenericInlineModelAdmin с разметкой «стек» и «таблица» соответственно.

GenericPrefetch()

class GenericPrefetch(lookup, querysets, to_attr=None) [source]

Этот поиск похож на Prefetch() и его следует использовать только с GenericForeignKey. Аргумент querysets принимает список наборов запросов, каждый для разных ContentType. Это полезно для GenericForeignKey с неоднородным набором результатов.

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