dynamicforms 0.76.18__tar.gz → 0.76.20__tar.gz

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dynamicforms
-Version: 0.76.18
+Version: 0.76.20
 Summary: DynamicForms performs all the visualisation & data entry of your DRF Serializers & ViewSets and adds some candy of its own
 Project-URL: Homepage, https://github.com/velis74/DynamicForms
 Project-URL: Repository, https://github.com/velis74/DynamicForms

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/dynamicforms/__init__.py

@@ -1,5 +1,5 @@
 __title__ = "DynamicForms"
-__version__ = '0.76.18'
+__version__ = '0.76.20'
 __author__ = "Jure Erznožnik"
 __email__ = "jure.erznoznik@gmail.com"
 __license__ = "BSD 3-Clause"

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/dynamicforms/serializers.py

@@ -1,9 +1,11 @@
 from collections import OrderedDict
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
+from django.conf import settings
 from django.core.exceptions import FieldDoesNotExist
 from django.db import models
 from django.db.models.fields.related import RelatedField
+from django.utils.module_loading import import_string
 from rest_framework import serializers
 from rest_framework.fields import get_attribute, SkipField
 
@@ -484,3 +486,46 @@ class Serializer(DynamicFormsSerializer, serializers.Serializer):
     def create(self, validated_data):
         # Implemented just so IDE doesn't complain. Normally this will be handled in SingleRecordViewSet
         pass
+
+
+class DynamicModelMixin:
+    MODEL_FUNC_SETTING_NAME = None
+
+    def determine_model_at_runtime(self, request) -> Optional[models.Model]:
+        """
+        Determines what model should be the basis for the serializer at runtime. Allows for dynamic model adjustments
+        based on active code at the time of serialization
+        :return:
+        """
+        try:
+            model_func = import_string(getattr(settings, self.MODEL_FUNC_SETTING_NAME, None))
+            return model_func(self, request)
+        except ImportError:
+            pass
+        return None
+
+
+class DynamicModelSerializerMixin(DynamicModelMixin):
+    LAYOUT_FUNC_SETTING_NAME = None
+
+    def __init__(self, *args, **kwargs):
+        if model := self.determine_model_at_runtime(self.request):
+            self.meta.model = model
+        super().__init__(*args, **kwargs)
+
+    def determine_layout_at_runtime(self, request):
+        """
+        Determines what layout should be used for displaying the model at runtime. Allows for dynamic model adjustments
+        based on active code at the time of serialization
+        Usually you would override this like this:
+          layout = self.Meta.layout.clone()
+          layout.append_after_row('name_of_field', Row(...))
+          return layout
+        """
+        try:
+            layout_func = import_string(getattr(settings, self.LAYOUT_FUNC_SETTING_NAME, None))
+            return layout_func(self, request)
+        except ImportError:
+            pass
+        return self.Meta.layout
+

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/dynamicforms/template_render/layout.py

@@ -15,6 +15,9 @@ class Field(object):
         self.field_name = field_name
         self.render_format = render_format
 
+    def clone(self):
+        return Field(self.field_name, self.render_format)
+
     def field_def(self, serializer: "Serializer") -> Union[DFField, DRFSerializer]:
         return serializer.fields[self.field_name]
 
@@ -44,6 +47,9 @@ class Column(object):
         #  specify how big a column was to be used. Needs to change to support the Vue / Vuetify components and
         #  their props now. task: https://app.clickup.com/t/86bzw1k8f
 
+    def clone(self):
+        return Column(field=self.field.clone() if self.field else None, width_classes=self.width_classes)
+
     def _get_laid_fields(self):
         return {self.field.field_name} if self.field is not None else set()
 
@@ -69,6 +75,9 @@ class Row(object):
             else:
                 raise NotImplementedError(f"Unknown column type {column.__class__.__name__}")
 
+    def clone(self):
+        return Row(*[col.clone() for col in self.columns], component=self.component)
+
     def _get_laid_fields(self):
         return set().union(*(col._get_laid_fields() for col in self.columns))
 
@@ -102,6 +111,28 @@ class Layout(object):
         self.component_name = component_name
         self.auto_add_fields = auto_add_fields
 
+    def clone(self):
+        return Layout(
+            *[row.clone() for row in self.rows],
+            component_name=self.component_name,
+            columns=self.columns,
+            size=self.size,
+            header_classes=self.header_classes,
+            auto_add_fields=self.auto_add_fields
+        )
+
+    def append_after_row(self, field_name: Optional[str], *rows: Row):
+        """Adds new rows after the row with specified field. if field_name is None, inserts new rows at beginning"""
+        if field_name is None:
+            self.rows[0:0] = rows
+            return
+        for i, row in enumerate(self.rows):
+            for column in row.columns:
+                if column.field and column.field.field_name == field_name:
+                    self.rows[i + 1:i + 1] = rows
+                    return
+        raise ValueError(f"Field {field_name} not found in the layout")
+
     def _get_laid_fields(self):
         return set().union(*(row._get_laid_fields() for row in self.rows))
 
@@ -158,6 +189,15 @@ class Group(Column):
         self.layout = sub_layout
         self.footer = footer
 
+    def clone(self):
+        return Group(
+            field=self.field.clone() if self.field else None,
+            title=self.title,
+            sub_layout=self.layout.clone() if self.layout else None,
+            width_classes=self.width_classes,
+            footer=self.footer
+        )
+
     def _get_laid_fields(self):
         if self.field is None:
             return self.layout._get_laid_fields()

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/dynamicforms/template_render/mixins/serializer.py

@@ -188,7 +188,9 @@ class ViewModeSerializer(ViewModeBase, SerializerFilter, metaclass=SerializerMet
     @property
     def layout(self):
         template_context = getattr(self, "template_context", {})
-        if hasattr(self, "Meta") and hasattr(self.Meta, "layout"):
+        if hasattr(self, 'determine_layout_at_runtime') and (layout := self.determine_layout_at_runtime(self.request)):
+            return layout
+        elif hasattr(self, "Meta") and hasattr(self.Meta, "layout"):
             return self.Meta.layout
         else:
             from dynamicforms.template_render.layout import Layout

{dynamicforms-0.76.18 → dynamicforms-0.76.20}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "dynamicforms"
-version = "0.76.18"
+version = "0.76.20"
 description = "DynamicForms performs all the visualisation & data entry of your DRF Serializers & ViewSets and adds some candy of its own"
 readme = "README.md"
 requires-python = ">=3.8"