finish form field functionality and tests

bckohan · bckohan · commit 747df478e935 · 2022-08-07T16:08:13.000-07:00
diff --git a/README.rst b/README.rst
@@ -151,3 +151,15 @@ Installation
 .. note::
 
     ``django-enum`` *does not* need to be added to ``INSTALLED_APPS``.
+
+.. note::
+
+    ``django-enum`` has several optional dependencies that are not pulled in
+    by default. To utilize the
+    `enum-properties <https://pypi.org/project/enum-properties/>`_ choice types
+    you must `pip install enum-properties` and to use the ``EnumFilter`` type
+    for `django-filter <https://pypi.org/project/django-filter/>`_ you
+    must `pip install django-filter`.
+
+If features are utilized that require a missing optional dependency an
+exception will be thrown.
diff --git a/django_enum/fields.py b/django_enum/fields.py
@@ -35,6 +35,8 @@ class EnumMixin:
 
     def _coerce_to_value_type(self, value):
         """Coerce the value to the enumerations value type"""
+        # note if enum type is int and a floating point is passed we could get
+        # situations like X.xxx == X - this is acceptable
         return type(self.enum.values[0])(value)
 
     def __init__(self, *args, enum=None, strict=strict, **kwargs):
diff --git a/django_enum/forms.py b/django_enum/forms.py
@@ -1,56 +1,162 @@
 """Enumeration support for django model forms"""
 from django.core.exceptions import ValidationError
 from django.forms.fields import ChoiceField
+from django.forms.widgets import Select
+
 # pylint: disable=R0801
 
+__all__ = ['NonStrictSelect', 'EnumChoiceField']
+
+
+class _Unspecified:
+    """
+    Marker used by EnumChoiceField to determine if empty_value
+    was overridden
+    """
+
+
+class NonStrictSelect(Select):
+    """
+    A Select widget for non-strict EnumChoiceFields that includes any existing
+    non-conforming value as a choice option.
+    """
+
+    def render(self, *args, **kwargs):
+        """Before rendering if we're a non strict field and our value is """
+        value = kwargs.get('value')
+        if value not in self.attrs.get('empty_values', []):
+            self.choices = list(self.choices) + [(value, value)]
+        return super().render(*args, **kwargs)
+
 
 class EnumChoiceField(ChoiceField):
     """
     The default ``ChoiceField`` will only accept the base enumeration values.
     Use this field on forms to accept any value mappable to an enumeration
     including any labels or symmetric properties.
+
+    :param enum: The Enumeration type
+    :param empty_value: Allow users to define what empty is because some
+        enumeration types might use an empty value (i.e. empty string) as an
+        enumeration value. This value will be returned when any "empty" value
+        is encountered. If unspecified the default empty value of '' is
+        returned.
+    :param strict: If False, values not included in the enumeration list, but
+        of the same primitive type are acceptable.
+    :param choices: Override choices, otherwise enumeration choices attribute
+        will be used.
+    :param kwargs: Any additional parameters to pass to ChoiceField base class.
     """
 
-    def __init__(self, enum, *, empty_value='', choices=(), **kwargs):
+    strict = True
+    empty_value = ''
+
+    def __init__(
+            self,
+            enum,
+            *,
+            empty_value=_Unspecified,
+            strict=strict,
+            choices=(),
+            **kwargs
+    ):
         self.enum = enum
-        self.empty_value = empty_value
+        self.strict = strict
+        if not self.strict:
+            kwargs.setdefault('widget', NonStrictSelect)
+
         super().__init__(
             choices=choices or getattr(self.enum, 'choices', ()),
             **kwargs
         )
 
+        if empty_value is not _Unspecified:
+            self.empty_values.insert(0, empty_value)
+            self.empty_value = empty_value
+
+        # remove any of our valid enumeration values or symmetric properties
+        # from our empty value list if there exists an equivalency
+        for empty in self.empty_values:
+            for enum_val in self.enum:
+                if empty == enum_val:
+                    # copy the list instead of modifying the class's
+                    self.empty_values = [
+                        empty for empty in self.empty_values
+                        if empty != enum_val
+                    ]
+                    if empty == self.empty_value:
+                        raise ValueError(
+                            f'Enumeration value {repr(enum_val)} is equivalent'
+                            f' to {self.empty_value}, you must specify a '
+                            f'non-conflicting empty_value.'
+                        )
+
     def _coerce_to_value_type(self, value):
         """Coerce the value to the enumerations value type"""
         return type(self.enum.values[0])(value)
 
     def _coerce(self, value):
