migration issues fixed, migration test suite, strict parameter

Author: bckohan

.github/workflows/test.yml

@@ -42,7 +42,6 @@ jobs:
     - name: Run Static Analysis
       run: |
         poetry run pylint django_enum
-        poetry run mypy django_enum
         poetry run doc8 -q doc
         poetry check
         poetry run pip check

.gitignore

@@ -130,3 +130,8 @@ dmypy.json
 
 /poetry.lock
 test.db
+django_enum/tests/edit_tests/migrations/0001_initial.py
+django_enum/tests/edit_tests/migrations/0002_alter_values.py
+django_enum/tests/edit_tests/migrations/0003_remove_black.py
+django_enum/tests/edit_tests/migrations/0004_remove_int_enum.py
+django_enum/tests/edit_tests/migrations/0005_add_int_enum.py

django_enum/fields.py

@@ -22,27 +22,54 @@ class EnumMixin:
     and convert any values to the Enumeration type in question.
 
     :param enum: The enum class
+    :param strict: If True (default) the field will throw ValueErrors if the
+        value is not coercible to a valid enumeration type.
     :param args: Any standard unnamed field arguments for the underlying
         field type.
     :param field_kwargs: Any standard named field arguments for the underlying
         field type.
     """
 
     enum = None
+    strict = True
 
-    def __init__(self, *args, enum, **kwargs):
+    def _coerce_to_value_type(self, value):
+        """Coerce the value to the enumerations value type"""
+        return type(self.enum.values[0])(value)
+
+    def __init__(self, *args, enum=None, strict=strict, **kwargs):
         self.enum = enum
-        kwargs.setdefault('choices', self.enum.choices)
+        self.strict = strict if enum else False
+        if self.enum is not None:
+            kwargs.setdefault('choices', enum.choices if enum else [])
         super().__init__(*args, **kwargs)
 
+    def _try_coerce(self, value):
+        if self.enum is not None:
+            try:
+                value = self.enum(value)
+            except (TypeError, ValueError):
+                try:
+                    value = self.enum(self._coerce_to_value_type(value))
+                except (TypeError, ValueError) as err:
+                    if self.strict:
+                        raise ValueError(
+                            f"'{value}' is not a valid {self.enum.__name__} "
+                            f"required by field {self.name}."
+                        ) from err
+        return value
+
     def deconstruct(self):
         """
-        Preserve enum class for migrations
+        Preserve enum class for migrations. Strict is omitted because
+        reconstructed fields are *always* non-strict sense enum is null.
 
         See deconstruct_
         """
         name, path, args, kwargs = super().deconstruct()
-        kwargs['enum'] = self.enum
+        if self.enum is not None:
+            kwargs['choices'] = self.enum.choices
+
         return name, path, args, kwargs
 
     def get_prep_value(self, value):
@@ -51,39 +78,22 @@ def get_prep_value(self, value):
 
         See get_prep_value_
         """
-        if value is not None:
-            if not isinstance(value, self.enum):
-                try:
-                    value = self.enum(value).value
-                except (TypeError, ValueError) as err:
-                    raise ValueError(
-                        f"Field '{self.name}' expected a "
-                        f"'{self.enum.__name__}' but got '{value}'.",
-                    ) from err
-            else:
+        if value is not None and self.enum is not None:
+            value = self._try_coerce(value)
+            if isinstance(value, self.enum):
                 value = value.value
         return super().get_prep_value(value)
 
-    # def get_db_prep_save(self, value, connection):
-    #     return self.get_db_prep_value(value, connection=connection)
-
     def get_db_prep_value(self, value, connection, prepared=False):
         """
         Convert the field value into the Enum type and then pull its value
         out.
 
         See get_db_prep_value_
         """
