Class: QgsDateRange

class qgis.core.QgsDateRange(begin: Union[QDate, datetime.date], end: Union[QDate, datetime.date], includeBeginning: bool = True, includeEnd: bool = True)

Bases: sip.wrapper

Constructor for QgsTemporalRange. The begin and end are specified, and optionally whether or not these bounds are included in the range.

Note

in Python begin and end must be provided.

QgsDateRange(QgsDateRange)

QgsRange which stores a range of dates.

Invalid QDates as the beginning or end are permitted. In this case, the bound is considered to be infinite. E.g. QgsDateRange(QDate(),QDate(2017,1,1)) is treated as a range containing all dates before 2017-1-1. QgsDateRange(QDate(2017,1,1),QDate()) is treated as a range containing all dates after 2017-1-1.

See also

QgsDateTimeRange

New in version 3.0.

Parameters
  • begin (Union[QDate) –

  • end (Union[QDate) –

  • includeBeginning (bool = True) –

  • includeEnd

begin(self) → QDate

Returns the beginning of the range.

See also

end()

Return type

QDate

contains(self, other: QgsDateRange) → bool

Returns True if this range contains another range.

contains(self, element: Union[QDate, datetime.date]) -> bool Returns True if this range contains a specified element.

Parameters

other (QgsDateRange) –

Return type

bool

end(self) → QDate

Returns the upper bound of the range.

See also

begin()

See also

includeEnd()

Return type

QDate

includeBeginning(self) → bool

Returns True if the beginning is inclusive, or False if the beginning is exclusive.

See also

begin()

See also

includeEnd()

Return type

bool

includeEnd(self) → bool

Returns True if the end is inclusive, or False if the end is exclusive.

See also

end()

Return type

bool

isEmpty(self) → bool

Returns True if the range is empty, ie the beginning equals (or exceeds) the end and either of the bounds are exclusive. A range with both invalid beginning and end is considered infinite and not empty.

Return type

bool

isInfinite(self) → bool

Returns True if the range consists of all possible values.

See also

isEmpty()

See also

isInstant()

Return type

bool

isInstant(self) → bool

Returns True if the range consists only of a single instant.

See also

isEmpty()

See also

isInfinite()

Return type

bool

overlaps(self, other: QgsDateRange) → bool

Returns True if this range overlaps another range.

Parameters

other (QgsDateRange) –

Return type

bool