⬆️ Upgrade openapi generator (#202)

Author: bisgaard-itis

api/openapi.json

@@ -116,8 +116,8 @@ _check_venv_active:
 
 .PHONY: install-dev
 install-dev: _check_venv_active .install-dev-reqs python-client  ## installs osparc_client and osparc in edit mode
-	uv pip install -e artifacts/client
-	uv pip install -e .
+	# for some reason this command refuses to run with uv. Looks related to https://github.com/astral-sh/uv/issues/1661
+	pip install --editable artifacts/client --editable .
 	uv pip list
 
 .PHONY: install-unit-test
@@ -129,6 +129,10 @@ install-e2e-test: _check_venv_active guard-OSPARC_VERSION ## install packages fo
 	$(eval version := $(shell bash $(CLIENTS_PYTHON_DIR)/test/e2e/ci/bash/osparc_version.bash $(OSPARC_VERSION)))
 	uv pip install -r $(CLIENTS_PYTHON_DIR)/requirements/e2e-test.txt osparc-client==$(version) osparc==$(version)
 
+.PHONY: install-e2e-test-local
+install-e2e-test-local: _check_venv_active python-client ## install packages for e2e testing with local (repo) client [e2e]
+	pip install -r $(CLIENTS_PYTHON_DIR)/requirements/e2e-test.txt --editable artifacts/client --editable .
+
 .PHONY: install-doc
 install-doc: _check_venv_active .install-dev-reqs ## install packages for generating documentation
 	uv pip install -r $(CLIENTS_PYTHON_DIR)/requirements/doc.txt

clients/python/Makefile

@@ -1,4 +1,3 @@
 -r ../../../requirements.txt
 -r unit-test.txt
--r e2e-test.txt
 pylint

clients/python/requirements/dev.txt

@@ -1,8 +1,11 @@
 -r ../../../requirements.txt
 black
 faker
+openapi-spec-validator #installed as backend for prance
+parse
 pipdeptree
 pipreqs
+prance
 pytest
 pytest-asyncio
 pytest-mock

clients/python/requirements/unit-test.txt

@@ -30,6 +30,7 @@
     "tenacity",
     "tqdm>=4.48.0",
     f"osparc_client=={VERSION}",
+    "urllib3",
     "aiofiles",
 ]
 

clients/python/setup.py

@@ -3,9 +3,8 @@
 from typing import Optional
 
 from osparc_client.api_client import ApiClient as _ApiClient
-from osparc_client import Configuration
+from ._configuration import Configuration
 from pydantic import ValidationError
-
 from ._settings import ConfigurationEnvVars
 
 
@@ -16,7 +15,6 @@ def __init__(
         header_name=None,
         header_value=None,
         cookie=None,
-        pool_threads=1,
     ):
         if configuration is None:
             try:
@@ -36,4 +34,4 @@ def __init__(
                     "osparc.Configuration object explicitly"
                 ) from exc
 
-        super().__init__(configuration, header_name, header_value, cookie, pool_threads)
+        super().__init__(configuration, header_name, header_value, cookie)

clients/python/src/osparc/_api_client.py

@@ -5,7 +5,8 @@
 import logging
 import math
 from pathlib import Path
-from typing import Any, Iterator, List, Optional, Tuple, Union, Set, Final
+from typing import Any, Iterator, List, Optional, Tuple, Union, Final, Set
+from tempfile import NamedTemporaryFile
 
 import httpx
 from httpx import Response
@@ -27,7 +28,6 @@
 )
 from urllib.parse import urljoin
 import aiofiles
-from tempfile import NamedTemporaryFile
 import shutil
 from ._utils import (
     DEFAULT_TIMEOUT_SECONDS,

clients/python/src/osparc/_api_files_api.py

@@ -4,7 +4,17 @@
 
 import httpx
 from osparc_client.api.solvers_api import SolversApi as _SolversApi
-from .models import JobInputs, OnePageSolverPort, SolverPort
+from .models import (
+    JobInputs,
+    OnePageSolverPort,
+    SolverPort,
+    Job,
+    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
@@ -13,8 +23,11 @@
     _DEFAULT_PAGINATION_OFFSET,
     PaginationIterable,
 )
-
 import warnings
+from tempfile import NamedTemporaryFile
+from pathlib import Path
+from pydantic import validate_call
+from pydantic import StrictStr
 
 
 class SolversApi(_SolversApi):
@@ -88,8 +101,59 @@ def jobs(self, solver_key: str, version: str, **kwargs) -> PaginationIterable:
         )
         return self.iter_jobs(solver_key, version, **kwargs)
 
