rename iter and deprecate

Author: pcrespov

clients/python/src/osparc/_solvers_api.py

@@ -14,6 +14,8 @@
     dev_features_enabled,
 )
 
+import warnings
+
 
 class SolversApi(_SolversApi):
     """Class for interacting with solvers"""
@@ -51,7 +53,7 @@ def list_solver_ports(
         return page.items if page.items else []
 
     @dev_feature
-    def jobs(self, solver_key: str, version: str) -> PaginationGenerator:
+    def iter_jobs(self, solver_key: str, version: str, **kwargs) -> PaginationGenerator:
         """Returns an iterator through which one can iterate over
         all Jobs submitted to the solver
 
@@ -73,6 +75,7 @@ def _pagination_method():
                 version=version,
                 limit=_DEFAULT_PAGINATION_LIMIT,
                 offset=_DEFAULT_PAGINATION_OFFSET,
+                **kwargs,
             )
 
         return PaginationGenerator(
@@ -82,6 +85,16 @@ def _pagination_method():
             auth=self._auth,
         )
 
+    @dev_feature
+    def jobs(self, solver_key: str, version: str, **kwargs) -> PaginationGenerator:
+        warnings.warn(
+            "The 'jobs' method is deprecated and will be removed in a future version. "
+            "Please use 'iter_jobs' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.iter_jobs(solver_key, version, **kwargs)
+
     def create_job(
         self, solver_key: str, version: str, job_inputs: JobInputs, **kwargs
     ):

clients/python/src/osparc/_studies_api.py

@@ -18,6 +18,7 @@
     PaginationGenerator,
     dev_features_enabled,
 )
+import warnings
 
 _logger = logging.getLogger(__name__)
 
@@ -68,7 +69,7 @@ def clone_study(self, study_id: str, **kwargs):
         kwargs = {**kwargs, **ParentProjectInfo().model_dump(exclude_none=True)}
         return super().clone_study(study_id, **kwargs)
 
-    def studies(self, **kwargs) -> PaginationGenerator:
+    def iter_studies(self, **kwargs) -> PaginationGenerator:
         def _pagination_method():
             page_study = self.list_studies(
                 limit=_DEFAULT_PAGINATION_LIMIT,
@@ -85,6 +86,15 @@ def _pagination_method():
             auth=self._auth,
         )
 
+    def studies(self, **kwargs) -> PaginationGenerator:
+        warnings.warn(
+            "The 'studies' method is deprecated and will be removed in a future version. "
+            "Please use 'iter_studies' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.iter_studies(**kwargs)
+
     def get_study_job_output_logfiles(self, study_id: str, job_id: str) -> Path:
         return asyncio.run(
             self.get_study_job_output_logfiles_async(study_id=study_id, job_id=job_id)

clients/python/test/e2e/ci/e2e/e2e/postprocess.py

@@ -239,7 +239,7 @@ def clean_up_jobs(artifacts_dir: Path, retry_minutes: Optional[PositiveInt] = No
                             assert isinstance(solver, osparc.Solver)
                             assert (id_ := solver.id) is not None
                             assert (version := solver.version) is not None
-                            for job in solvers_api.jobs(id_, version):
+                            for job in solvers_api.iter_jobs(id_, version):
                                 assert isinstance(job, osparc.Job)
                                 solvers_api.delete_job(id_, version, job.id)
         except RetryError as exc:

clients/python/test/e2e/conftest.py

@@ -164,7 +164,7 @@ def sleeper_study_id(api_client: osparc.ApiClient) -> UUID:
     as input a single file containing a single integer"""
     _test_study_title = "sleeper_test_study"
     study_api = osparc.StudiesApi(api_client=api_client)
-    for study in study_api.studies():
+    for study in study_api.iter_studies():
         if study.title == _test_study_title:
             return UUID(study.uid)
     pytest.fail(f"Could not find {_test_study_title} study")

clients/python/test/e2e/test_solvers_api.py

@@ -24,7 +24,7 @@ def test_jobs(api_client: osparc.ApiClient, sleeper: osparc.Solver):
     n_jobs: int = 3
     solvers_api = osparc.SolversApi(api_client=api_client)
     # initial iterator
-    init_iter = solvers_api.jobs(sleeper.id, sleeper.version)
+    init_iter = solvers_api.iter_jobs(sleeper.id, sleeper.version)
     n_init_iter: int = len(init_iter)
     assert n_init_iter >= 0
 
@@ -36,10 +36,10 @@ def test_jobs(api_client: osparc.ApiClient, sleeper: osparc.Solver):
         )
         created_job_ids.append(job.id)
 
-    tmp_iter = solvers_api.jobs(sleeper.id, sleeper.version)
-    solvers_api.jobs(sleeper.id, sleeper.version)
+    tmp_iter = solvers_api.iter_jobs(sleeper.id, sleeper.version)
+    solvers_api.iter_jobs(sleeper.id, sleeper.version)
 
-    final_iter = solvers_api.jobs(sleeper.id, sleeper.version)
+    final_iter = solvers_api.iter_jobs(sleeper.id, sleeper.version)
     assert len(final_iter) > 0, "No jobs were available"
     assert n_init_iter + n_jobs == len(
         final_iter