@GitHK review: example assert

Author: pcrespov

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

@@ -2,7 +2,6 @@
     Models Node as a central element in a project's pipeline
 """
 
-from copy import deepcopy
 from typing import Annotated, Any, TypeAlias, Union
 
 from common_library.basic_types import Undefined
@@ -116,16 +115,6 @@ class NodeState(BaseModel):
     )
 
 
-def _patch_json_schema_extra(schema: dict) -> None:
-    # NOTE: exporting without this trick does not make runHash as nullable.
-    # It is a Pydantic issue see https://github.com/samuelcolvin/pydantic/issues/1270
-    for prop_name in ["parent", "runHash"]:
-        if prop_name in schema.get("properties", {}):
-            prop = deepcopy(schema["properties"][prop_name])
-            prop["nullable"] = True
-            schema["properties"][prop_name] = prop
-
-
 class Node(BaseModel):
     key: ServiceKey = Field(
         ...,
@@ -285,6 +274,5 @@ def _convert_from_enum(cls, v):
 
     model_config = ConfigDict(
         extra="forbid",
-        json_schema_extra=_patch_json_schema_extra,
         populate_by_name=True,
     )

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

@@ -19,6 +19,7 @@
     field_validator,
     model_validator,
 )
+from pydantic.config import JsonDict
 
 from .callbacks_mapping import CallbacksMapping
 from .generics import ListModel
@@ -490,57 +491,29 @@ def _not_allowed_in_both_specs(self):
     model_config = _BaseConfig
 
 
-class SimcoreServiceLabels(DynamicSidecarServiceLabels):
-    """
-    Validate all the simcores.services.* labels on a service.
-
-    When no other fields expect `settings` are present
-    the service will be started as legacy by director-v0.
-
-    If `paths_mapping` is present the service will be started
-    via dynamic-sidecar by director-v2.
-
-    When starting via dynamic-sidecar, if `compose_spec` is
-    present, also `container_http_entry` must be present.
-    When both of these fields are missing a docker-compose
-    spec will be generated before starting the service.
-    """
-
-    settings: Annotated[
-        Json[SimcoreServiceSettingsLabel],
-        Field(
-            default_factory=dict,
-            alias="simcore.service.settings",
-            description=(
-                "Json encoded. Contains setting like environment variables and "
-                "resource constraints which are required by the service. "
-                "Should be compatible with Docker REST API."
-            ),
-        ),
-    ]
+def _simcore_service_labels_json_schema_extra(json_schema_extra: JsonDict):
 
     assert "json_schema_extra" in SimcoreServiceSettingLabelEntry.model_config  # nosec
-    assert isinstance(
+    assert isinstance(  # nosec
         SimcoreServiceSettingLabelEntry.model_config["json_schema_extra"], dict
-    )  # nosec
+    )
 
     assert "json_schema_extra" in PathMappingsLabel.model_config  # nosec
-    assert isinstance(
+    assert isinstance(  # nosec
         PathMappingsLabel.model_config["json_schema_extra"], dict
-    )  # nosec
-    assert isinstance(
+    )
+    assert isinstance(  # nosec
         PathMappingsLabel.model_config["json_schema_extra"]["examples"], list
-    )  # nosec
+    )
 
     assert "json_schema_extra" in CallbacksMapping.model_config  # nosec
     assert isinstance(CallbacksMapping.model_config["json_schema_extra"], dict)  # nosec
-    assert isinstance(
+    assert isinstance(  # nosec
         CallbacksMapping.model_config["json_schema_extra"]["examples"], list
-    )  # nosec
+    )
 
-    model_config = _BaseConfig | ConfigDict(
-        extra="allow",
-        json_schema_extra={
+    json_schema_extra.update(
+        {
             "examples": [
                 # WARNING: do not change order. Used in tests!
                 # legacy service
@@ -623,3 +596,38 @@ class SimcoreServiceLabels(DynamicSidecarServiceLabels):
             ]
         },
     )
+
+
+class SimcoreServiceLabels(DynamicSidecarServiceLabels):
+    """
+    Validate all the simcores.services.* labels on a service.
+
+    When no other fields expect `settings` are present
+    the service will be started as legacy by director-v0.
+
+    If `paths_mapping` is present the service will be started
+    via dynamic-sidecar by director-v2.
+
+    When starting via dynamic-sidecar, if `compose_spec` is
+    present, also `container_http_entry` must be present.
+    When both of these fields are missing a docker-compose
+    spec will be generated before starting the service.
+    """
+
+    settings: Annotated[
+        Json[SimcoreServiceSettingsLabel],
+        Field(
+            default_factory=dict,
+            alias="simcore.service.settings",
+            description=(
+                "Json encoded. Contains setting like environment variables and "
+                "resource constraints which are required by the service. "
+                "Should be compatible with Docker REST API."
+            ),
+        ),
+    ]
+
+    model_config = _BaseConfig | ConfigDict(
+        extra="allow",
+        json_schema_extra=_simcore_service_labels_json_schema_extra,
+    )

packages/pytest-simcore/src/pytest_simcore/pydantic_models.py

@@ -98,23 +98,30 @@ def _is_model_cls(obj) -> bool:
             (model_config := model_cls.model_config)
             and isinstance(model_config, dict)
             and (json_schema_extra := model_config.get("json_schema_extra", {}))
-            and isinstance(json_schema_extra, dict)
         ):
-            if "example" in json_schema_extra:
-                yield ModelExample(
-                    model_cls=model_cls,
-                    example_name="example",
-                    example_data=json_schema_extra["example"],
-                )
-
-            elif "examples" in json_schema_extra:
-                for index, example in enumerate(json_schema_extra["examples"]):
+            processed_schema_extra = {}
+
+            if callable(json_schema_extra):
+                json_schema_extra(processed_schema_extra)
+            else:
+                processed_schema_extra = json_schema_extra
+
+            if isinstance(processed_schema_extra, dict):
+                if "example" in processed_schema_extra:
                     yield ModelExample(
                         model_cls=model_cls,
-                        example_name=f"examples_{index}",
-                        example_data=example,
+                        example_name="example",
+                        example_data=processed_schema_extra["example"],
                     )
 
+                elif "examples" in processed_schema_extra:
+                    for index, example in enumerate(processed_schema_extra["examples"]):
+                        yield ModelExample(
+                            model_cls=model_cls,
+                            example_name=f"examples_{index}",
+                            example_data=example,
+                        )
+
 
 ## PYDANTIC MODELS & SCHEMAS -----------------------------------------------------