Customising the Django comment app

Question

I'm having problems with customising the django comments framework. I need to add a 'company' field. I've followed the documentation and not really getting anywhere. It's not far from working because when i add COMMENTS_APP = 'comments_app' to my settings.py the 'comments' app dissapears from admin interface. When i try and write a comment it comes up with the company field where it asks for your email, url etc.

I'd like to be able to view all the comments in the admin panel along with the company field i've added.

Do i need to create a admin.py or have i just got something missing?

Here is my code for my customised comments app:

//MODELS

 from django.db import models
    from django.contrib.comments.models import Comment

    class CommentWithAddedFields(Comment):
        company = models.CharField(max_length=300)

//FORMS.py

from django import forms
from django.contrib.comments.forms import CommentForm
from comments_app.models import CommentWithAddedFields

class CommentFormWithAddedFields(CommentForm):
    company = forms.CharField(max_length=300)


    def get_comment_model(self):

        return CommentWithAddedFields


    def get_comment_create_data(self):

        data = super(CommentFormWithAddedFields, self).get_comment_create_data()
        data['company'] = self.cleaned_data['company']
        return data

//__init.py

from comments_app.models import CommentWithAddedFields
from comments_app.forms import CommentFormWithAddedFields

def get_model():
    return CommentWithAddedFields


def get_form():
    return CommentFormWithAddedFields

I have added the app in the my settings.py file and added COMMENTS_APP = 'comments_app' as i mentioned above.

Am I missed something?

Thanks

Alasdair · Accepted Answer · 2012-10-02T12:08:28.240

1

Yes, you need to create an admin.py for your custom comments app if you want your model to appear in the django admin. You should be able to subclass the CommentsAdmin, and customize as required.

from django.contrib import admin
from django.utils.translation import ugettext_lazy as _, ungettext
from django.contrib.comments.admin import CommentsAdmin
from django.contrib.comments import get_model

from comments_app.models import CommentWithAddedFields

class MyCommentsAdmin(CommentsAdmin):
    # Same fieldsets as parent admin, but include 'company'
    fieldsets = (
        (None,
           {'fields': ('content_type', 'object_pk', 'site')}
        ),
        (_('Content'),
           {'fields': ('user', 'user_name', 'user_email', 'user_url', 'company', 'comment')}
        ),
        (_('Metadata'),
           {'fields': ('submit_date', 'ip_address', 'is_public', 'is_removed')}
        ),
     )

# Only register the admin if the comments model is CommentWithAddedFields
# The equivalent section in django.contrib.comments.admin is what prevents 
# the admin from being registered when you set COMMENTS_APP = 'comments_app' 
# in your settings file
if get_model() is CommentWithAddedFields:
    admin.site.register(CommentWithAddedFields, MyCommentsAdmin)

edited Oct 02 '12 at 12:08

answered Oct 02 '12 at 11:59

Alasdair

298,606
55
578
516

Alasair, thanks very much for your reply. I will give that a go! May I ask where you got the above code from? Where did you find a copy of the admin.py file for the exisiting Comments app? – JDavies Oct 02 '12 at 12:02
The existing `admin.py` file is in `django.contrib.comments.admin` ([source on github](https://github.com/django/django/blob/stable/1.4.x/django/contrib/comments/admin.py)). I based the fieldsets and registration snippet on that, then tried to add the required imports. Hope it works for you! – Alasdair Oct 02 '12 at 12:07
Just quickly, I don't suppose you know how to hide the URL field? – JDavies Oct 02 '12 at 13:25
Hiding the url in the admin is easy, just remove `user_url` from the `fieldsets`. Removing the url from the comment form is another question really. Try [this question](http://stackoverflow.com/questions/1456267/django-comments-want-to-remove-user-url-not-expand-the-model-how-to). – Alasdair Oct 02 '12 at 13:55
Thanks, I managed to sort it by just adding a hideen field for the URL as gave it a default value. Thanks again! – JDavies Oct 02 '12 at 14:57

Customising the Django comment app

1 Answers1