Module Recurrence

source code

Classes used for recurrence.

Classes

[hide private]

Main Recurrence Kinds

RecurrenceRule
One rule defining recurrence for an item.

RecurrenceRuleSet
A collection of recurrence and exclusion rules, dates, and exclusion dates.

Recurrence Enumerations

FrequencyEnum
The base frequency for a recurring event.

WeekdayAndPositionStruct
Composition of a WeekdayEnum and an integer selecting first (1), last (-1), or n-th occurrence of that weekday in the month.

WeekdayEnum
The names of weekdays.

Functions

[hide private]

fromDateUtilFrequency(val)
Convert a dateutil frequency constant to its associated FrequencyEnum.

source code

fromDateUtilWeekday(val)
Convert a dateutil weekday constant to its associated WeekdayEnum.

source code

toDateUtil(val)
Convert a Chandler frequency, weekday, or byweekday selector to the associated dateutil value.

source code

toDateUtilFrequency(enum)
Return the dateutil constant associated with the given frequency.

source code

toDateUtilStruct(structlist)
Convert a WeekdayAndPositionStruct to the associated dateutil byweekday class.

source code

toDateUtilWeekday(enum)
Convert the English string for a weekday in WeekdayEnum to dateutil's special weekday class associated with that day.

source code

Variables

[hide private]

SHORT_FREQUENCIES = ('hourly', 'minutely', 'secondly')

__parcel__ = 'osaf.pim.calendar'

adverbFrequencyMap = {'daily': u'Daily', 'hourly': u'Hourly', ...

descriptionFormat = {'fdp': u'%(days)s every %(interval)s %(fr...

pluralFrequencyMap = {'daily': u'days', 'hourly': u'hours', 'm...

shortWeekdays = [u'', u'Sun', u'Mon', u'Tue', u'Wed', u'Thu', ...

singularFrequencyMap = {'daily': u'day', 'hourly': u'hour', 'm...

weekdayAbbrevMap = {'friday': u'Fri', 'monday': u'Mon', 'satur...

Variables Details

[hide private]

adverbFrequencyMap

Value:

{'daily': u'Daily',
 'hourly': u'Hourly',
 'minutely': u'Minutely',
 'monthly': u'Monthly',
 'secondly': u'Secondly',
 'weekly': u'Weekly',
 'yearly': u'Yearly'}

descriptionFormat

Value:

{'fdp': u'%(days)s every %(interval)s %(frequencyplural)s',
 'fds': u'%(days)s every %(frequencysingular)s',
 'fdup': u'%(days)s every %(interval)s %(frequencyplural)s until %(dat
e)s',
 'fdus': u'%(days)s every %(frequencysingular)s until %(date)s',
 'fp': u'Every %(interval)s %(frequencyplural)s',
 'fs': u'%(frequencyadverb)s',
 'fup': u'Every %(interval)s %(frequencyplural)s until %(date)s',
...

pluralFrequencyMap

Value:

{'daily': u'days',
 'hourly': u'hours',
 'minutely': u'minutes',
 'monthly': u'months',
 'secondly': u'seconds',
 'weekly': u'weeks',
 'yearly': u'years'}

shortWeekdays

Value:

[u'', u'Sun', u'Mon', u'Tue', u'Wed', u'Thu', u'Fri', u'Sat']

singularFrequencyMap

Value:

{'daily': u'day',
 'hourly': u'hour',
 'minutely': u'minute',
 'monthly': u'month',
 'secondly': u'second',
 'weekly': u'week',
 'yearly': u'year'}

weekdayAbbrevMap

Value:

{'friday': u'Fri',
 'monday': u'Mon',
 'saturday': u'Sat',
 'sunday': u'Sun',
 'thursday': u'Thu',
 'tuesday': u'Tue',
 'wednesday': u'Wed'}