ical.guides.recurrence API documentation

ical.guides.recurrence

Recurrence Rules & Event Generation

Work In Progress (WIP) / TODO: This guide is currently a placeholder. Content will be added in a future update.

This guide covers the technical architecture behind how ical handles recurrence rules (RFC 5545) and generates timeline events.

Key Design Principles

  1. Pydantic-based Data Model: Recurrence rules are parsed into structured Python objects using validation patterns.
  2. Timeline Iteration: Events are evaluated lazily via a heapq-merged stream of iterators to handle potentially infinite recurrences efficiently.
  3. Instance Modification: Editing specific occurrences (using RECURRENCE-ID) excludes them from the parent series.
1"""
2.. include:: ../../guides/recurrence.md
3"""