Source code for tcms.core.helpers.comments

# -*- coding: utf-8 -*-
Functions that help access comments
of objects.
from django.conf import settings
from django.contrib.contenttypes.models import ContentType
from django.contrib.sites.models import Site
from django.db.models.signals import post_save
from django.utils import timezone
from django_comments.models import Comment

[docs] def add_comment(objs, comments, user, submit_date=None): """ Add django.comment for an object. :param objs: List of object to which to add comments :type objs: list :param comments: The commentary :type comments: str :param user: Who is adding this :type user: A User model :param submit_date: A time stamp :type submit_date: datetime.datetime :return: A list of :class:`django_comments.models.Comment` objects representing the newly created comments :rtype: list Example:: from django.contrib.auth.models import User testuser = User.objects.get(email='') from tcms.testruns.models import TestExecution testrun = TestExecution.objects.get(pk=171675) comments = 'stupid comments by Homer' add_comment([testrun,], comments, testuser) """ site = Site.objects.get(pk=settings.SITE_ID) created = [] for obj in objs: content_type = ContentType.objects.get_for_model(model=obj.__class__) comment = Comment.objects.create( content_type=content_type, site=site,, user=user, comment=comments, submit_date=submit_date or,, user_name=user.username, ) created.append(comment) post_save.send( created=False, instance=obj, sender=obj.__class__, called_from_add_comment=True, ) return created
[docs] def get_comments(obj): content_type = ContentType.objects.get_for_model(obj) return ( Comment.objects.filter( content_type=content_type,, site=settings.SITE_ID, is_removed=False, ) .select_related("user") .only("submit_date", "user__username", "comment") .order_by("pk") )