base model serializer

codeforlife/serializers/__init__.py

@@ -0,0 +1,6 @@
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:19:12(+00:00).
+"""
+
+from .base import *

codeforlife/serializers/base.py

@@ -0,0 +1,21 @@
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:19:24(+00:00).
+
+Base model serializers.
+"""
+
+import typing as t
+
+from django.db.models import Model
+from rest_framework.serializers import ModelSerializer as _ModelSerializer
+
+AnyModel = t.TypeVar("AnyModel", bound=Model)
+
+
+class ModelSerializer(_ModelSerializer[AnyModel], t.Generic[AnyModel]):
+    """Base model serializer for all model serializers."""
+
+    # pylint: disable-next=useless-parent-delegation
+    def update(self, instance, validated_data: t.Dict[str, t.Any]):
+        return super().update(instance, validated_data)

codeforlife/user/serializers/klass.py

@@ -1,10 +1,14 @@
-from rest_framework import serializers
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:28:29(+00:00).
+"""
 
+from ...serializers import ModelSerializer
 from ..models import Class
 
 
 # pylint: disable-next=missing-class-docstring
-class ClassSerializer(serializers.ModelSerializer[Class]):
+class ClassSerializer(ModelSerializer[Class]):
     # pylint: disable-next=missing-class-docstring,too-few-public-methods
     class Meta:
         model = Class

codeforlife/user/serializers/school.py

@@ -1,10 +1,14 @@
-from rest_framework import serializers
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:28:19(+00:00).
+"""
 
+from ...serializers import ModelSerializer
 from ..models import School
 
 
 # pylint: disable-next=missing-class-docstring
-class SchoolSerializer(serializers.ModelSerializer[School]):
+class SchoolSerializer(ModelSerializer[School]):
     # pylint: disable-next=missing-class-docstring,too-few-public-methods
     class Meta:
         model = School

codeforlife/user/serializers/student.py

@@ -1,10 +1,14 @@
-from rest_framework import serializers
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:27:56(+00:00).
+"""
 
+from ...serializers import ModelSerializer
 from ..models import Student
 
 
 # pylint: disable-next=missing-class-docstring
-class StudentSerializer(serializers.ModelSerializer[Student]):
+class StudentSerializer(ModelSerializer[Student]):
     # pylint: disable-next=missing-class-docstring,too-few-public-methods
     class Meta:
         model = Student

codeforlife/user/serializers/teacher.py

@@ -1,10 +1,14 @@
-from rest_framework import serializers
+"""
+© Ocado Group
+Created on 20/01/2024 at 11:27:43(+00:00).
+"""
 
+from ...serializers import ModelSerializer
 from ..models import Teacher
 
 
 # pylint: disable-next=missing-class-docstring
-class TeacherSerializer(serializers.ModelSerializer[Teacher]):
+class TeacherSerializer(ModelSerializer[Teacher]):
     # pylint: disable-next=missing-class-docstring,too-few-public-methods
     class Meta:
         model = Teacher

codeforlife/user/serializers/user.py

@@ -3,15 +3,14 @@
 Created on 19/01/2024 at 11:06:00(+00:00).
 """
 
-from rest_framework import serializers
-
+from ...serializers import ModelSerializer
 from ..models import User
 from .student import StudentSerializer
 from .teacher import TeacherSerializer
 
 
 # pylint: disable-next=missing-class-docstring
-class UserSerializer(serializers.ModelSerializer[User]):
+class UserSerializer(ModelSerializer[User]):
     student = StudentSerializer(
         source="new_student",
         read_only=True,