annotations

Author: pcrespov

packages/models-library/src/models_library/projects.py

@@ -12,6 +12,7 @@
 from models_library.workspaces import WorkspaceID
 from pydantic import BaseModel, ConfigDict, Field, HttpUrl, field_validator
 
+from ._compat import Undefined
 from .basic_regex import DATE_RE, UUID_RE_BASE
 from .emails import LowerCaseEmailStr
 from .projects_access import AccessRights, GroupIDStr
@@ -24,6 +25,9 @@
     none_to_empty_str_pre_validator,
 )
 
+_Unset: Any = Undefined
+
+
 ProjectID: TypeAlias = UUID
 ClassifierID: TypeAlias = str
 
@@ -151,7 +155,7 @@ class Project(BaseProjectModel):
             description="Contains the reference to the project classifiers",
             examples=["some:id:to:a:classifier"],
         ),
-    ]
+    ] = _Unset
 
     # Project state (SEE projects_state.py)
     state: ProjectState | None = None

packages/models-library/src/models_library/projects_nodes.py

@@ -144,31 +144,39 @@ class Node(BaseModel):
     label: str = Field(
         ..., description="The short name of the node", examples=["JupyterLab"]
     )
-    progress: float | None = Field(
-        default=None,
-        ge=0,
-        le=100,
-        description="the node progress value (deprecated in DB, still used for API only)",
-        deprecated=True,
-    )
-    thumbnail: Annotated[str, HttpUrl] | None = Field(
-        default=None,
-        description="url of the latest screenshot of the node",
-        examples=["https://placeimg.com/171/96/tech/grayscale/?0.jpg"],
-    )
+    progress: Annotated[
+        float | None,
+        Field(
+            ge=0,
+            le=100,
+            description="the node progress value (deprecated in DB, still used for API only)",
+            deprecated=True,
+        ),
+    ] = None
+
+    thumbnail: Annotated[
+        str | HttpUrl | None,
+        Field(
+            description="url of the latest screenshot of the node",
+            examples=["https://placeimg.com/171/96/tech/grayscale/?0.jpg"],
+        ),
+    ] = None
 
     # RUN HASH
-    run_hash: str | None = Field(
-        default=None,
-        description="the hex digest of the resolved inputs +outputs hash at the time when the last outputs were generated",
-        alias="runHash",
-    )
+    run_hash: Annotated[
+        str | None,
+        Field(
+            description="the hex digest of the resolved inputs +outputs hash at the time when the last outputs were generated",
+            alias="runHash",
+        ),
+    ] = None
 
     # INPUT PORTS ---
     inputs: Annotated[
         InputsDict | None,
         Field(default_factory=dict, description="values of input properties"),
-    ]
+    ] = _Unset
+
     inputs_required: Annotated[
         list[InputID],
         Field(
@@ -177,15 +185,23 @@ class Node(BaseModel):
             alias="inputsRequired",
         ),
     ] = _Unset
