add drf specific EnumField serializer

bckohan · bckohan · commit 4095e28ba4b4 · 2022-08-11T02:30:30.000-07:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -48,6 +48,12 @@ jobs:
     - name: Remove enum-properties
       run: |
         poetry run pip uninstall -y enum-properties
+    - name: Install djangorestframework
+      run: |
+        poetry install -E djangorestframework
+    - name: Run Unit Tests w/ djangorestframework
+      run: |
+        poetry run pytest --cov-fail-under=30
     - name: Install django-filters
       run: |
         poetry install -E filters
diff --git a/django_enum/drf.py b/django_enum/drf.py
@@ -0,0 +1,79 @@
+"""Support for django rest framework symmetric serialization"""
+
+
+try:
+    from typing import Any, Type, Union
+
+    from django.db.models import Choices
+    from rest_framework.fields import ChoiceField
+
+    class EnumField(ChoiceField):
+        """
+        A djangorestframework serializer field for Enumeration types. If
+        unspecified ModelSerializers will assign django_enum.fields.EnumField
+        model field types to ChoiceFields. ChoiceFields do not accept
+        symmetrical values, this field will.
+
+        :param enum: The type of the Enumeration of the field
+        :param strict: If True (default) only values in the Enumeration type
+            will be acceptable. If False, no errors will be thrown if other
+            values of the same primitive type are used
+        :param kwargs: Any other named arguments applicable to a ChoiceField
+            will be passed up to the base classes.
+        """
+
+        enum: Type[Choices]
+        strict: bool = True
+
+        def __init__(
+                self,
+                enum: Type[Choices],
+                strict: bool = strict,
+                **kwargs
+        ):
+            self.enum = enum
+            self.strict = strict
+            self.choices = kwargs.pop('choices', enum.choices)
+            super().__init__(choices=self.choices, **kwargs)
+
+        def to_internal_value(self, data: Any) -> Union[Choices, Any]:
+            """
+            Transform the *incoming* primitive data into an enum instance.
+            """
+            if data == '' and self.allow_blank:
+                return ''
+
+            if not isinstance(data, self.enum):
+                try:
+                    data = self.enum(data)
+                except (TypeError, ValueError):
+                    try:
+                        data = type(self.enum.values[0])(data)
+                        data = self.enum(data)
+                    except (TypeError, ValueError):
+                        if self.strict or not isinstance(
+                            data,
+                            type(self.enum.values[0])
+                        ):
+                            self.fail('invalid_choice', input=data)
+            return data
+
+        def to_representation(self, value: Any) -> Any:
+            """
+            Transform the *outgoing* enum value into its primitive value.
+            """
+            return getattr(value, 'value', value)
+
+
+except (ImportError, ModuleNotFoundError):
+
+    class _MissingDjangoRestFramework:
+        """Throw error if drf support is used without djangorestframework"""
+
+        def __init__(self, *args, **kwargs):
+            raise ImportError(
+                f'{self.__class__.__name__} requires djangorestframework to '
+                f'be installed.'
+            )
+
+    EnumField = _MissingDjangoRestFramework  # type: ignore
diff --git a/django_enum/tests/djenum/urls.py b/django_enum/tests/djenum/urls.py
@@ -1,7 +1,6 @@
 from django.urls import include, path
 from django_enum.tests.djenum.models import EnumTester
 from django_enum.tests.djenum.views import (
-    DRFView,
     EnumTesterCreateView,
     EnumTesterDeleteView,
     EnumTesterDetailView,
@@ -11,14 +10,10 @@
     EnumTesterListView,
     EnumTesterUpdateView,
 )
-from rest_framework import routers
 
 app_name = 'django_enum_tests_djenum'
 
 
-router = routers.DefaultRouter()
-router.register(r'enumtesters', DRFView)
-
 urlpatterns = [
     path('enum/<int:pk>', EnumTesterDetailView.as_view(), name='enum-detail'),
     path('enum/list/', EnumTesterListView.as_view(), name='enum-list'),
@@ -27,10 +22,22 @@
     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/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete'),
-    path('drf/', include(router.urls))
+    path('enum/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete')
 ]
 
+
+try:
+    from django_enum.tests.djenum.views import DRFView
+    from rest_framework import routers
+
+    router = routers.DefaultRouter()
+    router.register(r'enumtesters', DRFView)
+    urlpatterns.append(path('drf/', include(router.urls)))
+
+except ImportError:  # pragma: no cover
+    pass
+
+
 try:
     from django_enum.tests.djenum.views import EnumTesterFilterViewSet
     from django_filters.views import FilterView
diff --git a/django_enum/tests/djenum/views.py b/django_enum/tests/djenum/views.py
@@ -4,7 +4,6 @@
 from django_enum.tests.djenum import enums as dj_enums
 from django_enum.tests.djenum.forms import EnumTesterForm
 from django_enum.tests.djenum.models import EnumTester
-from rest_framework import serializers, viewsets
 
 
 class URLMixin:
@@ -97,15 +96,21 @@ def get_success_url(self):  # pragma: no cover
         return reverse(f'{self.NAMESPACE}:enum-list')
 
 
