icalendar.prop.dt.period module#

PERIOD property type from RFC 5545.

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

Bases: TimeBase

A span of time, written either as a start and an end or as a start and a duration.

The value is a tuple of two datetime.datetime objects, or of a datetime and a datetime.timedelta. Whichever way it was written, start, end, and duration are all available, and by_duration says which of the two forms is written back out.

Conforming with RFC 5545 Section 3.3.9, a period is built from datetimes only, the start must come before the end, and a duration must be positive. A half written as a date does not conform. Such a half is read as midnight, in the timezone of the other half where it has one, so that a calendar that gets this wrong can still be read and written.

FREEBUSY holds periods directly. RDATE holds them through vDDDLists, which splits a comma separated list and hands each value to vDDDTypes. The halves themselves are parsed by vDatetime and vDuration.

Parameters:

per (tuple[date | datetime, date | datetime | timedelta]) – The start of the period, and either its end or its duration.
params (dict[str, Any] | None) – The parameters of the property.

Raises:

TypeError – If the start is not a date or a datetime, or if the end is not a date, a datetime, or a duration.
ValueError – If the start is after the end.

Examples

A period from 18:00:00 UTC on January 1, 1997 to 07:00:00 UTC on January 2, 1997, and one that starts at 18:00:00 UTC and lasts 5 hours and 30 minutes:

19970101T180000Z/19970102T070000Z
19970101T180000Z/PT5H30M

>>> from icalendar.prop import vPeriod
>>> period = vPeriod.from_ical("19970101T180000Z/19970102T070000Z")
>>> vPeriod(period).to_ical()
b'19970101T180000Z/19970102T070000Z'
>>> period = vPeriod.from_ical("19970101T180000Z/PT5H30M")
>>> vPeriod(period).duration
datetime.timedelta(seconds=19800)

A half written as a date is read as midnight:

>>> vPeriod(vPeriod.from_ical("19970101/19970102")).to_ical()
b'19970101T000000/19970102T000000'

Changed in version 7.3.0: A period written with dates is read as midnight.

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#: Whether the value is written as a duration rather than as an end.

default_value: ClassVar[str] = 'PERIOD'#

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

duration: timedelta#: The time between the start and the end.

end: datetime#: The end of the period, computed from the duration where there is one.

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

property ical_value: tuple[datetime, timedelta | datetime]#: Returns the period as a tuple of its start datetime and either its end datetime or duration.

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#: The start of the period.

to_ical()[source]#

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:: list