pydantic-forms 2.7.0__tar.gz → 2.8.0__tar.gz

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydantic-forms
-Version: 2.7.0
+Version: 2.8.0
 Summary: Pydantic-forms engine.
 Author: SURF
 Author-email: SURF <automation-beheer@surf.nl>

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pydantic_forms/utils/json.py

@@ -177,7 +177,7 @@ if IS_ORJSON:
     logger.debug("Using orjson")
 
     def json_loads(s: Union[str, bytes, bytearray]) -> PY_JSON_TYPES:
-        o = orjson.loads(s)
+        o = orjson.loads(bytes(s) if isinstance(s, bytearray) else s)
         if isinstance(o, list):
             return [from_serializable(dikt) for dikt in o]
         return from_serializable(o)

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pydantic_forms/validators/__init__.py

@@ -9,6 +9,7 @@ from pydantic_forms.validators.components.display_subscription import DisplaySub
 from pydantic_forms.validators.components.divider import Divider
 from pydantic_forms.validators.components.hidden import Hidden
 from pydantic_forms.validators.components.label import Label
+from pydantic_forms.validators.components.layout import Layout
 from pydantic_forms.validators.components.list_of_one import ListOfOne
 from pydantic_forms.validators.components.list_of_two import ListOfTwo
 from pydantic_forms.validators.components.long_text import LongText
