merge in changes from django-enum==1.2.2

Author: bckohan

.github/workflows/test.yml

@@ -118,6 +118,7 @@ jobs:
     - name: Install Poetry
       uses: snok/install-poetry@v1
       with:
+        version: 1.5.1
         virtualenvs-create: true
         virtualenvs-in-project: true
     - name: Install Basic Dependencies

.safety-policy.yml

@@ -12,4 +12,7 @@ security: # configuration for the `safety check` command
             reason: dev dependency
         53269:
             reason: dev dependency
+            #expires: '2022-10-21' # datetime string - date this ignore will expire, best practice to use this variable
+        51499:
+            reason: dev dependency
     continue-on-vulnerability-error: False # Suppress non-zero exit codes when vulnerabilities are found. Enable this in pipelines and CI/CD processes if you want to pass builds that have vulnerabilities. We recommend you set this to False.

README.rst

@@ -1,4 +1,4 @@
-|MIT license| |PyPI version fury.io| |PyPI pyversions| |PyPI status| |Documentation Status|
+|MIT license| |PyPI version fury.io| |PyPI pyversions| |PyPi djversions| |PyPI status| |Documentation Status|
 |Code Cov| |Test Status|
 
 .. |MIT license| image:: https://img.shields.io/badge/License-MIT-blue.svg
@@ -10,6 +10,9 @@
 .. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/django-enum.svg
    :target: https://pypi.python.org/pypi/django-enum/
 
+.. |PyPI djversions| image:: https://img.shields.io/pypi/djversions/django-enum.svg
+   :target: https://pypi.org/project/django-enum/
+
 .. |PyPI status| image:: https://img.shields.io/pypi/status/django-enum.svg
    :target: https://pypi.python.org/pypi/django-enum
 

django_enum/choices.py

@@ -65,6 +65,9 @@ class TextChoices(
         accepts enum-properties property lists.
         """
 
+        def __hash__(self):
+            return DjangoTextChoices.__hash__(self)
+
 
     class IntegerChoices(
         DjangoSymmetricMixin,
@@ -76,6 +79,9 @@ class IntegerChoices(
         accepts enum-properties property lists.
         """
 
+        def __hash__(self):
+            return DjangoIntegerChoices.__hash__(self)
+
 
     class FloatChoices(
         DjangoSymmetricMixin,
@@ -88,6 +94,10 @@ class FloatChoices(
         property lists.
         """
 
+        def __hash__(self):
+            return float.__hash__(self)
+
+
     # mult inheritance type hint bug
     class FlagChoices(  # type: ignore
         DecomposeMixin,
@@ -108,6 +118,10 @@ class FlagChoices(  # type: ignore
         lists.
         """
 
+        def __hash__(self):
+            return enum.IntFlag.__hash__(self)
+
+
 
 except (ImportError, ModuleNotFoundError):
 

django_enum/forms.py

@@ -99,7 +99,7 @@ class ChoiceFieldMixin:  # pylint: disable=R0902
     _primitive_: Optional[Type] = None
     _strict_: bool = True
     empty_value: Any = ''
-    empty_values: List[Any]
+    empty_values: List[Any] = TypedChoiceField.empty_values
     choices: Iterable[Tuple[Any, Any]]
 
     _empty_value_overridden_: bool = False

django_enum/tests/djenum/admin.py

@@ -7,7 +7,7 @@
 class AdminDisplayBug35Admin(admin.ModelAdmin):
 
     list_display = ('text_enum', 'int_enum')
-    readonly_fields = ('text_enum', 'int_enum')
+    readonly_fields = ('text_enum', 'int_enum', 'blank_int', 'blank_txt')
 
 
 admin.site.register(AdminDisplayBug35, AdminDisplayBug35Admin)

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

@@ -1,12 +1,11 @@
-# Generated by Django 3.2.20 on 2023-08-08 16:45
+# Generated by Django 4.2.4 on 2023-10-02 16:10
 
 import datetime
-import pathlib
 from decimal import Decimal
-
+from django.db import migrations, models
 import django_enum.fields
 import django_enum.tests.djenum.enums
-from django.db import migrations, models
+import pathlib
 
 
 class Migration(migrations.Migration):
@@ -21,8 +20,10 @@ class Migration(migrations.Migration):
             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)),
+                ('text_enum', django_enum.fields.EnumCharField(choices=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], default='V1', max_length=4)),
+                ('int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], default=2)),
+                ('blank_int', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], default=None, null=True)),
+                ('blank_txt', django_enum.fields.EnumCharField(choices=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], default=None, max_length=4, null=True)),
             ],
         ),
         migrations.CreateModel(
@@ -206,7 +207,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='enumflagtesterrelated',
             name='related_flags',
-            field=models.ManyToManyField(related_name='related_flags', to='django_enum_tests_djenum.EnumFlagTester'),
+            field=models.ManyToManyField(related_name='related_flags', to='django_enum_tests_djenum.enumflagtester'),
         ),
         migrations.AddConstraint(
             model_name='emptyenumvaluetester',
@@ -234,10 +235,18 @@ class Migration(migrations.Migration):
         ),
         migrations.AddConstraint(
             model_name='admindisplaybug35',
-            constraint=models.CheckConstraint(check=models.Q(('text_enum__in', ['A', 'B', 'C']), ('text_enum__isnull', True), _connector='OR'), name='django_enum_tests_djenum_AdminDisplayBug35_text_enum_DJTextEnum'),
+            constraint=models.CheckConstraint(check=models.Q(('text_enum__in', ['V1', 'V22', 'V333', 'D'])), name='django_enum_tests_djenum_AdminDisplayBug35_text_enum_TextEnum'),
+        ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('int_enum__in', [0, 2, 32767])), name='ngo_enum_tests_djenum_AdminDisplayBug35_int_enum_SmallPosIntEnum'),
+        ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('blank_int__in', [0, 2, 32767]), ('blank_int__isnull', True), _connector='OR'), name='go_enum_tests_djenum_AdminDisplayBug35_blank_int_SmallPosIntEnum'),
         ),
         migrations.AddConstraint(
             model_name='admindisplaybug35',
-            constraint=models.CheckConstraint(check=models.Q(('int_enum__in', [1, 2, 3]), ('int_enum__isnull', True), _connector='OR'), name='django_enum_tests_djenum_AdminDisplayBug35_int_enum_DJIntEnum'),
+            constraint=models.CheckConstraint(check=models.Q(('blank_txt__in', ['V1', 'V22', 'V333', 'D']), ('blank_txt__isnull', True), _connector='OR'), name='django_enum_tests_djenum_AdminDisplayBug35_blank_txt_TextEnum'),
         ),
     ]

