refactor views to simplify serializer and schema handling

- Remove drf-spectacular import and extend_schema decorator

Author: metaforx

djangocms_rest/serializers/placeholders.py

@@ -96,23 +96,29 @@ class PlaceholderSerializer(serializers.Serializer):
     language = serializers.CharField()
     content = serializers.ListSerializer(child=serializers.JSONField(), allow_empty=True, required=False)
 
-    def __init__(self, request: Request, placeholder: Placeholder, language: str, *args, **kwargs):
-        renderer = PlaceholderRenderer(request)
-        placeholder.content = renderer.render_placeholder(
-            placeholder,
-            context={},
-            language=language,
-            use_cache=True,
-        )
-        if request.GET.get("html", False):
-            html = render_html(request, placeholder, language)
-            for key, value in html.items():
-                if not hasattr(placeholder, key):
-                    setattr(placeholder, key, value)
-                    self.fields[key] = serializers.CharField()
-        placeholder.label = placeholder.get_label()
-        placeholder.language = language
-        super().__init__(placeholder, *args, **kwargs)
+    def __init__(self, *args, **kwargs):
+        request = kwargs.pop('request', None)
+        placeholder = kwargs.pop('instance', None)
+        language = kwargs.pop('language', None)
+        super().__init__(*args, **kwargs)
+
+        if placeholder and request and language:
+            renderer = PlaceholderRenderer(request)
+            placeholder.content = renderer.render_placeholder(
+                placeholder,
+                context={},
+                language=language,
+                use_cache=True,
+            )
+            if request.GET.get("html", False):
+                html = render_html(request, placeholder, language)
+                for key, value in html.items():
+                    if not hasattr(placeholder, key):
+                        setattr(placeholder, key, value)
+                        self.fields[key] = serializers.CharField()
+            placeholder.label = placeholder.get_label()
+            placeholder.language = language
+            self.instance = placeholder
 
 
 class PlaceholderRelationFieldSerializer(serializers.Serializer):

djangocms_rest/views.py

@@ -14,31 +14,13 @@
 from djangocms_rest.utils import get_object, get_placeholder
 from djangocms_rest.views_base import BaseAPIView
 
-try:
-    from drf_spectacular.utils import extend_schema
-except ImportError:
-
-    def extend_schema(*args, **kwargs):
-        """
-        Empty decorator for when drf-spectacular is not installed.
-        """
-
-        def decorator(func):
-            return func
-
-        return decorator
-
 
 class LanguageListView(BaseAPIView):
-    """
-    List of languages available for the site. For each language the API returns the
-    link to the list of pages for that languages.
-    """
-
-    @extend_schema(
-        responses={200: LanguageSerializer},
-    )
+    serializer_class = LanguageSerializer
+
     def get(self, request: Request) -> Response:
+        """List of languages available for the site. For each language the API returns the
+        link to the list of pages for that languages."""
         languages = get_languages().get(get_current_site(request).id, None)
         if languages is None:
             raise Http404
@@ -49,16 +31,11 @@ def get(self, request: Request) -> Response:
 
 
 class PageTreeListView(BaseAPIView):
-    """
-    List of all pages on this site for a given language.
-    """
-
     permission_classes = [IsAllowedLanguage]
+    serializer_class = PageMetaSerializer
 
-    @extend_schema(
-        responses=PageMetaSerializer, description="Get a list of all pages for the given language on the current site."
-    )
     def get(self, request, language):
+        """List of all pages on this site for a given language."""
         site = self.site
         qs = Page.objects.filter(node__site=site)
         if request.user.is_anonymous:
@@ -77,18 +54,12 @@ def get(self, request, language):
 
 
 class PageDetailView(BaseAPIView):
-    """
-    Retrieve a page instance. The page instance includes the placeholders and
-    their links to retrieve dynamic content.
-    """
-
     permission_classes = [CanViewPage]
+    serializer_class = PageContentSerializer
 
-    @extend_schema(
-        responses=PageContentSerializer,
-        description="Get a page instance with placeholders and their links to retrieve dynamic content.",
-    )
     def get(self, request: Request, language: str, path: str = "") -> Response:
+        """Retrieve a page instance. The page instance includes the placeholders and
+        their links to retrieve dynamic content."""
         site = self.site
         page = get_object(site, path)
         self.check_object_permissions(request, page)
@@ -102,23 +73,22 @@ def get(self, request: Request, language: str, path: str = "") -> Response:
 
 
 class PlaceholderDetailView(BaseAPIView):
-    """Placeholder contain the dynamic content. This view retrieves the content as a
-    structured nested object.
-
-    Attributes:
-
-    - "slot": The slot name of the placeholder.
-    - "content": The content of the placeholder as a nested JSON tree
-    - "language": The language of the content
-    - "label": The verbose label of the placeholder
-
-    Optional (if the get parameter `?html=1` is added to the API url):
-    - "html": The content rendered as html. Sekizai blocks such as "js" or "css" will be added
-      as separate attributes"""
-
+    serializer_class = PlaceholderSerializer
     permission_classes = [CanViewPageContent]
 
     def get(self, request: Request, language: str, content_type_id: int, object_id: int, slot: str) -> Response:
+        """Placeholder contain the dynamic content. This view retrieves the content as a
+        structured nested object.
+
+        Attributes:
+        - "slot": The slot name of the placeholder.
+        - "content": The content of the placeholder as a nested JSON tree
+        - "language": The language of the content
+        - "label": The verbose label of the placeholder
+
+        Optional (if the get parameter `?html=1` is added to the API url):
+        - "html": The content rendered as html. Sekizai blocks such as "js" or "css" will be added
+          as separate attributes"""
         placeholder = get_placeholder(content_type_id, object_id, slot)
         if placeholder is None:
             raise Http404
@@ -129,5 +99,5 @@ def get(self, request: Request, language: str, content_type_id: int, object_id:
 
         self.check_object_permissions(request, source)
 
-        serializer = PlaceholderSerializer(request, placeholder, language, read_only=True)
+        serializer = self.serializer_class(instance=placeholder, request=request, language=language, read_only=True)
         return Response(serializer.data)