+    @validate_call
     def create_job(
         self, solver_key: str, version: str, job_inputs: JobInputs, **kwargs
-    ):
+    ) -> Job:
+        _job_inputs = _JobInputs.from_json(job_inputs.model_dump_json())
+        assert _job_inputs is not None
         kwargs = {**kwargs, **ParentProjectInfo().model_dump(exclude_none=True)}
-        return super().create_job(solver_key, version, job_inputs, **kwargs)
+        return super().create_job(solver_key, version, _job_inputs, **kwargs)
+
+    def get_job_output_logfile(
+        self,
+        solver_key: str,
+        version: str,
+        job_id: StrictStr,
+        **kwargs,
+    ):
+        data = super().get_job_output_logfile(
+            solver_key=solver_key, version=version, job_id=job_id, **kwargs
+        )
+        with NamedTemporaryFile(delete=False) as tmp_file:
+            log_file = Path(tmp_file.name)
+            log_file.write_bytes(data)
+            return log_file
+
+    def get_job_outputs(
+        self,
+        solver_key: str,
+        version: str,
+        job_id: StrictStr,
+        **kwargs,
+    ) -> JobOutputs:
+        _osparc_client_outputs = super().get_job_outputs(
+            solver_key=solver_key, version=version, job_id=job_id, **kwargs
+        )
+        return JobOutputs.model_validate_json(_osparc_client_outputs.to_json())
+
+    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_solvers_api.py

@@ -7,8 +7,19 @@
 from typing import 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
@@ -58,8 +69,18 @@ def __init__(self, api_client: ApiClient):
         )
 
     def create_study_job(self, study_id: str, job_inputs: JobInputs, **kwargs):
+        _job_inputs = _JobInputs.from_json(job_inputs.model_dump_json())
+        assert _job_inputs is not None
         kwargs = {**kwargs, **ParentProjectInfo().model_dump(exclude_none=True)}
-        return super().create_study_job(study_id, job_inputs, **kwargs)
+        return super().create_study_job(study_id, _job_inputs, **kwargs)
+
+    def get_study_job_outputs(
+        self, study_id: StrictStr, job_id: StrictStr, **kwargs
+    ) -> JobOutputs:
+        _job_outputs = super().get_study_job_outputs(
+            study_id=study_id, job_id=job_id, **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)}
@@ -140,3 +161,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/_api_studies_api.py

@@ -0,0 +1,45 @@
+from osparc_client import Configuration as _Configuration
+from typing import Set
+from urllib3 import Retry
+
+
+class Configuration(_Configuration):
+    def __init__(
+        self,
+        host="https://api.osparc.io",
+        api_key=None,
+        api_key_prefix=None,
+        username=None,
+        password=None,
+        *,
+        retry_max_count: int = 4,
+        retry_methods: Set[str] = {
+            "DELETE",
+            "GET",
+            "HEAD",
+            "OPTIONS",
+            "PUT",
+            "TRACE",
+            "POST",
+            "PATCH",
+            "CONNECT",
+        },
+        retry_status_codes: Set[int] = {429, 503, 504},
+        retry_backoff_factor=4.0,
+    ):
+        retries = Retry(
+            total=retry_max_count,
+            backoff_factor=retry_backoff_factor,
+            status_forcelist=retry_status_codes,
+            allowed_methods=retry_methods,
+            respect_retry_after_header=True,
+            raise_on_status=True,
+        )
+        super().__init__(
+            host=host,
+            api_key=api_key,
+            api_key_prefix=api_key_prefix,
+            username=username,
+            password=password,
+            retries=retries,
+        )