-class EnumTesterSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = EnumTester
-        fields = '__all__'
+try:
+    from rest_framework import serializers, viewsets
+
+    class EnumTesterSerializer(serializers.ModelSerializer):
+        class Meta:
+            model = EnumTester
+            fields = '__all__'
 
 
-class DRFView(viewsets.ModelViewSet):
-    queryset = EnumTester.objects.all()
-    serializer_class = EnumTesterSerializer
+    class DRFView(viewsets.ModelViewSet):
+        queryset = EnumTester.objects.all()
+        serializer_class = EnumTesterSerializer
+
+except (ImportError, ModuleNotFoundError):  # pragma: no cover
+    pass
 
 
 try:
diff --git a/django_enum/tests/enum_prop/urls.py b/django_enum/tests/enum_prop/urls.py
@@ -2,7 +2,6 @@
     from django.urls import include, path
     from django_enum.tests.enum_prop.models import EnumTester
     from django_enum.tests.enum_prop.views import (
-        DRFView,
         EnumTesterCreateView,
         EnumTesterDeleteView,
         EnumTesterDetailView,
@@ -12,13 +11,9 @@
         EnumTesterListView,
         EnumTesterUpdateView,
     )
-    from rest_framework import routers
 
     app_name = 'django_enum_tests_enum_prop'
 
-    router = routers.DefaultRouter()
-    router.register(r'enumtesters', DRFView)
-
     urlpatterns = [
         path('enum/<int:pk>', EnumTesterDetailView.as_view(), name='enum-detail'),
         path('enum/list/', EnumTesterListView.as_view(), name='enum-list'),
@@ -27,10 +22,20 @@
         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/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete'),
-        path('drf/', include(router.urls))
+        path('enum/form/<int:pk>/delete/', EnumTesterFormDeleteView.as_view(), name='enum-form-delete')
     ]
 
+    try:
+        from django_enum.tests.enum_prop.views import DRFView
+        from rest_framework import routers
+
+        router = routers.DefaultRouter()
+        router.register(r'enumtesters', DRFView)
+        urlpatterns.append(path('drf/', include(router.urls)))
+
+    except ImportError:  # pragma: no cover
+        pass
+
     try:
         from django_enum.tests.enum_prop.views import EnumTesterFilterViewSet
         from django_filters.views import FilterView
diff --git a/django_enum/tests/enum_prop/views.py b/django_enum/tests/enum_prop/views.py
@@ -3,9 +3,20 @@
     from django_enum.filters import FilterSet as EnumFilterSet
     from django_enum.tests.djenum import views
     from django_enum.tests.enum_prop import enums as prop_enums
+    from django_enum.tests.enum_prop.enums import (
+        BigIntEnum,
+        BigPosIntEnum,
+        Constants,
+        DJIntEnum,
+        DJTextEnum,
+        IntEnum,
+        PosIntEnum,
+        SmallIntEnum,
+        SmallPosIntEnum,
+        TextEnum,
+    )
     from django_enum.tests.enum_prop.forms import EnumTesterForm
     from django_enum.tests.enum_prop.models import EnumTester
-    from rest_framework import serializers, viewsets
 
 
     class EnumTesterDetailView(views.EnumTesterDetailView):
@@ -66,17 +77,39 @@ class EnumTesterFormDeleteView(views.EnumTesterFormDeleteView):
         enums = prop_enums
 
 
-    class EnumTesterSerializer(serializers.ModelSerializer):
-        class Meta:
-            model = EnumTester
-            fields = '__all__'
+    try:
+
+        from django_enum.drf import EnumField
+        from rest_framework import serializers, viewsets
+
+        class EnumTesterSerializer(serializers.ModelSerializer):
 
+            small_pos_int = EnumField(SmallPosIntEnum, allow_null=True)
+            small_int = EnumField(SmallIntEnum)
+            pos_int = EnumField(PosIntEnum)
+            int = EnumField(IntEnum, allow_null=True)
+            big_pos_int = EnumField(BigPosIntEnum, allow_null=True)
+            big_int = EnumField(BigIntEnum)
+            constant = EnumField(Constants, allow_null=True)
+            text = EnumField(TextEnum, allow_null=True)
+            dj_int_enum = EnumField(DJIntEnum)
+            dj_text_enum = EnumField(DJTextEnum)
+            non_strict_int = EnumField(SmallPosIntEnum, strict=False, allow_null=True)
+            non_strict_text = EnumField(TextEnum, strict=False, allow_blank=True)
+            no_coerce = EnumField(SmallPosIntEnum, allow_null=True)
 
-    class DRFView(viewsets.ModelViewSet):
-        queryset = EnumTester.objects.all()
-        serializer_class = EnumTesterSerializer
+            class Meta:
+                model = EnumTester
+                fields = '__all__'
 
 
+        class DRFView(viewsets.ModelViewSet):
+            queryset = EnumTester.objects.all()
+            serializer_class = EnumTesterSerializer
+
+    except (ImportError, ModuleNotFoundError):  # pragma: no cover
+        pass
+
     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/pyproject.toml b/pyproject.toml
