Moved rendering to fieldWidget

Author: eadwinCode

tests/test_zform_field_list.py

@@ -25,7 +25,8 @@ def test_add_item(field_list):
     new_field = field_list.add_item()
     assert len(field_list._items) == 1
     assert isinstance(new_field, StringField)
-    assert new_field.name == "xys.0"
+    assert new_field.name == "xys"
+    assert new_field.field_info_args.alias == "xys.0"
 
 
 def test_clear_items(field_list):
@@ -59,7 +60,8 @@ def test_extra_indices(field_list):
 def test_get_new_field_at(field_list):
     new_field = field_list._get_new_field_at("xys.2")
     assert isinstance(new_field, StringField)
-    assert new_field.name == "xys.2"
+    assert new_field.name == "xys"
+    assert new_field.field_info_args.alias == "xys.2"
 
 
 def test_field_list_iteration(field_list):
@@ -74,8 +76,10 @@ def test_field_list_indexing(field_list):
     field_list.add_item()
     field_list.add_item()
     assert isinstance(field_list._items[0], StringField)
-    assert field_list._items[0].name == "xys.0"
-    assert field_list._items[1].name == "xys.1"
+    assert field_list._items[0].name == "xys"
+    assert field_list._items[0].field_info_args.alias == "xys.0"
+    assert field_list._items[1].name == "xys"
+    assert field_list._items[1].field_info_args.alias == "xys.1"
 
 
 def test_field_list_len(field_list):

tests/test_zform_obj_field.py

@@ -73,8 +73,8 @@ def test_process(object_field):
     data = {"name": "Alice", "age": 25}
     object_field.process(data)
 
-    assert object_field._fields[0]._value == "Alice"
-    assert object_field._fields[1]._value == 25
+    assert object_field._fields[0].value == "Alice"
+    assert object_field._fields[1].value == 25
 
 
 def test_python_type_with_schema(schema_object_field):

zform/fields/base.py

@@ -19,6 +19,54 @@
 T_ = t.TypeVar("T_")
 
 
+class FieldTransientData:
+    def __init__(self) -> None:
+        self._data = None
+        self.errors = []
+        self.raw_data = None
+        self._value = None
+
+    @property
+    def value(self) -> t.Any:
+        return self._value
+
+    @value.setter
+    def value(self, value: t.Any) -> None:
+        """
+        Set the data associated with the field.
+
+        Args:
+            value: The data to set.
+        """
+        self._value = value
+
+    @property
+    def data(self) -> t.Any:
+        """
+        Get the data associated with the field.
+
+        Returns:
+            t.Any: The data associated with the field.
+        """
+        return self.raw_data if self.raw_data else self._data
+
+    @data.setter
+    def data(self, value: t.Any) -> None:
+        """
+        Set the data associated with the field.
+
+        Args:
+            value: The data to set.
+        """
+        self._data = value
+
+    def clear(self):
+        self.data = None
+        self.errors = []
+        self.raw_data = None
+        self._value = None
+
+
 class FieldBaseMeta(type):
     def __call__(cls, *args: t.Any, **kwargs: t.Any):
         field_info_args = kwargs.pop("field_info_args", None)
@@ -65,18 +113,14 @@ def __init__(
         disabled: t.Optional[bool] = False,
         read_only: t.Optional[bool] = False,
         field_info_args: t.Optional[t.Union[AttributeDict, t.Dict]] = None,
+        help_text: t.Optional[str] = None,
         **attrs: t.Any,
     ) -> None:
         # A field is fully configured when __field_info_args__ is provided
         assert self.type
 
-        self._value = None
         self.name = name or "no-name"
         self.id = id
-
-        self._data = None
-        self.raw_data = None
-        self.errors = []
         self._default = None
         self.attrs = AttributeDict(
             attrs,
@@ -86,7 +130,7 @@ def __init__(
                 "class": class_,
             },
         )
