Fixed #17262 -- Refactored tzinfo implementations.

This commit deprecates django.utils.tzinfo in favor of the more recent
django.utils.timezone which was introduced when Django gained support
for time zones.

django/utils/timezone.py

@@ -18,7 +18,8 @@ from django.conf import settings
 from django.utils import six
 
 __all__ = [
-    'utc', 'get_default_timezone', 'get_current_timezone',
+    'utc', 'get_fixed_timezone',
+    'get_default_timezone', 'get_current_timezone',
     'activate', 'deactivate', 'override',
     'is_naive', 'is_aware', 'make_aware', 'make_naive',
 ]
@@ -47,19 +48,45 @@ class UTC(tzinfo):
     def dst(self, dt):
         return ZERO
 
+class FixedOffset(tzinfo):
+    """
+    Fixed offset in minutes east from UTC. Taken from Python's docs.
+
+    Kept as close as possible to the reference version. __init__ was changed
+    to make its arguments optional, according to Python's requirement that
+    tzinfo subclasses can be instantiated without arguments.
+    """
+
+    def __init__(self, offset=None, name=None):
+        if offset is not None:
+            self.__offset = timedelta(minutes=offset)
+        if name is not None:
+            self.__name = name
+
+    def utcoffset(self, dt):
+        return self.__offset
+
+    def tzname(self, dt):
+        return self.__name
+
+    def dst(self, dt):
+        return ZERO
+
 class ReferenceLocalTimezone(tzinfo):
     """
-    Local time implementation taken from Python's docs.
+    Local time. Taken from Python's docs.
 
     Used only when pytz isn't available, and most likely inaccurate. If you're
     having trouble with this class, don't waste your time, just install pytz.
 
-    Kept identical to the reference version. Subclasses contain improvements.
+    Kept as close as possible to the reference version. __init__ was added to
+    delay the computation of STDOFFSET, DSTOFFSET and DSTDIFF which is
+    performed at import time in the example.
+
+    Subclasses contain further improvements.
     """
 
     def __init__(self):
-        # This code is moved in __init__ to execute it as late as possible
-        # See get_default_timezone().
         self.STDOFFSET = timedelta(seconds=-_time.timezone)
         if _time.daylight:
             self.DSTOFFSET = timedelta(seconds=-_time.altzone)
@@ -68,9 +95,6 @@ class ReferenceLocalTimezone(tzinfo):
         self.DSTDIFF = self.DSTOFFSET - self.STDOFFSET
         tzinfo.__init__(self)
 
-    def __repr__(self):
-        return "<LocalTimezone>"
-
     def utcoffset(self, dt):
         if self._isdst(dt):
             return self.DSTOFFSET
@@ -84,8 +108,7 @@ class ReferenceLocalTimezone(tzinfo):
             return ZERO
 
     def tzname(self, dt):
-        is_dst = False if dt is None else self._isdst(dt)
-        return _time.tzname[is_dst]
+        return _time.tzname[self._isdst(dt)]
 
     def _isdst(self, dt):
         tt = (dt.year, dt.month, dt.day,
@@ -103,6 +126,10 @@ class LocalTimezone(ReferenceLocalTimezone):
     error message is helpful.
     """
 
+    def tzname(self, dt):
+        is_dst = False if dt is None else self._isdst(dt)
+        return _time.tzname[is_dst]
+
     def _isdst(self, dt):
         try:
             return super(LocalTimezone, self)._isdst(dt)
@@ -116,6 +143,17 @@ class LocalTimezone(ReferenceLocalTimezone):
 utc = pytz.utc if pytz else UTC()
 """UTC time zone as a tzinfo instance."""
 
+def get_fixed_timezone(offset):
+    """
+    Returns a tzinfo instance with a fixed offset from UTC.
+    """
+    if isinstance(offset, timedelta):
+        offset = offset.seconds // 60
+    sign = '-' if offset < 0 else '+'
+    hhmm = '%02d%02d' % divmod(abs(offset), 60)
+    name = sign + hhmm
+    return FixedOffset(offset, name)
+
 # In order to avoid accessing the settings at compile time,
 # wrap the expression in a function and cache the result.
 _localtime = None
@@ -125,8 +163,6 @@ def get_default_timezone():
     Returns the default time zone as a tzinfo instance.
 
     This is the time zone defined by settings.TIME_ZONE.
-
-    See also :func:`get_current_timezone`.
     """
     global _localtime
     if _localtime is None:

django/utils/tzinfo.py

@@ -2,11 +2,18 @@
 
 from __future__ import unicode_literals
 
-import time
 from datetime import timedelta, tzinfo
+import time
+import warnings
 
 from django.utils.encoding import force_str, force_text, DEFAULT_LOCALE_ENCODING
 
+warnings.warn(
+    "django.utils.tzinfo will be removed in Django 1.9. "
+    "Use django.utils.timezone instead.",
+    PendingDeprecationWarning)
+
+
 # Python's doc say: "A tzinfo subclass must have an __init__() method that can
 # be called with no arguments". FixedOffset and LocalTimezone don't honor this
 # requirement. Defining __getinitargs__ is sufficient to fix copy/deepcopy as
@@ -15,6 +22,10 @@ from django.utils.encoding import force_str, force_text, DEFAULT_LOCALE_ENCODING
 class FixedOffset(tzinfo):
     "Fixed offset in minutes east from UTC."
     def __init__(self, offset):
+        warnings.warn(
+            "django.utils.tzinfo.FixedOffset will be removed in Django 1.9. "
+            "Use django.utils.timezone.get_fixed_timezone instead.",
+            PendingDeprecationWarning)
         if isinstance(offset, timedelta):
             self.__offset = offset
             offset = self.__offset.seconds // 60
@@ -48,6 +59,10 @@ class FixedOffset(tzinfo):
 class LocalTimezone(tzinfo):
     "Proxy timezone information from time module."
     def __init__(self, dt):
+        warnings.warn(
+            "django.utils.tzinfo.LocalTimezone will be removed in Django 1.9. "
+            "Use django.utils.timezone.get_default_timezone instead.",
+            PendingDeprecationWarning)
         tzinfo.__init__(self)
         self.__dt = dt
         self._tzname = self.tzname(dt)