-        if value == self.empty_value or value in self.empty_values:
+        """
+        Attempt conversion of value to an enumeration value and return it
+        if successful.
+
+        :param value The value to convert
+        :return An enumeration value or the canonical empty value if value is
+            one of our empty_values, or the value itself if this is a
+            non-strict field and the value is of a matching primitive type
+        :raises ValidationError if a valid return value cannot be determined.
+        """
+        if value in self.empty_values:
             return self.empty_value
         if self.enum is not None and not isinstance(value, self.enum):
             try:
                 value = self.enum(value)
             except (TypeError, ValueError):
                 try:
-                    value = self.enum(self._coerce_to_value_type(value))
+                    value = self._coerce_to_value_type(value)
+                    value = self.enum(value)
                 except (TypeError, ValueError) as err:
-                    raise ValidationError(
-                        f'{value} is not a valid {self.enum}.',
-                        code='invalid_choice',
-                        params={'value': value},
-                    ) from err
+                    if self.strict or not isinstance(
+                            value,
+                            type(self.enum.values[0])
+                    ):
+                        raise ValidationError(
+                            f'{value} is not a valid {self.enum}.',
+                            code='invalid_choice',
+                            params={'value': value},
+                        ) from err
         return value
 
+    def widget_attrs(self, widget):
+        attrs = super().widget_attrs(widget)
+        attrs.setdefault('empty_value', self.empty_value)
+        attrs.setdefault('empty_values', self.empty_values)
+        return attrs
+
     def clean(self, value):
+        """
+        Validate the given value and return its "cleaned" value as an
+        appropriate Python object. Raise ValidationError for any errors.
+        """
         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'
-    #         )
+    def prepare_value(self, value):
+        """Must return the raw enumeration value type"""
+        value = self._coerce(value)
+        return super().prepare_value(
+            value.value
+            if isinstance(value, self.enum)
+            else value
+        )
+
+    def to_python(self, value):
+        """Return the value as its full enumeration object"""
+        return self._coerce(value)
+
+    def valid_value(self, value):
+        """Return false if this value is not valid"""
+        try:
+            self._coerce(value)
+            return True
+        except ValidationError:
+            return False
diff --git a/django_enum/tests/djenum/forms.py b/django_enum/tests/djenum/forms.py
@@ -26,7 +26,7 @@ class EnumTesterForm(ModelForm):
     text = EnumChoiceField(TextEnum)
     dj_int_enum = EnumChoiceField(DJIntEnum)
     dj_text_enum = EnumChoiceField(DJTextEnum)
-    non_strict_int = EnumChoiceField(SmallPosIntEnum)
+    non_strict_int = EnumChoiceField(SmallPosIntEnum, strict=False)
 
     class Meta:
         model = EnumTester
diff --git a/django_enum/tests/djenum/migrations/0001_initial.py b/django_enum/tests/djenum/migrations/0001_initial.py
@@ -1,7 +1,7 @@
 # Generated by Django 3.2.14 on 2022-07-26 03:42
 
-from django.db import migrations, models
 import django_enum.fields
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
diff --git a/django_enum/tests/djenum/urls.py b/django_enum/tests/djenum/urls.py
@@ -5,6 +5,7 @@
     EnumTesterDeleteView,
     EnumTesterDetailView,
     EnumTesterFormCreateView,
+    EnumTesterFormDeleteView,
     EnumTesterFormView,
     EnumTesterListView,
     EnumTesterUpdateView,
@@ -19,7 +20,8 @@
     path('enum/form/add/', EnumTesterFormCreateView.as_view(), name='enum-form-add'),
     path('enum/<int:pk>/', EnumTesterUpdateView.as_view(), name='enum-update'),
     path('enum/form/<int:pk>/', EnumTesterFormView.as_view(), name='enum-form-update'),
-    path('enum/<int:pk>/delete/', EnumTesterDeleteView.as_view(), name='enum-delete')
+    path('enum/<int:pk>/delete/', EnumTesterDeleteView.as_view(), name='enum-delete'),
+    path('enum/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete')
 ]
 
 try:
diff --git a/django_enum/tests/djenum/views.py b/django_enum/tests/djenum/views.py
@@ -46,12 +46,18 @@ class EnumTesterUpdateView(URLMixin, UpdateView):
     fields = '__all__'
     template_name = 'enumtester_form.html'
 
+    def get_success_url(self):  # pragma: no cover
+        return reverse(f'{self.NAMESPACE}:enum-update', kwargs={'pk': self.object.pk})
+
 
 class EnumTesterFormView(URLMixin, UpdateView):
     form_class = EnumTesterForm
     model = EnumTester
     template_name = 'enumtester_form.html'
 
+    def get_success_url(self):  # pragma: no cover
+        return reverse(f'{self.NAMESPACE}:enum-update', kwargs={'pk': self.object.pk})
+
 
 class EnumTesterFormCreateView(URLMixin, CreateView):
     form_class = EnumTesterForm
