style: Run black on the rest of the project.

Author: feanil

backend/sample_plugin/__init__.py

@@ -2,4 +2,4 @@
 A sample backend plugin for the Open edX Platform.
 """
 
-__version__ = '0.1.0'
+__version__ = "0.1.0"

backend/sample_plugin/models.py

@@ -1,6 +1,7 @@
 """
 Database models for sample_plugin.
 """
+
 from django.contrib.auth import get_user_model
 from django.db import models
 from opaque_keys.edx.django.models import CourseKeyField
@@ -16,28 +17,26 @@ class CourseArchiveStatus(models.Model):
     """
 
     course_id = CourseKeyField(
-        max_length=255,
-        db_index=True,
-        help_text="The unique identifier for the course."
+        max_length=255, db_index=True, help_text="The unique identifier for the course."
     )
 
     user = models.ForeignKey(
         get_user_model(),
         on_delete=models.CASCADE,
         related_name="course_archive_statuses",
-        help_text="The user who this archive status is for."
+        help_text="The user who this archive status is for.",
     )
 
     is_archived = models.BooleanField(
         default=False,
         db_index=True,  # Add index for performance on this frequently filtered field
-        help_text="Whether the course is archived."
+        help_text="Whether the course is archived.",
     )
 
     archive_date = models.DateTimeField(
         null=True,
         blank=True,
-        help_text="The date and time when the course was archived."
+        help_text="The date and time when the course was archived.",
     )
 
     created_at = models.DateTimeField(auto_now_add=True)
@@ -61,7 +60,6 @@ class Meta:
         # Ensure combination of course_id and user is unique
         constraints = [
             models.UniqueConstraint(
-                fields=['course_id', 'user'],
-                name='unique_user_course_archive_status'
+                fields=["course_id", "user"], name="unique_user_course_archive_status"
             )
         ]

backend/sample_plugin/serializers.py

@@ -1,6 +1,7 @@
 """
 Serializers for the sample_plugin app.
 """
+
 from rest_framework import serializers
 
 from sample_plugin.models import CourseArchiveStatus
@@ -18,12 +19,12 @@ class Meta:
 
         model = CourseArchiveStatus
         fields = [
-            'id',
-            'course_id',
-            'user',
-            'is_archived',
-            'archive_date',
-            'created_at',
-            'updated_at',
+            "id",
+            "course_id",
+            "user",
+            "is_archived",
+            "archive_date",
+            "created_at",
+            "updated_at",
         ]
-        read_only_fields = ['id', 'created_at', 'updated_at', 'archive_date']
+        read_only_fields = ["id", "created_at", "updated_at", "archive_date"]

backend/sample_plugin/signals.py

@@ -12,4 +12,4 @@
 #     """
 #     Handle user retirement actions for this app.
 #     """
-#     pass
+#     pass

backend/sample_plugin/urls.py

@@ -1,16 +1,21 @@
 """
 URLs for sample_plugin.
 """
+
 from django.urls import include, path
 from rest_framework.routers import DefaultRouter
 
 from sample_plugin.views import CourseArchiveStatusViewSet
 
 # Create a router and register our viewsets with it
 router = DefaultRouter()
-router.register(r'course-archive-status', CourseArchiveStatusViewSet, basename='course-archive-status')
+router.register(
+    r"course-archive-status",
+    CourseArchiveStatusViewSet,
+    basename="course-archive-status",
+)
 
 # The API URLs are now determined automatically by the router
 urlpatterns = [
-    path('api/v1/', include(router.urls)),
+    path("api/v1/", include(router.urls)),
 ]

backend/sample_plugin/views.py

@@ -1,6 +1,7 @@
 """
 Views for the sample_plugin app.
 """
+
 import logging
 
 from django.utils import timezone
@@ -51,7 +52,7 @@ class CourseArchiveStatusPagination(PageNumberPagination):
     """
 
     page_size = 20
-    page_size_query_param = 'page_size'
+    page_size_query_param = "page_size"
     max_page_size = 100
 
 
@@ -60,7 +61,7 @@ class CourseArchiveStatusThrottle(UserRateThrottle):
     Throttle for the CourseArchiveStatus API.
     """
 
-    rate = '60/minute'
+    rate = "60/minute"
 
 
 class CourseArchiveStatusViewSet(viewsets.ModelViewSet):
@@ -78,9 +79,16 @@ class CourseArchiveStatusViewSet(viewsets.ModelViewSet):
     pagination_class = CourseArchiveStatusPagination
     throttle_classes = [CourseArchiveStatusThrottle, AnonRateThrottle]
     filter_backends = [DjangoFilterBackend, filters.OrderingFilter]
-    filterset_fields = ['course_id', 'user', 'is_archived']
-    ordering_fields = ['course_id', 'user', 'is_archived', 'archive_date', 'created_at', 'updated_at']
-    ordering = ['-updated_at']
+    filterset_fields = ["course_id", "user", "is_archived"]
+    ordering_fields = [
+        "course_id",
+        "user",
+        "is_archived",
+        "archive_date",
+        "created_at",
+        "updated_at",
+    ]
+    ordering = ["-updated_at"]
 
     def get_queryset(self):
         """
@@ -95,7 +103,7 @@ def get_queryset(self):
         self._validate_query_params()
 
         # Always use select_related to avoid N+1 queries
-        base_queryset = CourseArchiveStatus.objects.select_related('user')
+        base_queryset = CourseArchiveStatus.objects.select_related("user")
 
         if user.is_staff or user.is_superuser:
             return base_queryset
@@ -108,12 +116,12 @@ def _validate_query_params(self):
         Validate query parameters to prevent injection.
         """
         # Example validation for course_id format
