fh-pydantic-form 0.3.6__tar.gz → 0.3.8__tar.gz

{fh_pydantic_form-0.3.6 → fh_pydantic_form-0.3.8}/.github/workflows/build.yaml

@@ -27,6 +27,7 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
 
       - name: "Set up Python"
         uses: actions/setup-python@v5

{fh_pydantic_form-0.3.6 → fh_pydantic_form-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fh-pydantic-form
-Version: 0.3.6
+Version: 0.3.8
 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
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: monsterui>=1.0.19
+Requires-Dist: monsterui>=1.0.29
 Requires-Dist: pydantic>=2.0
-Requires-Dist: python-fasthtml>=0.12.12
+Requires-Dist: python-fasthtml>=0.12.29
 Description-Content-Type: text/markdown
 
 # fh-pydantic-form
@@ -480,6 +480,83 @@ form_renderer = PydanticForm(
 
 This automatic default injection means you can safely exclude fields that shouldn't be user-editable while maintaining data integrity.
 
+### SkipJsonSchema Fields
+
+`fh-pydantic-form` provides advanced handling for `SkipJsonSchema` fields with selective visibility control. By default, fields marked with `SkipJsonSchema` are hidden from forms, but you can selectively show specific ones using the `keep_skip_json_fields` parameter.
+
+```python
+from pydantic.json_schema import SkipJsonSchema
+
+class DocumentModel(BaseModel):
+    title: str
+    content: str
+    
+    # Hidden by default - system fields
+    document_id: SkipJsonSchema[str] = Field(
+        default_factory=lambda: f"doc_{uuid4().hex[:12]}",
+        description="Internal document ID"
+    )
+    created_at: SkipJsonSchema[datetime.datetime] = Field(
+        default_factory=datetime.datetime.now,
+        description="Creation timestamp"
+    )
+    version: SkipJsonSchema[int] = Field(
+        default=1, 
+        description="Document version"
+    )
+
+# Normal form - all SkipJsonSchema fields hidden
+form_normal = PydanticForm("doc_form", DocumentModel)
+
+# Admin form - selectively show some SkipJsonSchema fields
+form_admin = PydanticForm(
+    "admin_form", 
+    DocumentModel,
+    keep_skip_json_fields=[
+        "document_id",  # Show document ID
+        "version",      # Show version number
+        # created_at remains hidden
+    ]
+)
+```
+
+#### Nested SkipJsonSchema Fields
+
+The feature supports dot notation for nested objects and list items:
+
+```python
+class Address(BaseModel):
+    street: str
+    city: str
+    # Hidden system field
+    internal_id: SkipJsonSchema[str] = Field(default_factory=lambda: f"addr_{uuid4().hex[:8]}")
+
+class UserModel(BaseModel):
+    name: str
+    main_address: Address
+    other_addresses: List[Address]
+
+# Show specific nested SkipJsonSchema fields
+form = PydanticForm(
+    "user_form",
+    UserModel,
+    keep_skip_json_fields=[
+        "main_address.internal_id",        # Show main address ID
+        "other_addresses.internal_id",     # Show all address IDs in the list
+    ]
+)
+```
+
+**Key Features:**
+- **Hidden by default:** SkipJsonSchema fields are automatically excluded from forms
+- **Selective visibility:** Use `keep_skip_json_fields` to show specific fields
+- **Nested support:** Access nested fields with dot notation (`"main_address.internal_id"`)
+- **List support:** Show fields in all list items (`"addresses.internal_id"`)
+- **Smart defaults:** Non-kept fields use model defaults, kept fields retain initial values
+- **Admin interfaces:** Perfect for admin panels or debugging where you need to see system fields
+
+See `examples/complex_example.py` for a comprehensive demonstration of SkipJsonSchema field handling.
+
 ## Refreshing & Resetting
 
 Forms support dynamic refresh and reset functionality:
@@ -824,6 +901,38 @@ comparison_form.register_routes(app)
 - **Metrics Integration**: Right side typically shows LLM output quality scores
 - **Flexible Layout**: Responsive design works on desktop and mobile
 - **Form Validation**: Standard validation works with either form
+- **Intelligent List Copying**: Copy lists between forms with automatic length adjustment
+
+### Copying Between Forms
+
+The ComparisonForm provides granular copy functionality at multiple levels. When you enable copy buttons (via `copy_left=True` or `copy_right=True`), each field, nested model, and list item gets its own copy button for maximum flexibility:
+
+```python
+# Enable copy buttons (copy FROM right TO left)
+comparison_form = ComparisonForm(
+    name="extraction_evaluation",
+    left_form=left_form,
+    right_form=right_form,
+    left_label="Ground Truth",
+    right_label="LLM Output",
+    copy_left=True,  # Show copy buttons on right form to copy TO left
+)
+```
+
+**Copy Granularity Levels:**
+
+The copy feature works at five different levels of granularity:
+
+1. **Individual Fields** - Copy a single field value (e.g., `name`, `price`, `status`)
+
+2. **Nested BaseModel (Entire Object)** - Copy all fields within a nested model at once
+
+3. **Individual Fields in Nested Models** - Copy a specific field within a nested object
+
+4. **Full List Fields** - Copy entire lists with automatic length adjustment
+
+5. **Individual List Items** - Add a single item from one list to another
+
 
 ### Common Patterns
 
@@ -1007,6 +1116,7 @@ form_renderer = PydanticForm(
 | `disabled_fields` | `Optional[List[str]]` | `None` | List of specific field names to disable |
 | `label_colors` | `Optional[Dict[str, str]]` | `None` | Mapping of field names to CSS colors or Tailwind classes |
 | `exclude_fields` | `Optional[List[str]]` | `None` | List of field names to exclude from rendering (auto-injected on submission) |
+| `keep_skip_json_fields` | `Optional[List[str]]` | `None` | List of SkipJsonSchema field paths to selectively show (supports dot notation for nested fields) |
 | `spacing` | `SpacingValue` | `"normal"` | Spacing theme: `"normal"`, `"compact"`, or `SpacingTheme` enum |
 | `metrics_dict` | `Optional[Dict[str, Dict]]` | `None` | Field metrics for highlighting and tooltips |
 
@@ -1025,7 +1135,7 @@ form_renderer = PydanticForm(
 | Method | Purpose |
 |--------|---------|
 | `render_inputs()` | Generate the HTML form inputs (without `<form>` wrapper) |
-| `with_initial_values(initial_values)` | Create a new form instance with same configuration but different initial values |
+| `with_initial_values(initial_values, metrics_dict=None)` | Create a new form instance with same configuration but different initial values |
 | `refresh_button(text=None, **kwargs)` | Create a refresh button component |
 | `reset_button(text=None, **kwargs)` | Create a reset button component |
 | `register_routes(app)` | Register HTMX endpoints for list manipulation |

{fh_pydantic_form-0.3.6 → fh_pydantic_form-0.3.8}/README.md

@@ -455,6 +455,83 @@ form_renderer = PydanticForm(
 
 This automatic default injection means you can safely exclude fields that shouldn't be user-editable while maintaining data integrity.
 
+### SkipJsonSchema Fields
+
+`fh-pydantic-form` provides advanced handling for `SkipJsonSchema` fields with selective visibility control. By default, fields marked with `SkipJsonSchema` are hidden from forms, but you can selectively show specific ones using the `keep_skip_json_fields` parameter.
+
+```python
+from pydantic.json_schema import SkipJsonSchema
+
+class DocumentModel(BaseModel):
+    title: str
+    content: str
+    
+    # Hidden by default - system fields
+    document_id: SkipJsonSchema[str] = Field(
+        default_factory=lambda: f"doc_{uuid4().hex[:12]}",
+        description="Internal document ID"
+    )
+    created_at: SkipJsonSchema[datetime.datetime] = Field(
+        default_factory=datetime.datetime.now,
+        description="Creation timestamp"
+    )
+    version: SkipJsonSchema[int] = Field(
+        default=1, 
+        description="Document version"
+    )
+
+# Normal form - all SkipJsonSchema fields hidden
+form_normal = PydanticForm("doc_form", DocumentModel)
+
+# Admin form - selectively show some SkipJsonSchema fields
+form_admin = PydanticForm(
+    "admin_form", 
+    DocumentModel,
+    keep_skip_json_fields=[
+        "document_id",  # Show document ID
+        "version",      # Show version number
+        # created_at remains hidden
+    ]
+)
+```
+
+#### Nested SkipJsonSchema Fields
+
+The feature supports dot notation for nested objects and list items:
+
+```python
+class Address(BaseModel):
+    street: str
+    city: str
+    # Hidden system field
+    internal_id: SkipJsonSchema[str] = Field(default_factory=lambda: f"addr_{uuid4().hex[:8]}")
+
+class UserModel(BaseModel):
+    name: str
+    main_address: Address
+    other_addresses: List[Address]
+
+# Show specific nested SkipJsonSchema fields
+form = PydanticForm(
+    "user_form",
+    UserModel,
+    keep_skip_json_fields=[
+        "main_address.internal_id",        # Show main address ID
+        "other_addresses.internal_id",     # Show all address IDs in the list
+    ]
+)
+```
+
+**Key Features:**
+- **Hidden by default:** SkipJsonSchema fields are automatically excluded from forms
+- **Selective visibility:** Use `keep_skip_json_fields` to show specific fields
+- **Nested support:** Access nested fields with dot notation (`"main_address.internal_id"`)
+- **List support:** Show fields in all list items (`"addresses.internal_id"`)
+- **Smart defaults:** Non-kept fields use model defaults, kept fields retain initial values
+- **Admin interfaces:** Perfect for admin panels or debugging where you need to see system fields
+
+See `examples/complex_example.py` for a comprehensive demonstration of SkipJsonSchema field handling.
+
 ## Refreshing & Resetting
 
 Forms support dynamic refresh and reset functionality:
@@ -799,6 +876,38 @@ comparison_form.register_routes(app)
 - **Metrics Integration**: Right side typically shows LLM output quality scores
 - **Flexible Layout**: Responsive design works on desktop and mobile
 - **Form Validation**: Standard validation works with either form
+- **Intelligent List Copying**: Copy lists between forms with automatic length adjustment
+
+### Copying Between Forms
+
+The ComparisonForm provides granular copy functionality at multiple levels. When you enable copy buttons (via `copy_left=True` or `copy_right=True`), each field, nested model, and list item gets its own copy button for maximum flexibility:
+
+```python
+# Enable copy buttons (copy FROM right TO left)
+comparison_form = ComparisonForm(
+    name="extraction_evaluation",
+    left_form=left_form,
+    right_form=right_form,
+    left_label="Ground Truth",
+    right_label="LLM Output",
+    copy_left=True,  # Show copy buttons on right form to copy TO left
+)
+```
+
+**Copy Granularity Levels:**
+
+The copy feature works at five different levels of granularity:
+
+1. **Individual Fields** - Copy a single field value (e.g., `name`, `price`, `status`)
+
+2. **Nested BaseModel (Entire Object)** - Copy all fields within a nested model at once
+
+3. **Individual Fields in Nested Models** - Copy a specific field within a nested object
+
+4. **Full List Fields** - Copy entire lists with automatic length adjustment
+
+5. **Individual List Items** - Add a single item from one list to another
+
 
 ### Common Patterns
 
@@ -982,6 +1091,7 @@ form_renderer = PydanticForm(
 | `disabled_fields` | `Optional[List[str]]` | `None` | List of specific field names to disable |
 | `label_colors` | `Optional[Dict[str, str]]` | `None` | Mapping of field names to CSS colors or Tailwind classes |
 | `exclude_fields` | `Optional[List[str]]` | `None` | List of field names to exclude from rendering (auto-injected on submission) |
+| `keep_skip_json_fields` | `Optional[List[str]]` | `None` | List of SkipJsonSchema field paths to selectively show (supports dot notation for nested fields) |
 | `spacing` | `SpacingValue` | `"normal"` | Spacing theme: `"normal"`, `"compact"`, or `SpacingTheme` enum |
 | `metrics_dict` | `Optional[Dict[str, Dict]]` | `None` | Field metrics for highlighting and tooltips |
 
@@ -1000,7 +1110,7 @@ form_renderer = PydanticForm(
 | Method | Purpose |
 |--------|---------|
 | `render_inputs()` | Generate the HTML form inputs (without `<form>` wrapper) |
-| `with_initial_values(initial_values)` | Create a new form instance with same configuration but different initial values |
+| `with_initial_values(initial_values, metrics_dict=None)` | Create a new form instance with same configuration but different initial values |
 | `refresh_button(text=None, **kwargs)` | Create a refresh button component |
 | `reset_button(text=None, **kwargs)` | Create a reset button component |
 | `register_routes(app)` | Register HTMX endpoints for list manipulation |

{fh_pydantic_form-0.3.6 → fh_pydantic_form-0.3.8}/RELEASE_NOTES.md

@@ -1,5 +1,66 @@
 # Release Notes
 
+## Version 0.3.8 (2025-10-02)
+
+### 🎉 New Features
+
+#### Intelligent Copying in ComparisonForm
+- **NEW**: Comprehensive copy functionality at multiple granularity levels
+  - Individual field copying
+  - Full nested BaseModel object copying
+  - Individual fields within nested models
+  - **Full list field copying with automatic length alignment**
+  - Individual list item copying with smart insertion
+
+
+### 🔧 Bug Fixes & Improvements
+
+#### SkipJsonSchema Field Handling
+- **FIXED**: SkipJsonSchema fields now properly preserve initial values when provided
+- **IMPROVED**: Better handling of skip fields with default values
+- **ENHANCED**: More robust field introspection for SkipJsonSchema annotation
+
+
+## Version 0.3.7 (2025-09-19)
+
+### 🎉 New Features
+
+#### SkipJsonSchema Field Support with Selective Override
+- **NEW**: Added comprehensive support for fields marked with `SkipJsonSchema` annotation
+- **NEW**: `keep_skip_json_fields` parameter allows selective inclusion of specific SkipJsonSchema fields
+  - Supports dot-notation paths for nested fields (e.g., `"addresses.internal_id"`)
+  - Enables fine-grained control over which internal fields are exposed in forms
+  - Works with complex nested structures and list fields
+- **ENHANCED**: SkipJsonSchema fields are automatically excluded from form rendering by default
+- **IMPROVED**: Better field introspection for complex type scenarios including optional skip fields
+
+### 🔧 Bug Fixes & Improvements
+
+#### Default Values Handling
+- **FIXED**: Default values for simple fields now work correctly without initial values
+- **IMPROVED**: Better handling of field defaults when no initial values are provided
+- **ENHANCED**: More robust form rendering for fields with default values
+
+#### Documentation & Examples
+- **UPDATED**: README.md with SkipJsonSchema handling documentation
+- **ENHANCED**: Complex example updated to demonstrate SkipJsonSchema usage patterns
+- **IMPROVED**: Better code documentation and examples
+
+### 🧪 Testing
+- **NEW**: Comprehensive test coverage for SkipJsonSchema field handling
+- **NEW**: Tests for default values behavior without initial values
+- **IMPROVED**: Enhanced test coverage for edge cases and type introspection
+
+### 📊 Statistics
+- **7 commits** since v0.3.6
+- Focus on optional field handling and default value improvements
+- Enhanced SkipJsonSchema support with comprehensive testing
+
+**Key Highlights:**
+This release significantly improves handling of optional fields, particularly those marked with `SkipJsonSchema`, and fixes important issues with default value handling when no initial values are provided.
+
+---
+
 ## Version 0.3.6 (2025-07-21)
 
 - **NEW**: can now pass new metrics_dict to `.with_initial_values()` helper method.

{fh_pydantic_form-0.3.6 → fh_pydantic_form-0.3.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fh-pydantic-form"
-version = "0.3.6"
+version = "0.3.8"
 description = "a library to turn any pydantic BaseModel object into a fasthtml/monsterui input form"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -29,9 +29,9 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "monsterui>=1.0.19",
+    "monsterui>=1.0.29",
     "pydantic>=2.0",
-    "python-fasthtml>=0.12.12",
+    "python-fasthtml>=0.12.29",
 ]
 
 [project.urls]