@@ -33,6 +34,7 @@ __all__ = (
     "Divider",
     "Hidden",
     "Label",
+    "Layout",
     "ListOfOne",
     "ListOfTwo",
     "LongText",

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pydantic_forms/validators/components/accept.py

@@ -33,7 +33,7 @@ class Accept(str):
 
     data: ClassVar[Optional[AcceptData]] = None
 
-    _enum_adapter = TypeAdapter(AcceptValues)
+    _enum_adapter: ClassVar[TypeAdapter[AcceptValues]] = TypeAdapter(AcceptValues)
 
     @classmethod
     def __get_pydantic_json_schema__(cls, core_schema: CoreSchema, handler: GetJsonSchemaHandler) -> dict[str, Any]:

pydantic_forms-2.8.0/pydantic_forms/validators/components/layout.py

@@ -0,0 +1,68 @@
+# Copyright 2019-2026 SURF.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from collections.abc import Iterator
+from dataclasses import dataclass
+from typing import Final, Literal
+
+from annotated_types import GroupedMetadata
+from pydantic import Field, JsonValue
+
+# Fixed: the pydantic-forms frontend renders a 12-column grid and clamps span and start to it
+GRID_COLUMNS: Final = 12
+
+LayoutAlign = Literal["start", "center", "end", "stretch"]
+
+
+@dataclass(frozen=True)
+class Layout(GroupedMetadata):
+    """Position a field on the 12-column form grid, e.g. `Annotated[str, Layout(span=6)]`.
+
+    Adds a camelCase `layout` object to the field's JSON schema.
+    Fields without one take the full width.
+
+    Args:
+        span: Width in columns (1-12), full width when unset.
+        start: Column (1-12) to start at, leaves the columns before it empty.
+        new_row: Always start on a new row, even when the current row has space left.
+        row_span: Height in rows, one row when unset. The following fields are placed next to it.
+        align: Vertical position of the field within its row.
+    """
+
+    span: int | None = None
+    start: int | None = None
+    new_row: bool = False
+    row_span: int | None = None
+    align: LayoutAlign | None = None
+
+    def __post_init__(self) -> None:
+        if self.span is not None and not 1 <= self.span <= GRID_COLUMNS:
+            raise ValueError(f"span must be between 1 and {GRID_COLUMNS}")
+        if self.start is not None and not 1 <= self.start <= GRID_COLUMNS:
+            raise ValueError(f"start must be between 1 and {GRID_COLUMNS}")
+        if self.start is not None and self.start + (self.span or 1) - 1 > GRID_COLUMNS:
+            raise ValueError(f"start + span exceeds the {GRID_COLUMNS} column grid")
+        if self.row_span is not None and self.row_span < 1:
+            raise ValueError("row_span must be at least 1")
+
+    def __iter__(self) -> Iterator[object]:
+        options: dict[str, JsonValue] = {
+            "span": self.span,
+            "start": self.start,
+            "newRow": self.new_row or None,
+            "rowSpan": self.row_span,
+            "align": self.align,
+        }
+        layout: dict[str, JsonValue] = {key: value for key, value in options.items() if value}
+        # An empty Layout() is the same as no Layout, the field takes the full width
+        if layout:
+            yield Field(json_schema_extra={"layout": layout})

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pydantic_forms/validators/components/read_only.py

@@ -123,7 +123,9 @@ def read_only_field(default: Any, merge_type: Any | None = None) -> Any:
     if isinstance(default, list):
         raise TypeError(f"Use {read_only_list.__name__}")
 
-    dynamic_validator = TypeAdapter(default.__class__) if isinstance(default, STRINGY_TYPES) else None
+    dynamic_validator: TypeAdapter[Any] | None = (
+        TypeAdapter(default.__class__) if isinstance(default, STRINGY_TYPES) else None
+    )
 
     def validate(v: Any) -> Any:
         if dynamic_validator:

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "pydantic-forms"
 description = "Pydantic-forms engine."
-version = "2.7.0"
+version = "2.8.0"
 readme = "README.md"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
@@ -92,7 +92,7 @@ dev = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.10,<0.13"]
+requires = ["uv_build>=0.13,<0.14"]
 build-backend = "uv_build"
 
 [tool.uv]
@@ -240,7 +240,6 @@ disallow_incomplete_defs = false
 init_forbid_extra = true
 init_typed = true
 warn_required_dynamic_aliases = true
-warn_untyped_fields = true
 
 [tool.coverage.run]
 source = ["pydantic_forms"]

{pydantic_forms-2.7.0 → pydantic_forms-2.8.0}/pyproject.toml.orig

@@ -1,7 +1,7 @@
 [project]
 name = "pydantic-forms"
 description = "Pydantic-forms engine."
-version = "2.7.0"
+version = "2.8.0"
 readme = "README.md"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
@@ -101,7 +101,7 @@ dev = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.10,<0.13"]
+requires = ["uv_build>=0.13,<0.14"]
 build-backend = "uv_build"
 
 [tool.uv]
@@ -238,7 +238,6 @@ disallow_incomplete_defs = false
 init_forbid_extra = true
 init_typed = true
 warn_required_dynamic_aliases = true
-warn_untyped_fields = true
 
 [tool.coverage.run]
 source = ["pydantic_forms"]

pydantic_forms-2.8.0/tests/unit_tests/test_layout.py

@@ -0,0 +1,85 @@
+from typing import Annotated
+
+import pytest
+from pydantic import BaseModel, Field
+
+from pydantic_forms.core import FormPage
+from pydantic_forms.validators import Layout, LongText
+
+
+def test_layout_json_schema_leaves_out_unset_options():
+    class Form(FormPage):
+        name: Annotated[str, Layout(span=6, new_row=True, align="end")]
+        city: Annotated[str, Layout(start=4)]
+        full: Annotated[str, Layout()]
+        tall: Annotated[str, Layout(span=6, row_span=2)]
+
+    properties = Form.model_json_schema()["properties"]
+    assert properties["name"]["layout"] == {"span": 6, "newRow": True, "align": "end"}
+    assert properties["city"]["layout"] == {"start": 4}
+    assert "layout" not in properties["full"]
+    assert properties["tall"]["layout"] == {"span": 6, "rowSpan": 2}
+
+
+def test_layout_combines_with_other_schema_extras():
+    class Form(FormPage):
+        comments: Annotated[LongText, Layout(span=6)] = Field(title="Comments")
+
+    assert Form.model_json_schema()["properties"]["comments"] == {
+        "format": "long",
+        "layout": {"span": 6},
+        "title": "Comments",
+        "type": "string",
+    }
+
+
+def test_layout_in_nested_model():
+    class Address(BaseModel):
+        street: Annotated[str, Layout(span=8)]
+        postal_code: Annotated[str, Layout(span=4)]
+
+    class Form(FormPage):
+        address: Address
+
+    properties = Form.model_json_schema()["$defs"]["Address"]["properties"]
+    assert properties["street"]["layout"] == {"span": 8}
+    assert properties["postal_code"]["layout"] == {"span": 4}
+
+
+def test_layout_does_not_affect_validation():
+    class Form(FormPage):
+        name: Annotated[str, Layout(span=6)]
+
+    assert Form(name="Jane").model_dump() == {"name": "Jane"}
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        {"span": 0},
+        {"span": 13},
+        {"start": 0},
+        {"start": 13},
+        {"start": 10, "span": 6},
+        {"start": 12, "span": 2},
+        {"row_span": 0},
+    ],
+)
+def test_layout_rejects_positions_outside_the_grid(kwargs):
+    with pytest.raises(ValueError):
+        Layout(**kwargs)
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        {"span": 1},
+        {"span": 12},
+        {"start": 12},
+        {"start": 7, "span": 6},
+        {"start": 1, "span": 12},
+        {"row_span": 3},
+    ],
+)
+def test_layout_accepts_positions_within_the_grid(kwargs):
+    Layout(**kwargs)