-        if value is not None:
-            if not isinstance(value, self.enum):
-                try:
-                    value = self.enum(value).value
-                except (TypeError, ValueError) as err:
-                    raise ValueError(
-                        f"Field '{self.name}' expected a "
-                        f"'{self.enum.__name__}' but got '{value}'.",
-                    ) from err
-            else:
+        if value is not None and self.enum is not None:
+            value = self._try_coerce(value)
+            if isinstance(value, self.enum):
                 value = value.value
         return super().get_db_prep_value(
             value,
@@ -104,7 +114,7 @@ def from_db_value(
         """
         if value is None:  # pragma: no cover
             return value
-        return self.enum(value)
+        return self._try_coerce(value)
 
     def to_python(self, value):
         """
@@ -117,12 +127,12 @@ def to_python(self, value):
         :raises ValidationError: If the value is not mappable to a valid
             enumeration
         """
-        if isinstance(value, self.enum) or value is None:
+        if self.enum is None or isinstance(value, self.enum) or value is None:
             return value
 
         try:
-            return self.enum(value)
-        except (TypeError, ValueError) as err:
+            return self._try_coerce(value)
+        except ValueError as err:
             raise ValidationError(
                 f"'{value}' is not a valid {self.enum.__name__}."
             ) from err
@@ -160,10 +170,11 @@ class EnumCharField(EnumMixin, CharField):
     A database field supporting enumerations with character values.
     """
 
-    def __init__(self, enum, *args, **kwargs):
+    def __init__(self, *args, enum=None, **kwargs):
+        choices = kwargs.get('choices', enum.choices if enum else [])
         kwargs.setdefault(
             'max_length',
-            max([len(define.value) for define in enum])
+            max([len(choice[0]) for choice in choices])
         )
         super().__init__(*args, enum=enum, **kwargs)
 

django_enum/forms.py

@@ -36,3 +36,15 @@ def _coerce(self, value):
 
     def clean(self, value):
         return super().clean(self._coerce(value))
+
+    # def prepare_value(self, value):
+    #     return value
+    #
+    # def to_python(self, value):
+    #     return value
+    #
+    # def validate(self, value):
+    #     if value in self.empty_values and self.required:
+    #         raise ValidationError(
+    #           self.error_messages['required'], code='required'
+    #         )

django_enum/tests/app1/enums.py

@@ -1,6 +1,24 @@
 from django.utils.translation import gettext as _
 from django_enum import FloatChoices, IntegerChoices, TextChoices
 from enum_properties import p, s
+from django.db.models import (
+    IntegerChoices as DjangoIntegerChoices,
+    TextChoices as DjangoTextChoices
+)
+
+
+class DJIntEnum(DjangoIntegerChoices):
+
+    ONE = 1, 'One'
+    TWO = 2, 'Two'
+    THREE = 3, 'Three'
+
+
+class DJTextEnum(DjangoTextChoices):
+
+    A = 'A', 'Label A'
+    B = 'B', 'Label B'
+    C = 'C', 'Label C'
 
 
 class TextEnum(TextChoices, p('version'), p('help'), s('aliases', case_fold=True)):

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

@@ -1,9 +1,7 @@
-# Generated by Django 3.2.14 on 2022-07-19 20:29
+# Generated by Django 3.2.14 on 2022-07-22 14:29
 
-import django_enum.fields
-import django_enum.tests.app1.enums
-import django_enum.tests.app1.models
 from django.db import migrations, models
+import django_enum.fields
 
 
 class Migration(migrations.Migration):
@@ -18,19 +16,21 @@ class Migration(migrations.Migration):
             name='EnumTester',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('small_pos_int', django_enum.fields.EnumPositiveSmallIntegerField(blank=True, choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], db_index=True, default=None, enum=django_enum.tests.app1.enums.SmallPosIntEnum, null=True)),
-                ('small_int', django_enum.fields.EnumSmallIntegerField(blank=True, choices=[(-32768, 'Value -32768'), (0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], db_index=True, default=32767, enum=django_enum.tests.app1.enums.SmallIntEnum)),
-                ('pos_int', django_enum.fields.EnumPositiveIntegerField(blank=True, choices=[(0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483647, 'Value 2147483647')], db_index=True, default=2147483647, enum=django_enum.tests.app1.enums.PosIntEnum)),
-                ('int', django_enum.fields.EnumIntegerField(blank=True, choices=[(-2147483648, 'Value -2147483648'), (0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483647, 'Value 2147483647')], db_index=True, enum=django_enum.tests.app1.enums.IntEnum, null=True)),
-                ('big_pos_int', django_enum.fields.EnumPositiveBigIntegerField(blank=True, choices=[(0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483648, 'Value 2147483647')], db_index=True, default=None, enum=django_enum.tests.app1.enums.BigPosIntEnum, null=True)),
-                ('big_int', django_enum.fields.EnumBigIntegerField(blank=True, choices=[(-2147483649, 'Value -2147483649'), (1, 'Value 1'), (2, 'Value 2'), (2147483648, 'Value 2147483647')], db_index=True, default=-2147483649, enum=django_enum.tests.app1.enums.BigIntEnum)),
-                ('constant', django_enum.fields.EnumFloatField(blank=True, choices=[(3.141592653589793, 'Pi'), (2.71828, "Euler's Number"), (1.618033988749895, 'Golden Ratio')], db_index=True, default=None, enum=django_enum.tests.app1.enums.Constants, null=True)),
-                ('text', django_enum.fields.EnumCharField(blank=True, choices=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], db_index=True, default=None, enum=django_enum.tests.app1.enums.TextEnum, max_length=4, null=True)),
+                ('small_pos_int', django_enum.fields.EnumPositiveSmallIntegerField(blank=True, choices=[(0, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], db_index=True, default=None, null=True)),
+                ('small_int', django_enum.fields.EnumSmallIntegerField(blank=True, choices=[(-32768, 'Value -32768'), (0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (32767, 'Value 32767')], db_index=True, default=32767)),
+                ('pos_int', django_enum.fields.EnumPositiveIntegerField(blank=True, choices=[(0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483647, 'Value 2147483647')], db_index=True, default=2147483647)),
+                ('int', django_enum.fields.EnumIntegerField(blank=True, choices=[(-2147483648, 'Value -2147483648'), (0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483647, 'Value 2147483647')], db_index=True, null=True)),
+                ('big_pos_int', django_enum.fields.EnumPositiveBigIntegerField(blank=True, choices=[(0, 'Value 0'), (1, 'Value 1'), (2, 'Value 2'), (2147483648, 'Value 2147483647')], db_index=True, default=None, null=True)),
+                ('big_int', django_enum.fields.EnumBigIntegerField(blank=True, choices=[(-2147483649, 'Value -2147483649'), (1, 'Value 1'), (2, 'Value 2'), (2147483648, 'Value 2147483647')], db_index=True, default=-2147483649)),
+                ('constant', django_enum.fields.EnumFloatField(blank=True, choices=[(3.141592653589793, 'Pi'), (2.71828, "Euler's Number"), (1.618033988749895, 'Golden Ratio')], db_index=True, default=None, null=True)),
+                ('text', django_enum.fields.EnumCharField(blank=True, choices=[('V1', 'Value1'), ('V22', 'Value2'), ('V333', 'Value3'), ('D', 'Default')], db_index=True, default=None, max_length=4, null=True)),
                 ('int_choice', models.IntegerField(blank=True, choices=[(1, 'One'), (2, 'Two'), (3, 'Three')], default=1)),
                 ('char_choice', models.CharField(blank=True, choices=[('A', 'First'), ('B', 'Second'), ('C', 'Third')], default='A', max_length=1)),
                 ('int_field', models.IntegerField(blank=True, default=1)),
                 ('float_field', models.FloatField(blank=True, default=1.5)),
                 ('char_field', models.CharField(blank=True, default='A', max_length=1)),
+                ('dj_int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(1, 'One'), (2, 'Two'), (3, 'Three')], default=1)),
+                ('dj_text_enum', django_enum.fields.EnumCharField(choices=[('A', 'Label A'), ('B', 'Label B'), ('C', 'Label C')], default='A', max_length=1)),
             ],
             options={
                 'ordering': ('id',),
@@ -40,9 +40,9 @@ class Migration(migrations.Migration):
             name='MyModel',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('txt_enum', django_enum.fields.EnumCharField(blank=True, choices=[('V0', 'Value 0'), ('V1', 'Value 1'), ('V2', 'Value 2')], enum=django_enum.tests.app1.models.MyModel.TextEnum, max_length=2, null=True)),
-                ('int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(1, 'One'), (2, 'Two'), (3, 'Three')], enum=django_enum.tests.app1.models.MyModel.IntEnum)),
-                ('color', django_enum.fields.EnumCharField(choices=[('R', 'Red'), ('G', 'Green'), ('B', 'Blue')], enum=django_enum.tests.app1.models.MyModel.Color, max_length=1)),
+                ('txt_enum', django_enum.fields.EnumCharField(blank=True, choices=[('V0', 'Value 0'), ('V1', 'Value 1'), ('V2', 'Value 2')], max_length=2, null=True)),
+                ('int_enum', django_enum.fields.EnumPositiveSmallIntegerField(choices=[(1, 'One'), (2, 'Two'), (3, 'Three')])),
+                ('color', django_enum.fields.EnumCharField(choices=[('R', 'Red'), ('G', 'Green'), ('B', 'Blue')], max_length=1)),
             ],
         ),
     ]

django_enum/tests/app1/models.py

@@ -1,7 +1,10 @@
 from django.db import models
 from django.urls import reverse
+from enum import auto
 from django_enum import EnumField, IntegerChoices, TextChoices
 from django_enum.tests.app1.enums import (
+    DJIntEnum,
+    DJTextEnum,
     BigIntEnum,
     BigPosIntEnum,
     Constants,
@@ -65,6 +68,9 @@ class EnumTester(models.Model):
     )
     ################################################
 
+    dj_int_enum = EnumField(DJIntEnum, default=DJIntEnum.ONE.value)
+    dj_text_enum = EnumField(DJTextEnum, default=DJTextEnum.A.value)
+
     def get_absolute_url(self):
         return reverse('django_enum_tests_app1:enum-detail', kwargs={'pk': self.pk})
 
@@ -96,5 +102,3 @@ class Color(TextChoices, s('rgb'), s('hex', case_fold=True)):
     int_enum = EnumField(IntEnum)
     color = EnumField(Color)
 
-    def save(self, *args, **kwargs):
-        super().save(*args, **kwargs)

django_enum/tests/app1/templates/django_enum_tests_app1/enumtester_detail.html

@@ -11,6 +11,8 @@ <h1>{{ object.pk }}</h1>
     <p class="big_int">big_int: <b><span class="value">{{ object.big_int.value }}</span></b> <b><span class="label">{{ object.big_int.label }}</span></b></p>
     <p class="constant">constant: <b><span class="value">{{ object.constant.value }}</span></b> <b><span class="label">{{ object.constant.label }}</span></b></p>
     <p class="text">text: <b><span class="value">{{ object.text.value }}</span></b> <b><span class="label">{{ object.text.label }}</span></b></p>
+    <p class="dj_int_enum">dj_int_enum: <b><span class="value">{{ object.dj_int_enum.value }}</span></b> <b><span class="label">{{ object.dj_int_enum.label }}</span></b></p>
+    <p class="dj_text_enum">dj_text_enum: <b><span class="value">{{ object.dj_text_enum.value }}</span></b> <b><span class="label">{{ object.dj_text_enum.label }}</span></b></p>
 
     <p>
     <a href="{% url 'django_enum_tests_app1:enum-update' pk=object.pk %}">Edit</a>

django_enum/tests/app1/templates/django_enum_tests_app1/enumtester_list.html

@@ -13,6 +13,8 @@ <h2>{{ object.pk }}</h2>
         <p class="big_int">big_int: <b><span class="value">{{ object.big_int.value }}</span></b> <b><span class="label">{{ object.big_int.label }}</span></b></p>
         <p class="constant">constant: <b><span class="value">{{ object.constant.value }}</span></b> <b><span class="label">{{ object.constant.label }}</span></b></p>
         <p class="text">text: <b><span class="value">{{ object.text.value }}</span></b> <b><span class="label">{{ object.text.label }}</span></b></p>
+        <p class="dj_int_enum">dj_int_enum: <b><span class="value">{{ object.dj_int_enum.value }}</span></b> <b><span class="label">{{ object.dj_int_enum.label }}</span></b></p>
+        <p class="dj_text_enum">dj_text_enum: <b><span class="value">{{ object.dj_text_enum.value }}</span></b> <b><span class="label">{{ object.dj_text_enum.label }}</span></b></p>
 
         <p>
         <a href="{% url 'django_enum_tests_app1:enum-update' pk=object.pk %}">Edit</a>

django_enum/tests/app1/views.py

@@ -13,6 +13,8 @@
     SmallIntEnum,
     SmallPosIntEnum,
     TextEnum,
+    DJIntEnum,
+    DJTextEnum
 )
 from django_enum.tests.app1.models import EnumTester
 from django_filters.views import FilterView
@@ -47,6 +49,8 @@ class EnumTesterForm(ModelForm):
         big_int = EnumChoiceField(BigIntEnum)
         constant = EnumChoiceField(Constants)
         text = EnumChoiceField(TextEnum)
+        dj_int_enum = EnumChoiceField(DJIntEnum)
+        dj_text_enum = EnumChoiceField(DJTextEnum)
 
         class Meta:
             model = EnumTester