Sort imports

Author: fsbraun

djangocms_rest/cms_config.py

@@ -1,4 +1,5 @@
 from functools import cached_property
+
 from cms.app_base import CMSAppConfig
 
 

djangocms_rest/permissions.py

@@ -1,6 +1,7 @@
 from cms.models import Page, PageContent
 from cms.utils.i18n import get_language_tuple, get_languages
 from cms.utils.page_permissions import user_can_view_page
+
 from rest_framework.exceptions import NotFound
 from rest_framework.permissions import BasePermission
 from rest_framework.request import Request

djangocms_rest/plugin_rendering.py

@@ -9,6 +9,7 @@
 from cms.utils.plugins import get_plugins
 
 from rest_framework import serializers
+
 from djangocms_rest.serializers.placeholders import PlaceholderSerializer
 from djangocms_rest.serializers.utils.cache import (
     get_placeholder_rest_cache,

djangocms_rest/serializers/pages.py

@@ -1,7 +1,7 @@
-from typing import Dict
+from django.db import models
 
 from cms.models import PageContent
-from django.db import models
+
 from rest_framework import serializers
 
 from djangocms_rest.serializers.placeholders import PlaceholderRelationSerializer
@@ -40,7 +40,7 @@ class PreviewMixin:
 
 
 class BasePageContentMixin:
-    def get_base_representation(self, page_content: PageContent) -> Dict:
+    def get_base_representation(self, page_content: PageContent) -> dict:
         request = getattr(self, "request", None)
         path = page_content.page.get_path(page_content.language)
         absolute_url = get_absolute_frontend_url(request, path)
@@ -74,13 +74,13 @@ def get_base_representation(self, page_content: PageContent) -> Dict:
 
 
 class PageTreeSerializer(serializers.ListSerializer):
-    def __init__(self, tree: Dict, *args, **kwargs):
+    def __init__(self, tree: dict, *args, **kwargs):
         if not isinstance(tree, dict):
             raise TypeError(f"Expected tree to be a dict, got {type(tree).__name__}")
         self.tree = tree
         super().__init__(tree.get(None, []), *args, **kwargs)
 
-    def tree_to_representation(self, item: PageContent) -> Dict:
+    def tree_to_representation(self, item: PageContent) -> dict:
         serialized_data = self.child.to_representation(item)
         serialized_data["children"] = []
         if item.page in self.tree:
@@ -89,7 +89,7 @@ def tree_to_representation(self, item: PageContent) -> Dict:
             ]
         return serialized_data
 
-    def to_representation(self, data: Dict) -> list[Dict]:
+    def to_representation(self, data: dict) -> list[dict]:
         nodes = data.all() if isinstance(data, models.manager.BaseManager) else data
         return [self.tree_to_representation(node) for node in nodes]
 
@@ -127,7 +127,7 @@ def many_init(cls, *args, **kwargs):
         kwargs["child"] = cls(context=context)
         return PageTreeSerializer(tree, *args[1:], **kwargs)
 
-    def to_representation(self, page_content: PageContent) -> Dict:
+    def to_representation(self, page_content: PageContent) -> dict:
         return self.get_base_representation(page_content)
 
 
@@ -138,7 +138,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.request = self.context.get("request")
 
