Инфраструктура contenttypes ¶

Предварительный просмотр ¶

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

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

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

Установка системы contenttypes ¶

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

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

• Приложение администрирования использует его для отслеживания истории каждого объекта, добавленного или измененного через интерфейс администрирования.
• Django используется для разрешения ассоциированных пользователей к определенным моделям.système d'authentification

Модель ContentType ¶

класс ContentType¶

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

app_label¶

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

model¶

Имя класса модели.

Дополнительно доступно следующее свойство:

name¶

Читаемое имя типа контента. Это происходит из атрибута verbose_name модели.

Давайте посмотрим на пример, чтобы увидеть, как это работает. Если приложение contenttypes уже установлено, то вы добавляете его sites в настройки 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 представляет, и выполняет с этой моделью, возвращая соответствующий объект.une recherche get()

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, используют последний метод. Например, в системе аутентификации Django используется шаблон с внешним ключом для ; это позволяет представлять такие понятия, как «может добавить запись в блог» или «может удалить новость».système de permissions 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

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

класс GenericForeignKey¶

Чтобы настроить GenericForeignKey :

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

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)

Точно так же ключи GenericForeignKey не появляются в формах ModelForm .

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

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}