pydantic-forms 2.1.2__tar.gz → 2.2.0__tar.gz

{pydantic_forms-2.1.2 → pydantic_forms-2.2.0}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.1.2
+current_version = 2.2.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((\-rc)(?P<build>\d+))?

{pydantic_forms-2.1.2 → pydantic_forms-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydantic-forms
-Version: 2.1.2
+Version: 2.2.0
 Summary: Pydantic-forms engine.
 Home-page: https://github.com/workfloworchestrator/pydantic-forms
 Author: SURF

{pydantic_forms-2.1.2 → pydantic_forms-2.2.0}/pydantic_forms/__init__.py

@@ -13,4 +13,4 @@
 
 """Pydantic-forms engine."""
 
-__version__ = "2.1.2"
+__version__ = "2.2.0"

{pydantic_forms-2.1.2 → pydantic_forms-2.2.0}/pydantic_forms/validators/__init__.py

@@ -1,4 +1,5 @@
 from pydantic_forms.validators.components.accept import Accept, AcceptValues
+from pydantic_forms.validators.components.callout import Callout, callout
 from pydantic_forms.validators.components.choice import Choice
 from pydantic_forms.validators.components.choice_list import choice_list
 from pydantic_forms.validators.components.contact_person import ContactPerson, ContactPersonName
@@ -40,4 +41,6 @@ __all__ = (
     "Timestamp",
     "unique_conlist",
     "validate_unique_list",
+    "callout",
+    "Callout",
 )

pydantic_forms-2.2.0/pydantic_forms/validators/components/callout.py

@@ -0,0 +1,76 @@
+# Copyright 2019-2025 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 enum import Enum
+from functools import partial
+from types import new_class
+from typing import Annotated, Any, ClassVar, TypedDict, Union
+
+from pydantic import BaseModel, Field
+
+
+class CalloutMessageType(str, Enum):
+    PRIMARY = "primary"
+    SUCCESS = "success"
+    WARNING = "warning"
+    DANGER = "danger"
+    ACCENT = "accent"
+
+
+class CalloutData(TypedDict, total=False):
+    header: Union[str, None]
+    message: Union[str, None]
+    icon_type: Union[str, None]
+    message_type: Union[CalloutMessageType, str]
+
+
+class _Callout(BaseModel):
+    data: ClassVar[Union[CalloutData, None]] = None
+
+
+Callout = Annotated[_Callout, Field(frozen=True, default=None, validate_default=False)]
+
+
+def create_callout_schema(data: CalloutData, schema: dict[str, Any]) -> None:
+    schema.update(
+        {
+            "format": "callout",
+            "type": "string",
+            "default": data,
+        }
+    )
+
+
+def callout(
+    *,
+    header: Union[str, None] = None,
+    message: Union[str, None] = None,
+    icon_type: Union[str, None] = "info",
+    message_type: Union[CalloutMessageType, str] = CalloutMessageType.PRIMARY,
+) -> type[Callout]:
+
+    data: CalloutData = {
+        "header": header,
+        "message": message,
+        "icon_type": icon_type,
+        "message_type": message_type,
+    }
+
+    namespace = {"data": data}
+    klass: type[Callout] = new_class("CalloutValue", (_Callout,), {}, lambda ns: ns.update(namespace))
+
+    json_schema_extra = partial(create_callout_schema, data)
+
+    return Annotated[
+        klass,
+        Field(frozen=True, default=None, validate_default=False, json_schema_extra=json_schema_extra),
+    ]  # type: ignore

pydantic_forms-2.2.0/tests/unit_tests/test_callout.py

@@ -0,0 +1,97 @@
+from uuid import uuid4
+
+from pydantic_forms.core import FormPage
+from pydantic_forms.validators import DisplaySubscription, Label
+from pydantic_forms.validators.components.callout import CalloutMessageType, callout
+from tests.unit_tests.helpers import PYDANTIC_VERSION
+
+
+def test_callout_default():
+    """Ensure Callout default is None and schema defaults are correctly injected."""
+    CalloutField = callout(
+        header="Test header",
+        message="This is a test message",
+        icon_type="info",
+        message_type=CalloutMessageType.SUCCESS,
+    )
+
+    some_sub_id = uuid4()
+
+    class Form(FormPage):
+        display_sub: DisplaySubscription = some_sub_id
+        label: Label = "bla"
+        callout_field: CalloutField
+
+    # The field itself should default to None (display-only)
+    assert Form().model_dump() == {
+        "display_sub": some_sub_id,
+        "label": "bla",
+        "callout_field": None,
+    }
+
+    # And the field accepts no input (display only)
+    assert Form(display_sub="").model_dump() == {
+        "display_sub": some_sub_id,
+        "label": "bla",
+        "callout_field": None,
+    }
+
+
+def test_callout_schema():
+    """Ensure the callout field generates a correct JSON schema with default data."""
+    CalloutField = callout(
+        header="Header",
+        message="A message",
+        icon_type="bell",
+        message_type="danger",
+    )
+
+    class Form(FormPage):
+        callout_field: CalloutField
+
+    if PYDANTIC_VERSION == "2.8":
+        callout_field_ref = {"allOf": [{"$ref": "#/$defs/CalloutValue"}]}
+    else:
+        callout_field_ref = {"$ref": "#/$defs/CalloutValue"}
+
+    expected = {
+        "$defs": {"CalloutValue": {"properties": {}, "title": "CalloutValue", "type": "object"}},
+        "additionalProperties": False,
+        "properties": {
+            "callout_field": {
+                **callout_field_ref,
+                "default": {
+                    "header": "Header",
+                    "message": "A message",
+                    "icon_type": "bell",
+                    "message_type": "danger",
+                },
+                "format": "callout",
+                "type": "string",
+            },
+        },
+        "title": "unknown",
+        "type": "object",
+    }
+
+    assert Form.model_json_schema() == expected
+
+
+def test_callout_accepts_custom_message_type():
+    """Ensure custom (non-enum) message_type values are accepted and serialized correctly."""
+    CalloutField = callout(
+        header="Custom",
+        message="Supports custom color values",
+        icon_type="iInCircle",
+        message_type="neutral",  # custom
+    )
+
+    class Form(FormPage):
+        callout_field: CalloutField
+
+    schema = Form.model_json_schema()
+
+    default_data = schema["properties"]["callout_field"]["default"]
+    assert default_data["message_type"] == "neutral"
+    assert default_data["header"] == "Custom"
+    assert default_data["icon_type"] == "iInCircle"