WIP Staging Resolving Merge Issues

Author: AdvitRanawadePenn

backend/Pipfile

@@ -65,4 +65,4 @@ ics = "*"
 drf-nested-routers = "*"
 
 [requires]
-python_full_version = "3.11"
+python_full_version = "3.11"

backend/Pipfile.lock

@@ -0,0 +1,13 @@
+# Generated by Django 5.0.2 on 2024-11-05 17:58
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("courses", "0065_auto_20240425_2031"),
+        ("courses", "0065_topic_historical_probabilities_fall_and_more"),
+    ]
+
+    operations = []

backend/courses/migrations/0066_merge_20241105_1258.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.0.2 on 2024-11-05 18:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("courses", "0066_merge_20241105_1258"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="course",
+            name="credits",
+        ),
+        migrations.RemoveField(
+            model_name="topic",
+            name="historical_probabilities_fall",
+        ),
+        migrations.RemoveField(
+            model_name="topic",
+            name="historical_probabilities_spring",
+        ),
+        migrations.RemoveField(
+            model_name="topic",
+            name="historical_probabilities_summer",
+        ),
+        migrations.AlterField(
+            model_name="course",
+            name="num_activities",
+            field=models.IntegerField(
+                default=0,
+                help_text="\nThe number of distinct activities belonging to this course (precomputed for efficiency).\nMaintained by the registrar import / recompute_soft_state script.\n",
+            ),
+        ),
+    ]

backend/courses/migrations/0067_remove_course_credits_and_more.py

@@ -15,7 +15,6 @@
 from PennCourses.settings.base import FIRST_BANNER_SEM, PRE_NGSS_PERMIT_REQ_RESTRICTION_CODES
 from review.annotations import review_averages
 
-
 User = get_user_model()
 
 
@@ -154,9 +153,7 @@ class Course(models.Model):
         ),
     )
     code = models.CharField(
-        max_length=8,
-        db_index=True,
-        help_text="The course code, e.g. `120` for CIS-120.",
+        max_length=8, db_index=True, help_text="The course code, e.g. `120` for CIS-120."
     )
     semester = models.CharField(
         max_length=5,
@@ -204,15 +201,6 @@ class Course(models.Model):
         help_text="The dash-joined department and code of the course, e.g. `CIS-120` for CIS-120.",
     )
 
-    credits = models.DecimalField(
-        max_digits=4,  # some course for 2019C is 14 CR...
-        decimal_places=2,
-        null=True,
-        blank=True,
-        db_index=True,
-        help_text="The number of credits this course takes. This is precomputed for efficiency.",
-    )
-
     prerequisites = models.TextField(
         blank=True,
         help_text="Text describing the prereqs for a course, e.g. 'CIS 120, 160' for CIS-121.",
@@ -276,7 +264,7 @@ class Course(models.Model):
         help_text=dedent(
             """
             The number of distinct activities belonging to this course (precomputed for efficiency).
-            Maintained by the registrar import / recomputestats script.
+            Maintained by the registrar import / recompute_soft_state script.
             """
         ),
     )
@@ -377,36 +365,6 @@ class Topic(models.Model):
         ),
     )
 
-    historical_probabilities_spring = models.FloatField(
-        default=0,
-        help_text=dedent(
-            """
-        The historical probability of a student taking a course in this topic in the spring
-        semester, based on historical data. This field is recomputed nightly from the
-        `parent_course` graph (in the recompute_soft_state cron job).
-        """
-        ),
-    )
-    historical_probabilities_summer = models.FloatField(
-        default=0,
-        help_text=dedent(
-            """
-        The historical probability of a student taking a course in this topic in the summer
-        semester, based on historical data. This field is recomputed nightly from the
-        `parent_course` graph (in the recompute_soft_state cron job).
-        """
-        ),
-    )
-    historical_probabilities_fall = models.FloatField(
-        default=0,
-        help_text=dedent(
-            """
-        The historical probability of a student taking a course in this topic in the fall
-        semester, based on historical data. This field is recomputed nightly from the
-        `parent_course` graph (in the recompute_soft_state cron job).
-        """
-        ),
-    )
     branched_from = models.ForeignKey(
         "Topic",
         related_name="branched_to",
@@ -763,8 +721,7 @@ class Meta:
     )
 
     instructors = models.ManyToManyField(
-        Instructor,
-        help_text="The Instructor object(s) of the instructor(s) teaching the section.",
+        Instructor, help_text="The Instructor object(s) of the instructor(s) teaching the section."
     )
     associated_sections = models.ManyToManyField(
         "Section",
@@ -823,8 +780,7 @@ class Meta:
     )
 
     registration_volume = models.PositiveIntegerField(
-        default=0,
-        help_text="The number of active PCA registrations watching this section.",
+        default=0, help_text="The number of active PCA registrations watching this section."
     )  # For the set of PCA registrations for this section, use the related field `registrations`.
 
     def __str__(self):
