icalendar.prop.recur.frequency module#

FREQ value type of RECUR from RFC 5545.

class icalendar.prop.recur.frequency.vFrequency(value, encoding='utf-8', /, params: dict[str, Any] | None = None)[source]#

Bases: str

A simple class that catches illegal values.

frequencies = {'DAILY': 'DAILY', 'HOURLY': 'HOURLY', 'MINUTELY': 'MINUTELY', 'MONTHLY': 'MONTHLY', 'SECONDLY': 'SECONDLY', 'WEEKLY': 'WEEKLY', 'YEARLY': 'YEARLY'}#
classmethod from_ical(ical)[source]#
property ical_value: str#

Return the Python string value.

This property provides access to the underlying frequency string value, which must be one of the valid recurrence frequencies defined in RFC 5545.

Returns:

The frequency string value (SECONDLY, MINUTELY, HOURLY, DAILY,

WEEKLY, MONTHLY, or YEARLY).

Return type:

str

Example

>>> from icalendar.prop import vFrequency
>>> freq = vFrequency("DAILY")
>>> freq.ical_value
'DAILY'
>>> freq2 = vFrequency("WEEKLY")
>>> freq2.ical_value
'WEEKLY'

See also

RFC 5545 Section 3.3.10 for the FREQ value type specification.

params: Parameters#
classmethod parse_jcal_value(value)[source]#

Parse a jCal value for vFrequency.

Raises:

JCalParsingError – If the value is not a valid frequency.

Return type:

None

to_ical()[source]#