class documentation

class tzrange(tzrangebase): (source)

Known subclasses: dateutil.tz.tz.tzstr

View In Hierarchy

The ``tzrange`` object is a time zone specified by a set of offsets and abbreviations, equivalent to the way the ``TZ`` variable can be specified in POSIX-like systems, but using Python delta objects to specify DST start, end and offsets. :param stdabbr: The abbreviation for standard time (e.g. ``'EST'``). :param stdoffset: An integer or :class:`datetime.timedelta` object or equivalent specifying the base offset from UTC. If unspecified, +00:00 is used. :param dstabbr: The abbreviation for DST / "Summer" time (e.g. ``'EDT'``). If specified, with no other DST information, DST is assumed to occur and the default behavior or ``dstoffset``, ``start`` and ``end`` is used. If unspecified and no other DST information is specified, it is assumed that this zone has no DST. If this is unspecified and other DST information is *is* specified, DST occurs in the zone but the time zone abbreviation is left unchanged. :param dstoffset: A an integer or :class:`datetime.timedelta` object or equivalent specifying the UTC offset during DST. If unspecified and any other DST information is specified, it is assumed to be the STD offset +1 hour. :param start: A :class:`relativedelta.relativedelta` object or equivalent specifying the time and time of year that daylight savings time starts. To specify, for example, that DST starts at 2AM on the 2nd Sunday in March, pass: ``relativedelta(hours=2, month=3, day=1, weekday=SU(+2))`` If unspecified and any other DST information is specified, the default value is 2 AM on the first Sunday in April. :param end: A :class:`relativedelta.relativedelta` object or equivalent representing the time and time of year that daylight savings time ends, with the same specification method as in ``start``. One note is that this should point to the first time in the *standard* zone, so if a transition occurs at 2AM in the DST zone and the clocks are set back 1 hour to 1AM, set the ``hours`` parameter to +1. **Examples:** .. testsetup:: tzrange from dateutil.tz import tzrange, tzstr .. doctest:: tzrange >>> tzstr('EST5EDT') == tzrange("EST", -18000, "EDT") True >>> from dateutil.relativedelta import * >>> range1 = tzrange("EST", -18000, "EDT") >>> range2 = tzrange("EST", -18000, "EDT", -14400, ... relativedelta(hours=+2, month=4, day=1, ... weekday=SU(+1)), ... relativedelta(hours=+1, month=10, day=31, ... weekday=SU(-1))) >>> tzstr('EST5EDT') == range1 == range2 True

Method __eq__ Undocumented
Method __init__ Undocumented
Method transitions For a given year, get the DST on and off transition times, expressed always on the standard time side. For zones with no transitions, this function returns ``None``.
Instance Variable hasdst Undocumented
Instance Variable _dst_abbr Undocumented
Instance Variable _dst_base_offset_ Undocumented
Instance Variable _dst_offset Undocumented
Instance Variable _end_delta Undocumented
Instance Variable _start_delta Undocumented
Instance Variable _std_abbr Undocumented
Instance Variable _std_offset Undocumented
Property _dst_base_offset Undocumented

Inherited from tzrangebase:

Method __ne__ Undocumented
Method __repr__ Undocumented
Method dst Undocumented
Method fromutc Given a datetime in UTC, return local time
Method is_ambiguous Whether or not the "wall time" of a given datetime is ambiguous in this zone.
Method tzname Undocumented
Method utcoffset Undocumented
Class Variable __hash__ Undocumented
Method _isdst Undocumented
Method _naive_isdst Undocumented

Inherited from _tzinfo (via tzrangebase):

Method _fold Undocumented
Method _fold_status Determine the fold status of a "wall" datetime, given a representation of the same datetime as a (naive) UTC datetime. This is calculated based on the assumption that ``dt.utcoffset() - dt.dst()`` is constant for all datetimes, and that this offset is the actual number of hours separating ``dt_utc`` and ``dt_wall``.
Method _fromutc Given a timezone-aware datetime in a given timezone, calculates a timezone-aware datetime in a new timezone.
def __eq__(self, other): (source)

Undocumented

def __init__(self, stdabbr, stdoffset=None, dstabbr=None, dstoffset=None, start=None, end=None): (source)
def transitions(self, year): (source)

For a given year, get the DST on and off transition times, expressed always on the standard time side. For zones with no transitions, this function returns ``None``. :param year: The year whose transitions you would like to query. :return: Returns a :class:`tuple` of :class:`datetime.datetime` objects, ``(dston, dstoff)`` for zones with an annual DST transition, or ``None`` for fixed offset zones.

hasdst = (source)
overridden in dateutil.tz.tz.tzstr

Undocumented

_dst_abbr = (source)

Undocumented

_dst_base_offset_ = (source)

Undocumented

_dst_offset = (source)

Undocumented

_end_delta = (source)
overridden in dateutil.tz.tz.tzstr

Undocumented

_start_delta = (source)
overridden in dateutil.tz.tz.tzstr

Undocumented

_std_abbr = (source)

Undocumented

_std_offset = (source)

Undocumented