tweaking both the test code and adding support for supression of completed recurrences in the rrule expanding

Author: tobixen

caldav/calendarobjectresource.py

@@ -160,7 +160,7 @@ def split_expanded(self) -> List[Self]:
             ret.append(obj)
         return ret
 
-    def expand_rrule(self, start: datetime, end: datetime) -> None:
+    def expand_rrule(self, start: datetime, end: datetime, include_completed: bool=True) -> None:
         """This method will transform the calendar content of the
         event and expand the calendar data from a "master copy" with
         RRULE set and into a "recurrence set" with RECURRENCE-ID set
@@ -186,6 +186,7 @@ def expand_rrule(self, start: datetime, end: datetime) -> None:
         # FIXME too much copying
         stripped_event = self.copy(keep_uid=True)
 
+        ## TODO: use icalendar_instance instead
         if stripped_event.vobject_instance is None:
             raise ValueError(
                 "Unexpected value None for stripped_event.vobject_instance"
@@ -203,6 +204,9 @@ def expand_rrule(self, start: datetime, end: datetime) -> None:
         calendar = self.icalendar_instance
         calendar.subcomponents = []
         for occurrence in recurrings:
+            ## Ignore completed task recurrences
+            if not include_completed and occurrence.name=='VTODO' and occurrence.get('STATUS') in ('COMPLETED', 'CANCELLED'):
+                continue
             if "RECURRENCE-ID" not in occurrence:
                 occurrence.add("RECURRENCE-ID", occurrence.get("DTSTART"))
             calendar.add_component(occurrence)

caldav/collection.py

@@ -924,7 +924,7 @@ def search(
                     continue
                 recurrence_properties = ["exdate", "exrule", "rdate", "rrule"]
                 if any(key in component for key in recurrence_properties):
-                    o.expand_rrule(start, end)
+                    o.expand_rrule(start, end, include_completed=include_completed)
 
             ## An expanded recurring object comes as one Event() with
             ## icalendar data containing multiple objects.  The caller may

tests/test_caldav_unit.py

@@ -193,6 +193,30 @@
 UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
 SEQUENCE:1
 CREATED:20250411T234336Z
+LAST-MODIFIED:20250414T082134Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250418
+RECURRENCE-ID;VALUE=DATE:20250418
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250414T082134Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250422
+RECURRENCE-ID;VALUE=DATE:20250422
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
 LAST-MODIFIED:20250425T124511Z
 SUMMARY:Clean Rosie filter
 STATUS:COMPLETED
@@ -207,6 +231,20 @@
 UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
 SEQUENCE:1
 CREATED:20250411T234336Z
+LAST-MODIFIED:20250425T124511Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250429
+RECURRENCE-ID;VALUE=DATE:20250429
+COMPLETED:20250425T124511Z
+PERCENT-COMPLETE:100
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
 LAST-MODIFIED:20250502T113705Z
 SUMMARY:Clean Rosie filter
 STATUS:COMPLETED
@@ -357,15 +395,17 @@ def testSearchForRecurringTask(self):
         mytasks = calendar.search(
             todo=True,
             expand="client",
-            start=datetime(2025, 6, 6),
-            end=datetime(2025, 7, 6),
+            start=datetime(2025, 5, 5),
+            end=datetime(2025, 6, 5),
         )
         assert len(mytasks) == 9
+
+        ## It should not include the COMPLETED recurrences
         mytasks = calendar.search(
             todo=True,
             expand="client",
             start=datetime(2025, 1, 1),
-            end=datetime(2025, 7, 6),
+            end=datetime(2025, 6, 5),
         )
         assert len(mytasks) == 9