handle metadata and job inputs/outputs in studies api

Author: bisgaard-itis

clients/python/src/osparc/_api_solvers_api.py

@@ -4,8 +4,16 @@
 
 import httpx
 from osparc_client.api.solvers_api import SolversApi as _SolversApi
-from .models import JobInputs, OnePageSolverPort, SolverPort, JobOutputs, JobMetadata
+from .models import (
+    JobInputs,
+    OnePageSolverPort,
+    SolverPort,
+    JobOutputs,
+    JobMetadata,
+    JobMetadataUpdate,
+)
 from osparc_client import JobInputs as _JobInputs
+from osparc_client import JobMetadataUpdate as _JobMetadataUpdate
 
 from ._api_client import ApiClient
 from ._settings import ParentProjectInfo
@@ -19,6 +27,7 @@
 import warnings
 from tempfile import NamedTemporaryFile
 from pathlib import Path
+from pydantic import validate_call
 
 
 class SolversApi(_SolversApi):
@@ -99,6 +108,7 @@ def jobs(self, solver_key: str, version: str, **kwargs) -> PaginationGenerator:
         )
         return self.iter_jobs(solver_key, version, **kwargs)
 
+    @validate_call
     def create_job(
         self, solver_key: str, version: str, job_inputs: JobInputs, **kwargs
     ):
@@ -121,3 +131,20 @@ def get_job_outputs(self, *args, **kwargs) -> JobOutputs:
     def get_job_custom_metadata(self, *args, **kwargs) -> JobMetadata:
         metadata = super().get_job_custom_metadata(*args, **kwargs)
         return JobMetadata.model_validate_json(metadata.to_json())
+
+    @validate_call
+    def replace_job_custom_metadata(
+        self,
+        solver_key: str,
+        version: str,
+        job_id: str,
+        job_metadata_update: JobMetadataUpdate,
+    ) -> JobMetadata:
+        _job_metadata_update = _JobMetadataUpdate.from_json(
+            job_metadata_update.model_dump_json()
+        )
+        assert _job_metadata_update is not None
+        _job_custom_metadata = super().replace_job_custom_metadata(
+            solver_key, version, job_id, _job_metadata_update
+        )
+        return JobMetadata.model_validate_json(_job_custom_metadata.to_json())

clients/python/src/osparc/_api_studies_api.py

@@ -7,9 +7,19 @@
 from typing import Any, Optional
 
 import httpx
-from .models import JobInputs, JobLogsMap, PageStudy
+from pydantic import StrictStr
+
+from .models import (
+    JobInputs,
+    JobLogsMap,
+    PageStudy,
+    JobOutputs,
+    JobMetadata,
+    JobMetadataUpdate,
+)
 from osparc_client.api.studies_api import StudiesApi as _StudiesApi
 from osparc_client import JobInputs as _JobInputs
+from osparc_client import JobMetadataUpdate as _JobMetadataUpdate
 from tqdm.asyncio import tqdm_asyncio
 
 from ._api_client import ApiClient
@@ -70,6 +80,10 @@ def create_study_job(self, study_id: str, job_inputs: JobInputs, **kwargs):
         kwargs = {**kwargs, **ParentProjectInfo().model_dump(exclude_none=True)}
         return super().create_study_job(study_id, _job_inputs, **kwargs)
 
+    def get_study_job_outputs(self, *args, **kwargs) -> JobOutputs:
+        _job_outputs = super().get_study_job_outputs(*args, **kwargs)
+        return JobOutputs.model_validate_json(_job_outputs.to_json())
+
     def clone_study(self, study_id: str, **kwargs):
         kwargs = {**kwargs, **ParentProjectInfo().model_dump(exclude_none=True)}
         return super().clone_study(study_id, **kwargs)
@@ -149,3 +163,22 @@ async def _download(unique_node_name: str, download_link: str) -> None:
             )
 
         return folder
+
+    def get_study_job_custom_metadata(self, study_id: str, job_id: str) -> JobMetadata:
+        _job_metadata = super().get_study_job_custom_metadata(study_id, job_id)
+        return JobMetadata.model_validate_json(_job_metadata.to_json())
+
+    def replace_study_job_custom_metadata(
+        self,
+        study_id: StrictStr,
+        job_id: StrictStr,
+        job_metadata_update: JobMetadataUpdate,
+    ) -> JobMetadata:
+        _job_metadata_update = _JobMetadataUpdate.from_json(
+            job_metadata_update.model_dump_json()
+        )
+        assert _job_metadata_update is not None
+        _job_metadata = super().replace_study_job_custom_metadata(
+            study_id, job_id, _job_metadata_update
+        )
+        return JobMetadata.model_validate_json(_job_metadata.to_json())

clients/python/src/osparc/_models.py

@@ -1,6 +1,7 @@
 from osparc_client import JobInputs as _JobInputs
 from osparc_client import JobOutputs as _JobOutputs
 from osparc_client import JobMetadata as _JobMetadata
+from osparc_client import JobMetadataUpdate as _JobMetadataUpdate
 from .models import File
 from typing import Dict, Union, List
 from pydantic import BaseModel, StrictStr, Field
@@ -33,3 +34,12 @@ class JobMetadata(BaseModel):
 
 
 assert set(_JobMetadata.model_fields.keys()) == set(JobMetadata.model_fields.keys())
+
+
+class JobMetadataUpdate(BaseModel):
+    metadata: Dict[str, Union[bool, float, int, str, None]]
+
+
+assert set(_JobMetadataUpdate.model_fields.keys()) == set(
+    JobMetadataUpdate.model_fields.keys()
+)

clients/python/src/osparc/models.py

@@ -29,10 +29,6 @@
 )
 from osparc_client.models.job import Job as Job
 from osparc_client.models.job_logs_map import JobLogsMap as JobLogsMap
-from osparc_client.models.job_metadata import JobMetadata as JobMetadata
-from osparc_client.models.job_metadata_update import (
-    JobMetadataUpdate as JobMetadataUpdate,
-)
 from osparc_client.models.values_value import ValuesValue as ValuesValue
 from osparc_client.models.job_status import JobStatus as JobStatus
 from osparc_client.models.links import Links as Links
@@ -74,6 +70,8 @@
 
 from ._models import JobInputs as JobInputs
 from ._models import JobOutputs as JobOutputs
+from ._models import JobMetadata as JobMetadata
+from ._models import JobMetadataUpdate as JobMetadataUpdate
 
 # renames
 TaskStates = _RunningState