Preparation for v0.7. Corrected a bug where datetime.max.time() resulted in incorrect date/time. Changed tests to compare time_override models via string to prevent future regressions. Added choices GROUPED_ALL_TIMEZONES_CHOICES and GROUPED_COMMON_TIMEZONES_CHOICES.

michaeljohnbarr · michaeljohnbarr · commit 2bdf78b14124 · 2015-02-24T15:11:41.000-05:00
diff --git a/README.rst b/README.rst
@@ -40,7 +40,7 @@ welcomed and appreciated.
 Documentation
 -------------
 
-Documentation for django-timezone-utils is available at `Read the Docs <https://django-timezone-utils.readthedocs.org/>`_
+Documentation for django-timezone-utils is available at `Read the Docs <https://django-timezone-utils.readthedocs.org/>`_.
 
 Inspiration
 -----------
@@ -107,6 +107,7 @@ Contributors
 
 Changelog
 ---------
+- 0.7 Corrected a bug where datetime.max.time() resulted in incorrect date/time. Changed tests to compare time_override models via string to prevent future regressions. Added choices ``GROUPED_ALL_TIMEZONES_CHOICES`` and ``GROUPED_COMMON_TIMEZONES_CHOICES``.
 - 0.6 Added RTD documentation. LinkedTZDateTimeField now returns the datetime object in the overidden timezone and time.
 - 0.5 Bug fix: time override on datetime.min.time() failed to set time properly
 - 0.4 Removed support for Python 2.5
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,9 +51,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.6'
+version = '0.7'
 # The full version, including alpha/beta/rc tags.
-release = '0.6'
+release = '0.7'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/tests/models.py b/tests/models.py
@@ -164,3 +164,20 @@ class ModelWithLocalTZCharField(models.Model):
         default=settings.TEST_DATETIME,
         populate_from='timezone'
     )
+
+
+class TZTimeFramedModel(models.Model):
+    other_model = models.ForeignKey(
+        to='tests.TZWithGoodStringDefault',
+        related_name='fk_to_tz_too'
+    )
+    start = LinkedTZDateTimeField(
+        default=settings.TEST_DATETIME,
+        populate_from=get_other_model_timezone,
+        time_override=datetime.min.time()
+    )
+    end = LinkedTZDateTimeField(
+        default=settings.TEST_DATETIME,
+        populate_from=get_other_model_timezone,
+        time_override=datetime.max.time()
+    )
diff --git a/tests/test_choices.py b/tests/test_choices.py
@@ -5,13 +5,16 @@
 from datetime import datetime
 from operator import itemgetter
 import pytz
+import re
 
 # Django
 from django.test import TestCase
 
 # App
 from timezone_utils.choices import (ALL_TIMEZONES_CHOICES,
                                     COMMON_TIMEZONES_CHOICES,
+                                    GROUPED_ALL_TIMEZONES_CHOICES,
+                                    GROUPED_COMMON_TIMEZONES_CHOICES,
                                     PRETTY_ALL_TIMEZONES_CHOICES,
                                     PRETTY_COMMON_TIMEZONES_CHOICES,
                                     TIMEZONE_OFFSET_REGEX, get_choices)
@@ -113,7 +116,51 @@ def test_PRETTY_COMMON_TIMEZONES_CHOICES_values(self):
                 )
             )
 
