fh-pydantic-form 0.2.3__tar.gz → 0.2.5__tar.gz

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fh-pydantic-form
-Version: 0.2.3
+Version: 0.2.5
 Summary: a library to turn any pydantic BaseModel object into a fasthtml/monsterui input form
 Project-URL: Homepage, https://github.com/Marcura/fh-pydantic-form
 Project-URL: Repository, https://github.com/Marcura/fh-pydantic-form

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/RELEASE_NOTES.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## Version 0.2.5 (2025-06-19)
+
+- Fix bug with empty lists. Now should parse correctly to empty lists instead of returning defaults.
+## Version 0.2.4 (2025-06-18)
+
+- Added support for SkipJsonSchema fields. They will automatically be excluded from the form and defaults used for validation. 
 ## Version 0.2.3 (2025-06-16 )
 
 - Removed the custom css injection for compact spacing. Instead applying to components directly. 

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fh-pydantic-form"
-version = "0.2.3"
+version = "0.2.5"
 description = "a library to turn any pydantic BaseModel object into a fasthtml/monsterui input form"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -49,6 +49,7 @@ markers = [
     "slow: tests that take longer to run",
     "enum: tests specifically for enum field functionality",
     "unit: fast unit tests with minimal dependencies",
+    "e2e: end to end tests, somewhat slow" 
 ]
 
 [build-system]

fh_pydantic_form-0.2.5/src/fh_pydantic_form/constants.py

@@ -0,0 +1,12 @@
+"""
+Shared constants and sentinel values used across the library.
+"""
+
+
+class _Unset:
+    """Sentinel class to indicate an unset value."""
+
+    pass
+
+
+_UNSET = _Unset()

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/src/fh_pydantic_form/defaults.py

@@ -2,11 +2,16 @@ from __future__ import annotations
 
 import datetime as _dt
 from enum import Enum
-from typing import Any, get_args, get_origin, Literal
+from typing import Any, Literal, get_args, get_origin
 
 from pydantic import BaseModel
 
-from .type_helpers import _UNSET, get_default, _is_optional_type
+from fh_pydantic_form.constants import _UNSET
+from fh_pydantic_form.type_helpers import (
+    _is_optional_type,
+    _is_skip_json_schema_field,
+    get_default,
+)
 
 
 def _today():
@@ -122,6 +127,23 @@ def default_dict_for_model(model_cls: type[BaseModel]) -> dict[str, Any]:
             continue
         # --------------------------------------------------------------------
 
+        # Check if this is a SkipJsonSchema field - if so, always get its default
+        if _is_skip_json_schema_field(field):
+            default_val = get_default(field)
+            if default_val is not _UNSET:
+                # Handle BaseModel defaults by converting to dict
+                if hasattr(default_val, "model_dump"):
+                    out[name] = default_val.model_dump()
+                # Convert enum instances to their values
+                elif isinstance(default_val, Enum):
+                    out[name] = default_val.value
+                else:
+                    out[name] = default_val
+            else:
+                # No default for SkipJsonSchema field - use smart default
+                out[name] = default_for_annotation(field.annotation)
+            continue
+
         # 1. Check for model-supplied default or factory
         default_val = get_default(field)  # returns _UNSET if no default
         if default_val is not _UNSET:

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/src/fh_pydantic_form/field_renderers.py

@@ -15,9 +15,9 @@ from fastcore.xml import FT
 from pydantic import ValidationError
 from pydantic.fields import FieldInfo
 