-        self.help_text = None
+        self.help_text = help_text
         self.label = None
 
         self._field_info_args = AttributeDict(
@@ -103,7 +147,9 @@ def __init__(
                 self.id = self._field_info.alias
             self.label = FormLabel(self.id, label or self.name.capitalize())
             self.help_text = self.help_text or self._field_info_args.description
+
         self._widget: t.Optional[FieldWidget] = None
+        self._transient_data = FieldTransientData()
 
     @property
     def widget(self) -> FieldWidget:
@@ -157,23 +203,41 @@ def required(self) -> bool:
 
     @property
     def data(self) -> t.Any:
-        """
-        Get the data associated with the field.
-
-        Returns:
-            t.Any: The data associated with the field.
-        """
-        return self.raw_data if self.raw_data else self._data
+        return self._transient_data.data
 
     @data.setter
     def data(self, value: t.Any) -> None:
+        self._transient_data.data = value
+
+    @property
+    def errors(self) -> t.List[str]:
+        return self._transient_data.errors
+
+    @errors.setter
+    def errors(self, value: t.Any) -> None:
+        self._transient_data.errors = value
+
+    @property
+    def raw_data(self) -> t.Any:
+        return self._transient_data.raw_data
+
+    @raw_data.setter
+    def raw_data(self, value: t.Any) -> None:
+        self._transient_data.raw_data = value
+
+    @property
+    def value(self) -> T_:
         """
-        Set the data associated with the field.
+        Get the processed value of the field.
 
-        Args:
-            value: The data to set.
+        Returns:
+            T_: The processed value of the field.
         """
-        self._data = value
+        return t.cast(T_, self._transient_data.value)
+
+    @value.setter
+    def value(self, value: t.Any) -> t.Any:
+        self._transient_data.value = value
 
     @default.setter
     def default(self, value: t.Any) -> None:
@@ -196,24 +260,11 @@ def model_field(self) -> ModelField:
         """
         return self.__resolver.model_field
 
-    @property
-    def value(self) -> T_:
+    def clear(self) -> None:
         """
-        Get the processed value of the field.
-
-        Returns:
-            T_: The processed value of the field.
-        """
-        return self._value
-
-    def clear(self):
+        Clear the field's value and errors.
         """
-        Clear all field inputs and validation.
-        """
-        self.raw_data = None
-        self.errors = []
-        self._data = None
-        self._value = None
+        self._transient_data.clear()
 
     def validate_setup(self) -> None:
         """
@@ -234,13 +285,13 @@ def process(
             data: The input data to process.
             suppress_error: Whether to suppress validation errors.
         """
-        self.errors.clear()
+        self._transient_data.errors.clear()
         v_, errors_ = self.model_field.validate(
             data, {"processing_data": True}, loc=(self.__class__.__name__,)
         )
 
         if not errors_:
-            self._value = v_
+            self.value = v_
             # export to JSON for UI to understand
             self.data = fail_silently(self.model_field.serialize, v_) or v_
 
@@ -254,6 +305,7 @@ def load(self) -> "FieldBase":
         Returns:
             FieldBase: The field instance with the default value loaded.
         """
+        self._transient_data.clear()
         self.process(self.default, suppress_error=True)
         return self
 
@@ -343,7 +395,7 @@ def __apply_model_field(self) -> None:
         self.__resolver = FormParameterResolver(new_model_field)
 
     async def process_form_data(
-        self, ctx: IExecutionContext, body: t.Any
+        self, ctx: IExecutionContext, body: t.Any, **kwargs: t.Any
     ) -> ResolverResult:
         """
         Process form data for the field.
@@ -355,12 +407,12 @@ async def process_form_data(
         Returns:
             ResolverResult: The result of the form data processing.
         """
-        res = await self.__resolver.resolve(ctx, body=body)
+        res = await self.__resolver.resolve(ctx, body=body, **kwargs)
         _, self.raw_data = dict(res.raw_data).popitem()
         self.errors = format_errors(res.errors)
 
         if not res.errors:
-            self._value = res.data[self.model_field.name]
+            self.value = res.data[self.model_field.name]
 
         return res
 
@@ -452,7 +504,7 @@ def rebuild(
         z_field_info_args.update(
             name=name,
             field_info_args=AttributeDict(
-                **field_info_args,
+                field_info_args,
                 alias=alias,
                 annotation=annotation or get_form_field_python_type(self),
                 default=default,

zform/fields/flist.py

@@ -35,7 +35,7 @@ def get_render_context(self) -> t.Dict:
             Dict: A dictionary containing the field and the next index for rendering.
         """
         ctx = super().get_render_context()
-        ctx.update(field=self, next_index=len(self.field._items))
+        ctx.update(field=self, next_index=len(self.field.items))
         return ctx
 
 
@@ -79,7 +79,6 @@ class MyModel(BaseModel):
     """
 
     type = "list"
-
     widgetType: t.Type[FieldWidget] = FieldListWidget
 
     def __init__(
@@ -116,7 +115,7 @@ def _get_new_field_at(self, alias: str) -> FieldBase:
             FieldBase: A new instance of the base field type.
         """
         kwargs = dict(getattr(self._base_field, ZFORM_FIELD_ATTRIBUTES, {}))
-        kwargs.update(name=alias)
+        kwargs.update(alias=alias, name=self.name)
         instance = self._base_field.create_from_annotation(
             annotation=get_form_field_python_type(self._base_field), **kwargs
         )
@@ -133,6 +132,16 @@ def validate_setup(self) -> None:
             self.model_field.type_
         ), "Annotation must be a Sequence"
 
+    @property
+    def items(self) -> t.List[FieldBase]:
+        """
+        Get the list of items in the field.
+
+        Returns:
+            List[FieldBase]: The list of items in the field.
+        """
+        return list(self._items)
+
     @property
     def python_type(self) -> t.Type:
         """
@@ -160,7 +169,7 @@ def process(
                 self.add_item().process(item_data, suppress_error=suppress_error)
 
     async def process_form_data(
-        self, ctx: IExecutionContext, body: t.Any
+        self, ctx: IExecutionContext, body: t.Any, **kwargs: t.Any
     ) -> ResolverResult:
         """
         Process form data for the entire list of fields.
@@ -186,8 +195,8 @@ async def process_form_data(
             self._items.append(field)
             res = await field.process_form_data(ctx, body=body)
 
-            values.append(res.data[key] if res.data else None)
-            raw_data[str(index)] = res.raw_data[key]
+            values.append(res.data[self.name] if res.data else None)
+            raw_data[str(index)] = res.raw_data[self.name]
 
             if res.errors:
                 errors.setdefault(self.model_field.alias, []).extend(res.errors)

zform/fields/obj.py

@@ -65,7 +65,6 @@ class FormSerializer(BaseModel):
     """
 
     type: t.Optional[str] = "json"
-
     widgetType: t.Type[FieldWidget] = ObjectFieldWidget
 
     def __init__(
@@ -139,6 +138,12 @@ def _name_formatter(self, name: str) -> str:
         Returns:
             str: Formatted name including this field's ID.
         """
+        if self.field_info_args.alias:
+            return (
+                self.field_info_args.alias
+                + ("." if self.field_info_args.alias else "")
+                + name
+            )
         return self.id + ("." if self.id else "") + name
 
     def __iter__(self) -> t.Iterator[FieldBase]:
@@ -180,7 +185,7 @@ async def _process_form_data(
         return values, errors, raw_data
 
     async def process_form_data(
-        self, ctx: IExecutionContext, body: t.Any
+        self, ctx: IExecutionContext, body: t.Any, **kwargs: t.Any
     ) -> ResolverResult:
         """
         Process and validate form data for this object field.