homeassistant.components.calendar.trigger.Timespan Class Reference

Public Member Functions
bool	__contains__ (self, datetime.datetime trigger)
str	__str__ (self)
Timespan	next_upcoming (self, datetime.datetime now, datetime.timedelta interval)
Timespan	with_offset (self, datetime.timedelta offset)

Detailed Description

A time range part of start/end dates, used for considering active events.

Definition at line 56 of file trigger.py.

Member Function Documentation

__contains__()

bool homeassistant.components.calendar.trigger.Timespan.__contains__	(		self,
		datetime.datetime	trigger
	)

Return true if the trigger time is within the time span.

Definition at line 69 of file trigger.py.

__str__()

str homeassistant.components.calendar.trigger.Timespan.__str__

(

self

)

Return a string representing the half open interval time span.

Definition at line 87 of file trigger.py.

next_upcoming()

Timespan homeassistant.components.calendar.trigger.Timespan.next_upcoming	(		self,
		datetime.datetime	now,
		datetime.timedelta	interval
	)

Return a subsequent time span following the current time span.

This effectively gives us a cursor like interface for advancing through
time using the interval as a hint. The returned span may have a
different interval than the one specified. For example, time span may
be longer during a daylight saving time transition, or may extend due to
drift if the current interval is old. The returned time span is
adjacent and non-overlapping.

Definition at line 73 of file trigger.py.

with_offset()

Timespan homeassistant.components.calendar.trigger.Timespan.with_offset	(		self,
		datetime.timedelta	offset
	)

Return a new interval shifted by the specified offset.

Definition at line 65 of file trigger.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/calendar/trigger.py