Ticket #10285: render_comment_list.diff

django/contrib/comments/templatetags/comments.py

@@ -113 +113 @@
     def get_context_value_from_queryset(self, context, qs):
         return list(qs)
 
+class RenderCommentListNode(CommentListNode):
+    """ Render the comment list directly """
+    
+    #@classmethod
+    def handle_token(cls, parser, token):
+        """Class method to parse render_comment_list and return a Node."""
+        tokens = token.contents.split()
+        if tokens[1] != 'for':
+            raise template.TemplateSyntaxError("Second argument in %r tag must be 'for'" % tokens[0])
+
+        # {% render_comment_list for obj %}
+        if len(tokens) == 3:
+            return cls(object_expr=parser.compile_filter(tokens[2]))
+
+        # {% render_comment_list for app.models pk %}
+        elif len(tokens) == 4:
+            return cls(
+                ctype = BaseCommentNode.lookup_content_type(tokens[2], tokens[0]),
+                object_pk_expr = parser.compile_filter(tokens[3])
+            )
+    handle_token = classmethod(handle_token)
+    
+    def render(self, context):
+        ctype, object_pk = self.get_target_ctype_pk(context)
+        if object_pk:
+            template_search_list = [
+                "comments/%s/%s/list.html" % (ctype.app_label, ctype.model),
+                "comments/%s/list.html" % ctype.app_label,
+                "comments/list.html"
+            ]
+            qs = self.get_query_set(context)
+            context.push()
+            liststr = render_to_string(template_search_list, {"comment_list" : self.get_context_value_from_queryset(context, qs)}, context)
+            context.pop()
+            return liststr
+        else:
+            return ''
+
 class CommentCountNode(BaseCommentNode):
     """Insert a count of comments into the context."""
     def get_context_value_from_queryset(self, context, qs):
@@ -217 +255 @@
     return CommentListNode.handle_token(parser, token)
 
 #@register.tag
+def render_comment_list(parser, token):
+    """
+    Render the comment list (as returned by ``{% render_comment_list %}``) through
+    the ``comments/list.html`` template
+        
+    Syntax::
+        {% render_comment_list for [object] %}
+        {% render_comment_list for [app].[model] [object_id] %}
+    """
+    return RenderCommentListNode.handle_token(parser, token)
+
+#@register.tag
 def get_comment_form(parser, token):
     """
     Get a (new) form object to post a new comment.
@@ -254 +304 @@
 
 register.tag(get_comment_count)
 register.tag(get_comment_list)
+register.tag(render_comment_list)
 register.tag(get_comment_form)
 register.tag(render_comment_form)
 register.simple_tag(comment_form_target)

django/contrib/comments/templates/comments/list.html

@@ +1 @@
+<dl id="comments">
+{% for comment in comment_list %}
+    <dt id="c{{ comment.id }}">
+        {{ comment.submit_date }} - {{ comment.name }}
+    </dt>
+    <dd>
+        <p>{{ comment.comment }}</p>
+    </dd>
+{% endfor %}
+</dl>

tests/regressiontests/comment_tests/tests/templatetag_tests.py

@@ -63 +63 @@
 
     def testGetCommentListFromObject(self):
         self.testGetCommentList("{% get_comment_list for a as cl %}")
+    
+    def testRenderCommentList(self, tag=None):
+        t = "{% load comments %}" + (tag or "{% render_comment_list for comment_tests.article a.id %}")
+        ctx, out = self.render(t, a=Article.objects.get(pk=1))
+        self.assert_(out.strip().startswith("<dl id=\"comments\">"))
+        self.assert_(out.strip().endswith("</dl>"))
+    
+    def testRenderCommentListFromLiteral(self):
+        self.testRenderCommentList("{% render_comment_list for comment_tests.article 1 %}")
+    
+    def testRenderCommentListFromObject(self):
+        self.testRenderCommentList("{% render_comment_list for a %}")