icalendar.prop.dt.types module

Combined property type for the date and time properties from RFC 5545.

class icalendar.prop.dt.types.vDDDTypes(dt, params=None)

Bases: TimeBase

A combined Datetime, Date or Duration parser/generator. Their format cannot be confused, and often values can be of either types. So this is practical.

property VALUE: str

The VALUE parameter or the default.

Purpose:

VALUE explicitly specify the value type format for a property value.

Description:

This parameter specifies the value type and format of the property value. The property values MUST be of a single value type. For example, a "RDATE" property cannot have a combination of DATE-TIME and TIME value types.

If the property's value is the default value type, then this parameter need not be specified. However, if the property's default value type is overridden by some other allowable value type, then this parameter MUST be specified.

Applications MUST preserve the value data for x-name and iana-token values that they don't recognize without attempting to interpret or parse the value data.

Returns:

The VALUE parameter or the default.

Examples

The VALUE defaults to the name of the property. Note that it is case-insensitive but always uppercase.

>>> from icalendar import vBoolean
>>> b = vBoolean(True)
>>> b.VALUE
'BOOLEAN'

Setting the VALUE parameter of a typed property usually does not make sense. For convenience, using this property, the value will be converted to an uppercase string. If you have some custom property, you might use it like this:

>>> from icalendar import vUnknown, Event
>>> v = vUnknown("Some property text.")
>>> v.VALUE = "x-type"  # lower case
>>> v.VALUE
'X-TYPE'
>>> event = Event()
>>> event.add("x-prop", v)
>>> print(event.to_ical())
BEGIN:VEVENT
X-PROP;VALUE=X-TYPE:Some property text.
END:VEVENT

default_value: ClassVar[str] = 'DATE-TIME'

dt: datetime | date | timedelta | time | tuple[datetime, datetime] | tuple[datetime, timedelta]

property dts: list

Compatibility method to return a list of datetimes.

classmethod examples()

Examples of vDDDTypes.

Return type:

list[vDDDTypes]

classmethod from_ical(ical, timezone=None)

classmethod from_jcal(jcal_property)

Parse jCal from RFC 7265.

Parameters:

jcal_property (list) – The jCal property to parse.

Raises:

JCalParsingError – If the provided jCal is invalid.

Return type:

None

params: Parameters

classmethod parse_jcal_value(jcal)

Parse a jCal value.

Raises:

JCalParsingError – If the value can't be parsed as either a date, time, date-time, duration, or period.

Return type:

timedelta

property td: timedelta

Compatibility property returning self.dt.

This class is used to replace different time components. Some of them contain a datetime or date (.dt). Some of them contain a timedelta (.td). This property allows interoperability.

to_ical()

Return the ical representation.

Return type:

bytes

to_jcal(name)

The jCal representation of this property according to RFC 7265.

Return type:

list

to_property_type()

Convert to a property type.

Raises:

ValueError – If the type is unknown.

Return type:

vDatetime | vDate | vDuration | vTime | vPeriod