Add SecretFieldModel and its serializer to handle secret fields.

Author: CorneiZeR

tests/test_viewset_mixin.py

@@ -4,7 +4,7 @@
 from rest_framework.test import APIClient
 from time_machine import TimeMachineFixture
 
-from tests.testapp.models import ExampleModel, AllFieldsModel, Tag
+from tests.testapp.models import ExampleModel, AllFieldsModel, Tag, SecretFieldModel
 
 pytestmark = pytest.mark.django_db
 
@@ -93,3 +93,20 @@ def test_all_fields_viewset(
         True,
         "test, example",
     ]
+
+
+def test_secret_field_viewset(api_client, workbook_reader):
+    SecretFieldModel.objects.create(title="foo", secret="bar")
+
+    response = api_client.get("/secret-field/")
+    assert response.status_code == 200
+
+    wb = workbook_reader(response.content)
+    sheet = wb.worksheets[0]
+    rows = list(sheet.rows)
+    assert len(rows) == 2
+    header, data = rows
+
+    # Check that the secret field is not included in the header or data
+    assert [col.value for col in header] == ["title"]
+    assert [col.value for col in data] == ["foo"]

tests/testapp/models.py

@@ -30,3 +30,11 @@ def __str__(self):
 
     def get_tag_names(self):
         return [tag.name for tag in self.tags.all()]
+
+
+class SecretFieldModel(models.Model):
+    title = models.CharField(max_length=100)
+    secret = models.CharField(max_length=100)
+
+    def __str__(self):
+        return self.title

tests/testapp/serializers.py

@@ -1,6 +1,6 @@
 from rest_framework import serializers
 
-from .models import ExampleModel, AllFieldsModel
+from .models import ExampleModel, AllFieldsModel, SecretFieldModel
 
 
 class ExampleSerializer(serializers.ModelSerializer):
@@ -23,3 +23,14 @@ class Meta:
             "is_active",
             "tags",
         )
+
+class SecretFieldSerializer(serializers.ModelSerializer):
+    secret_external = serializers.CharField(write_only=True)
+
+    class Meta:
+        model = SecretFieldModel
+        fields = ("title", "secret", "secret_external")
+
+        extra_kwargs = {
+            "secret": {"write_only": True}
+        }

tests/testapp/views.py

@@ -2,8 +2,8 @@
 from drf_excel.mixins import XLSXFileMixin
 from drf_excel.renderers import XLSXRenderer
 
-from .models import ExampleModel, AllFieldsModel
-from .serializers import ExampleSerializer, AllFieldsSerializer
+from .models import ExampleModel, AllFieldsModel, SecretFieldModel
+from .serializers import ExampleSerializer, AllFieldsSerializer, SecretFieldSerializer
 
 
 class ExampleViewSet(XLSXFileMixin, ReadOnlyModelViewSet):
@@ -18,3 +18,10 @@ class AllFieldsViewSet(XLSXFileMixin, ReadOnlyModelViewSet):
     serializer_class = AllFieldsSerializer
     renderer_classes = (XLSXRenderer,)
     filename = "al_fileds.xlsx"
+
+
+class SecretFieldViewSet(XLSXFileMixin, ReadOnlyModelViewSet):
+    queryset = SecretFieldModel.objects.all()
+    serializer_class = SecretFieldSerializer
+    renderer_classes = (XLSXRenderer,)
+    filename = "secret.xlsx"

tests/urls.py

@@ -1,9 +1,10 @@
 from rest_framework import routers
 
-from .testapp.views import ExampleViewSet, AllFieldsViewSet
+from .testapp.views import ExampleViewSet, AllFieldsViewSet, SecretFieldViewSet
 
 router = routers.SimpleRouter()
 router.register(r"examples", ExampleViewSet)
 router.register(r"all-fields", AllFieldsViewSet)
+router.register(r"secret-field", SecretFieldViewSet)
 
 urlpatterns = router.urls