django_enum/tests/djenum/models.py

@@ -188,13 +188,23 @@ class BadDefault(models.Model):
 class AdminDisplayBug35(models.Model):
 
     text_enum = EnumField(
-        DJTextEnum,
+        TextEnum,
+        default=TextEnum.VALUE1
+    )
+
+    int_enum = EnumField(
+        SmallPosIntEnum,
+        default=SmallPosIntEnum.VAL2
+    )
+
+    blank_int = EnumField(
+        SmallPosIntEnum,
         null=True,
         default=None
     )
 
-    int_enum = EnumField(
-        DJIntEnum,
+    blank_txt = EnumField(
+        TextEnum,
         null=True,
         default=None
     )

django_enum/tests/enum_prop/admin.py

@@ -1,9 +1,15 @@
 try:
     from django.contrib import admin
-    from django_enum.tests.enum_prop.models import BitFieldModel, EnumTester
+    from django_enum.tests.enum_prop.models import BitFieldModel, AdminDisplayBug35, EnumTester
+
+    class AdminDisplayBug35Admin(admin.ModelAdmin):
+
+        list_display = ('text_enum', 'int_enum')
+        readonly_fields = ('text_enum', 'int_enum', 'blank_int', 'blank_txt')
 
     admin.site.register(EnumTester)
     admin.site.register(BitFieldModel)
+    admin.site.register(AdminDisplayBug35, AdminDisplayBug35Admin)
 
 except (ImportError, ModuleNotFoundError):  # pragma: no cover
     pass

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

@@ -1,10 +1,9 @@
-# Generated by Django 4.2.4 on 2023-08-08 01:54
+# Generated by Django 4.2.4 on 2023-10-02 16:10
 
 import datetime
 from decimal import Decimal
-
-import django_enum.fields
 from django.db import migrations, models
+import django_enum.fields
 
 
 class Migration(migrations.Migration):
@@ -15,6 +14,16 @@ 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=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], default='V1', max_length=4)),
+                ('int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], default=2)),
+                ('blank_int', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], default=None, null=True)),
+                ('blank_txt', django_enum.fields.EnumCharField(choices=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], default=None, max_length=4, null=True)),
+            ],
+        ),
         migrations.CreateModel(
             name='BitFieldModel',
             fields=[
@@ -314,4 +323,20 @@ class Migration(migrations.Migration):
             name='related_flags',
             field=models.ManyToManyField(related_name='related_flags', to='django_enum_tests_enum_prop.enumflagproptester'),
         ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('text_enum__in', ['V1', 'V22', 'V333', 'D'])), name='django_enum_tests_enum_prop_AdminDisplayBug35_text_enum_TextEnum'),
+        ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('int_enum__in', [0, 2, 32767])), name='_enum_tests_enum_prop_AdminDisplayBug35_int_enum_SmallPosIntEnum'),
+        ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('blank_int__in', [0, 2, 32767]), ('blank_int__isnull', True), _connector='OR'), name='enum_tests_enum_prop_AdminDisplayBug35_blank_int_SmallPosIntEnum'),
+        ),
+        migrations.AddConstraint(
+            model_name='admindisplaybug35',
+            constraint=models.CheckConstraint(check=models.Q(('blank_txt__in', ['V1', 'V22', 'V333', 'D']), ('blank_txt__isnull', True), _connector='OR'), name='django_enum_tests_enum_prop_AdminDisplayBug35_blank_txt_TextEnum'),
+        ),
     ]