icalendar.prop.dt.period module#

PERIOD property type from RFC 5545.

class icalendar.prop.dt.period.vPeriod(per, params=None)[source]#

Bases: TimeBase

Period of Time

Value Name:

PERIOD

Purpose:

This value type is used to identify values that contain a precise period of time.

Format Definition:

This value type is defined by the following notation:

 period     = period-explicit / period-start

period-explicit = date-time "/" date-time
; [ISO.8601.2004] complete representation basic format for a
; period of time consisting of a start and end.  The start MUST
; be before the end.

period-start = date-time "/" dur-value
; [ISO.8601.2004] complete representation basic format for a
; period of time consisting of a start and positive duration
; of time.

Description:

If the property permits, multiple "period" values are specified by a COMMA-separated list of values. There are two forms of a period of time. First, a period of time is identified by its start and its end. This format is based on the [ISO.8601.2004] complete representation, basic format for "DATE- TIME" start of the period, followed by a SOLIDUS character followed by the "DATE-TIME" of the end of the period. The start of the period MUST be before the end of the period. Second, a period of time can also be defined by a start and a positive duration of time. The format is based on the [ISO.8601.2004] complete representation, basic format for the "DATE-TIME" start of the period, followed by a SOLIDUS character, followed by the [ISO.8601.2004] basic format for "DURATION" of the period.

Example

The period starting at 18:00:00 UTC, on January 1, 1997 and ending at 07:00:00 UTC on January 2, 1997 would be:

19970101T180000Z/19970102T070000Z

The period start at 18:00:00 on January 1, 1997 and lasting 5 hours and 30 minutes would be:

19970101T180000Z/PT5H30M

>>> from icalendar.prop import vPeriod
>>> period = vPeriod.from_ical('19970101T180000Z/19970102T070000Z')
>>> period = vPeriod.from_ical('19970101T180000Z/PT5H30M')

property FBTYPE: FBTYPE | str#

Specify the free or busy time type.

Description:: This parameter specifies the free or busy time type. The value FREE indicates that the time interval is free for scheduling. The value BUSY indicates that the time interval is busy because one or more events have been scheduled for that interval. The value BUSY-UNAVAILABLE indicates that the time interval is busy and that the interval can not be scheduled. The value BUSY-TENTATIVE indicates that the time interval is busy because one or more events have been tentatively scheduled for that interval. If not specified on a property that allows this parameter, the default is BUSY. Applications MUST treat x-name and iana-token values they don't recognize the same way as they would the BUSY value.

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

by_duration: bool#

default_value: ClassVar[str] = 'PERIOD'#

property dt#: Make this cooperate with the other vDDDTypes.

duration: timedelta#

end: datetime#

classmethod examples()[source]#

Examples of vPeriod.

Return type:: list[None]

static from_ical(ical, timezone=None)[source]#

classmethod from_jcal(jcal_property)[source]#

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

overlaps(other)[source]#

params: Parameters#

classmethod parse_jcal_value(jcal)[source]#

Parse a jCal value.

Raises:: JCalParsingError – If the period is not a list with exactly two items, or it can't parse a date-time or duration.
Return type:: tuple[datetime, datetime] | tuple[datetime, timedelta]

start: datetime#

to_ical()[source]#

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:: list

icalendar.prop.dt.period module#

This Page