module documentation

The rrule module offers a small, complete, and very fast, implementation of the recurrence rules documented in the `iCalendar RFC <https://tools.ietf.org/html/rfc5545>`_, including support for caching of results.

Class rrule That's the base of the rrule operation. It accepts all the keywords defined in the RFC as its constructor parameters (except byday, which was renamed to byweekday) and more. The constructor prototype is::...
Class rrulebase No class docstring; 0/5 instance variable, 5/11 methods documented
Class rruleset The rruleset type allows more complex recurrence setups, mixing multiple rules, dates, exclusion rules, and exclusion dates. The type constructor takes the following keyword arguments:
Class weekday This version of weekday does not allow n = 0.
Constant DAILY Undocumented
Constant FR Undocumented
Constant FREQNAMES Undocumented
Constant HOURLY Undocumented
Constant M29 Undocumented
Constant M30 Undocumented
Constant M31 Undocumented
Constant M365MASK Undocumented
Constant M365RANGE Undocumented
Constant M366MASK Undocumented
Constant M366RANGE Undocumented
Constant MDAY365MASK Undocumented
Constant MDAY366MASK Undocumented
Constant MINUTELY Undocumented
Constant MO Undocumented
Constant MONTHLY Undocumented
Constant NMDAY365MASK Undocumented
Constant NMDAY366MASK Undocumented
Constant SA Undocumented
Constant SECONDLY Undocumented
Constant SU Undocumented
Constant TH Undocumented
Constant TU Undocumented
Constant WDAYMASK Undocumented
Constant WE Undocumented
Constant WEEKLY Undocumented
Constant YEARLY Undocumented
Variable easter Undocumented
Variable parser Undocumented
Variable rrulestr Undocumented
Variable weekdays Undocumented
Class _iterinfo Undocumented
Class _rrulestr Parses a string representation of a recurrence rule or set of recurrence rules.
Function _invalidates_cache Decorator for rruleset methods which may invalidate the cached length.
DAILY = (source)

Undocumented

Undocumented

FREQNAMES: list[str] = (source)

Undocumented

Value
['YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY', 'MINUTELY', 'SECONDLY']
HOURLY = (source)

Undocumented

Undocumented

Undocumented

Undocumented

M365MASK = (source)

Undocumented

Value
tuple(M365MASK)
M365RANGE: tuple[int, ...] = (source)

Undocumented

Value
(0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365)
M366MASK = (source)

Undocumented

Value
tuple(((((((((((([1]*31+[2]*29)+[3]*31)+[4]*30)+[5]*31)+[6]*30)+[7]*31)+[8]*31)+[9]*30)+[10]*31)+[11]*30)+[12]*31)+[1]*7)
M366RANGE: tuple[int, ...] = (source)

Undocumented

Value
(0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366)
MDAY365MASK = (source)

Undocumented

Value
tuple(MDAY365MASK)
MDAY366MASK = (source)

Undocumented

Value
tuple((((((((((((M31+M29)+M31)+M30)+M31)+M30)+M31)+M31)+M30)+M31)+M30)+M31)+M31[:7])
MINUTELY = (source)

Undocumented

Undocumented

MONTHLY = (source)

Undocumented

NMDAY365MASK = (source)

Undocumented

Value
list(NMDAY366MASK)
NMDAY366MASK = (source)

Undocumented

Value
tuple((((((((((((M31+M29)+M31)+M30)+M31)+M30)+M31)+M31)+M30)+M31)+M30)+M31)+M31[:7])

Undocumented

SECONDLY = (source)

Undocumented

Undocumented

Undocumented

Undocumented

WDAYMASK = (source)

Undocumented

Value
[0, 1, 2, 3, 4, 5, 6]*55

Undocumented

WEEKLY = (source)

Undocumented

YEARLY = (source)

Undocumented

easter = (source)

Undocumented

parser = (source)

Undocumented

rrulestr = (source)

Undocumented

weekdays = (source)

Undocumented

def _invalidates_cache(f): (source)

Decorator for rruleset methods which may invalidate the cached length.