-    def to_representation(self, page_content: PageContent) -> Dict:
+    def to_representation(self, page_content: PageContent) -> dict:
         declared_slots = [
             placeholder.slot
             for placeholder in page_content.page.get_declared_placeholders()
@@ -171,7 +171,7 @@ class PreviewPageContentSerializer(PageContentSerializer, PreviewMixin):
 
     placeholders = PlaceholderRelationSerializer(many=True, required=False)
 
-    def to_representation(self, page_content: PageContent) -> Dict:
+    def to_representation(self, page_content: PageContent) -> dict:
         # Get placeholders directly from the page_content
         # This avoids the extra query to get_declared_placeholders
         placeholders = page_content.placeholders.all()
@@ -198,5 +198,5 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.request = self.context.get("request")
 
-    def to_representation(self, page_content: PageContent) -> Dict:
+    def to_representation(self, page_content: PageContent) -> dict:
         return self.get_base_representation(page_content)

djangocms_rest/serializers/placeholders.py

@@ -1,4 +1,5 @@
 from django.template import Context
+
 from rest_framework import serializers
 
 from djangocms_rest.serializers.utils.render import render_html

djangocms_rest/serializers/plugins.py

@@ -1,9 +1,27 @@
-from rest_framework import serializers
-from cms.plugin_pool import plugin_pool
+from typing import Any, Optional
+
 from django.core.exceptions import FieldDoesNotExist
-from typing import Dict, Any, Optional
 from django.db.models import Field
 
+from cms.models import CMSPlugin
+from cms.plugin_pool import plugin_pool
+
+from rest_framework import serializers
+
+
+class GenericPluginSerializer(serializers.ModelSerializer):
+    def to_representation(self, instance: CMSPlugin):
+        ret = super().to_representation(instance)
+        for field in self.Meta.model._meta.get_fields():
+            if field.is_relation and not field.many_to_many and not field.one_to_many:
+                field_name = field.name
+                if field_name in ret and getattr(instance, field_name, None):
+                    ret[field_name] = self.serialize_fk(field)
+        return ret
+
+    def serialize_fk(self, related_obj):
+        pass
+
 
 class PluginDefinitionSerializer(serializers.Serializer):
     """
@@ -70,7 +88,7 @@ def get_field_format(field: Field) -> Optional[str]:
     return format_mapping.get(field.__class__.__name__)
 
 
-def generate_plugin_definitions() -> Dict[str, Any]:
+def generate_plugin_definitions() -> dict[str, Any]:
     """
     Generate plugin definitions from registered plugins.
 

djangocms_rest/serializers/utils/render.py

@@ -1,15 +1,16 @@
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 from cms.models import CMSPlugin
 from cms.plugin_rendering import ContentRenderer
+
 from rest_framework import serializers
 from sekizai.context import SekizaiContext
 from sekizai.helpers import get_varname
 
 
 def render_plugin(
-    instance: CMSPlugin, context: Dict[str, Any]
-) -> Optional[Dict[str, Any]]:
+    instance: CMSPlugin, context: dict[str, Any]
+) -> Optional[dict[str, Any]]:
     instance, plugin = instance.get_plugin_instance()
     if not instance:
         return None

djangocms_rest/urls.py

@@ -2,6 +2,7 @@
 
 from . import views
 
+
 urlpatterns = [
     # Published content endpoints
     path(

djangocms_rest/utils.py

@@ -1,9 +1,11 @@
-from cms.models import Page, PageUrl
 from django.contrib.sites.models import Site
 from django.contrib.sites.shortcuts import get_current_site
 from django.core.exceptions import FieldError
 from django.db.models import QuerySet
 from django.http import Http404
+
+from cms.models import Page, PageUrl
+
 from rest_framework.request import Request
 
 

djangocms_rest/views.py

@@ -1,19 +1,17 @@
+from django.contrib.sites.shortcuts import get_current_site
+
 from cms.models import PageContent, Placeholder
 from cms.utils.conf import get_languages
 from cms.utils.page_permissions import user_can_view_page
-from django.contrib.sites.shortcuts import get_current_site
+
 from rest_framework.exceptions import NotFound
 from rest_framework.pagination import LimitOffsetPagination
 from rest_framework.permissions import IsAdminUser
 from rest_framework.request import Request
 from rest_framework.response import Response
 
-from djangocms_rest.permissions import (
-    CanViewPage,
-    IsAllowedPublicLanguage,
-)
+from djangocms_rest.permissions import CanViewPage, IsAllowedPublicLanguage
 from djangocms_rest.serializers.languages import LanguageSerializer
-
 from djangocms_rest.serializers.pages import (
     PageContentSerializer,
     PageListSerializer,
@@ -28,6 +26,7 @@
 from djangocms_rest.utils import get_object, get_site_filtered_queryset
 from djangocms_rest.views_base import BaseAPIView, BaseListAPIView
 
+
 try:
     from drf_spectacular.types import OpenApiTypes  # noqa: F401
     from drf_spectacular.utils import OpenApiParameter, extend_schema  # noqa: F401