feat: add schedule queryset requested filter

CHANGELOG.rst

@@ -15,6 +15,15 @@ Unreleased
 ----------
 * Configuration for automatic filters docs generation.
 
+
+[1.12.0] - 2024-12-10
+---------------------
+
+Added
+~~~~~
+
+* ScheduleQuerySetRequested filter added which can be used to modify the Schedule QuerySet.
+
 [1.11.0] - 2024-09-30
 ---------------------
 

openedx_filters/__init__.py

@@ -3,4 +3,4 @@
 """
 from openedx_filters.filters import *
 
-__version__ = "1.11.0"
+__version__ = "1.12.0"

openedx_filters/learning/filters.py

@@ -4,6 +4,8 @@
 
 from typing import Optional
 
+from django.db.models.query import QuerySet
+
 from openedx_filters.exceptions import OpenEdxFilterException
 from openedx_filters.tooling import OpenEdxPublicFilter
 from openedx_filters.utils import SensitiveDataManagementMixin
@@ -818,3 +820,29 @@ def run_filter(cls, url, org):
         """
         data = super().run_pipeline(url=url, org=org)
         return data.get("url"), data.get("org")
+
+
+class ScheduleQuerySetRequested(OpenEdxPublicFilter):
+    """
+    Filter class designed to apply additional filtering to a given QuerySet of Schedules.
+    """
+
+    filter_type = "org.openedx.learning.schedule.queryset.requested.v1"
+
+    @classmethod
+    def run_filter(cls, schedules: QuerySet) -> QuerySet:
+        """
+        Execute the filtering logic for the given QuerySet of schedules.
+
+        This method processes the input QuerySet using the configured pipeline steps
+        to applies additional filtering rules. It returns the filtered QuerySet for
+        further processing.
+
+        Arguments:
+            schedules (QuerySet): The original QuerySet of schedules to be filtered.
+
+        Returns:
+            QuerySet: A refined QuerySet of schedules after applying the filter.
+        """
+        data = super().run_pipeline(schedules=schedules)
+        return data.get("schedules")

openedx_filters/learning/tests/test_filters.py

@@ -25,6 +25,7 @@
     InstructorDashboardRenderStarted,
     ORASubmissionViewRenderStarted,
     RenderXBlockStarted,
+    ScheduleQuerySetRequested,
     StudentLoginRequested,
     StudentRegistrationRequested,
     VerticalBlockChildRenderStarted,
@@ -776,3 +777,26 @@ def test_lms_page_url_requested(self):
 
         self.assertEqual(url, url_result)
         self.assertEqual(org, org_result)
+
+
+@ddt
+class TestScheduleFilters(TestCase):
+    """
+    Test class to verify standard behavior of the schedule filters.
+
+    You'll find test suites for:
+    - `ScheduleQuerySetRequested`
+    """
+
+    def test_schedule_requested(self):
+        """
+        Test schedule requested filter.
+
+        Expected behavior:
+            - The filter should return the filtered schedules.
+        """
+        schedules = Mock()
+
+        result = ScheduleQuerySetRequested.run_filter(schedules)
+
+        self.assertEqual(schedules, result)