[ENH] V1 → V2 API Migration - setups (#1619)

Fixes #1625 
Depends on #1576
Related to #1575

Details
This PR implements `Setups` resource, and refactor its existing
functions

---------

Co-authored-by: Franz Király <fkiraly@gcos.ai>
Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com>
Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Simon Blanke <simon.blanke@yahoo.com>
Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de>
Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

Author: 8 people

openml/_api/clients/http.py

@@ -89,6 +89,26 @@ def _key_to_path(self, key: str) -> Path:
         """
         return self.path.joinpath(key)
 
+    def _get_body_filename_from_response(self, response: Response) -> str:
+        content_type = response.headers.get("Content-Type", "").lower()
+
+        if "application/json" in content_type:
+            return "body.json"
+
+        if "text/xml" in content_type:
+            return "body.xml"
+
+        return "body.txt"
+
+    def _get_body_filename_from_path(self, path: Path) -> str:
+        if (path / "body.json").exists():
+            return "body.json"
+
+        if (path / "body.xml").exists():
+            return "body.xml"
+
+        return "body.txt"
+
     def load(self, key: str) -> Response:
         """
         Load a cached HTTP response from disk.
@@ -112,31 +132,26 @@ def load(self, key: str) -> Response:
         """
         path = self._key_to_path(key)
 
-        if not path.exists():
-            raise FileNotFoundError(f"Cache entry not found: {path}")
-
         meta_path = path / "meta.json"
-        headers_path = path / "headers.json"
-        body_path = path / "body.bin"
+        meta_raw = meta_path.read_bytes() if meta_path.exists() else "{}"
+        meta = json.loads(meta_raw)
 
-        if not (meta_path.exists() and headers_path.exists() and body_path.exists()):
-            raise FileNotFoundError(f"Incomplete cache at {path}")
-
-        with meta_path.open("r", encoding="utf-8") as f:
-            meta = json.load(f)
-
-        with headers_path.open("r", encoding="utf-8") as f:
-            headers = json.load(f)
+        headers_path = path / "headers.json"
+        headers_raw = headers_path.read_bytes() if headers_path.exists() else "{}"
+        headers = json.loads(headers_raw)
 
+        body_path = path / self._get_body_filename_from_path(path)
+        if not body_path.exists():
+            raise FileNotFoundError(f"Incomplete cache at {body_path}")
         body = body_path.read_bytes()
 
         response = Response()
-        response.status_code = meta["status_code"]
-        response.url = meta["url"]
-        response.reason = meta["reason"]
         response.headers = headers
         response._content = body
-        response.encoding = meta["encoding"]
+        response.status_code = meta.get("status_code")
+        response.url = meta.get("url")
+        response.reason = meta.get("reason")
+        response.encoding = meta.get("encoding")
 
         return response
 
@@ -160,7 +175,9 @@ def save(self, key: str, response: Response) -> None:
         path = self._key_to_path(key)
         path.mkdir(parents=True, exist_ok=True)
 
-        (path / "body.bin").write_bytes(response.content)
+        body_filename = self._get_body_filename_from_response(response)
+        with (path / body_filename).open("wb") as f:
+            f.write(response.content)
 
         with (path / "headers.json").open("w", encoding="utf-8") as f:
             json.dump(dict(response.headers), f)

openml/_api/resources/base/resources.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
+import builtins
 from abc import abstractmethod
+from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any
 
 from openml.enums import ResourceType
@@ -9,6 +11,8 @@
 
 if TYPE_CHECKING:
     from openml.evaluations import OpenMLEvaluation
+    from openml.flows.flow import OpenMLFlow
+    from openml.setups.setup import OpenMLSetup
 
 
 class DatasetAPI(ResourceAPI):
@@ -83,3 +87,24 @@ class SetupAPI(ResourceAPI):
     """Abstract API interface for setup resources."""
 
     resource_type: ResourceType = ResourceType.SETUP
+
+    @abstractmethod
+    def list(
+        self,
+        limit: int,
+        offset: int,
+        *,
+        setup: Iterable[int] | None = None,
+        flow: int | None = None,
+        tag: str | None = None,
+    ) -> list[OpenMLSetup]: ...
+
+    @abstractmethod
+    def get(self, setup_id: int) -> OpenMLSetup: ...
+
+    @abstractmethod
+    def exists(
+        self,
+        flow: OpenMLFlow,
+        param_settings: builtins.list[dict[str, Any]],
+    ) -> int | bool: ...