dynamicforms 0.76.19__tar.gz → 0.77.1__tar.gz

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dynamicforms
-Version: 0.76.19
+Version: 0.77.1
 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.19 → dynamicforms-0.77.1}/docs/reference/layout.md

@@ -18,7 +18,7 @@ class MySerializer(serializers.ModelSerializer):
         fields = ['field1', 'field2', 'field3', 'field4']
         layout = Layout(
             Row('field1', 'field2'),
-            Row(Column('field3'), Column(Field('field4'))),
+            Row(Column('field3'), Column(Field('field4', 'my_component_name'))),
         )
 ```
 
@@ -43,7 +43,7 @@ Layout(
 * rows: A list of Row objects defining the layout structure.
 * component_name: The name of the Vue component to use for rendering (default: "df-form-layout"). Used for overriding 
   default rendering.
-* columns: Number of columns for automatically added fields (default: 1).
+* columns: Number of columns for automatically added fields (default: 1). Also important for layout and colspan.
 * size: Size of the layout ("small", "large", "", etc.). Mostly effective when this layout is going to be rendered in a 
   dialog. See [DialogSize](dialog-size) for reference on size classes. 
 * header_classes: CSS classes for the header.
@@ -58,12 +58,12 @@ The Row class represents a horizontal group of columns.
 from typing import Union
 from dynamicforms.template_render.layout import Layout, Row, Column, Field
 
-Row(*columns: Union[Column, Field, str], component="FormRow")
+Row(*columns: Union[Column, Field, str], component_name="FormRow")
 ```
 
 * columns: A list of Column objects or field names.
-* component: The name of the Vue component to use for rendering (default: "FormRow"). Change when overriding default 
-  rendering components.
+* component_name: The name of the Vue component to use for rendering (default: "FormRow"). Change when overriding
+  default rendering components.
 
 ## Column
 
@@ -74,10 +74,10 @@ from typing import Union, Optional, Tuple
 from dynamicforms.template_render.layout import Layout, Row, Column, Field
 from dynamicforms.fields import DFField
 
-Column(field: Union[Tuple[str, DFField], Field, str, None], width_classes: Optional[str] = None)
+Column(field: Union[Tuple[str, DFField], Field, str, None], colspan: int = 1)
 ```
 * field: A Field object or field name.
-* width_classes: CSS classes for controlling column width. Note: subject to change soon. 
+* colspan: how many columns does this field span. See Layout.columns property 
 
 
 ## Group
@@ -92,7 +92,7 @@ Group(
     field: Union[str, Field, None],
     title: str = None, 
     sub_layout: Layout = None, 
-    width_classes: Optional[str] = None,
+    colspan: int = 1,
     footer: Optional[str] = None,
 )
 ```
