class documentation

class _rrulestr(object): (source)

View In Hierarchy

Parses a string representation of a recurrence rule or set of recurrence rules. :param s: Required, a string defining one or more recurrence rules. :param dtstart: If given, used as the default recurrence start if not specified in the rule string. :param cache: If set ``True`` caching of results will be enabled, improving performance of multiple queries considerably. :param unfold: If set ``True`` indicates that a rule string is split over more than one line and should be joined before processing. :param forceset: If set ``True`` forces a :class:`dateutil.rrule.rruleset` to be returned. :param compatible: If set ``True`` forces ``unfold`` and ``forceset`` to be ``True``. :param ignoretz: If set ``True``, time zones in parsed strings are ignored and a naive :class:`datetime.datetime` object is returned. :param tzids: If given, a callable or mapping used to retrieve a :class:`datetime.tzinfo` from a string representation. Defaults to :func:`dateutil.tz.gettz`. :param tzinfos: Additional time zone names / aliases which may be present in a string representation. See :func:`dateutil.parser.parse` for more information. :return: Returns a :class:`dateutil.rrule.rruleset` or :class:`dateutil.rrule.rrule`

Method __call__ Undocumented
Method _handle_BYWEEKDAY Two ways to specify this: +1MO or MO(+1)
Method _handle_FREQ Undocumented
Method _handle_int Undocumented
Method _handle_int_list Undocumented
Method _handle_UNTIL Undocumented
Method _handle_WKST Undocumented
Method _parse_date_value Undocumented
Method _parse_rfc Undocumented
Method _parse_rfc_rrule Undocumented
Class Variable _freq_map Undocumented
Class Variable _weekday_map Undocumented
def __call__(self, s, **kwargs): (source)

Undocumented

def _handle_BYWEEKDAY(self, rrkwargs, name, value, **kwargs): (source)

Two ways to specify this: +1MO or MO(+1)

def _handle_FREQ(self, rrkwargs, name, value, **kwargs): (source)

Undocumented

def _handle_int(self, rrkwargs, name, value, **kwargs): (source)

Undocumented

def _handle_int_list(self, rrkwargs, name, value, **kwargs): (source)

Undocumented

def _handle_UNTIL(self, rrkwargs, name, value, **kwargs): (source)

Undocumented

def _handle_WKST(self, rrkwargs, name, value, **kwargs): (source)

Undocumented

def _parse_date_value(self, date_value, parms, rule_tzids, ignoretz, tzids, tzinfos): (source)

Undocumented

def _parse_rfc(self, s, dtstart=None, cache=False, unfold=False, forceset=False, compatible=False, ignoretz=False, tzids=None, tzinfos=None): (source)

Undocumented

def _parse_rfc_rrule(self, line, dtstart=None, cache=False, ignoretz=False, tzinfos=None): (source)

Undocumented

_freq_map = (source)

Undocumented

_weekday_map: dict[str, int] = (source)

Undocumented