-    def test_get_choices_values(self):
+    def test_GROUPED_ALL_TIMEZONES_CHOICES_group_name(self):
+        group_name_re = re.compile(r'GMT(\+|-)\d{2}:\d{2}')
+        for group_name in map(lambda x: x[0], GROUPED_ALL_TIMEZONES_CHOICES):
+            self.assertNotEqual(
+                group_name_re.match(group_name),
+                None
+            )
+
+    def test_GROUPED_COMMON_TIMEZONES_CHOICES_group_name(self):
+        group_name_re = re.compile(r'GMT(\+|-)\d{2}:\d{2}')
+        for group_name in map(lambda x: x[0], GROUPED_COMMON_TIMEZONES_CHOICES):
+            self.assertNotEqual(
+                group_name_re.match(group_name),
+                None
+            )
+
+    def test_GROUPED_ALL_TIMEZONES_CHOICES_values(self):
+        for name, display in map(
+            lambda v: v[0],
+            map(lambda x: x[1], GROUPED_ALL_TIMEZONES_CHOICES)
+        ):
+            self.assertIn(
+                name,
+                pytz.all_timezones
+            )
+            self.assertIn(
+                display,
+                pytz.all_timezones
+            )
+
+    def test_GROUPED_COMMON_TIMEZONES_CHOICES_values(self):
+        for name, display in map(
+            lambda v: v[0],
+            map(lambda x: x[1], GROUPED_COMMON_TIMEZONES_CHOICES)
+        ):
+            self.assertIn(
+                name,
+                pytz.common_timezones
+            )
+            self.assertIn(
+                display,
+                pytz.common_timezones
+            )
+
+    def test_get_choices_values_ungrouped(self):
         choices = get_choices(pytz.common_timezones)
         values = map(itemgetter(0), choices)
         for value in values:
diff --git a/tests/test_valid_tzdatetimefield.py b/tests/test_valid_tzdatetimefield.py
@@ -15,7 +15,7 @@
 from .models import (ModelWithDateTimeOnly, CallableTimeStampedModel,
                      StaticTimeStampedModel, ModelWithForeignKeyToTimeZone,
                      NullModelWithDateTimeOnly, ModelWithLocalTimeZone,
-                     ModelWithLocalTZCharField)
+                     ModelWithLocalTZCharField, TZTimeFramedModel)
 
 
 # ==============================================================================
@@ -31,6 +31,11 @@ def setUp(self):
 
         location = TZWithGoodStringDefault.objects.create()
         ModelWithForeignKeyToTimeZone.objects.create(other_model=location)
