Default human readable names without underscores

Part of #32, #37

Author: mfogel

README.rst

@@ -86,6 +86,8 @@ Changelog
 *   3.0 (in developement, not yet released)
 
     *   Support django 1.11, 2.0
+    *   Change default human-readable timezone names to exclude underscores
+        (`#32`__ & `#37`__)
 
 
 *   2.1 (2018-03-01)
@@ -158,6 +160,8 @@ __ http://pypi.python.org/pypi/pytz/
 __ http://pypi.python.org/pypi/django-timezone-field/
 __ http://www.pip-installer.org/
 __ https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
+__ https://github.com/mfogel/django-timezone-field/issues/32
+__ https://github.com/mfogel/django-timezone-field/issues/37
 __ https://github.com/mfogel/django-timezone-field/issues/38
 __ https://github.com/mfogel/django-timezone-field/issues/39
 __ https://github.com/mfogel/django-timezone-field/issues?q=milestone%3A1.3

tests/tests.py

@@ -68,6 +68,11 @@ def test_invalid_uncommon_tz(self):
         form = TestForm({'tz': UNCOMMON_TZ})
         self.assertFalse(form.is_valid())
 
+    def test_default_human_readable_choices_dont_have_underscores(self):
+        form = TestForm()
+        pst_choice = [c for c in form.fields['tz'].choices if c[0] == PST]
+        self.assertEqual(pst_choice[0][1], 'America/Los Angeles')
+
 
 class TimeZoneFieldModelFormTestCase(TestCase):
 
@@ -119,6 +124,11 @@ def test_invalid_uncommmon_tz(self):
         self.assertFalse(form.is_valid())
         self.assertTrue(any('choice' in e for e in form.errors['tz']))
 
+    def test_default_human_readable_choices_dont_have_underscores(self):
+        form = TestModelForm()
+        pst_choice = [c for c in form.fields['tz'].choices if c[0] == PST_tz]
+        self.assertEqual(pst_choice[0][1], 'America/Los Angeles')
+
 
 class TimeZoneFieldTestCase(TestCase):
 
@@ -238,6 +248,10 @@ def createField():
             TimeZoneField('a verbose name', 'a name', True, 42)
         self.assertRaises(ValueError, createField)
 
+    def test_default_human_readable_choices_dont_have_underscores(self):
+        m = TestModel(tz=PST_tz)
+        self.assertEqual(m.get_tz_display(), 'America/Los Angeles')
+
 
 class TimeZoneFieldLimitedChoicesTestCase(TestCase):
 
@@ -368,12 +382,15 @@ def test_specifying_defaults_not_frozen(self):
         name, path, args, kwargs = field.deconstruct()
         self.assertNotIn('max_length', kwargs)
 
-        choices = [(pytz.timezone(tz), tz) for tz in pytz.common_timezones]
+        choices = [
+            (pytz.timezone(tz), tz.replace('_', ' '))
+            for tz in pytz.common_timezones
+        ]
         field = TimeZoneField(choices=choices)
         name, path, args, kwargs = field.deconstruct()
         self.assertNotIn('choices', kwargs)
 
-        choices = [(tz, tz) for tz in pytz.common_timezones]
+        choices = [(tz, tz.replace('_', ' ')) for tz in pytz.common_timezones]
         field = TimeZoneField(choices=choices)
         name, path, args, kwargs = field.deconstruct()
         self.assertNotIn('choices', kwargs)

timezone_field/fields.py

@@ -36,7 +36,10 @@ class TimeZoneField(models.Field):
 
     # NOTE: these defaults are excluded from migrations. If these are changed,
     #       existing migration files will need to be accomodated.
-    CHOICES = [(pytz.timezone(tz), tz.replace('_', ' ')) for tz in pytz.common_timezones]
+    CHOICES = [
+        (pytz.timezone(tz), tz.replace('_', ' '))
+        for tz in pytz.common_timezones
+    ]
     MAX_LENGTH = 63
 
     def __init__(self, *args, **kwargs):

timezone_field/forms.py

@@ -14,7 +14,9 @@ def coerce_to_pytz(val):
 
         defaults = {
             'coerce': coerce_to_pytz,
-            'choices': [(tz, tz) for tz in pytz.common_timezones],
+            'choices': [
+                (tz, tz.replace('_', ' ')) for tz in pytz.common_timezones
+            ],
             'empty_value': None,
         }
         defaults.update(kwargs)