@@ -881,9 +837,7 @@ def current_percent_open(self):
                 return None
             try:
                 last_status_update = StatusUpdate.objects.filter(
-                    section=self,
-                    created_at__gt=add_drop_start,
-                    created_at__lt=add_drop_end,
+                    section=self, created_at__gt=add_drop_start, created_at__lt=add_drop_end
                 ).latest("created_at")
             except StatusUpdate.DoesNotExist:
                 last_status_update = None
@@ -928,12 +882,7 @@ class StatusUpdate(models.Model):
     A registration status update for a specific section (e.g. CIS-120-001 went from open to close)
     """
 
-    STATUS_CHOICES = (
-        ("O", "Open"),
-        ("C", "Closed"),
-        ("X", "Cancelled"),
-        ("", "Unlisted"),
-    )
+    STATUS_CHOICES = (("O", "Open"), ("C", "Closed"), ("X", "Cancelled"), ("", "Unlisted"))
     section = models.ForeignKey(
         Section,
         related_name="status_updates",
@@ -968,8 +917,7 @@ class StatusUpdate(models.Model):
     # and the save() method of StatusUpdate
 
     in_add_drop_period = models.BooleanField(
-        default=False,
-        help_text="Was this status update created during the add/drop period?",
+        default=False, help_text="Was this status update created during the add/drop period?"
     )  # This field is maintained in the save() method of alerts.models.AddDropPeriod,
     # and the save() method of StatusUpdate
 
@@ -1100,8 +1048,7 @@ class Room(models.Model):
         ),
     )
     number = models.CharField(
-        max_length=8,
-        help_text="The room number, e.g. `101` for Wu and Chen Auditorium in Levine.",
+        max_length=8, help_text="The room number, e.g. `101` for Wu and Chen Auditorium in Levine."
     )
     name = models.CharField(
         max_length=80,
@@ -1540,3 +1487,73 @@ def __str__(self):
         return (
             f"Friendship(Sender: {self.sender}, Recipient: {self.recipient}, Status: {self.status})"
         )
+
+class Comment(models.Model):
+    """
+    A single comment associated with a topic to be displayed on PCR. Comments support replies
+    through the parent_id and path fields. The path field allows for efficient database querying
+    and can indicate levels of nesting and can make pagination simpler. Idea implemented based
+    on this guide: https://blog.miguelgrinberg.com/post/implementing-user-comments-with-sqlalchemy.
+    """
+
+    # Log base 10 value of maximum adjacent comment length.
+    _N = 10
+
+    text = models.TextField()
+    created_at = models.DateTimeField(auto_now_add=True)
+    modified_at = models.DateTimeField(auto_now=True)
+    author = models.ForeignKey(
+        get_user_model(),
+        on_delete = models.SET_NULL,
+        null=True,
+        related_name="comments"
+    )
+    upvotes = models.ManyToManyField(
+        get_user_model(),
+        related_name="upvotes",
+        help_text="The number of upvotes a comment gets."
+    )
+    downvotes = models.ManyToManyField(
+        get_user_model(),
+        related_name="downvotes",
+        help_text="The number of downvotes a comment gets."
+    )
+    section = models.ForeignKey(
+        Section,
+        on_delete=models.CASCADE,
+        help_text=dedent(
+            """
+        The section with which a comment is associated. Section was chosen instead of topics for
+        hosting comments because topics are SOFT STATE and are recomputed regularly.
+        """
+        ),
+        null=True
+    )
+
+    base = models.ForeignKey(
+        "self",
+        on_delete=models.SET_NULL, # redundant due to special deletion conditions
+        null=True,
+    )
+    parent = models.ForeignKey(
+        "self",
+        on_delete=models.SET_NULL, # similarly redundant
+        null=True,
+        related_name="children"
+    )
+    path = models.TextField(db_index=True)
+
+    def level(self):
+        return len(self.path.split('.'))
+    
+    def delete(self, **kwargs):
+        if Comment.objects.filter(parent_id=self).exists():
+            self.text = "This comment has been removed."
+            self.upvotes.clear()
+            self.downvotes.clear()
+            self.author = None
+            self.save()
+        else:
+            super().delete(**kwargs)
+    def __str__(self):
+        return f"{self.author}: {self.text}"

backend/courses/models.py

@@ -14,6 +14,7 @@
     Section,
     StatusUpdate,
     UserProfile,
+    Comment
 )
 from plan.management.commands.recommendcourses import cosine_similarity
 
@@ -475,3 +476,49 @@ class FriendshipRequestSerializer(serializers.Serializer):
 
     def to_representation(self, instance):
         return super().to_representation(instance)
+
+class CommentSerializer(serializers.ModelSerializer):
+    author_name = serializers.CharField(source="author.username", read_only=True)
+    votes = serializers.SerializerMethodField()
+    section = serializers.CharField(source="section.full_code", read_only=True)
+    base = serializers.SerializerMethodField()
+    parent = serializers.SerializerMethodField()
+
+    def get_votes(self, obj):
+        return len(obj.upvotes.values_list('id')) - len(obj.downvotes.values_list('id'))
+    def get_base(self, obj):
+        if obj.base is None:
+            return None
+        return obj.base.id
+    def get_parent(self, obj):
+        if obj.parent is None:
+            return None
+        return obj.parent.id
+
+    class Meta:
+        model = Comment
+        fields = ['id', 'text', 'created_at', 'modified_at', 'author_name', 'votes', 'section', 'base', 'parent', 'path']
+
+class CommentListSerializer(serializers.ModelSerializer):
+    author_name = serializers.CharField(source="author.username", read_only=True)
+    votes = serializers.SerializerMethodField()
+    section = serializers.CharField(source="section.full_code", read_only=True)
+    base = serializers.SerializerMethodField()
+    parent = serializers.SerializerMethodField()
+    user_upvoted = serializers.BooleanField()
+    user_downvoted = serializers.BooleanField()
+
+    def get_votes(self, obj):
+        return len(obj.upvotes.values_list('id')) - len(obj.downvotes.values_list('id'))
+    def get_base(self, obj):
+        if obj.base is None:
+            return None
+        return obj.base.id
+    def get_parent(self, obj):
+        if obj.parent is None:
+            return None
+        return obj.parent.id
+
+    class Meta:
+        model = Comment
+        fields = ['id', 'text', 'created_at', 'modified_at', 'author_name', 'votes', 'section', 'base', 'parent', 'path', 'user_upvoted', 'user_downvoted']

backend/courses/serializers.py

@@ -771,3 +771,22 @@ def normalize_and_round(prob, i):
             [semester_probabilities["A"], semester_probabilities["B"], semester_probabilities["C"]],
         )
     )
+
+def get_section_from_course_instructor_semester(course_code, professors, semester):
+    """
+    Attempts to return a course section that matches the given parameters.
+    ValueError is raised if the section does not exist.
+    """
+    sections = Section.objects.prefetch_related('instructors').filter(
+        course__full_code=course_code,
+        course__semester=semester
+    )
+    
+    professors_query = Q(instructors__name=professors[0])
+    for professor in professors[1:]:
+        professors_query &= Q(instructors__name=professor)
+    matching_sections = sections.filter(professors_query).distinct()
+    
+    if matching_sections.count() == 1:
+        return matching_sections.first()
+    raise ValueError(f"No section exists with course code ({course_code}), professor ({professors[0]}), semester ({semester})")