-    inputs_units: dict[InputID, UnitStr] | None = Field(
-        description="Overrides default unit (if any) defined in the service for each port",
-        alias="inputsUnits",
-    )
-    input_access: dict[InputID, AccessEnum] | None = Field(
-        default=None,
-        description="map with key - access level pairs",
-        alias="inputAccess",
-    )
+
+    inputs_units: Annotated[
+        dict[InputID, UnitStr] | None,
+        Field(
+            description="Overrides default unit (if any) defined in the service for each port",
+            alias="inputsUnits",
+        ),
+    ] = None
+
+    input_access: Annotated[
+        dict[InputID, AccessEnum] | None,
+        Field(
+            description="map with key - access level pairs",
+            alias="inputAccess",
+        ),
+    ] = None
+
     input_nodes: Annotated[
         list[NodeID] | None,
         Field(
@@ -200,38 +216,50 @@ class Node(BaseModel):
         OutputsDict | None,
         Field(default_factory=dict, description="values of output properties"),
     ] = _Unset
-    output_node: bool | None = Field(default=None, deprecated=True, alias="outputNode")
-    output_nodes: list[NodeID] | None = Field(
-        default=None,
-        description="Used in group-nodes. Node IDs of those connected to the output",
-        alias="outputNodes",
-    )
 
-    parent: NodeID | None = Field(
-        default=None,
-        description="Parent's (group-nodes') node ID s. Used to group",
-    )
+    output_node: Annotated[
+        bool | None, Field(deprecated=True, alias="outputNode")
+    ] = None
 
-    position: Position | None = Field(
-        default=None,
-        deprecated=True,
-        description="Use projects_ui.WorkbenchUI.position instead",
-    )
+    output_nodes: Annotated[
+        list[NodeID] | None,
+        Field(
+            description="Used in group-nodes. Node IDs of those connected to the output",
+            alias="outputNodes",
+        ),
+    ] = None
+
+    parent: Annotated[
+        NodeID | None,
+        Field(
+            description="Parent's (group-nodes') node ID s. Used to group",
+        ),
+    ] = None
+
+    position: Annotated[
+        Position | None,
+        Field(
+            deprecated=True,
+            description="Use projects_ui.WorkbenchUI.position instead",
+        ),
+    ] = None
 
     state: Annotated[
         NodeState | None,
         Field(default_factory=NodeState, description="The node's state object"),
     ] = _Unset
 
-    boot_options: dict[EnvVarKey, str] | None = Field(
-        default=None,
-        alias="bootOptions",
-        description=(
-            "Some services provide alternative parameters to be injected at boot time. "
-            "The user selection should be stored here, and it will overwrite the "
-            "services's defaults."
+    boot_options: Annotated[
+        dict[EnvVarKey, str] | None,
+        Field(
+            alias="bootOptions",
+            description=(
+                "Some services provide alternative parameters to be injected at boot time. "
+                "The user selection should be stored here, and it will overwrite the "
+                "services's defaults."
+            ),
         ),
-    )
+    ] = None
 
     @field_validator("thumbnail", mode="before")
     @classmethod
@@ -258,4 +286,5 @@ def _convert_from_enum(cls, v):
     model_config = ConfigDict(
         extra="forbid",
         json_schema_extra=_patch_json_schema_extra,
+        populate_by_name=True,
     )

services/api-server/src/simcore_service_api_server/models/schemas/meta.py

@@ -1,12 +1,10 @@
-from typing import Annotated
-
 from models_library.api_schemas__common.meta import BaseMeta
-from pydantic import AnyHttpUrl, ConfigDict, StringConstraints
+from pydantic import AnyHttpUrl, ConfigDict
 
 
 class Meta(BaseMeta):
-    docs_url: Annotated[AnyHttpUrl, StringConstraints(max_length=65536)]
-    docs_dev_url: Annotated[AnyHttpUrl, StringConstraints(max_length=65536)]
+    docs_url: AnyHttpUrl
+    docs_dev_url: AnyHttpUrl
     model_config = ConfigDict(
         json_schema_extra={
             "example": {

services/api-server/tests/unit/test__models_examples.py

@@ -0,0 +1,23 @@
+import json
+from itertools import chain
+from typing import Any
+
+import pytest
+import simcore_service_api_server.models.schemas
+import simcore_service_api_server.models.schemas.meta
+from pydantic import BaseModel
+from pytest_simcore.pydantic_models import walk_model_examples_in_package
+
+
+@pytest.mark.parametrize(
+    "model_cls, example_name, example_data",
+    chain(
+        walk_model_examples_in_package(simcore_service_api_server.models.schemas.meta)
+    ),
+)
+def test_all_models_library_models_config_examples(
+    model_cls: type[BaseModel], example_name: int, example_data: Any
+):
+    assert model_cls.model_validate(
+        example_data
+    ), f"Failed {example_name} : {json.dumps(example_data)}"

services/web/server/src/simcore_service_webserver/meta_modeling/_function_nodes.py

@@ -36,7 +36,7 @@ def create_param_node_from_iterator_with_outputs(iterator_node: Node) -> Node:
         version=ServiceVersion("1.0.0"),
         label=iterator_node.label,
         inputs={},
-        inputNodes=[],
+        input_nodes=[],
         thumbnail="",  # NOTE: hack due to issue in projects json-schema
         outputs=deepcopy(iterator_node.outputs),
     )

services/web/server/src/simcore_service_webserver/studies_dispatcher/_projects.py

@@ -59,9 +59,9 @@ def _create_file_picker(download_link: str, output_label: str | None):
     data = {}
     data["downloadLink"] = url = TypeAdapter(AnyUrl).validate_python(download_link)
     if output_label:
-        data["label"] = Path(output_label).name # type: ignore[assignment]
+        data["label"] = Path(output_label).name  # type: ignore[assignment]
     elif url.path:
-        data["label"] = Path(url.path).name # type: ignore[assignment]
+        data["label"] = Path(url.path).name  # type: ignore[assignment]
     output = DownloadLink.model_validate(data)
 
     output_id = "outFile"
@@ -70,7 +70,7 @@ def _create_file_picker(download_link: str, output_label: str | None):
         version=_FILE_PICKER_VERSION,
         label="File Picker",
         inputs={},
-        inputNodes=[],
+        input_nodes=[],
         outputs={output_id: output},
         progress=0,
     )
@@ -121,7 +121,7 @@ def _create_project_with_service(
         inputs=None,
     )
 
-    project = _create_project(
+    return _create_project(
         project_id=project_id,
         name=f"Service {service_info.title}",
         description=f"Autogenerated study with service {service_info.footprint}",
@@ -135,8 +135,6 @@ def _create_project_with_service(
         },
     )
 
-    return project
-
 
 def _create_project_with_filepicker_and_service(
     project_id: ProjectID,
@@ -160,12 +158,12 @@ def _create_project_with_filepicker_and_service(
                 output=file_picker_output_id,
             )
         },
-        inputNodes=[
+        input_nodes=[
             file_picker_id,
         ],
     )
 
-    project = _create_project(
+    return _create_project(
         project_id=project_id,
         name=f"Viewer {viewer_info.title}",
         description=f"Autogenerated study with file-picker and service {viewer_info.footprint}",
@@ -181,8 +179,6 @@ def _create_project_with_filepicker_and_service(
         },
     )
 
-    return project
-
 
 async def _add_new_project(
     app: web.Application, project: Project, user: UserInfo, *, product_name: str