Understanding 'GenericForeignKey' in Django

In some cases we might want to store generic model object, rather a particular specific model as 'ForeignKey'. Here is the scenario of such kind. Suppose there are models like User, Project, Ticket and TimeLine as below.

class Ticket(models.Model):
    name = models.CharField(max_length=200, verbose_name=_("name"))
    slug = models.SlugField(max_length=250, null=False, blank=True, verbose_name=_("slug"))

class Project(models.Model):
    name = models.CharField(max_length=200, verbose_name=_("name"))
    slug = models.SlugField(max_length=250, null=False, blank=True, verbose_name=_("slug"))

class User(models.Model):
    name = models.CharField(max_length=200, verbose_name=_("name"))
    slug = models.SlugField(max_length=250, null=False, blank=True, verbose_name=_("slug"))

class Timeline(models.Model):
    involved_object = *****
    event_type = models.CharField(max_length=250, default="created")

If we want to store the user activities with these models like "created User, created Project, created Task" in a timeline, we have to create all the three models(User, Project, Task) as 'ForeignKey' fields. This is not a good programming practice. To overcome this, Django's content types framework provides a special field type (GenericForeignKey) which allows the relationship to be with any model.

Using 'GenericForeignKey':

Here is the solution for the above scenario. There are three parts to setting up a GenericForeignKey:

Give your model a ForeignKey to ContentType. The usual name for this field is “content_type”.
Give your model a field that can store primary key values from the models you’ll be relating to. For most models, this means a PositiveIntegerField. The usual name for this field is “object_id”.
Give your model a GenericForeignKey, and pass it the names of the two fields described above. If these fields are named “content_type” and “object_id”, you can omit this – those are the default field names GenericForeignKey will look for.

So by following the above three steps, the TimeLine will look as following.

class Timeline(models.Model):
    content_type = models.ForeignKey(ContentType, related_name="content_type_timelines")
    object_id = models.PositiveIntegerField()
    content_object = GenericForeignKey('content_type', 'object_id')
    event_type = models.CharField(max_length=250, default="created")

For example, if we want to store the event "created Project" after the project is created, the following snippet will do things for us.

t1 = TimeLine(content_object=project_object)
t1.save()

But due to the way 'GenericForeignKey' is implemented, you cannot use such fields directly with filters (filter() and exclude(), for example) via the database API. Because a GenericForeignKey isn’t a normal field object, the following examples will not work:

TimeLine.objects.filter(content_object=project_object)
# This will also fail
TimeLine.objects.get(content_object=project_object)

To retrieve the TimeLine object with the project object, we have to follow these steps.

Get the 'ContentType' object with the following code.

from django.contrib.contenttypes.models import ContentType
    contenttype_obj = ContentType.objects.get_for_model(project_object)

"object_id" is stored with project_object.id

TimeLine.objects.filter(object_id=project_object.id, content_type=contenttype_obj)

Posted On 06 July 2012 By MicroPyramid

Previous post Next post

Need any Help in your Project?Let's Talk

Latest Comments

OUR SERVICES

OPEN SOURCE PACKAGES

Django-CRM :Customer relationship management based on Django

Django-blog-it : django blog with complete customization and ready to use with one click installer Edit

Django-webpacker : A django compressor tool

Django-MFA : Multi Factor Authentication

Docker-box : Web Interface to manage full blown docker containers and images

More...

Understanding 'GenericForeignKey' in Django

Using 'GenericForeignKey':

Need any Help in your Project?Let's Talk

Is Django best framework for your web application development

How to maintain user session across sub domains in Django

What is Django CRM and it’s advantages

Implementation of single sign on using auth0 in django application

Customizing Django REST API Serializers

How to implement TokenBasedAuthentication in DjangoRestFramework?

Understanding middleware functionality in django2.0

Django acceptance testing automation with robot framework

How to filter a Django Queryset using Extra

how to pass extra context data to serializers in django-rest-framework ?

Overriding Django Model behaviour with Proxy Model

Understanding Routers in Django-Rest-Framework

Django Single Sign On(SSO) to multiple applications

How to Document API Requests using Django Rest Swagger

Django webpacker - A compression tool to bundles css, js files

What's great about Django girls to inspire women into programming

How to use nested formsets in django

How to convert xml content into json using xmltodict

Custom validations for serializer fields Django Rest Framework

How To Add A Custom Managers In Django

Introduction to API development using Django REST framework with Example

Django-REST Framework Object Level Permissions and User Level Permissions

Using Python weasyprint generate HTML to PDF in django

How to create thumbnail image in Django templates using sorl-thumbnail?

Deploying Your Django app on Heroku

Django Template language Intro

Using Gitlab API, integrating gitlab in django project for authentication and access

Sorl-thumbnail to generate thumbnails in django

Django Conditional Expressions in Queries

Querying with Django Q objects

How to Create initial django migrations for existing DB schema.

Integration Of GitHub API with python django

Django Unit Test cases with Forms and Views

Django - Database access optimization

How To Write Custom migrations in Django

Dynamically Adding Google Maps with Marker In Django

Django - migrating from function based views to class based views

Integration Of Linkedin API in python django

Understanding Checkout flow in Django Oscar.

Django efficient implementation of Amazon s3 and Cloudfront CDN for faster loading.

How to monitor django application live events with sentry

How to create Custom User Model or Extend User Model in Django?

Working with Django Plugins

Export html web page to pdf using jspdf

Preserve file names with sorl for better SEO

Custom Password Less Authentication in Django

Improving page speed score in Google Page Score test- PART2

Extract text with OCR for all image types in python using pytesseract

Factory Boy - An alternative for Fixtures

Improving page speed score in Google Page Score test- PART1

Integration of 2checkout with django

Get count, average, min, max values from model field using Django Aggregate

Set Up Travis CI For Django project

Sending emails using sendgrid on heroku for a Django App

Django Custom Template Tags And Filters

Generic, functional based and class based views in Django REST Framework

Python Memcached Implementation for Django project

How to customize Django Oscar Models, Views and URL's

Integrate Django-Oscar-Accounts with Django-Oscar

Google plus API integration with django

Extract data from PDF and all Microsoft Office files in python

django Payu Payment gateway Integration

Running Django with PyPy to boost performance

How to Create your own e-commerce shop using Django-Oscar.

Setting Up Coveralls for Django Project

Sendgrid Inbound Email Parsing with django

How to customize the admin actions in list pages of Django admin?

Handling Custom Error Pages(404, 500) In Django

Autocomplete with Django-Haystack and Elasticsearch with single letter querying.

How to create Periodic Tasks with Django Celery?

Best Practices of Using Django Celery in Django Social Auth

Custom Decorators To Check User Roles And Permissions In Django

Implement search with Django-haystack and Elasticsearch Part-1

How to index binary files in django haystack

Understanding django serializers with examples

Introduction to Django's Class based views - Understanding how a class based view works

Understanding Django Permissions And Groups