Updated documentation to add missed choices for grouped choices. Fixed a bug for time_override. Version bump for preparation of v0.8 release.

Author: michaeljohnbarr

README.rst

@@ -107,6 +107,7 @@ Contributors
 
 Changelog
 ---------
+- 0.8 Corrected a bug to where ``time_override`` caused invalid date due to not converting to the correct timezone first. Added choices ``GROUPED_ALL_TIMEZONES_CHOICES`` and ``GROUPED_COMMON_TIMEZONES_CHOICES`` to the documentation.
 - 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

docs/choices.rst

@@ -57,6 +57,78 @@ Contains constants and functions to generate model/form choices for time zones.
         ...
     )
 
+``GROUPED_ALL_TIMEZONES_CHOICES``
+---------------------------------
+.. py:data:: GROUPED_ALL_TIMEZONES_CHOICES
+
+    Returns choices grouped by the timezone offset and ordered alphabetically by
+    their Olson Time Zone name populated from |pytz.all_timezones|_.
+
+.. code-block:: python
+
+    >>> from timezone_utils.choices import GROUPED_ALL_TIMEZONES_CHOICES
+    >>> print GROUPED_ALL_TIMEZONES_CHOICES
+    (
+        (
+            'GMT-12:00',
+            (
+                ('Etc/GMT+12', 'Etc/GMT+12'),
+            )
+        ),
+        (
+            'GMT-11:00',
+            (
+                ('Etc/GMT+11', 'Etc/GMT+11'),
+                ('Pacific/Midway', 'Pacific/Midway'),
+                ('Pacific/Niue', 'Pacific/Niue'),
+                ('Pacific/Pago_Pago', 'Pacific/Pago_Pago'),
+                ('Pacific/Samoa', 'Pacific/Samoa'),
+                ('US/Samoa', 'US/Samoa')
+            )
+        ),
+        ...
+    )
+
+``GROUPED_COMMON_TIMEZONES_CHOICES``
+------------------------------------
+.. py:data:: GROUPED_COMMON_TIMEZONES_CHOICES
+
+    Returns choices grouped by the timezone offset and ordered alphabetically by
+    their Olson Time Zone name populated from |pytz.common_timezones|_.
+
+.. code-block:: python
+
+    >>> from timezone_utils.choices import GROUPED_ALL_TIMEZONES_CHOICES
+    >>> print GROUPED_ALL_TIMEZONES_CHOICES
+    (
+        (
+            'GMT-11:00',
+            (
+                ('Pacific/Midway', 'Pacific/Midway'),
+                ('Pacific/Niue', 'Pacific/Niue'),
+                ('Pacific/Pago_Pago', 'Pacific/Pago_Pago')
+            )
+        ),
+        (
+            'GMT-10:00',
+            (
+                ('America/Adak', 'America/Adak'),
+                ('Pacific/Honolulu', 'Pacific/Honolulu'),
+                ('Pacific/Johnston', 'Pacific/Johnston'),
+                ('Pacific/Rarotonga', 'Pacific/Rarotonga'),
+                ('Pacific/Tahiti', 'Pacific/Tahiti'),
+                ('US/Hawaii', 'US/Hawaii')
+            )
+        ),
+        (
+            'GMT-09:30',
+            (
+                ('Pacific/Marquesas', 'Pacific/Marquesas'),
+            )
+        ),
+        ...
+    )
+
 ``PRETTY_ALL_TIMEZONES_CHOICES``
 --------------------------------
 .. py:data:: PRETTY_ALL_TIMEZONES_CHOICES
@@ -107,14 +179,16 @@ Contains constants and functions to generate model/form choices for time zones.
         ...
     )
 
-``get_choices(timezones)``
---------------------------
-.. py:function:: get_choices(timezones)
+``get_choices(timezones, grouped=False)``
+-----------------------------------------
+.. py:function:: get_choices(timezones, grouped=False)
 
         Retrieves timezone choices from any iterable (normally from `pytz <pytz.sourceforge.net/>`_).
 
         :param timezones: Any iterable that contains valid Olson Time Zone strings.
         :type timezones: iterable
+        :param grouped: Whether to group the choices by time zone offset.
+        :type grouped: bool
         :return: A tuple containing tuples of time zone choices.
         :rtype: tuple
         :raises pytz.exceptions.UnknownTimeZoneError: if the string from the iterable ``timezones``

docs/conf.py

@@ -51,9 +51,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.7'
+version = '0.8'
 # The full version, including alpha/beta/rc tags.
-release = '0.7'
+release = '0.8'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

timezone_utils/__init__.py

@@ -1,2 +1,2 @@
-__version__ = (0, 7)
+__version__ = (0, 8)
 VERSION = '.'.join(map(str, __version__))

timezone_utils/fields.py

@@ -320,6 +320,11 @@ def _convert_value(self, value, model_instance, add):
             # Retrieve the time override
             time_override = self._get_time_override()
 
+            # Convert the value to the correct timezone prior to applying the
+            #   time_override
+            if not value.tzinfo == tz:
+                value = value.astimezone(tz)
+
             # Convert the value to the date/time
             value = datetime.combine(
                 date=value.date(),