@@ -100,7 +100,7 @@ Group(
 * field: A Field object, field name, or None for flat field grouping.
 * title: The title of the group.
 * sub_layout: A Layout object for custom layout within the group.
-* width_classes: CSS classes for controlling group width.
+* colspan: how many columns does this group span in the layout.
 * footer: Optional footer text for the group.
 
 Groups can be used in two main ways:

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/dynamicforms/__init__.py

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

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/dynamicforms/serializers.py

@@ -491,7 +491,7 @@ class Serializer(DynamicFormsSerializer, serializers.Serializer):
 class DynamicModelMixin:
     MODEL_FUNC_SETTING_NAME = None
 
-    def determine_model_at_runtime(self) -> Optional[models.Model]:
+    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
@@ -499,7 +499,7 @@ class DynamicModelMixin:
         """
         try:
             model_func = import_string(getattr(settings, self.MODEL_FUNC_SETTING_NAME, None))
-            return model_func(self)
+            return model_func(self, request)
         except ImportError:
             pass
         return None
@@ -509,11 +509,11 @@ class DynamicModelSerializerMixin(DynamicModelMixin):
     LAYOUT_FUNC_SETTING_NAME = None
 
     def __init__(self, *args, **kwargs):
-        if model := self.determine_model_at_runtime():
-            self.meta.model = model
+        if model := self.determine_model_at_runtime(kwargs.get("context", {}).get("request")):
+            self.Meta.model = model
         super().__init__(*args, **kwargs)
 
-    def determine_layout_at_runtime(self):
+    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
@@ -524,7 +524,7 @@ class DynamicModelSerializerMixin(DynamicModelMixin):
         """
         try:
             layout_func = import_string(getattr(settings, self.LAYOUT_FUNC_SETTING_NAME, None))
-            return layout_func(self)
+            return layout_func(self, request)
         except ImportError:
             pass
         return self.Meta.layout

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/dynamicforms/template_render/layout.py

@@ -11,12 +11,12 @@ if TYPE_CHECKING:
 
 
 class Field(object):
-    def __init__(self, field_name: str, render_format: Optional[str] = None):
+    def __init__(self, field_name: str, component_name: Optional[str] = None):
         self.field_name = field_name
-        self.render_format = render_format
+        self.component_name = component_name
 
     def clone(self):
-        return Field(self.field_name, self.render_format)
+        return Field(self.field_name, self.component_name)
 
     def field_def(self, serializer: "Serializer") -> Union[DFField, DRFSerializer]:
         return serializer.fields[self.field_name]
@@ -25,14 +25,18 @@ class Field(object):
         field = self.field_def(serializer).as_component_def()
 
         field["name"] = self.field_name
-        if self.render_format:
-            field["render_format"] = self.render_format
+        field["component_name"] = self.component_name
         fields[self.field_name] = field
         return field["name"]
 
 
 class Column(object):
-    def __init__(self, field: Union[Tuple[str, DFField], Field, str, None], width_classes: Optional[str] = None):
+    def __init__(
+        self,
+        field: Union[Tuple[str, DFField], Field, str, None],
+        colspan: int = 1,
+        component_name: Optional[str] = "form-field",
+    ):
         if isinstance(field, str):
             self.field = Field(field)
         elif isinstance(field, Field):
@@ -42,13 +46,13 @@ class Column(object):
             self.field = field
         else:
             raise NotImplementedError(f"Unknown field type {field.__class__.__name__}")
-        self.width_classes = width_classes or ""
-        # TODO: It was a lot more useful when bootstrap was the front-end framework and this basically allowed to
-        #  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
+        self.component_name = component_name
+        self.colspan = colspan or 1
 
     def clone(self):
-        return Column(field=self.field.clone() if self.field else None, width_classes=self.width_classes)
+        return Column(
+            field=self.field.clone() if self.field else None, colspan=self.colspan, component_name=self.component_name
+        )
 
     def _get_laid_fields(self):
         return {self.field.field_name} if self.field is not None else set()
@@ -56,14 +60,15 @@ class Column(object):
     def as_component_def(self, serializer: "Serializer", fields: Dict) -> Dict:
         fld_def = self.field.as_component_def(serializer, fields) if self.field is not None else dict()
         res = dict(type="column", field=fld_def)
-        if self.width_classes:
-            res["width_classes"] = self.width_classes
+        if self.colspan != 1:
+            res["colspan"] = self.colspan
+        res["component_name"] = self.component_name
         return res
 
 
 class Row(object):
-    def __init__(self, *columns: Union[Column, Field, str], component: str = None):
-        self.component = component or "FormRow"
+    def __init__(self, *columns: Union[Column, Field, str], component_name: str = "form-row"):
+        self.component_name = component_name
         self.columns: List[Column] = []
         for column in columns:
             if isinstance(column, str):
@@ -76,14 +81,15 @@ class Row(object):
                 raise NotImplementedError(f"Unknown column type {column.__class__.__name__}")
 
     def clone(self):
-        return Row(*[col.clone() for col in self.columns], component=self.component)
+        return Row(*[col.clone() for col in self.columns], component_name=self.component_name)
 
     def _get_laid_fields(self):
         return set().union(*(col._get_laid_fields() for col in self.columns))
 
     def as_component_def(self, serializer: "Serializer", fields: Dict) -> dict:
         return dict(
-            component=self.component, columns=[col.as_component_def(serializer, fields) for col in self.columns]
+            component_name=self.component_name,
+            columns=[col.as_component_def(serializer, fields) for col in self.columns],
         )
 
 
@@ -103,6 +109,8 @@ class Layout(object):
         :param columns: for all fields not added in layout manually, add them in n-column layout
         :param size: 'small', 'large' or ''
         :param header_classes: 'bg-info', ..., or ''
+        :param auto_add_fields: whether we should automatically add all unlisted fields
+          from the serializer (in as_component_def)
         """
         self.rows: List[Row] = list(rows) or []
         self.columns = columns
@@ -118,19 +126,24 @@ class Layout(object):
             columns=self.columns,
             size=self.size,
             header_classes=self.header_classes,
-            auto_add_fields=self.auto_add_fields
+            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"""
+        """
+        Adds new rows after the row with specified field. if field_name is None, inserts new rows at beginning.
+        Note that if specified field is in a subgroup, the new rows will not be inserted in the subgroup,
+        but below it instead.
+        """
         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
+            if field_name in row._get_laid_fields():
+                self.rows[i + 1 : i + 1] = rows
+                return
+
         raise ValueError(f"Field {field_name} not found in the layout")
 
     def _get_laid_fields(self):
@@ -181,21 +194,25 @@ class Group(Column):
         field: Union[str, Field, None],
         title: str = None,
         sub_layout: Layout = None,
-        width_classes: Optional[str] = None,
+        colspan: int = 1,
         footer: Optional[str] = None,
+        component_name: Optional[str] = "form-field-group",
     ):
