make DRF dependency optional

Author: mbi

CHANGES

@@ -1,6 +1,10 @@
 Version History
 ===============
 
+Version 0.6.2 (unreleased)
+--------------------------
+* Make DRF dependency optional
+
 Version 0.6.1
 -------------
 * Fixed docs and test configuration

captcha/tests/drf_views.py

@@ -0,0 +1,28 @@
+from rest_framework import serializers, status
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+from django.contrib.auth.models import User
+
+from captcha.serializers import CaptchaModelSerializer, CaptchaSerializer
+
+
+@api_view(["POST"])
+def test_serializer(request):
+    serializer = CaptchaSerializer(data=request.POST)
+    serializer.is_valid(raise_exception=True)
+    return Response(status=status.HTTP_200_OK)
+
+
+@api_view(["POST"])
+def test_model_serializer(request):
+    class UserCaptchaModelSerializer(CaptchaModelSerializer):
+        subject = serializers.CharField(max_length=100)
+        sender = serializers.EmailField()
+
+        class Meta:
+            model = User
+            fields = ("subject", "sender", "captcha_code", "captcha_hashkey")
+
+    serializer = UserCaptchaModelSerializer(data=request.POST)
+    serializer.is_valid(raise_exception=True)
+    return Response(status=status.HTTP_200_OK)

captcha/tests/tests.py

@@ -15,9 +15,10 @@
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.translation import gettext_lazy
-
+from django.conf import settings as django_settings
 from captcha.conf import settings
 from captcha.models import CaptchaStore
+from unittest import skipIf
 
 
 @override_settings(ROOT_URLCONF="captcha.tests.urls")
@@ -572,6 +573,10 @@ def test_empty_pool_fallback(self):
         self.assertEqual(CaptchaStore.objects.count(), 1)
         settings.CAPTCHA_GET_FROM_POOL = __current_test_get_from_pool_setting
 
+    @skipIf(
+        "rest_framework" not in django_settings.INSTALLED_APPS,
+        "Only run if DRF is installed",
+    )
     def test_serializer(self):
         r = self.client.post(
             reverse("captcha-test-serializer"),
@@ -582,6 +587,10 @@ def test_serializer(self):
         )
         self.assertEqual(r.status_code, 200)
 