+from fh_pydantic_form.constants import _UNSET
 from fh_pydantic_form.registry import FieldRendererRegistry
 from fh_pydantic_form.type_helpers import (
-    _UNSET,
     _get_underlying_type_if_optional,
     _is_optional_type,
     get_default,

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/src/fh_pydantic_form/form_parser.py

@@ -7,6 +7,8 @@ from typing import (
     Optional,
     Tuple,
     Union,
+    get_origin,
+    get_args,
 )
 
 from fh_pydantic_form.type_helpers import (
@@ -14,6 +16,7 @@ from fh_pydantic_form.type_helpers import (
     _is_enum_type,
     _is_literal_type,
     _is_optional_type,
+    _is_skip_json_schema_field,
 )
 
 logger = logging.getLogger(__name__)
@@ -32,17 +35,16 @@ def _identify_list_fields(model_class) -> Dict[str, Dict[str, Any]]:
     list_fields = {}
     for field_name, field_info in model_class.model_fields.items():
         annotation = getattr(field_info, "annotation", None)
-        if (
-            annotation is not None
-            and hasattr(annotation, "__origin__")
-            and annotation.__origin__ is list
-        ):
-            item_type = annotation.__args__[0]
-            list_fields[field_name] = {
-                "item_type": item_type,
-                "is_model_type": hasattr(item_type, "model_fields"),
-                "field_info": field_info,  # Store for later use if needed
-            }
+        if annotation is not None:
+            # Handle Optional[List[...]] by unwrapping the Optional
+            base_ann = _get_underlying_type_if_optional(annotation)
+            if get_origin(base_ann) is list:
+                item_type = get_args(base_ann)[0]
+                list_fields[field_name] = {
+                    "item_type": item_type,
+                    "is_model_type": hasattr(item_type, "model_fields"),
+                    "field_info": field_info,  # Store for later use if needed
+                }
     return list_fields
 
 
@@ -77,6 +79,11 @@ def _parse_non_list_fields(
         if field_name in exclude_fields:
             continue
 
+        # Skip SkipJsonSchema fields - they should not be parsed from form data
+        if _is_skip_json_schema_field(field_info):
+            logger.debug(f"Skipping SkipJsonSchema field during parsing: {field_name}")
+            continue
+
         # Create full key with prefix
         full_key = f"{base_prefix}{field_name}"
 
@@ -91,11 +98,21 @@ def _parse_non_list_fields(
 
         # Handle Literal fields (including Optional[Literal[...]])
         elif _is_literal_type(annotation):
-            result[field_name] = _parse_literal_field(full_key, form_data, field_info)
+            if full_key in form_data:  # User sent it
+                result[field_name] = _parse_literal_field(
+                    full_key, form_data, field_info
+                )
+            elif _is_optional_type(annotation):  # Optional but omitted
+                result[field_name] = None
+            # otherwise leave the key out – defaults will be injected later
 
         # Handle Enum fields (including Optional[Enum])
         elif _is_enum_type(annotation):
-            result[field_name] = _parse_enum_field(full_key, form_data, field_info)
+            if full_key in form_data:  # User sent it
+                result[field_name] = _parse_enum_field(full_key, form_data, field_info)
+            elif _is_optional_type(annotation):  # Optional but omitted
+                result[field_name] = None
+            # otherwise leave the key out – defaults will be injected later
 
         # Handle nested model fields (including Optional[NestedModel])
         elif (
@@ -112,9 +129,14 @@ def _parse_non_list_fields(
             # Get the nested model class (unwrap Optional if needed)
             nested_model_class = _get_underlying_type_if_optional(annotation)
 
-            # Parse the nested model - pass the base_prefix
+            # Parse the nested model - pass the base_prefix and exclude_fields
             nested_value = _parse_nested_model_field(
-                field_name, form_data, nested_model_class, field_info, base_prefix
+                field_name,
+                form_data,
+                nested_model_class,
+                field_info,
+                base_prefix,
+                exclude_fields,
             )
 
             # Only assign if we got a non-None value or the field is not optional
@@ -126,8 +148,13 @@ def _parse_non_list_fields(
 
         # Handle simple fields
         else:
-            # Use updated _parse_simple_field that handles optionality
-            result[field_name] = _parse_simple_field(full_key, form_data, field_info)
+            if full_key in form_data:  # User sent it
+                result[field_name] = _parse_simple_field(
+                    full_key, form_data, field_info
+                )
+            elif _is_optional_type(annotation):  # Optional but omitted
+                result[field_name] = None
+            # otherwise leave the key out – defaults will be injected later
 
     return result
 
@@ -249,6 +276,7 @@ def _parse_nested_model_field(
     nested_model_class,
     field_info,
     parent_prefix: str = "",
+    exclude_fields: Optional[List[str]] = None,
 ) -> Optional[Dict[str, Any]]:
     """
     Parse a nested Pydantic model field from form data.
@@ -282,6 +310,13 @@ def _parse_nested_model_field(
             sub_key = f"{current_prefix}{sub_field_name}"
             annotation = getattr(sub_field_info, "annotation", None)
 
+            # Skip SkipJsonSchema fields - they should not be parsed from form data
+            if _is_skip_json_schema_field(sub_field_info):
+                logger.debug(
+                    f"Skipping SkipJsonSchema field in nested model during parsing: {sub_field_name}"
+                )
+                continue
+
             # Handle based on field type, with Optional unwrapping
             is_optional = _is_optional_type(annotation)
             base_type = _get_underlying_type_if_optional(annotation)
@@ -323,6 +358,7 @@ def _parse_nested_model_field(
                 form_data,
                 nested_list_defs,
                 current_prefix,  # ← prefix for this nested model
+                exclude_fields,  # Pass through exclude_fields
             )
             # Merge without clobbering keys already set in step 1
             for lf_name, lf_val in list_results.items():
@@ -404,6 +440,7 @@ def _parse_list_fields(
     form_data: Dict[str, Any],
     list_field_defs: Dict[str, Dict[str, Any]],
     base_prefix: str = "",
+    exclude_fields: Optional[List[str]] = None,
 ) -> Dict[str, List[Any]]:
     """
     Parse list fields from form data by analyzing keys and reconstructing ordered lists.
@@ -412,10 +449,13 @@ def _parse_list_fields(
         form_data: Dictionary containing form field data
         list_field_defs: Dictionary of list field definitions
         base_prefix: Prefix to use when looking up field names in form_data
+        exclude_fields: Optional list of field names to exclude from parsing
 
     Returns:
         Dictionary with parsed list fields
     """
+    exclude_fields = exclude_fields or []
+
     # Skip if no list fields defined
     if not list_field_defs:
         return {}
@@ -497,20 +537,18 @@ def _parse_list_fields(
         if items:  # Only add if items were found
             final_lists[field_name] = items
 
-    # For any list field that didn't have form data, use its default
+    # Ensure every rendered list field appears in final_lists
     for field_name, field_def in list_field_defs.items():
-        if field_name not in final_lists:
-            field_info = field_def["field_info"]
-            if hasattr(field_info, "default") and field_info.default is not None:
-                final_lists[field_name] = field_info.default
-            elif (
-                hasattr(field_info, "default_factory")
-                and field_info.default_factory is not None
-            ):
-                try:
-                    final_lists[field_name] = field_info.default_factory()
-                except Exception:
-                    pass
+        # Skip list fields the UI never showed (those in exclude_fields)
+        if field_name in exclude_fields:
+            continue
+
+        # When user supplied ≥1 item we already captured it
+        if field_name in final_lists:
+            continue
+
+        # User submitted form with zero items → honour intent with empty list
+        final_lists[field_name] = []
 
     return final_lists
 
@@ -543,7 +581,9 @@ def _parse_model_list_item(
     )
     # 2. Parse inner lists
     result.update(
-        _parse_list_fields(form_data, nested_list_defs, base_prefix=item_prefix)
+        _parse_list_fields(
+            form_data, nested_list_defs, base_prefix=item_prefix, exclude_fields=[]
+        )
     )
     return result
 

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/src/fh_pydantic_form/form_renderer.py

@@ -17,6 +17,7 @@ import monsterui.all as mui
 from fastcore.xml import FT
 from pydantic import BaseModel
 
+from fh_pydantic_form.constants import _UNSET
 from fh_pydantic_form.defaults import default_dict_for_model, default_for_annotation
 from fh_pydantic_form.field_renderers import (
     BaseFieldRenderer,
@@ -30,7 +31,7 @@ from fh_pydantic_form.form_parser import (
 )
 from fh_pydantic_form.list_path import walk_path
 from fh_pydantic_form.registry import FieldRendererRegistry
-from fh_pydantic_form.type_helpers import _UNSET, get_default
+from fh_pydantic_form.type_helpers import _is_skip_json_schema_field, get_default
 from fh_pydantic_form.ui_style import (
     SpacingTheme,
     SpacingValue,
@@ -344,6 +345,11 @@ class PydanticForm(Generic[ModelType]):
                 logger.debug(f"Skipping excluded field: {field_name}")
                 continue
 
+            # Skip SkipJsonSchema fields (they should not be rendered in the form)
+            if _is_skip_json_schema_field(field_info):
+                logger.debug(f"Skipping SkipJsonSchema field: {field_name}")
+                continue
+
             # Only use what was explicitly provided in initial values
             initial_value = (
                 self.values_dict.get(field_name) if self.values_dict else None
@@ -578,35 +584,30 @@ class PydanticForm(Generic[ModelType]):
         # Merge list results into the main result
         result.update(list_results)
 
-        # Inject defaults for excluded fields before returning
-        self._inject_default_values_for_excluded(result)
+        # Inject defaults for missing fields before returning
+        self._inject_missing_defaults(result)
 
         return result
 
-    def _inject_default_values_for_excluded(
-        self, data: Dict[str, Any]
-    ) -> Dict[str, Any]:
+    def _inject_missing_defaults(self, data: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Ensures that every field listed in self.exclude_fields is present in data
-        if the model defines a default or default_factory, or if initial_values were provided.
-
-        Also ensures all model fields have appropriate defaults if missing.
+        Ensures all model fields with defaults are present in data if missing.
+        Handles excluded fields, SkipJsonSchema fields, and any other fields
+        not rendered in the form.
 
         Priority order:
         1. initial_values (if provided during form creation)
         2. model defaults/default_factory
 
-        Operates top-level only (exclude_fields spec is top-level names).
-
         Args:
             data: Dictionary to modify in-place
 
         Returns:
             The same dictionary instance for method chaining
         """
-        # Handle excluded fields first
-        for field_name in self.exclude_fields:
-            # Skip if already present (e.g., user provided initial_values)
+        # Process ALL model fields, not just excluded ones
+        for field_name, field_info in self.model_class.model_fields.items():
+            # Skip if already present in parsed data
             if field_name in data:
                 continue
 
@@ -617,17 +618,10 @@ class PydanticForm(Generic[ModelType]):
                 if hasattr(initial_val, "model_dump"):
                     initial_val = initial_val.model_dump()
                 data[field_name] = initial_val
-                logger.debug(
-                    f"Injected initial value for excluded field '{field_name}'"
-                )
+                logger.debug(f"Injected initial value for missing field '{field_name}'")
                 continue
 
             # Second priority: use model defaults
-            field_info = self.model_class.model_fields.get(field_name)
-            if field_info is None:
-                logger.warning(f"exclude_fields contains unknown field '{field_name}'")
-                continue
-
             default_val = get_default(field_info)
             if default_val is not _UNSET:
                 # If the default is a BaseModel, convert to dict for consistency
@@ -635,27 +629,17 @@ class PydanticForm(Generic[ModelType]):
                     default_val = default_val.model_dump()
                 data[field_name] = default_val
                 logger.debug(
-                    f"Injected model default value for excluded field '{field_name}'"
+                    f"Injected model default value for missing field '{field_name}'"
                 )
             else:
-                # No default → leave missing; validation will surface error
-                logger.debug(f"No default found for excluded field '{field_name}'")
-
-        # Also handle any other missing fields that should have defaults
-        for field_name, field_info in self.model_class.model_fields.items():
-            if field_name not in data:
-                # Try to inject defaults for missing fields
-                if field_name in self.initial_values_dict:
-                    initial_val = self.initial_values_dict[field_name]
-                    if hasattr(initial_val, "model_dump"):
-                        initial_val = initial_val.model_dump()
-                    data[field_name] = initial_val
+                # Check if this is a SkipJsonSchema field
+                if _is_skip_json_schema_field(field_info):
+                    logger.debug(
+                        f"No default found for SkipJsonSchema field '{field_name}'"
+                    )
                 else:
-                    default_val = get_default(field_info)
-                    if default_val is not _UNSET:
-                        if hasattr(default_val, "model_dump"):
-                            default_val = default_val.model_dump()
-                        data[field_name] = default_val
+                    # No default → leave missing; validation will surface error
+                    logger.debug(f"No default found for field '{field_name}'")
 
         return data
 

{fh_pydantic_form-0.2.3 → fh_pydantic_form-0.2.5}/src/fh_pydantic_form/type_helpers.py

@@ -1,12 +1,88 @@
+# Explicit exports for public API
+__all__ = [
+    "_is_optional_type",
+    "_get_underlying_type_if_optional",
+    "_is_literal_type",
+    "_is_enum_type",
+    "_is_skip_json_schema_field",
+    "default_for_annotation",
+]
+
 import logging
 from enum import Enum
 from types import UnionType
-from typing import Any, Literal, Union, get_args, get_origin
+from typing import Annotated, Any, Literal, Union, get_args, get_origin
+
+from fh_pydantic_form.constants import _UNSET
 
 logger = logging.getLogger(__name__)
 
-# Sentinel value to indicate no default is available
-_UNSET = object()
+
+def _is_skip_json_schema_field(annotation_or_field_info: Any) -> bool:
+    """
+    Check if a field annotation or field_info indicates it should be skipped in JSON schema.
+
+    This handles the pattern where SkipJsonSchema is used with typing.Annotated:
+    - Annotated[str, SkipJsonSchema()]
+    - SkipJsonSchema[str] (which internally uses Annotated)
+    - Field metadata containing SkipJsonSchema (Pydantic 2 behavior)
+
+    Args:
+        annotation_or_field_info: The field annotation or field_info to check
+
+    Returns:
+        True if the field should be skipped in JSON schema
+    """
+    try:
+        from pydantic.json_schema import SkipJsonSchema
+
+        skip_json_schema_cls = SkipJsonSchema
+    except ImportError:  # very old Pydantic
+        skip_json_schema_cls = None
+
+    if skip_json_schema_cls is None:
+        return False
+
+    # Check if it's a field_info object with metadata
+    if hasattr(annotation_or_field_info, "metadata"):
+        metadata = getattr(annotation_or_field_info, "metadata", [])
+        if metadata:
+            for item in metadata:
+                if (
+                    item is skip_json_schema_cls
+                    or isinstance(item, skip_json_schema_cls)
+                    or (
+                        hasattr(item, "__class__")
+                        and item.__class__.__name__ == "SkipJsonSchema"
+                    )
+                ):
+                    return True
+
+    # Fall back to checking annotation (for backward compatibility)
+    annotation = annotation_or_field_info
+    if hasattr(annotation_or_field_info, "annotation"):
+        annotation = getattr(annotation_or_field_info, "annotation")
+
+    # 1. Direct or generic alias
+    if (
+        annotation is skip_json_schema_cls
+        or getattr(annotation, "__origin__", None) is skip_json_schema_cls
+    ):
+        return True
+
+    # 2. Something like Annotated[T, SkipJsonSchema()]
+    if get_origin(annotation) is Annotated:
+        for meta in get_args(annotation)[1:]:
+            meta_class = getattr(meta, "__class__", None)
+            if (
+                meta is skip_json_schema_cls  # plain class
+                or isinstance(meta, skip_json_schema_cls)  # instance
+                or (meta_class is not None and meta_class.__name__ == "SkipJsonSchema")
+            ):
+                return True
+
+    # 3. Fallback – cheap but effective
+    return "SkipJsonSchema" in repr(annotation)
 
 
 def _is_optional_type(annotation: Any) -> bool:
@@ -27,16 +103,6 @@ def _is_optional_type(annotation: Any) -> bool:
     return False
 
 
-# Explicit exports for public API
-__all__ = [
-    "_is_optional_type",
-    "_get_underlying_type_if_optional",
-    "_is_literal_type",
-    "_is_enum_type",
-    "default_for_annotation",
-]
-
-
 def _get_underlying_type_if_optional(annotation: Any) -> Any:
     """
     Extract the type T from Optional[T], otherwise return the original annotation.