get, exists setup migration

Author: EmanAbdelhaleem

openml/_api/resources/base.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, abstractmethod
 from collections.abc import Iterable
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from requests import Response
@@ -49,7 +49,7 @@ def list(
     def _create_setup(self, result_dict: dict) -> OpenMLSetup: ...
 
     @abstractmethod
-    def get(self, setup_id: int) -> OpenMLSetup: ...
+    def get(self, setup_id: int) -> tuple[str, OpenMLSetup]: ...
 
     @abstractmethod
-    def exists(self) -> int: ...
+    def exists(self, file_elements: dict[str, Any]) -> int: ...

openml/_api/resources/setups.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Iterable
+from typing import Any
 
 import xmltodict
 
@@ -156,7 +157,7 @@ def _create_setup_parameter_from_xml(self, result_dict: dict[str, str]) -> OpenM
             value=result_dict["oml:value"],
         )
 
-    def get(self, setup_id: int) -> OpenMLSetup:
+    def get(self, setup_id: int) -> tuple[str, OpenMLSetup]:
         """
         Downloads the setup (configuration) description from OpenML
         and returns a structured object
@@ -168,11 +169,40 @@ def get(self, setup_id: int) -> OpenMLSetup:
 
         Returns
         -------
-        OpenMLSetup (an initialized openml setup object)
+        tuple[str, OpenMLSetup]
+            A tuple containing:
+            - xml_content: The raw XML response from the server
+            - setup: An initialized OpenMLSetup object parsed from the XML
         """
+        url_suffix = f"/setup/{setup_id}"
+        setup_response = self._http.get(url_suffix)
+        xml_content = setup_response.text
+        result_dict = xmltodict.parse(xml_content)
+
+        setup = self._create_setup(result_dict)
+        return xml_content, setup
+
+    def exists(self, file_elements: dict[str, Any]) -> int:
+        """
+        Checks whether a hyperparameter configuration already exists on the server.
+
+        Parameters
+        ----------
+        file_elements : dict
+            Dictionary containing file data for the API request
+
+        Returns
+        -------
+        setup_id : int
+            setup id iff exists, False otherwise
+        """
+        api_call = "/setup/exists/"
+        setup_response = self._http.post(api_call, files=file_elements)
+        xml_content = setup_response.text
+        result_dict = xmltodict.parse(xml_content)
 
-    def exists(self) -> int:
-        pass
+        setup_id = int(result_dict["oml:setup_exists"]["oml:id"])
+        return setup_id if setup_id > 0 else False
 
 
 class SetupsV2(SetupsAPI):
@@ -192,8 +222,8 @@ def list(
     def _create_setup(self, result_dict: dict) -> OpenMLSetup:
         raise NotImplementedError("V2 API implementation is not yet available")
 
-    def get(self, setup_id: int) -> OpenMLSetup:
+    def get(self, setup_id: int) -> tuple[str, OpenMLSetup]:
         raise NotImplementedError("V2 API implementation is not yet available")
 
-    def exists(self) -> int:
+    def exists(self, file_elements: dict[str, Any]) -> int:
         raise NotImplementedError("V2 API implementation is not yet available")

openml/setups/functions.py

@@ -58,14 +58,8 @@ def setup_exists(flow: OpenMLFlow) -> int:
     file_elements = {
         "description": ("description.arff", description),
     }  # type: openml._api_calls.FILE_ELEMENTS_TYPE
-    result = openml._api_calls._perform_api_call(
-        "/setup/exists/",
-        "post",
-        file_elements=file_elements,
-    )
-    result_dict = xmltodict.parse(result)
-    setup_id = int(result_dict["oml:setup_exists"]["oml:id"])
-    return setup_id if setup_id > 0 else False
+
+    return api_context.backend.setups.exists(file_elements=file_elements)
 
 
 def _get_cached_setup(setup_id: int) -> OpenMLSetup:
@@ -92,7 +86,7 @@ def _get_cached_setup(setup_id: int) -> OpenMLSetup:
         setup_file = setup_cache_dir / "description.xml"
         with setup_file.open(encoding="utf8") as fh:
             setup_xml = xmltodict.parse(fh.read())
-            return _create_setup_from_xml(setup_xml)
+            return _create_setup(setup_xml)
 
     except OSError as e:
         raise openml.exceptions.OpenMLCacheException(
@@ -122,13 +116,12 @@ def get_setup(setup_id: int) -> OpenMLSetup:
     try:
         return _get_cached_setup(setup_id)
     except openml.exceptions.OpenMLCacheException:
-        url_suffix = f"/setup/{setup_id}"
-        setup_xml = openml._api_calls._perform_api_call(url_suffix, "get")
+        result: tuple[str, OpenMLSetup] = api_context.backend.setups.get(setup_id=setup_id)
+        setup_xml, setup = result
         with setup_file.open("w", encoding="utf8") as fh:
             fh.write(setup_xml)
 
-    result_dict = xmltodict.parse(setup_xml)
-    return _create_setup_from_xml(result_dict)
+    return setup
 
 
 def list_setups(  # noqa: PLR0913
@@ -238,6 +231,6 @@ def _to_dict(flow_id: int, openml_parameter_settings: list[dict[str, Any]]) -> O
     return xml
 
 
-def _create_setup_from_xml(result_dict: dict) -> OpenMLSetup:
+def _create_setup(result_dict: dict) -> OpenMLSetup:
     """Turns an API xml result into a OpenMLSetup object (or dict)"""
     return api_context.backend.setups._create_setup(result_dict)