pydantic-forms 2.4.0__tar.gz → 2.6.0__tar.gz

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/PKG-INFO

@@ -1,23 +1,11 @@
 Metadata-Version: 2.4
 Name: pydantic-forms
-Version: 2.4.0
+Version: 2.6.0
 Summary: Pydantic-forms engine.
-Home-page: https://github.com/workfloworchestrator/pydantic-forms
 Author: SURF
-Author-email: automation-beheer@surf.nl
-Requires-Python: >=3.10,<3.15
-Description-Content-Type: text/markdown
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: System Administrators
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python
-Classifier: Topic :: Internet
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development
-Classifier: Typing :: Typed
+Author-email: SURF <automation-beheer@surf.nl>
+License-Expression: Apache-2.0
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Framework :: AsyncIO
@@ -25,56 +13,38 @@ Classifier: Framework :: FastAPI
 Classifier: Framework :: Flask
 Classifier: Framework :: Pydantic :: 2
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
 Classifier: Intended Audience :: Telecommunications Industry
-Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Classifier: Topic :: Internet :: WWW/HTTP
-License-File: LICENSE
-Requires-Dist: more-itertools
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Dist: more-itertools>=10.0.0
 Requires-Dist: pydantic[email]>=2.9.0
 Requires-Dist: pydantic-i18n==0.4.5
-Requires-Dist: toml ; extra == "dev"
-Requires-Dist: bumpversion ; extra == "dev"
-Requires-Dist: mypy_extensions ; extra == "dev"
-Requires-Dist: pre-commit ; extra == "dev"
-Requires-Dist: pydocstyle ; extra == "dev"
-Requires-Dist: python-dotenv ; extra == "dev"
-Requires-Dist: watchdog ; extra == "dev"
-Requires-Dist: mkdocs ; extra == "doc"
-Requires-Dist: mkdocs-material ; extra == "doc"
-Requires-Dist: mkdocs-render-swagger-plugin ; extra == "doc"
-Requires-Dist: mkdocs-include-markdown-plugin ; extra == "doc"
-Requires-Dist: fastapi >=0.80.0 ; extra == "fastapi"
-Requires-Dist: orjson >=3.6.0,<4.0.0 ; extra == "orjson"
-Requires-Dist: apache-license-check ; extra == "test"
-Requires-Dist: black ; extra == "test"
-Requires-Dist: structlog ; extra == "test"
-Requires-Dist: jsonref ; extra == "test"
-Requires-Dist: mypy==1.18.2 ; extra == "test"
-Requires-Dist: pytest ; extra == "test"
-Requires-Dist: pytest-cov ; extra == "test"
-Requires-Dist: pytest-asyncio ; extra == "test"
-Requires-Dist: pytest-xdist ; extra == "test"
-Requires-Dist: ruff ; extra == "test"
-Requires-Dist: types-Deprecated ; extra == "test"
-Requires-Dist: types-certifi ; extra == "test"
-Requires-Dist: types-python-dateutil ; extra == "test"
-Requires-Dist: types-pytz ; extra == "test"
-Requires-Dist: types-toml ; extra == "test"
-Requires-Dist: types-ujson ; extra == "test"
-Requires-Dist: types-orjson ; extra == "test"
+Requires-Dist: fastapi>=0.103.2 ; extra == 'fastapi'
+Requires-Dist: orjson>=3.10.7,<4.0.0 ; extra == 'orjson'
+Requires-Python: >=3.10, <3.15
 Project-URL: Documentation, https://github.com/workfloworchestrator/pydantic-forms/blob/main/README.md
-Provides-Extra: dev
-Provides-Extra: doc
+Project-URL: Homepage, https://github.com/workfloworchestrator/pydantic-forms
+Project-URL: Source, https://github.com/workfloworchestrator/pydantic-forms
 Provides-Extra: fastapi
 Provides-Extra: orjson
-Provides-Extra: test
+Description-Content-Type: text/markdown
 
 # Pydantic forms
 