@@ -67,6 +73,15 @@ def get_success_url(self):  # pragma: no cover
         return reverse(f'{self.NAMESPACE}:enum-list')
 
 
+class EnumTesterFormDeleteView(URLMixin, DeleteView):
+    form_class = EnumTesterForm
+    model = EnumTester
+    template_name = 'enumtester_form.html'
+
+    def get_success_url(self):  # pragma: no cover
+        return reverse(f'{self.NAMESPACE}:enum-list')
+
+
 try:
     from django_enum.filters import FilterSet as EnumFilterSet
     from django_filters.views import FilterView
diff --git a/django_enum/tests/enum_prop/forms.py b/django_enum/tests/enum_prop/forms.py
@@ -28,7 +28,7 @@ class EnumTesterForm(ModelForm):
         text = EnumChoiceField(TextEnum)
         dj_int_enum = EnumChoiceField(DJIntEnum)
         dj_text_enum = EnumChoiceField(DJTextEnum)
-        non_strict_int = EnumChoiceField(SmallPosIntEnum)
+        non_strict_int = EnumChoiceField(SmallPosIntEnum, strict=False)
 
         class Meta:
             model = EnumTester
diff --git a/django_enum/tests/enum_prop/migrations/0001_initial.py b/django_enum/tests/enum_prop/migrations/0001_initial.py
@@ -1,7 +1,7 @@
 # Generated by Django 3.2.14 on 2022-07-26 03:42
 
-from django.db import migrations, models
 import django_enum.fields
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
diff --git a/django_enum/tests/enum_prop/urls.py b/django_enum/tests/enum_prop/urls.py
@@ -6,6 +6,7 @@
         EnumTesterDeleteView,
         EnumTesterDetailView,
         EnumTesterFormCreateView,
+        EnumTesterFormDeleteView,
         EnumTesterFormView,
         EnumTesterListView,
         EnumTesterUpdateView,
@@ -20,7 +21,8 @@
         path('enum/form/add/', EnumTesterFormCreateView.as_view(), name='enum-form-add'),
         path('enum/<int:pk>/', EnumTesterUpdateView.as_view(), name='enum-update'),
         path('enum/form/<int:pk>/', EnumTesterFormView.as_view(), name='enum-form-update'),
-        path('enum/<int:pk>/delete/', EnumTesterDeleteView.as_view(), name='enum-delete')
+        path('enum/<int:pk>/delete/', EnumTesterDeleteView.as_view(), name='enum-delete'),
+        path('enum/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete')
     ]
 
     try:
diff --git a/django_enum/tests/enum_prop/views.py b/django_enum/tests/enum_prop/views.py
@@ -1,5 +1,5 @@
 try:
-    from django.urls import reverse_lazy
+    from django.urls import reverse, reverse_lazy
     from django_enum.filters import FilterSet as EnumFilterSet
     from django_enum.tests.djenum import views
     from django_enum.tests.enum_prop.forms import EnumTesterForm
@@ -25,12 +25,19 @@ class EnumTesterUpdateView(views.EnumTesterUpdateView):
         model = EnumTester
         NAMESPACE = 'django_enum_tests_enum_prop'
 
+        def get_success_url(self):  # pragma: no cover
+            return reverse(f'{self.NAMESPACE}:enum-update',
+                           kwargs={'pk': self.object.pk})
+
 
     class EnumTesterFormView(views.EnumTesterFormView):
         form_class = EnumTesterForm
         model = EnumTester
         NAMESPACE = 'django_enum_tests_enum_prop'
 
+        def get_success_url(self):  # pragma: no cover
+            return reverse(f'{self.NAMESPACE}:enum-update',
+                           kwargs={'pk': self.object.pk})
 
     class EnumTesterFormCreateView(views.EnumTesterFormCreateView):
         form_class = EnumTesterForm
@@ -42,6 +49,12 @@ class EnumTesterDeleteView(views.EnumTesterDeleteView):
         model = EnumTester
         NAMESPACE = 'django_enum_tests_enum_prop'
 
+
+    class EnumTesterFormDeleteView(views.EnumTesterFormDeleteView):
+        form_class = EnumTesterForm
+        model = EnumTester
+        NAMESPACE = 'django_enum_tests_enum_prop'
+
     try:
 
         from django_enum.tests.djenum.views import EnumTesterFilterViewSet
diff --git a/django_enum/tests/tests.py b/django_enum/tests/tests.py
diff --git a/django_enum/tests/tmpls/templates/enumtester_detail.html b/django_enum/tests/tmpls/templates/enumtester_detail.html
diff --git a/setup.cfg b/setup.cfg