+    @skipIf(
+        "rest_framework" not in django_settings.INSTALLED_APPS,
+        "Only run if DRF is installed",
+    )
     def test_wrong_serializer(self):
         r = self.client.post(
             reverse("captcha-test-serializer"),
@@ -593,6 +602,10 @@ def test_wrong_serializer(self):
         self.assertEqual(r.status_code, 400)
         self.assertEqual(json.loads(r.content), {"error": "Invalid CAPTCHA"})
 
+    @skipIf(
+        "rest_framework" not in django_settings.INSTALLED_APPS,
+        "Only run if DRF is installed",
+    )
     def test_model_serializer(self):
         r = self.client.post(
             reverse("captcha-test-model-serializer"),
@@ -605,6 +618,10 @@ def test_model_serializer(self):
         )
         self.assertEqual(r.status_code, 200)
 
+    @skipIf(
+        "rest_framework" not in django_settings.INSTALLED_APPS,
+        "Only run if DRF is installed",
+    )
     def test_wrong_model_serializer(self):
         r = self.client.post(
             reverse("captcha-test-model-serializer"),

captcha/tests/urls.py

@@ -1,26 +1,19 @@
 from django.urls import include, re_path
+from django.conf import settings
 
 from .views import (
     test,
     test_custom_error_message,
     test_custom_generator,
     test_id_prefix,
     test_model_form,
-    test_model_serializer,
     test_non_required,
-    test_serializer,
 )
 
 
 urlpatterns = [
     re_path(r"test/$", test, name="captcha-test"),
     re_path(r"test-modelform/$", test_model_form, name="captcha-test-model-form"),
-    re_path(r"test-serializer/$", test_serializer, name="captcha-test-serializer"),
-    re_path(
-        r"test-model-serializer/$",
-        test_model_serializer,
-        name="captcha-test-model-serializer",
-    ),
     re_path(
         r"test2/$", test_custom_error_message, name="captcha-test-custom-error-message"
     ),
@@ -31,3 +24,17 @@
     re_path(r"test-id-prefix/$", test_id_prefix, name="captcha-test-id-prefix"),
     re_path(r"", include("captcha.urls")),
 ]
+
+
+if 'rest_framework' in settings.INSTALLED_APPS:
+    from .drf_views import test_serializer, test_model_serializer
+
+    urlpatterns += [
+        re_path(r"test-serializer/$", test_serializer, name="captcha-test-serializer"),
+        re_path(
+            r"test-model-serializer/$",
+            test_model_serializer,
+            name="captcha-test-model-serializer",
+        ),
+
+    ]

captcha/tests/views.py

@@ -1,14 +1,10 @@
-from rest_framework import serializers, status
-from rest_framework.decorators import api_view
-from rest_framework.response import Response
 
 from django import forms
 from django.contrib.auth.models import User
 from django.http import HttpResponse
 from django.template import engines
 
 from captcha.fields import CaptchaField
-from captcha.serializers import CaptchaModelSerializer, CaptchaSerializer
 
 
 TEST_TEMPLATE = r"""
@@ -117,24 +113,3 @@ class CaptchaTestForm(forms.Form):
 
     return _test(request, CaptchaTestForm)
 
-
-@api_view(["POST"])
-def test_serializer(request):
-    serializer = CaptchaSerializer(data=request.POST)
-    serializer.is_valid(raise_exception=True)
-    return Response(status=status.HTTP_200_OK)
-
-
-@api_view(["POST"])
-def test_model_serializer(request):
-    class UserCaptchaModelSerializer(CaptchaModelSerializer):
-        subject = serializers.CharField(max_length=100)
-        sender = serializers.EmailField()
-
-        class Meta:
-            model = User
-            fields = ("subject", "sender", "captcha_code", "captcha_hashkey")
-
-    serializer = UserCaptchaModelSerializer(data=request.POST)
-    serializer.is_valid(raise_exception=True)
-    return Response(status=status.HTTP_200_OK)

setup.py

@@ -35,7 +35,6 @@ def run_tests(self):
     "Django >= 4.2",
     "Pillow >=6.2.0",
     "django-ranged-response == 0.2.0",
-    "djangorestframework >= 3.15.0",
 ]
 EXTRAS_REQUIRE = {"test": ("testfixtures",)}
 

testproject/drf_settings.py

@@ -0,0 +1,3 @@
+from testproject.settings import * # noqa
+INSTALLED_APPS.append("rest_framework") # noqa
+

testproject/settings.py

@@ -29,7 +29,7 @@
     "django.contrib.sites",
     "django.forms",
     "django.contrib.messages",
-    "rest_framework",
+    # "rest_framework",
     "captcha",
 ]
 FORM_RENDERER = "django.forms.renderers.TemplatesSetting"

tox.ini

@@ -7,11 +7,12 @@ envlist =
         py{39,310}-django42-jinja2,
         py{310,311}-django{42,50}-jinja2,
         py312-django{50,51}-jinja2,
+        py313-django52-drf
         gettext,flake8,docs,coverage
 
 [gh-actions]
 python =
-  3.13: py312-django52,
+  3.13: py312-django52, py312-django52-drf
   3.12: py312-django50, py312-django51, py312-django52, py312-django51-jinja2
   3.11: p311-django-51, p311-django-50, p311-django-50-jinjia, p311-django-42, p311-django-42-jinjia
   3.10: py310-django42, py310-django42-jinja2, py310-django50, py310-django51, py310-django50-jinja2
@@ -30,10 +31,10 @@ deps =
         django50: Django>=5.0a,<5.1
         django51: Django>=5.1,<5.2
         django52: Django>=5.2a1,<5.3
-        py{39,310,311,312}-django{42,50}: python3-memcached
+        py{39,310,311,312, 313}-django{42,50,51,52}: python3-memcached
+        py313-django52-drf: djangorestframework
         jinja2
         Pillow
-        djangorestframework
 
 extras =
         test
@@ -54,6 +55,9 @@ commands = python -Wd manage.py test captcha --settings jinja2_settings
 [testenv:py312-django50-jinja2]
 commands = python -Wd manage.py test captcha --settings jinja2_settings
 
+[testenv:py313-django52-drf]
+commands = python -Wd manage.py test captcha --settings drf_settings
+
 
 [testenv:gettext]
 basepython = python3.12
@@ -107,8 +111,9 @@ passenv =
         CAPTCHA_SOX_PATH
 deps =
         coverage
+        djangorestframework
 
 commands=
         # coverage debug config
-        coverage run --rcfile=.coveragerc manage.py test captcha
+        coverage run --rcfile=.coveragerc manage.py test captcha  --settings drf_settings
         coverage report --rcfile=.coveragerc