icalendar.prop.recur.frequency module

FREQ value type of RECUR from RFC 5545.

class icalendar.prop.recur.frequency.vFrequency(value, encoding='utf-8', /, params=None)

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)

Return type:

Self

classmethod from_xcal(xml)

Parse xCal from RFC 6321.

Parameters:

xml (XCalParser | ElementAdapter | Element) – The XML to parse or a parser.

Raises:

XCalParsingError – If the provided xCal is invalid.

Return type:

VProp

property ical_value: str

Returns the frequency value as a string, for example, WEEKLY or DAILY.

See also

RFC 5545 Section 3.3.10 for the FREQ rule grammar.

params: Parameters

classmethod parse_jcal_value(value)

Parse a jCal value for vFrequency.

Raises:

JCalParsingError – If the value is not a valid frequency.

Return type:

Self

to_ical()

Return type:

bytes

to_xcal(element)

Add the xCal representation of this property according to RFC 6321.

Return type:

None