@@ -95,71 +65,46 @@ Documentation regarding the usage of Forms can be found
 [here](https://github.com/workfloworchestrator/orchestrator-core/blob/main/docs/architecture/application/forms-frontend.md)
 
 ### Installation (Development standalone)
-Install the project and its dependencies to develop on the code.
-
-#### Step 1 - install flit:
 
-```shell
-python3 -m venv venv
-source venv/bin/activate
-pip install flit
-```
+This project uses [uv](https://docs.astral.sh/uv/). Install the project and its dependencies to develop on the code:
 
-#### Step 2 - install the development code:
 ```shell
-flit install --deps develop --symlink --python venv/bin/python
-```
-
-!!! danger
-    Make sure to use the flit binary that is installed in your environment. You can check the correct
-    path by running
-    ```shell
-    which flit
-    ```
-
-To be sure that the packages will be installed against the correct venv you can also prepend the python interpreter
-that you want to use:
-
-```shell
-flit install --deps develop --symlink --python venv/bin/python
+uv sync --all-extras
 ```
 
+This creates a `.venv`, installs `pydantic-forms` in editable mode, and installs the `dev` dependency group
+(which chains in `test` and `doc`) plus the `fastapi` and `orjson` extras. There is no need to create or
+activate a virtualenv yourself -- prefix commands with `uv run` and uv will use the right interpreter.
 
 ### Running tests
 Run the unit-test suite to verify a correct setup.
 
-#### Step 2 - Run tests
 ```shell
-pytest tests/unit_tests
+uv run pytest tests/unit_tests
 ```
 
 or with xdist:
 
 ```shell
-pytest -n auto tests/unit_tests
+uv run pytest -n auto tests/unit_tests
 ```
 
 If you do not encounter any failures in the test, you should be able to develop features in the pydantic-forms.
 
-### Installation (Development symlinked into project that use pydantic-forms)
+### Installation (Development version used by a project that depends on pydantic-forms)
 
-If you are working on a project that already uses the `pydantic-forms` and you want to test your new form features
-against it, you can use some `flit` magic to symlink the dev version of the forms to your project. It will
-automatically replace the pypi dep with a symlink to the development version
-of the core and update/downgrade all required packages in your own project.
-
-#### Step 1 - install flit:
+If you are working on a project that already uses `pydantic-forms` and you want to test your new form features
+against it, point that project at your local checkout. Run this **from the other project**:
 
 ```shell
-python - m venv venv
-source venv/bin/activate
-pip install flit
+uv add --editable /path/to/pydantic-forms
 ```
 
-### Step 2 - symlink pydantic-forms to your own project
+This replaces the PyPI dependency with an editable install of your working copy and records it under
+`[tool.uv.sources]` in that project's `pyproject.toml`. Undo it with:
 
 ```shell
-flit install --deps develop --symlink --python /path/to/a/project/venv/bin/python
+uv remove pydantic-forms && uv add pydantic-forms
 ```
 
 # Increasing the version number for a (pre) release.
@@ -169,11 +114,11 @@ When your PR is accepted you will get a version number.
 You can do the necessary change with a clean, e.g. every change committed, branch:
 
 ```shell
-bumpversion patch --new-version 0.0.1
+uv version 0.0.1
 ```
 
-Note: specifying it like this, instead of relying on bumpversion itself to increase the version, allows you to
-set a "RC1" version if needed.
+Note: specifying the version explicitly, instead of relying on `uv version --bump patch` to increase it, allows
+you to set a "RC1" version if needed -- e.g. `uv version 0.0.1rc1`.
 
 # Debugging Form behaviour
 
@@ -185,4 +130,3 @@ LOG_LEVEL_PYDANTIC_FORMS=DEBUG
 
 This will add the traceback to the `JSONResponse`. If the loglevel is set to DEBUG the library will also add the
 traceback to the logger.
-

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/README.md

@@ -17,71 +17,46 @@ Documentation regarding the usage of Forms can be found
 [here](https://github.com/workfloworchestrator/orchestrator-core/blob/main/docs/architecture/application/forms-frontend.md)
 
 ### Installation (Development standalone)
-Install the project and its dependencies to develop on the code.
 
-#### Step 1 - install flit:
+This project uses [uv](https://docs.astral.sh/uv/). Install the project and its dependencies to develop on the code:
 
 ```shell
-python3 -m venv venv
-source venv/bin/activate
-pip install flit
-```
-
-#### Step 2 - install the development code:
-```shell
-flit install --deps develop --symlink --python venv/bin/python
-```
-
-!!! danger
-    Make sure to use the flit binary that is installed in your environment. You can check the correct
-    path by running
-    ```shell
-    which flit
-    ```
-
-To be sure that the packages will be installed against the correct venv you can also prepend the python interpreter
-that you want to use:
-
-```shell
-flit install --deps develop --symlink --python venv/bin/python
+uv sync --all-extras
 ```
 
+This creates a `.venv`, installs `pydantic-forms` in editable mode, and installs the `dev` dependency group
+(which chains in `test` and `doc`) plus the `fastapi` and `orjson` extras. There is no need to create or
+activate a virtualenv yourself -- prefix commands with `uv run` and uv will use the right interpreter.
 
 ### Running tests
 Run the unit-test suite to verify a correct setup.
 
-#### Step 2 - Run tests
 ```shell
-pytest tests/unit_tests
+uv run pytest tests/unit_tests
 ```
 
 or with xdist:
 
 ```shell
-pytest -n auto tests/unit_tests
+uv run pytest -n auto tests/unit_tests
 ```
 
 If you do not encounter any failures in the test, you should be able to develop features in the pydantic-forms.
 
-### Installation (Development symlinked into project that use pydantic-forms)
-
-If you are working on a project that already uses the `pydantic-forms` and you want to test your new form features
-against it, you can use some `flit` magic to symlink the dev version of the forms to your project. It will
-automatically replace the pypi dep with a symlink to the development version
-of the core and update/downgrade all required packages in your own project.
+### Installation (Development version used by a project that depends on pydantic-forms)
 
-#### Step 1 - install flit:
+If you are working on a project that already uses `pydantic-forms` and you want to test your new form features
+against it, point that project at your local checkout. Run this **from the other project**:
 
 ```shell
-python - m venv venv
-source venv/bin/activate
-pip install flit
+uv add --editable /path/to/pydantic-forms
 ```
 
-### Step 2 - symlink pydantic-forms to your own project
+This replaces the PyPI dependency with an editable install of your working copy and records it under
+`[tool.uv.sources]` in that project's `pyproject.toml`. Undo it with:
 
 ```shell
-flit install --deps develop --symlink --python /path/to/a/project/venv/bin/python
+uv remove pydantic-forms && uv add pydantic-forms
 ```
 
 # Increasing the version number for a (pre) release.
@@ -91,11 +66,11 @@ When your PR is accepted you will get a version number.
 You can do the necessary change with a clean, e.g. every change committed, branch:
 
 ```shell
-bumpversion patch --new-version 0.0.1
+uv version 0.0.1
 ```
 
-Note: specifying it like this, instead of relying on bumpversion itself to increase the version, allows you to
-set a "RC1" version if needed.
+Note: specifying the version explicitly, instead of relying on `uv version --bump patch` to increase it, allows
+you to set a "RC1" version if needed -- e.g. `uv version 0.0.1rc1`.
 
 # Debugging Form behaviour
 

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/__init__.py

@@ -13,4 +13,6 @@
 
 """Pydantic-forms engine."""
 
-__version__ = "2.4.0"
+from importlib.metadata import version
+
+__version__ = version("pydantic-forms")

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/core/asynchronous.py

@@ -18,7 +18,7 @@ import structlog
 from pydantic import ValidationError
 from pydantic_i18n import PydanticI18n
 
-from pydantic_forms.core.shared import FORMS
+from pydantic_forms.core.shared import FORMS, GenerateFormJsonSchema
 from pydantic_forms.core.translations import translations
 from pydantic_forms.exceptions import (
     FormException,
@@ -102,7 +102,10 @@ async def post_form(
         return generated_form
 
     # Form is not completely filled raise next form
-    raise FormNotCompleteError(generated_form.model_json_schema(), meta=getattr(generated_form, "meta__", None))
+    raise FormNotCompleteError(
+        generated_form.model_json_schema(schema_generator=GenerateFormJsonSchema),
+        meta=getattr(generated_form, "meta__", None),
+    )
 
 
 def _get_form(key: str) -> StateInputFormGeneratorAsync:

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/core/shared.py

@@ -11,10 +11,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from inspect import isasyncgenfunction, isgeneratorfunction
-from typing import Any, Callable
+from typing import Any, Callable, cast
 
 import structlog
 from pydantic import BaseModel, ConfigDict, PydanticUndefinedAnnotation, version
+from pydantic.json_schema import GenerateJsonSchema, JsonSchemaValue
+from pydantic_core import core_schema
 
 logger = structlog.get_logger(__name__)
 
@@ -22,6 +24,35 @@ logger = structlog.get_logger(__name__)
 PYDANTIC_VERSION = version.version_short()
 
 
+class GenerateFormJsonSchema(GenerateJsonSchema):
+    """JSON schema generator that also emits ``default`` values produced by ``default_factory``.
+
+    Pydantic intentionally leaves ``default_factory`` results out of the generated JSON schema. For
+    forms this is a problem: ``default_factory`` is the recommended way to declare mutable defaults
+    (``Field(default_factory=list)`` and friends), and frontends pre-fill fields from the schema
+    ``default``. Without it such fields render uninitialised, and dynamic array/object widgets reject
+    submission until the user performs a dummy add/remove interaction to materialise an empty value.
+
+    This generator evaluates argument-less factories and adds their result as the schema ``default``.
+    Factories that need the already-validated data (``default_factory_takes_data``) cannot be
+    evaluated at schema-generation time and are skipped, as is any factory that raises.
+    """
+
+    def default_schema(self, schema: core_schema.WithDefaultSchema) -> JsonSchemaValue:
+        json_schema = super().default_schema(schema)
+        if (
+            "default" not in json_schema
+            and "default_factory" in schema
+            and not schema.get("default_factory_takes_data", False)
+        ):
+            factory = cast(Callable[[], Any], schema["default_factory"])
+            try:
+                json_schema["default"] = self.encode_default(factory())
+            except Exception:  # never let a factory break schema generation
+                logger.debug("Could not evaluate default_factory for form schema", exc_info=True)
+        return json_schema
+
+
 class DisplayOnlyFieldType:
     pass
 

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/core/sync.py

@@ -18,7 +18,7 @@ import structlog
 from pydantic import ValidationError
 from pydantic_i18n import PydanticI18n
 
-from pydantic_forms.core.shared import FORMS
+from pydantic_forms.core.shared import FORMS, GenerateFormJsonSchema
 from pydantic_forms.core.translations import translations
 from pydantic_forms.exceptions import FormException, FormNotCompleteError, FormOverflowError, FormValidationError
 from pydantic_forms.types import InputForm, State, StateInputFormGenerator
@@ -88,7 +88,10 @@ def post_form(
             generated_form = generator.send(form_validated_data)
 
         # Form is not completely filled; raise next form
-        raise FormNotCompleteError(generated_form.model_json_schema(), meta=getattr(generated_form, "meta__", None))
+        raise FormNotCompleteError(
+            generated_form.model_json_schema(schema_generator=GenerateFormJsonSchema),
+            meta=getattr(generated_form, "meta__", None),
+        )
     except StopIteration as e:
         if user_inputs:
             raise FormOverflowError(f"Did not process all user_inputs ({len(user_inputs)} remaining)")

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/exceptions.py

@@ -1,5 +1,6 @@
 import os
 import traceback
+from collections.abc import Mapping
 from typing import Any, Iterable, Optional, TypedDict, Union, cast
 
 import structlog
@@ -36,9 +37,22 @@ class FormOverflowError(FormException):
     """Raised when more inputs are provided than the form can process."""
 
 
+Loc = tuple[Union[int, str], ...]
+
+
+def _error_is_nested_object_validator(error: ErrorDetails) -> bool:
+    """Return True for custom errors raised for an object payload instead of a leaf field."""
+    exc = error.get("ctx", {}).get("error")
+    return (
+        bool(error["loc"]) and isinstance(exc, (ValueError, AssertionError)) and isinstance(error.get("input"), Mapping)
+    )
+
+
 # def convert_errors(validation_error: ValidationError) -> Iterable[ErrorDetails]:
 def convert_errors(
-    validation_error: ValidationError, tr: PydanticI18n, locale: str = "en_US"
+    validation_error: ValidationError,
+    tr: PydanticI18n,
+    locale: str = "en_US",
 ) -> Iterable[ErrorDetails]:
     """Convert Pydantic's error messages to our needs.
 
@@ -55,6 +69,11 @@ def convert_errors(
             # Reinstate the "__root__" location for validation errors raised by Pydantic v1's root_validator.
             # With Pydantic v2's model_validator the location is an empty string, which breaks frontend clients.
             error["loc"] = ("__root__",)
+        elif _error_is_nested_object_validator(error):
+            # Errors raised by a model_validator on a nested model point at the nested model itself, which
+            # frontend clients cannot map to an input field. Mark them as model-level errors so that clients
+            # display the custom message, like they do for the form's own "__root__" errors.
+            error["loc"] = (*error["loc"], "__root__")
         return
 
     if LOG_LEVEL_PYDANTIC_FORMS == "DEBUG":
@@ -90,9 +109,6 @@ class FormValidationError(FormException):
         )
 
 
-Loc = tuple[Union[int, str], ...]
-
-
 class _ErrorDictRequired(TypedDict):
     loc: Loc
     msg: str

{pydantic_forms-2.4.0 → pydantic_forms-2.6.0}/pydantic_forms/validators/__init__.py

@@ -11,6 +11,7 @@ from pydantic_forms.validators.components.label import Label
 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
+from pydantic_forms.validators.components.markdown import Markdown, markdown
 from pydantic_forms.validators.components.migration_summary import MigrationSummary, migration_summary
 from pydantic_forms.validators.components.organisation_id import OrganisationId
 from pydantic_forms.validators.components.read_only import read_only_field, read_only_list
@@ -43,4 +44,6 @@ __all__ = (
     "validate_unique_list",
     "callout",
     "Callout",
+    "markdown",
+    "Markdown",
 )

pydantic_forms-2.6.0/pydantic_forms/validators/components/markdown.py

@@ -0,0 +1,70 @@
+# 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 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 MarkdownColor(str, Enum):
+    PRIMARY = "primary"
+    SUCCESS = "success"
+    WARNING = "warning"
+    DANGER = "danger"
+    ACCENT = "accent"
+
+
+class MarkdownData(TypedDict, total=False):
+    content: Union[str, None]
+    color: Union[MarkdownColor, str]
+
+
+class _Markdown(BaseModel):
+    data: ClassVar[Union[MarkdownData, None]] = None
+
+
+Markdown = Annotated[_Markdown, Field(frozen=True, default=None, validate_default=False)]
+
+
+def create_markdown_schema(data: MarkdownData, schema: dict[str, Any]) -> None:
+    schema.update(
+        {
+            "format": "markdown",
+            "type": "string",
+            "default": data,
+        }
+    )
+
+
+def markdown(
+    *,
+    content: Union[str, None] = None,
+    color: Union[MarkdownColor, str] = MarkdownColor.PRIMARY,
+) -> type[Markdown]:
+
+    data: MarkdownData = {
+        "content": content,
+        "color": color,
+    }
+
+    namespace = {"data": data}
+    klass: type[Markdown] = new_class("MarkdownValue", (_Markdown,), {}, lambda ns: ns.update(namespace))
+
+    json_schema_extra = partial(create_markdown_schema, data)
+
+    return Annotated[
+        klass,
+        Field(frozen=True, default=None, validate_default=False, json_schema_extra=json_schema_extra),
+    ]  # type: ignore