+        TZTimeFramedModel.objects.create(
+            start=make_aware(datetime(2014, 1, 1), pytz.timezone('US/Eastern')),
+            end=make_aware(datetime(2014, 12, 31), pytz.timezone('US/Eastern')),
+            other_model=location
+        )
 
     def test_that_model_timestamp_is_unaltered(self):
         """Make sure that we aren't modifying the timezone if one is not
@@ -127,3 +132,14 @@ def test_to_python_conversion(self):
             str(model_instance.timestamp),
             '2013-12-31 19:00:00-05:00'
         )
+
+    def test_full_overrides(self):
+        model_instance = TZTimeFramedModel.objects.get()
+        self.assertEqual(
+            str(model_instance.start),
+            '2014-01-01 00:00:00-05:00'
+        )
+        self.assertEqual(
+            str(model_instance.end),
+            '2014-12-31 23:59:59.999999-05:00'
+        )
diff --git a/timezone_utils/__init__.py b/timezone_utils/__init__.py
@@ -1,2 +1,2 @@
-__version__ = (0, 6)
+__version__ = (0, 7)
 VERSION = '.'.join(map(str, __version__))
diff --git a/timezone_utils/choices.py b/timezone_utils/choices.py
@@ -2,11 +2,14 @@
 # IMPORTS
 # ==============================================================================
 # Python
+from collections import defaultdict, namedtuple
 from datetime import datetime
+from operator import attrgetter
 import pytz
 import re
 
 __all__ = ('get_choices', 'ALL_TIMEZONES_CHOICES', 'COMMON_TIMEZONES_CHOICES',
+           'GROUPED_ALL_TIMEZONES_CHOICES', 'GROUPED_COMMON_TIMEZONES_CHOICES',
            'PRETTY_ALL_TIMEZONES_CHOICES', 'PRETTY_COMMON_TIMEZONES_CHOICES')
 
 
@@ -19,9 +22,13 @@
 )
 
 
-def get_choices(timezones):
+def get_choices(timezones, grouped=False):
     """Retrieves timezone choices from any iterable (normally pytz)."""
-    timezone_choices = []
+
+    # Created a namedtuple to store the "key" for the choices_dict
+    TZOffset = namedtuple('TZOffset', 'value offset_string')
+
+    choices_dict = defaultdict(list)
 
     # Iterate through the timezones and populate the timezone choices
     for tz in iter(timezones):
@@ -31,27 +38,43 @@ def get_choices(timezones):
         # Retrieve the timezone offset ("-0500" / "+0500")
         offset = now.strftime("%z")
 
-        # Format the timezone display string
-        display_string = '(GMT{plus_minus}{hours}:{minutes}) {tz}'.format(
-            tz=tz,
+        # Retrieve the offset string ("GMT-12:00" / "GMT+12:00")
+        timezone_offset_string = 'GMT{plus_minus}{hours}:{minutes}'.format(
             **TIMEZONE_OFFSET_REGEX.match(offset).groupdict()
         )
 
-        # Append a tuple of the timezone information:
-        #   (-500, 'US/Eastern', '(GMT-05:00) US/Eastern')
-        timezone_choices.append((int(offset), tz, display_string))
+        if not grouped:
+            # Format the timezone display string
+            display_string = '({timezone_offset_string}) {tz}'.format(
+                timezone_offset_string=timezone_offset_string,
+                tz=tz,
+            )
+        else:
+            display_string = tz
+
+        choices_dict[
+            TZOffset(value=int(offset), offset_string=timezone_offset_string)
+        ].append(
+            (tz, display_string)
+        )
 
-    # Sort the timezone choices by the integer offsets (negative to positive)
-    timezone_choices.sort()
+    choices = []
 
-    # Iterate through the timezone choices by index, and update the index to
-    #   remove the integer offset, leaving the:
-    #       ('US/Eastern', '(GMT-05:00) US/Eastern')
-    for i in range(len(timezone_choices)):
-        timezone_choices[i] = timezone_choices[i][1:]
+    for tz_offset in sorted(choices_dict, key=attrgetter('value')):
+        if not grouped:
+            choices.extend(
+                tuple(choices_dict[tz_offset])
+            )
+        else:
+            choices.append(
+                (
+                    tz_offset.offset_string,
+                    tuple(choices_dict[tz_offset])
+                )
+            )
 
     # Cast the timezone choices to a tuple and return
-    return tuple(timezone_choices)
+    return tuple(choices)
 
 
 # ==============================================================================
@@ -63,6 +86,16 @@ def get_choices(timezones):
     zip(pytz.common_timezones, pytz.common_timezones)
 )
 
+# Grouped by timezone offset, with "GMT-05:00" as the group name
+GROUPED_ALL_TIMEZONES_CHOICES = get_choices(
+    timezones=pytz.all_timezones,
+    grouped=True
+)
+GROUPED_COMMON_TIMEZONES_CHOICES = get_choices(
+    timezones=pytz.common_timezones,
+    grouped=True
+)
+
 # Sorted by timezone offset, with "(GMT-05:00) US/Eastern" as the display name
-PRETTY_ALL_TIMEZONES_CHOICES = get_choices(pytz.all_timezones)
-PRETTY_COMMON_TIMEZONES_CHOICES = get_choices(pytz.common_timezones)
+PRETTY_ALL_TIMEZONES_CHOICES = get_choices(timezones=pytz.all_timezones)
+PRETTY_COMMON_TIMEZONES_CHOICES = get_choices(timezones=pytz.common_timezones)
diff --git a/timezone_utils/fields.py b/timezone_utils/fields.py
@@ -308,22 +308,24 @@ def _convert_value(self, value, model_instance, add):
         # Retrieve the default timezone as the default
         tz = get_default_timezone()
 
+        # If populate_from exists, override the default timezone
+        if self.populate_from is not None:
+            tz = self._get_populate_from(model_instance)
+
         # Do not convert the time to the time override if auto_now or
         #   auto_now_add is set
         if self.time_override is not None and not (
             self.auto_now or (self.auto_now_add and add)
         ):
+            # Retrieve the time override
             time_override = self._get_time_override()
 
+            # Convert the value to the date/time
             value = datetime.combine(
                 date=value.date(),
                 time=time_override
             )
 
-        # If populate_from exists, override the default timezone
-        if self.populate_from is not None:
-            tz = self._get_populate_from(model_instance)
-
         # If the value is naive (due to the time_override conversion), make it
         #   aware based on the appropriate timezone
         if is_naive(value):

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-__version__ = (0, 6)`
	`1`	`+__version__ = (0, 7)`
`2`	`2`	`VERSION = '.'.join(map(str, __version__))`