UTC-6
is an offsetUS/Central
is a time zoneCST
is a highly-context-dependent abbreviation:UTC-6
)UTC-5
)UTC+8
)Examples:
Australia/Adelaide
(+09:30)Asia/Kathmandu
(+05:45)Africa/Monrovia
(+00:44:30) (Before 1979)Portugal, 1992
WET (+0 STD) -> WEST (+1 DST) 1992-03-29
WEST (+1 DST) -> CET (+1 STD) 1992-09-27
Portugal, 1996
CET (+1 STD) -> WEST (+1 DST) 1996-03-31
WEST (+1 DST) -> WET (+0 STD) 1996-10-27
WET (+0 STD) -> WEST (+1 DST) 2012-04-29
WEST (+1 DST) -> WET (+0 STD) 2012-07-20
WET (+0 STD) -> WEST (+1 DST) 2012-08-20
WEST (+1 DST) -> WET (+0 STD) 2012-09-30
... and Morocco in 2013-present, and Egypt in 2010 and 2014, and Palestine in 2011.
dt_before = datetime(1995, 1, 1, 23, 59, tzinfo=tz.gettz('Pacific/Kiritimati'))
dt_after = add_absolute(dt_before, timedelta(minutes=2))
print(dt_before)
print(dt_after)
1995-01-01 23:59:00-10:00 1995-01-03 00:01:00+14:00
Also Samoa on January 29, 2011.
dt_before = datetime(1969, 9, 30, 11, 59, tzinfo=tz.gettz('Pacific/Kwajalein'))
dt_after = add_absolute(dt_before, timedelta(minutes=2))
print(dt_before)
print(dt_after)
1969-09-30 11:59:00+11:00 1969-09-30 12:01:00-12:00
from dateutil import rrule as rr
# Close of business in New York on weekdays
closing_times = rr.rrule(freq=rr.DAILY, byweekday=(rr.MO, rr.TU, rr.WE, rr.TH, rr.FR),
byhour=17, dtstart=datetime(2017, 3, 9, 17), count=5)
for dt in closing_times:
print(dt.replace(tzinfo=NYC))
2017-03-09 17:00:00-05:00 2017-03-10 17:00:00-05:00 2017-03-13 17:00:00-04:00 2017-03-14 17:00:00-04:00 2017-03-15 17:00:00-04:00
for dt in closing_times:
print(dt.replace(tzinfo=NYC).astimezone(UTC))
2017-03-09 22:00:00+00:00 2017-03-10 22:00:00+00:00 2017-03-13 21:00:00+00:00 2017-03-14 21:00:00+00:00 2017-03-15 21:00:00+00:00
tzinfo
¶tzinfo
.Information provided is a function of the datetime:
tzname
: The (usually abbreviated) name of the time zone at the given datetimeutcoffset
: The offset from UTC at the given datetimedst
: The size of the datetime's DST offset (usually 0 or 1 hour)tzinfo
implementation¶class ET(tzinfo):
def utcoffset(self, dt):
if self.isdaylight(dt):
return timedelta(hours=-4)
else:
return timedelta(hours=-5)
def dst(self, dt):
if self.isdaylight(dt):
return timedelta(hours=1)
else:
return timedelta(hours=0)
def tzname(self, dt):
return "EDT" if self.isdaylight(dt) else "EST"
def isdaylight(self, dt):
dst_start = datetime(dt.year, 1, 1) + rd.relativedelta(month=3, weekday=rd.SU(+2), hour=2)
dst_end = datetime(dt.year, 1, 1) + rd.relativedelta(month=11, weekday=rd.SU, hour=2)
return dst_start <= dt.replace(tzinfo=None) < dst_end
print(datetime(2017, 11, 4, 12, 0, tzinfo=ET()))
print(datetime(2017, 11, 5, 12, 0, tzinfo=ET()))
2017-11-04 12:00:00-04:00 2017-11-05 12:00:00-05:00
dt_before_utc = datetime(2017, 11, 5, 0, 30, tzinfo=ET()).astimezone(tz.tzutc())
dt_during = (dt_before_utc + timedelta(hours=1)).astimezone(ET()) # 1:30 EST
dt_after = (dt_before_utc + timedelta(hours=2)).astimezone(ET()) # 1:30 EDT
print(dt_during) # Lookin good!
print(dt_after) # OH NO!
2017-11-05 01:30:00-04:00 2017-11-05 02:30:00-05:00
Ambiguous times are times where the same "wall time" occurs twice, such as during a DST to STD transition.
dt1 = datetime(2004, 10, 31, 4, 30, tzinfo=UTC)
for i in range(4):
dt = (dt1 + timedelta(hours=i)).astimezone(NYC)
print('{} | {} | {}'.format(dt, dt.tzname(),
'Ambiguous' if tz.datetime_ambiguous(dt) else 'Unambiguous'))
2004-10-31 00:30:00-04:00 | EDT | Unambiguous 2004-10-31 01:30:00-04:00 | EDT | Ambiguous 2004-10-31 01:30:00-05:00 | EST | Ambiguous 2004-10-31 02:30:00-05:00 | EST | Unambiguous
fold
attribute of datetime
Whether you are on the fold side is a property of the datetime:
print_tzinfo(datetime(2004, 10, 31, 1, 30, tzinfo=NYC)) # fold=0
print_tzinfo(datetime(2004, 10, 31, 1, 30, fold=1, tzinfo=NYC))
2004-10-31 01:30:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h 2004-10-31 01:30:00-0500 tzname: EST; UTC Offset: -5.00h; DST: 0.0h
Note: fold=1
represents the second instance of an ambiguous datetime
dt1 = datetime(2004, 10, 30, 12, 0); dt1a = datetime(2004, 10, 31, 1, 30)
dt2 = datetime(2004, 10, 30, 12, 0); dt2a = datetime(2004, 10, 31, 1, 30)
dt3 = datetime(2004, 10, 30, 11, 0); dt3a = datetime(2004, 10, 31, 2, 30) # Unambiguous
print_dt_eq(dt1.replace(tzinfo=NYC), dt2.replace(tzinfo=NYC)) # Unambiguous
print_dt_eq(dt1.replace(tzinfo=NYC), dt3.replace(tzinfo=NYC))
print_dt_eq(dt1a.replace(tzinfo=NYC), dt2a.replace(tzinfo=NYC)) # Ambiguous
print_dt_eq(dt1a.replace(tzinfo=NYC), dt2a.replace(fold=1, tzinfo=NYC), bold=True)
print_dt_eq(dt1a.replace(tzinfo=NYC), dt3a.replace(tzinfo=NYC))
print_dt_eq(dt1.replace(tzinfo=NYC), dt2.replace(tzinfo=CHI)) # Unambiguous
print_dt_eq(dt1.replace(tzinfo=NYC), dt3.replace(tzinfo=CHI))
If either datetime is ambiguous, the result is always False
:
print_dt_eq(dt1a.replace(fold=1, tzinfo=NYC), dt3a.replace(tzinfo=CHI), bold=True)
LON = gettz('Europe/London')
x = datetime(2007, 3, 25, 1, 0, tzinfo=LON)
ts = x.timestamp()
y = datetime.fromtimestamp(ts, LON)
z = datetime.fromtimestamp(ts, gettz('Europe/London'))
x == y
False
x == z
True
y == z
True
Imaginary times are wall times that don't exist in a given time zone, such as during an STD to DST transition.
dt1 = datetime(2004, 4, 4, 6, 30, tzinfo=UTC)
for i in range(3):
dt = (dt1 + timedelta(hours=i)).astimezone(NYC)
print('{} | {} '.format(dt, dt.tzname()))
2004-04-04 01:30:00-05:00 | EST 2004-04-04 03:30:00-04:00 | EDT 2004-04-04 04:30:00-04:00 | EDT
print(datetime(2007, 3, 25, 1, 0, tzinfo=LON))
2007-03-25 01:00:00+01:00
print(datetime(2007, 3, 25, 0, 0, tzinfo=UTC).astimezone(LON))
print(datetime(2007, 3, 25, 1, 0, tzinfo=UTC).astimezone(LON))
2007-03-25 00:00:00+00:00 2007-03-25 02:00:00+01:00
print('x (LON): {}'.format(x))
print('x (UTC): {}'.format(x.astimezone(UTC)))
print('x (LON->UTC->LON): {}'.format(x.astimezone(UTC).astimezone(LON)))
x (LON): 2007-03-25 01:00:00+01:00 x (UTC): 2007-03-25 00:00:00+00:00 x (LON->UTC->LON): 2007-03-25 00:00:00+00:00
print('y: {}'.format(y))
print('z: {}'.format(z))
y: 2007-03-25 00:00:00+00:00 z: 2007-03-25 00:00:00+00:00
x.tzinfo is y.tzinfo
True
x.tzinfo is z.tzinfo
False
dateutil
¶In dateutil
's suite of tzinfo
objects, you can attach time zones in the constructor if you have a wall time:
dt = datetime(2017, 8, 11, 14, tzinfo=tz.gettz('US/Pacific'))
print_tzinfo(dt)
2017-08-11 14:00:00-0700 tzname: PDT; UTC Offset: -7.00h; DST: 1.0h
If you have a naive wall time, or a wall time in another zone that you want to translate without shifting the offset, use datetime.replace
:
print_tzinfo(dt.replace(tzinfo=tz.gettz('US/Eastern')))
2017-08-11 14:00:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
If you have an absolute time, in UTC or otherwise, use datetime.astimezone()
:
print_tzinfo(dt.astimezone(tz.gettz('US/Eastern')))
2017-08-11 17:00:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
pytz
¶In pytz
, datetime.astimezone()
still works exactly as expected:
print_tzinfo(dt.astimezone(pytz.timezone('US/Eastern')))
2017-08-11 17:00:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
But the constructor or .replace
methods fail horribly:
print_tzinfo(dt.replace(tzinfo=pytz.timezone('US/Eastern')))
2017-08-11 14:00:00-0456 tzname: LMT; UTC Offset: -4.93h; DST: 0.0h
pytz
's time zone model¶tzinfo
s are all static offsetstzinfo
is attached by the time zone object itself:LOS_p = pytz.timezone('America/Los_Angeles')
dt = LOS_p.localize(datetime(2017, 8, 11, 14, 0))
print_tzinfo(dt)
2017-08-11 14:00:00-0700 tzname: PDT; UTC Offset: -7.00h; DST: 1.0h
normalize()
datetimes after you've done some arithmetic on them:dt_add = dt + timedelta(days=180)
print_tzinfo(dt_add)
2018-02-07 14:00:00-0700 tzname: PDT; UTC Offset: -7.00h; DST: 1.0h
print_tzinfo(LOS_p.normalize(dt_add))
2018-02-07 13:00:00-0800 tzname: PST; UTC Offset: -8.00h; DST: 0.0h
Both dateutil
and pytz
will automatically give you the right absolute time if converting from an absolute time.
dt1 = datetime(2004, 10, 31, 6, 30, tzinfo=UTC) # This is in the fold in EST
dt_dateutil = dt1.astimezone(tz.gettz('US/Eastern'))
dt_pytz = dt1.astimezone(pytz.timezone('US/Eastern'))
print(repr(dt_dateutil))
print_tzinfo(dt_dateutil)
datetime.datetime(2004, 10, 31, 1, 30, fold=1, tzinfo=tzfile('/usr/share/zoneinfo/US/Eastern')) 2004-10-31 01:30:00-0500 tzname: EST; UTC Offset: -5.00h; DST: 0.0h
print(repr(dt_pytz)) # Note that pytz doesn't set fold
print_tzinfo(dt_pytz)
datetime.datetime(2004, 10, 31, 1, 30, tzinfo=<DstTzInfo 'US/Eastern' EST-1 day, 19:00:00 STD>) 2004-10-31 01:30:00-0500 tzname: EST; UTC Offset: -5.00h; DST: 0.0h
dateutil
¶For backwards compatibility, dateutil
provides a tz.enfold
method to add a fold
attribute if necessary:
dt = datetime(2004, 10, 31, 1, 30, tzinfo=tz.gettz('US/Eastern'))
tz.enfold(dt)
datetime.datetime(2004, 10, 31, 1, 30, fold=1, tzinfo=tzfile('/usr/share/zoneinfo/US/Eastern'))
Python 2.7.12
Type "help", "copyright", "credits" or "license" for more information.
>>> from datetime import datetime
>>> from dateutil import tz
>>> dt = datetime(2004, 10, 31, 1, 30, tzinfo=tz.gettz('US/Eastern'))
>>> tz.enfold(dt)
_DatetimeWithFold(2004, 10, 31, 1, 30, tzinfo=tzfile('/usr/share/zoneinfo/US/Eastern'))
>>> tz.enfold(dt).tzname()
'EST'
>>> dt.tzname()
'EDT'
dateutil
¶To detect ambiguous times, dateutil
provides tz.datetime_ambiguous
tz.datetime_ambiguous(datetime(2004, 10, 31, 1, 30, tzinfo=NYC))
True
tz.datetime_ambiguous(datetime(2004, 10, 31, 1, 30), NYC)
True
dt_0 = datetime(2004, 10, 31, 0, 30, tzinfo=NYC)
for i in range(3):
dt_i = dt_0 + timedelta(hours=i)
dt_i = tz.enfold(dt_i, tz.datetime_ambiguous(dt_i))
print('{} (fold={})'.format(dt_i, dt_i.fold))
2004-10-31 00:30:00-04:00 (fold=0) 2004-10-31 01:30:00-05:00 (fold=1) 2004-10-31 02:30:00-05:00 (fold=0)
Note: fold
is ignored when the datetime
is not ambiguous:
for i in range(3):
dt_i = tz.enfold(dt_0 + timedelta(hours=i), fold=1)
print('{} (fold={})'.format(dt_i, dt_i.fold))
2004-10-31 00:30:00-04:00 (fold=1) 2004-10-31 01:30:00-05:00 (fold=1) 2004-10-31 02:30:00-05:00 (fold=1)
pytz
¶When localizing times, pytz
defaults to standard time:
dt_pytz = NYC_pytz.localize(datetime(2004, 10, 31, 1, 30))
print_tzinfo(dt_pytz)
2004-10-31 01:30:00-0500 tzname: EST; UTC Offset: -5.00h; DST: 0.0h
To get a time zone in daylight time, pass is_dst=True
to localize
:
dt_pytz = NYC_pytz.localize(datetime(2004, 10, 31, 1, 30), is_dst=True)
print_tzinfo(dt_pytz)
2004-10-31 01:30:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
If is_dst=None
is passed to localize
, pytz
raises an AmbiguousTimeError
:
for hour in (0, 1):
dt = datetime(2004, 10, 31, hour, 30)
try:
NYC_pytz.localize(dt, is_dst=None)
print('{} | {}'.format(dt, "Unambiguous"))
except pytz.AmbiguousTimeError:
print('{} | {}'.format(dt, "Ambiguous"))
2004-10-31 00:30:00 | Unambiguous 2004-10-31 01:30:00 | Ambiguous
dateutil
¶dateutil
provides a tz.datetime_exists()
function to tell you whether you've constructed an imaginary datetime
:
dt_0 = datetime(2004, 4, 4, 1, 30, tzinfo=NYC)
for i in range(3):
dt = dt_0 + timedelta(hours=i)
print('{} ({})'.format(dt, 'Exists' if tz.datetime_exists(dt) else 'Imaginary'))
2004-04-04 01:30:00-05:00 (Exists) 2004-04-04 02:30:00-04:00 (Imaginary) 2004-04-04 03:30:00-04:00 (Exists)
Generally for imaginary datetimes, you either want to skip over them or "slide forward":
def resolve_imaginary(dt): # This is a planned feature in dateutil 2.7.0
if dt.tzinfo is not None and not tz.datetime_exists(dt):
curr_offset = dt.utcoffset()
old_offset = (dt - timedelta(hours=24)).utcoffset()
dt += curr_offset - old_offset
return dt
print(resolve_imaginary(datetime(2004, 4, 4, 2, 30, tzinfo=NYC)))
2004-04-04 03:30:00-04:00
pytz
¶When using localize
on an imaginary datetime, pytz
will create an imaginary time and use is_dst
to decide what offset to assign it:
print(NYC_pytz.localize(datetime(2004, 4, 4, 2, 30), is_dst=True))
print(NYC_pytz.localize(datetime(2004, 4, 4, 2, 30), is_dst=False))
2004-04-04 02:30:00-04:00 2004-04-04 02:30:00-05:00
If you have a non-existent date, normalize()
will slide it forward or backwards, depending on the value passed to is_dst
(default is False
):
dt_imag_dst = NYC_pytz.localize(datetime(2004, 4, 4, 2, 30), is_dst=True)
dt_imag_std = NYC_pytz.localize(datetime(2004, 4, 4, 2, 30), is_dst=False)
print(NYC_pytz.normalize(dt_imag_dst))
print(NYC_pytz.normalize(dt_imag_std))
2004-04-04 01:30:00-05:00 2004-04-04 03:30:00-04:00
pytz
¶If you pass is_dst=None
, pytz
will throw a NonExistentTimeError
:
dt_0 = datetime(2004, 4, 4, 1, 30)
for i in range(3):
try:
dt = NYC_pytz.localize(dt_0 + timedelta(hours=i), is_dst=None)
exists = True
except pytz.NonExistentTimeError:
exists = False
print('{} ({})'.format(dt, 'Exists' if exists else 'Imaginary'))
2004-04-04 01:30:00-05:00 (Exists) 2004-04-04 01:30:00-05:00 (Imaginary) 2004-04-04 03:30:00-04:00 (Exists)
pytz
¶dateutil.tz.datetime_exists()
works with pytz
zones, too
dt_pytz_real = NYC_pytz.localize(datetime(2004, 4, 4, 1, 30))
dt_pytz_imag = NYC_pytz.localize(datetime(2004, 4, 4, 2, 30))
print('Real: {}'.format(tz.datetime_exists(dt_pytz_real)))
print('Imaginary: {}'.format(tz.datetime_exists(dt_pytz_imag)))
Real: True Imaginary: False
And will detect non-normalized datetimes
:
dt_nn = dt_pytz_real + timedelta(hours=3) # Needs to be normalized to DST
print('{}: {}'.format(dt_nn, 'Exists' if tz.datetime_exists(dt_nn) else 'Imaginary'))
2004-04-04 04:30:00-05:00: Imaginary
dateutil
's tzinfo
implementations¶# tz.tzutc() is equivalent to pytz.UTC or timezone.utc
dt = datetime(2014, 12, 19, 22, 30, tzinfo=tz.tzutc())
print_tzinfo(dt)
2014-12-19 22:30:00+0000 tzname: UTC; UTC Offset: 0.00h; DST: 0.0h
Static offsets represent zones with a fixed offset from UTC, and takes a tzname or either number of seconds or a timedelta
:
JST = tzoffset('JST', 32400) # Japan Standard Time is year round
IST = tzoffset('IST', # India Standard Time is year round
timedelta(hours=5, minutes=30))
EST = tzoffset(None, timedelta(hours=-5)) # Can use None as a name
dt = datetime(2016, 7, 17, 12, 15, tzinfo=tzutc())
print_tzinfo(dt.astimezone(JST))
print_tzinfo(dt.astimezone(IST))
print_tzinfo(dt.astimezone(EST))
2016-07-17 21:15:00+0900 tzname: JST; UTC Offset: 9.00h; DST: 0.0h 2016-07-17 17:45:00+0530 tzname: IST; UTC Offset: 5.50h; DST: 0.0h 2016-07-17 07:15:00-0500 tzname: None; UTC Offset: -5.00h; DST: 0.0h
In Python 3.2, timezone
objects were introduced to provide ready-made tzinfo
subclasses for the simple case of static offsets from UTC.
from datetime import timezone
dt = datetime(2014, 12, 19, 22, 30, tzinfo=timezone.utc) # Equivalent to pytz.UTC or dateutil.tz.tzutc()
print_tzinfo(dt)
2014-12-19 22:30:00+0000 tzname: UTC; UTC Offset: 0.00h; DST: None
JST = timezone(timedelta(hours=9), 'JST') # Japan Standard Time is year round
IST = timezone(timedelta(hours=5, minutes=30), # India Standard Time is year round
'IST')
EST = timezone(timedelta(hours=-5)) # Without a name, it's UTC-hh:mm
dt = datetime(2016, 7, 17, 12, 15, tzinfo=tzutc())
print_tzinfo(dt.astimezone(JST)); print()
print_tzinfo(dt.astimezone(IST)); print()
print_tzinfo(dt.astimezone(EST))
2016-07-17 21:15:00+0900 tzname: JST; UTC Offset: 9.00h; DST: None 2016-07-17 17:45:00+0530 tzname: IST; UTC Offset: 5.50h; DST: None 2016-07-17 07:15:00-0500 tzname: UTC-05:00; UTC Offset: -5.00h; DST: None
The tz.tzlocal()
class is a tzinfo
implementation that uses the OS hooks in Python's time
module to get the local system time.
# Temporarily changes the TZ file on *nix systems.
from helper_functions import TZEnvContext
print_tzinfo(dt.astimezone(tz.tzlocal()))
2016-07-17 08:15:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
with TZEnvContext('UTC'):
print_tzinfo(dt.astimezone(tz.tzlocal()))
2016-07-17 12:15:00+0000 tzname: UTC; UTC Offset: 0.00h; DST: 0.0h
with TZEnvContext('PST8PDT'):
print_tzinfo((dt + timedelta(days=180)).astimezone(tz.tzlocal()))
2017-01-13 04:15:00-0800 tzname: PST; UTC Offset: -8.00h; DST: 0.0h
tz.win.tzwinlocal()
directly queries the Windows registry for its time zone data and uses that to construct a tzinfo
.
Fixes this bug:
>>> dt = datetime(2014, 2, 11, 17, 0)
>>> print(dt.replace(tzinfo=tz.tzlocal()).tzname())
Eastern Standard Time
>>> print(dt.replace(tzinfo=tz.win.tzwinlocal()).tzname())
Eastern Standard Time
>>> with TZWinContext('Pacific Standard Time'):
... print(dt.replace(tzinfo=tz.tzlocal()).tzname())
... print(dt.replace(tzinfo=tz.win.tzwinlocal()).tzname())
Eastern Standard Time
Pacific Standard Time
The dateutil.tz.tzfile
class provides support for IANA zoneinfo
binaries (shipped with *nix systems).
DO NOT USE tz.tzfile
directly - use tz.gettz()
NYC = tz.gettz('America/New_York')
NYC
tzfile('/usr/share/zoneinfo/America/New_York')
The IANA database contains historical time zone transitions:
print_tzinfo(datetime(2017, 8, 12, 14, tzinfo=NYC)) # Eastern Daylight Time
2017-08-12 14:00:00-0400 tzname: EDT; UTC Offset: -4.00h; DST: 1.0h
print_tzinfo(datetime(1944, 1, 6, 12, 15, tzinfo=NYC)) # Eastern War Time
1944-01-06 12:15:00-0400 tzname: EWT; UTC Offset: -4.00h; DST: 1.0h
print_tzinfo(datetime(1901, 9, 6, 16, 7, tzinfo=NYC)) # Local solar mean
1901-09-06 16:07:00-0456 tzname: LMT; UTC Offset: -4.93h; DST: 0.0h
tz.gettz()
¶The most general way to get a time zone is to pass the relevant timezone string to the gettz() function, which will try parsing it a number of different ways until it finds a relevant string.
tz.gettz() # Passing nothing gives you local time
tzfile('/etc/localtime')
# If your TZSTR is an an Olson file, it is prioritized over the /etc/localtime tzfile.
with TZEnvContext('CST6CDT'):
print(gettz())
tzfile('/usr/share/zoneinfo/CST6CDT')
# If it doesn't find a tzfile, but it finds a valid abbreviation for the local zone,
# it returns tzlocal()
with TZEnvContext('LMT4'):
print(gettz('LMT'))
tzlocal()
# Retrieve IANA zone:
print(gettz('Pacific/Kiritimati'))
tzfile('/usr/share/zoneinfo/Pacific/Kiritimati')
# Directly parse a TZ variable:
print(gettz('AEST-10AEDT-11,M10.1.0/2,M4.1.0/3'))
tzstr('AEST-10AEDT-11,M10.1.0/2,M4.1.0/3')