-        super().__init__(field, width_classes)
+        super().__init__(field=field, colspan=colspan, component_name=component_name)
         self.title = title
         self.layout = sub_layout
         self.footer = footer
+        self.component_name = component_name
+        assert self.field or self.layout
 
     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
+            colspan=self.colspan,
+            footer=self.footer,
+            component_name=self.component_name,
         )
 
     def _get_laid_fields(self):
@@ -205,7 +222,6 @@ class Group(Column):
 
     def as_component_def(self, serializer: "Serializer", fields: Dict) -> Dict:
         res = super().as_component_def(serializer, fields)
-        assert self.field or self.layout
         sub_serializer = self.field.field_def(serializer) if self.field else None  # type: Serializer
         layout = self.layout or sub_serializer.layout
         res.update(
@@ -214,5 +230,6 @@ class Group(Column):
             title=self.title or sub_serializer.label,
             uuid=sub_serializer.uuid if sub_serializer else uuid.uuid4(),
             layout=layout.as_component_def(sub_serializer if sub_serializer else serializer),
+            component_name=self.component_name,
         )
         return res

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/dynamicforms/template_render/mixins/serializer.py

@@ -188,7 +188,7 @@ class ViewModeSerializer(ViewModeBase, SerializerFilter, metaclass=SerializerMet
     @property
     def layout(self):
         template_context = getattr(self, "template_context", {})
-        if hasattr(self, 'determine_layout_at_runtime') and (layout := self.determine_layout_at_runtime()):
+        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

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/examples/rest/basic_fields.py

@@ -2,7 +2,7 @@ from django.utils.translation import gettext_lazy as _
 
 from dynamicforms import fields, serializers
 from dynamicforms.action import Actions, TableAction, TablePosition
-from dynamicforms.template_render.layout import Layout
+from dynamicforms.template_render.layout import Group, Layout, Row
 from dynamicforms.template_render.responsive_table_layout import ResponsiveTableLayout, ResponsiveTableLayouts
 from dynamicforms.viewsets import ModelViewSet
 
@@ -55,7 +55,23 @@ class BasicFieldsSerializer(serializers.ModelSerializer):
     class Meta:
         model = BasicFields
         exclude = ()
-        layout = Layout(columns=3, size="large")
+        layout = Layout(
+            Row(
+                Group(
+                    None,
+                    "Booleans",
+                    Layout(Row("boolean_field"), Row("nullboolean_field"), auto_add_fields=False),
+                ),
+                Group(
+                    None,
+                    "Text fields",
+                    Layout(Row("char_field"), Row("slug_field"), Row("password_field"), auto_add_fields=False),
+                    colspan=2,
+                ),
+            ),
+            columns=3,
+            size="large",
+        )
         responsive_columns = ResponsiveTableLayouts(
             auto_generate_single_row_layout=True,
             layouts=[
@@ -81,7 +97,7 @@ class BasicFieldsSerializer(serializers.ModelSerializer):
                     auto_add_non_listed_columns=True,
                 ),
             ],
-            auto_generate_single_column_layout=True,
+            auto_generate_single_column_layout=False,
         )
 
 

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/examples/rest/calendar.py

@@ -61,7 +61,7 @@ class CalendarEventSerializer(RecurrenceEventSerializer):
             Row("description"),
             Row("start_at", "end_at"),
             Row("reminders"),
-            Row(Group("recurrence", width_classes="col-8"), Column("change_this_record_only", "col-4")),
+            Row(Group("recurrence", colspan=8), Column("change_this_record_only", colspan=4)),
             columns=2,
             size="large",
         )

{dynamicforms-0.76.19 → dynamicforms-0.77.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "dynamicforms"
-version = "0.76.19"
+version = "0.77.1"
 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"