close #37

Author: bckohan

django_enum/__init__.py

@@ -47,7 +47,7 @@
     'EnumFilter'
 ]
 
-VERSION = (1, 2, 0)
+VERSION = (1, 2, 1)
 
 __title__ = 'Django Enum'
 __version__ = '.'.join(str(i) for i in VERSION)

django_enum/tests/djenum/admin.py

@@ -1,4 +1,13 @@
 from django.contrib import admin
-from django_enum.tests.djenum.models import EnumTester
+from django_enum.tests.djenum.models import EnumTester, AdminDisplayBug35
 
 admin.site.register(EnumTester)
+
+
+class AdminDisplayBug35Admin(admin.ModelAdmin):
+
+    list_display = ('text_enum', 'int_enum')
+    readonly_fields = ('text_enum', 'int_enum')
+
+
+admin.site.register(AdminDisplayBug35, AdminDisplayBug35Admin)

django_enum/tests/djenum/migrations/0001_initial.py

@@ -1,7 +1,7 @@
-# Generated by Django 3.2.18 on 2023-04-02 18:58
+# Generated by Django 3.2.18 on 2023-04-09 00:14
 
-import django_enum.fields
 from django.db import migrations, models
+import django_enum.fields
 
 
 class Migration(migrations.Migration):
@@ -12,6 +12,14 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
+        migrations.CreateModel(
+            name='AdminDisplayBug35',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('text_enum', django_enum.fields.EnumCharField(choices=[('A', 'Label A'), ('B', 'Label B'), ('C', 'Label C')], default=None, max_length=1, null=True)),
+                ('int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(1, 'One'), (2, 'Two'), (3, 'Three')], default=None, null=True)),
+            ],
+        ),
         migrations.CreateModel(
             name='BadDefault',
             fields=[

django_enum/tests/djenum/models.py

@@ -114,3 +114,19 @@ class BadDefault(models.Model):
         default=5,
         blank=True
     )
+
+
+class AdminDisplayBug35(models.Model):
+
+    text_enum = EnumField(
+        DJTextEnum,
+        null=True,
+        default=None
+    )
+
+    int_enum = EnumField(
+        DJIntEnum,
+        null=True,
+        default=None
+    )
+

django_enum/tests/examples/models.py

@@ -8,23 +8,22 @@ class Map(models.Model):
     class MapBoxStyle(
         IntegerChoices,
         s('slug', case_fold=True),
-        s('label', case_fold=True),
         p('version')
     ):
         """
         https://docs.mapbox.com/api/maps/styles/
         """
-        _symmetric_builtins_ = ['name', 'uri']
-
-        # name             value    slug                 label         version
-        STREETS           =  1,   'streets',           'Streets',           11
-        OUTDOORS          =  2,   'outdoors',          'Outdoors',          11
-        LIGHT             =  3,   'light',             'Light',             10
-        DARK              =  4,   'dark',              'Dark',              10
-        SATELLITE         =  5,   'satellite',         'Satellite',          9
-        SATELLITE_STREETS =  6,   'satellite-streets', 'Satellite Streets', 11
-        NAVIGATION_DAY    =  7,   'navigation-day',    'Navigation Day',     1
-        NAVIGATION_NIGHT  =  8,   'navigation-night',  'Navigation Night',   1
+        _symmetric_builtins_ = ['name', s('label', case_fold=True), 'uri']
+
+        # name             value    label                 slug         version
+        STREETS           =  1,   'Streets',            'streets',           11
+        OUTDOORS          =  2,   'Outdoors',           'outdoors',          11
+        LIGHT             =  3,   'Light',              'light',             10
+        DARK              =  4,   'Dark',               'dark',              10
+        SATELLITE         =  5,   'Satellite',          'satellite',          9
+        SATELLITE_STREETS =  6,   'Satellite Streets',  'satellite-streets', 11
+        NAVIGATION_DAY    =  7,   'Navigation Day',     'navigation-day',     1
+        NAVIGATION_NIGHT  =  8,   'Navigation Night',   'navigation-night',   1
 
         @property
         def uri(self):

doc/requirements.txt

@@ -6,4 +6,4 @@ sphinxcontrib-htmlhelp==2.0.1; python_version >= "3.5"
 sphinxcontrib-jsmath==1.0.1; python_version >= "3.5"
 sphinxcontrib-qthelp==1.0.3; python_version >= "3.5"
 sphinxcontrib-serializinghtml==1.1.5; python_version >= "3.5"
-django-enum==1.2.0
+django-enum==1.2.1

doc/source/changelog.rst

@@ -2,6 +2,11 @@
 Change Log
 ==========
 
+v1.2.1
+======
+
+* Fixed `Document that with version 1.4 of enum-properties label is no longer overridable for Choices <https://github.com/bckohan/django-enum/issues/37>`_
+
 v1.2.0
 ======
 

doc/source/examples.rst

@@ -21,7 +21,7 @@ versioned and that when used as a parameter in the mapbox API they are in a URI
 format that is overly verbose for a human friendly user interface.
 
 Each mapbox style enumeration is therefore composed of 4 primary properties. A
-name slug used in the URI, a human friendly label for the style, a version
+a human friendly label for the style, a name slug used in the URI, a version
 number for the style and the full URI specification of the style. We might
 implement our style enumeration like so:
 
@@ -36,23 +36,22 @@ implement our style enumeration like so:
         class MapBoxStyle(
             IntegerChoices,
             s('slug', case_fold=True),
-            s('label', case_fold=True),
             p('version')
         ):
             """
             https://docs.mapbox.com/api/maps/styles/
             """
-            _symmetric_builtins_ = ['name', 'uri']
-
-            # name             value    slug                 label           version
-            STREETS           =  1,   'streets',           'Streets',           11
-            OUTDOORS          =  2,   'outdoors',          'Outdoors',          11
-            LIGHT             =  3,   'light',             'Light',             10
-            DARK              =  4,   'dark',              'Dark',              10
-            SATELLITE         =  5,   'satellite',         'Satellite',          9
-            SATELLITE_STREETS =  6,   'satellite-streets', 'Satellite Streets', 11
-            NAVIGATION_DAY    =  7,   'navigation-day',    'Navigation Day',     1
-            NAVIGATION_NIGHT  =  8,   'navigation-night',  'Navigation Night',   1
+            _symmetric_builtins_ = ['name', 'uri', 'label']
+
+            # name             value    label                 slug         version
+            STREETS           =  1,   'Streets',            'streets',           11
+            OUTDOORS          =  2,   'Outdoors',           'outdoors',          11
+            LIGHT             =  3,   'Light',              'light',             10
+            DARK              =  4,   'Dark',               'dark',              10
+            SATELLITE         =  5,   'Satellite',          'satellite',          9
+            SATELLITE_STREETS =  6,   'Satellite Streets',  'satellite-streets', 11
+            NAVIGATION_DAY    =  7,   'Navigation Day',     'navigation-day',     1
+            NAVIGATION_NIGHT  =  8,   'Navigation Night',   'navigation-night',   1
 
             @property
             def uri(self):
@@ -65,8 +64,10 @@ implement our style enumeration like so:
 
 
 We've used a small integer as the value of the enumeration to save storage
-space. We've also added a symmetric case insensitive slug and human friendly
-label for each style and a non-symmetric version property.
+space. We've also added a symmetric case insensitive slug and a non-symmetric
+version property. We do not need to specify the label property because we're
+inheriting from Django's Choices type which provides a ``label`` property as
+the second element in the value tuple.
 
 The version numbers will increment over time, but we're only concerned with the
 most recent versions, so we'll increment their values in this enumeration as

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-enum"
-version = "1.2.0"
+version = "1.2.1"
 description = "Full and natural support for enumerations as Django model fields."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"
@@ -15,7 +15,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Development Status :: 5 - Production/Stable",
     "Framework :: Django :: 3.2",
-    "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.0",
     "Framework :: Django :: 4.2",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",