Misc cleanup

netbox/core/api/serializers_/tasks.py

@@ -9,7 +9,11 @@ __all__ = (
 
 class BackgroundTaskSerializer(serializers.Serializer):
     id = serializers.CharField()
-    url = serializers.HyperlinkedIdentityField(view_name='core-api:rqtask-detail', lookup_field='id', lookup_url_kwarg='pk')
+    url = serializers.HyperlinkedIdentityField(
+        view_name='core-api:rqtask-detail',
+        lookup_field='id',
+        lookup_url_kwarg='pk'
+    )
     description = serializers.CharField()
     origin = serializers.CharField()
     func_name = serializers.CharField()
@@ -62,10 +66,15 @@ class BackgroundQueueSerializer(serializers.Serializer):
 
 class BackgroundWorkerSerializer(serializers.Serializer):
     name = serializers.CharField()
-    url = serializers.HyperlinkedIdentityField(view_name='core-api:rqworker-detail', lookup_field='name')
+    url = serializers.HyperlinkedIdentityField(
+        view_name='core-api:rqworker-detail',
+        lookup_field='name'
+    )
     state = serializers.SerializerMethodField()
     birth_date = serializers.CharField()
-    queue_names = serializers.ListField(child=serializers.CharField())
+    queue_names = serializers.ListField(
+        child=serializers.CharField()
+    )
     pid = serializers.CharField()
     successful_job_count = serializers.IntegerField()
     failed_job_count = serializers.IntegerField()

netbox/core/api/views.py

@@ -85,9 +85,9 @@ class ObjectChangeViewSet(ReadOnlyModelViewSet):
     filterset_class = filtersets.ObjectChangeFilterSet
 
 
-class BaseRQListView(viewsets.ViewSet):
+class BaseRQViewSet(viewsets.ViewSet):
     """
-    Retrieve a list of RQ Queues.
+    Base class for RQ view sets. Provides a list() method. Subclasses must implement get_data().
     """
     permission_classes = [IsAdminUser]
     serializer_class = None
@@ -105,7 +105,7 @@ class BaseRQListView(viewsets.ViewSet):
         return paginator.get_paginated_response(serializer.data)
 
 
-class BackgroundQueueViewSet(BaseRQListView):
+class BackgroundQueueViewSet(BaseRQViewSet):
     """
     Retrieve a list of RQ Queues.
     Note: Queue names are not URL safe so not returning a detail view.
@@ -120,7 +120,7 @@ class BackgroundQueueViewSet(BaseRQListView):
         return get_statistics(run_maintenance_tasks=True)["queues"]
 
 
-class BackgroundWorkerViewSet(BaseRQListView):
+class BackgroundWorkerViewSet(BaseRQViewSet):
     """
     Retrieve a list of RQ Workers.
     """
@@ -146,7 +146,7 @@ class BackgroundWorkerViewSet(BaseRQListView):
         return Response(serializer.data)
 
 
-class BackgroundTaskViewSet(BaseRQListView):
+class BackgroundTaskViewSet(BaseRQViewSet):
     """
     Retrieve the details of the specified RQ Task.
     """

netbox/core/tests/test_api.py

@@ -103,15 +103,10 @@ class DataFileTest(
 class BackgroundTaskTestCase(TestCase):
     user_permissions = ()
 
-    # Dummy worker functions
     @staticmethod
     def dummy_job_default():
         return "Job finished"
 
-    @staticmethod
-    def dummy_job_high():
-        return "Job finished"
-
     @staticmethod
     def dummy_job_failing():
         raise Exception("Job failed")