Generic relations in Django

While using django's content management system (admin), for adding different objects on it, you may want things like audit notes, that can be used for reference in the future or get some more info. you have two choice -

1. Add a explicit field to the object, though the down side is you will need to add that extra field with all the objects where you want note.
2. Create a generic model which can be used with different objects in your app. 

It's no brainer between above two choice, answer is 2nd. Generic relations are at help.

You can checkout django-contrib-comments, it's one of the example of generic relations. Let's take example of how Notes like foreign key reference can be added freely to any model in your app.

notes/models.py
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType

class Note(models.Model):

    note = models.TextField("note",

                            max_length=2000)

    date = models.DateTimeField(auto_now_add=True)

    # Below the mandatory fields for generic relation

    content_type = models.ForeignKey(

        ContentType, on_delete=models.CASCADE)

    object_id = models.PositiveIntegerField()

    content_object = GenericForeignKey('content_type', 'object_id')

    class Meta:

        verbose_name = 'Staff Note'

    def __unicode__(self):

        return self.date.strftime("%B %d, %Y")

Now, this Notes object can be referenced with any other model you want to use it with. Here is one example -

mymodel/models.py
from django.contrib.contenttypes.fields import GenericRelation

from notes.models import Note

class MyModel(models.Model):
    name = models.CharField("Name", max_length=100)
    notes = GenericRelation(Note)

When you run migration, it doesn't add anything in MyModel, as its generic relation it gets its references via django content type and object id.

How to add it in admin?

notes/admin.py

from django.contrib.contenttypes.admin import GenericTabularInline

from .models import Note

class NoteInline(GenericTabularInline):

    model = Note

    extra = 0

mymodel/admin.py

from misc.admin import NoteInline

from .models import MyModel

class MyModelAdmin(admin.ModelAdmin):

    inlines = [NoteInline, ]

admin.site.register(MyModel, MyModelAdmin)

And you are all set. It's easy to plug, efficient, and clean implementation. Good luck!

Django rest framework serializer with self-referential foreign key for comments

Django had default comments package sometime back (django.contrib.comments), since it's deprecated, there is external repo available for now.  It provides flat comments, so if you want threaded comments, you can use django-threadedcomments.

We are using django-rest-framework, and access the threaded comments via drf.

resources.py

class ObjectSerializer(serializers.ModelSerializer):

    comments = CommentsSerilizer(

        source='comments_set',

        many=True)

    class Meta:

        model = ObjectName

        fields = (

            "id",

            .....,

            "comments",

        )

serializers.py

from rest_framework import serializers

from .models import FluentComment

class RecursiveField(serializers.Serializer):

    def to_representation(self, value):

        serializer = self.parent.parent.__class__(

            value,

            context=self.context)

        return serializer.data

class CommentsSerilizer(serializers.ModelSerializer):

    children = RecursiveField(many=True)

    class Meta:

        model = FluentComment

        fields = (

            'comment',

            'url',

            'submit_date',

            'id',

            'children',

        )

Recursive Field is one way to get the self-referential objects via serializer, it handles parent-child relationship. Here is another way to do it -

class CommentsSerilizer(serializers.ModelSerializer):

    user = UserLightSerializer()

    class Meta:

        model = FluentComment

        fields = (

            'user',

            'comment',

            'submit_date',

            'id',

            'children',

        )

CommentsSerilizer._declared_fields[

     'children'] = CommentsSerilizer(many=True)

Above both options are fine, and it should do the magic. Good luck!