Django ContentTypes Framework for Generic Relations

Snippet

Django ContentTypes Framework for Generic Relations

Django's ContentTypes framework enables generic relationships allowing a single model to reference any other model in the system. This is ideal for tagging systems, comments, or any scenario where you need flexible foreign key relationships without creating multiple foreign key columns. The GenericForeignKey works with two columns: content_type stores the model type and object_id stores the primary key of the referenced object.

snippet.py
python
from django.db import models
from django.contrib.contenttypes.models import ContentType
from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
 
class TaggedItem(models.Model):
    tag = models.CharField(max_length=100)
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    content_object = GenericForeignKey('content_type', 'object_id')
    
    class Meta:
        indexes = [
            models.Index(fields=['content_type', 'object_id']),
        ]
 
class Article(models.Model):
    title = models.CharField(max_length=200)
    tags = GenericRelation(TaggedItem, related_query_name='articles')
    
class Product(models.Model):
    name = models.CharField(max_length=200)
    tags = GenericRelation(TaggedItem)
 
def get_objects_by_tag(tag_name):
    content_type = ContentType.objects.get_for_model(Article)
    return TaggedItem.objects.filter(
        tag=tag_name,
        content_type=content_type
    ).select_related('content_object')
 
def get_all_tags_for_object(obj):
    return obj.tags.all() if hasattr(obj, 'tags') else []

django

Breakdown

from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation

Imports generic relationship field classes from ContentTypes app

content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)

Stores reference to the target model's ContentType record

object_id = models.PositiveIntegerField()

Stores the PK of the linked object (supports any integer PK)

GenericRelation(TaggedItem, related_query_name='articles')

Creates reverse accessor enabling Article.tags.all() queries

ContentType.objects.get_for_model(Article)

Retrieves the ContentType instance for the Article model dynamically

models.Index(fields=['content_type', 'object_id'])

Composite index optimizes GenericForeignKey lookups

Previous snippet Next snippet

More Expert Python exercises →

From your library

Django ContentTypes Framework for Generic Relations

Related