-        course_id = self.request.query_params.get('course_id')
+        course_id = self.request.query_params.get("course_id")
         if course_id and not self._is_valid_course_id(course_id):
             logger.warning(
                 "Invalid course_id in request: %s, user: %s",
                 course_id,
-                self.request.user.username
+                self.request.user.username,
             )
             raise ValidationError({"course_id": "Invalid course ID format."})
 
@@ -140,20 +148,24 @@ def perform_create(self, serializer):
         data = serializer.validated_data.copy()
 
         # Set user to requesting user if not specified
-        if 'user' not in data:
-            data['user'] = self.request.user
+        if "user" not in data:
+            data["user"] = self.request.user
         # Only allow staff/superusers to create records for other users
-        elif data['user'] != self.request.user and not (self.request.user.is_staff or self.request.user.is_superuser):
+        elif data["user"] != self.request.user and not (
+            self.request.user.is_staff or self.request.user.is_superuser
+        ):
             logger.warning(
                 "Permission denied: User %s tried to create a record for user %s",
                 self.request.user.username,
-                data['user'].username
+                data["user"].username,
+            )
+            raise PermissionDenied(
+                "You do not have permission to create records for other users."
             )
-            raise PermissionDenied("You do not have permission to create records for other users.")
 
         # Set archive_date if is_archived is True
-        if data.get('is_archived', False):
-            data['archive_date'] = timezone.now()
+        if data.get("is_archived", False):
+            data["archive_date"] = timezone.now()
 
         # Create the record
         instance = serializer.save(**data)
@@ -163,7 +175,7 @@ def perform_create(self, serializer):
             "CourseArchiveStatus created: course_id=%s, user=%s, is_archived=%s",
             instance.course_id,
             instance.user.username,
-            instance.is_archived
+            instance.is_archived,
         )
 
         return instance
@@ -178,13 +190,13 @@ def perform_update(self, serializer):
         data = serializer.validated_data.copy()
 
         # Handle archive_date if is_archived changes
-        if 'is_archived' in data:
+        if "is_archived" in data:
             # If changing from not archived to archived
-            if data['is_archived'] and not instance.is_archived:
-                data['archive_date'] = timezone.now()
+            if data["is_archived"] and not instance.is_archived:
+                data["archive_date"] = timezone.now()
             # If changing from archived to not archived
-            elif not data['is_archived'] and instance.is_archived:
-                data['archive_date'] = None
+            elif not data["is_archived"] and instance.is_archived:
+                data["archive_date"] = None
 
         # Update the record
         updated_instance = serializer.save(**data)
@@ -194,7 +206,7 @@ def perform_update(self, serializer):
             "CourseArchiveStatus updated: course_id=%s, user=%s, is_archived=%s",
             updated_instance.course_id,
             updated_instance.user.username,
-            updated_instance.is_archived
+            updated_instance.is_archived,
         )
 
         return updated_instance
@@ -208,7 +220,7 @@ def perform_destroy(self, instance):
             "CourseArchiveStatus deleted: course_id=%s, user=%s, by=%s",
             instance.course_id,
             instance.user.username,
-            self.request.user.username
+            self.request.user.username,
         )
 
         # Delete the instance

backend/tests/test_api.py

@@ -30,7 +30,9 @@ def user():
     Create and return a test user.
     """
     return User.objects.create_user(
-        username="testuser", email="[email protected]", password="password123"
+        username="testuser",
+        email="[email protected]",
+        password="password123",
     )
 
 
@@ -40,7 +42,9 @@ def another_user():
     Create and return another test user.
     """
     return User.objects.create_user(
-        username="anotheruser", email="[email protected]", password="password123"
+        username="anotheruser",
+        email="[email protected]",
+        password="password123",
     )
 
 
@@ -140,7 +144,11 @@ def test_create_course_archive_status(api_client, user, course_key):
     """
     api_client.force_authenticate(user=user)
     url = reverse("sample_plugin:course-archive-status-list")
-    data = {"course_id": str(course_key), "user": user.id, "is_archived": True}
+    data = {
+        "course_id": str(course_key),
+        "user": user.id,
+        "is_archived": True,
+    }
     response = api_client.post(url, data, format="json")
 
     assert response.status_code == status.HTTP_201_CREATED
@@ -166,7 +174,11 @@ def test_create_course_archive_status_for_another_user(
     """
     api_client.force_authenticate(user=user)
     url = reverse("sample_plugin:course-archive-status-list")
-    data = {"course_id": str(course_key), "user": another_user.id, "is_archived": True}
+    data = {
+        "course_id": str(course_key),
+        "user": another_user.id,
+        "is_archived": True,
+    }
     response = api_client.post(url, data, format="json")
 
     assert response.status_code == status.HTTP_403_FORBIDDEN
@@ -181,7 +193,11 @@ def test_staff_create_course_archive_status_for_another_user(
     """
     api_client.force_authenticate(user=staff_user)
     url = reverse("sample_plugin:course-archive-status-list")
-    data = {"course_id": str(course_key), "user": user.id, "is_archived": True}
+    data = {
+        "course_id": str(course_key),
+        "user": user.id,
+        "is_archived": True,
+    }
     response = api_client.post(url, data, format="json")
 
     assert response.status_code == status.HTTP_201_CREATED