From 0159f474c6bbc15f20d52bc946bd252bd852b196 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Tue, 30 Dec 2025 09:11:27 +0500 Subject: [PATCH 01/24] set up folder structure and base code --- openml/_api/__init__.py | 8 +++ openml/_api/config.py | 5 ++ openml/_api/http/__init__.py | 1 + openml/_api/http/client.py | 23 ++++++ openml/_api/http/utils.py | 0 openml/_api/resources/__init__.py | 2 + openml/_api/resources/base.py | 22 ++++++ openml/_api/resources/datasets.py | 13 ++++ openml/_api/resources/tasks.py | 113 ++++++++++++++++++++++++++++++ openml/_api/runtime/core.py | 58 +++++++++++++++ openml/_api/runtime/fallback.py | 5 ++ openml/tasks/functions.py | 8 ++- 12 files changed, 255 insertions(+), 3 deletions(-) create mode 100644 openml/_api/__init__.py create mode 100644 openml/_api/config.py create mode 100644 openml/_api/http/__init__.py create mode 100644 openml/_api/http/client.py create mode 100644 openml/_api/http/utils.py create mode 100644 openml/_api/resources/__init__.py create mode 100644 openml/_api/resources/base.py create mode 100644 openml/_api/resources/datasets.py create mode 100644 openml/_api/resources/tasks.py create mode 100644 openml/_api/runtime/core.py create mode 100644 openml/_api/runtime/fallback.py diff --git a/openml/_api/__init__.py b/openml/_api/__init__.py new file mode 100644 index 000000000..5089f94dd --- /dev/null +++ b/openml/_api/__init__.py @@ -0,0 +1,8 @@ +from openml._api.runtime.core import APIContext + + +def set_api_version(version: str, strict=False): + api_context.set_version(version=version, strict=strict) + + +api_context = APIContext() diff --git a/openml/_api/config.py b/openml/_api/config.py new file mode 100644 index 000000000..bd93c3cad --- /dev/null +++ b/openml/_api/config.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +API_V1_SERVER = "https://www.openml.org/api/v1/xml" +API_V2_SERVER = "http://127.0.0.1:8001" +API_KEY = "..." diff --git a/openml/_api/http/__init__.py b/openml/_api/http/__init__.py new file mode 100644 index 000000000..fde2a5b0a --- /dev/null +++ b/openml/_api/http/__init__.py @@ -0,0 +1 @@ +from openml._api.http.client import HTTPClient diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py new file mode 100644 index 000000000..81a9213e3 --- /dev/null +++ b/openml/_api/http/client.py @@ -0,0 +1,23 @@ +from __future__ import annotations + +import requests + +from openml.__version__ import __version__ + + +class HTTPClient: + def __init__(self, base_url: str): + self.base_url = base_url + self.headers = {"user-agent": f"openml-python/{__version__}"} + + def get(self, path, params=None): + url = f"{self.base_url}/{path}" + return requests.get(url, params=params, headers=self.headers) + + def post(self, path, data=None, files=None): + url = f"{self.base_url}/{path}" + return requests.post(url, data=data, files=files, headers=self.headers) + + def delete(self, path, params=None): + url = f"{self.base_url}/{path}" + return requests.delete(url, params=params, headers=self.headers) diff --git a/openml/_api/http/utils.py b/openml/_api/http/utils.py new file mode 100644 index 000000000..e69de29bb diff --git a/openml/_api/resources/__init__.py b/openml/_api/resources/__init__.py new file mode 100644 index 000000000..078fc5998 --- /dev/null +++ b/openml/_api/resources/__init__.py @@ -0,0 +1,2 @@ +from openml._api.resources.datasets import DatasetsV1, DatasetsV2 +from openml._api.resources.tasks import TasksV1, TasksV2 diff --git a/openml/_api/resources/base.py b/openml/_api/resources/base.py new file mode 100644 index 000000000..1fae27665 --- /dev/null +++ b/openml/_api/resources/base.py @@ -0,0 +1,22 @@ +from __future__ import annotations + +from abc import ABC, abstractmethod +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from openml._api.http import HTTPClient + + +class ResourceAPI: + def __init__(self, http: HTTPClient): + self._http = http + + +class DatasetsAPI(ResourceAPI, ABC): + @abstractmethod + def get(self, id: int) -> dict: ... + + +class TasksAPI(ResourceAPI, ABC): + @abstractmethod + def get(self, id: int) -> dict: ... diff --git a/openml/_api/resources/datasets.py b/openml/_api/resources/datasets.py new file mode 100644 index 000000000..cd1bb595a --- /dev/null +++ b/openml/_api/resources/datasets.py @@ -0,0 +1,13 @@ +from __future__ import annotations + +from openml._api.resources.base import DatasetsAPI + + +class DatasetsV1(DatasetsAPI): + def get(self, id): + pass + + +class DatasetsV2(DatasetsAPI): + def get(self, id): + pass diff --git a/openml/_api/resources/tasks.py b/openml/_api/resources/tasks.py new file mode 100644 index 000000000..b0e9afbf8 --- /dev/null +++ b/openml/_api/resources/tasks.py @@ -0,0 +1,113 @@ +from __future__ import annotations + +import xmltodict + +from openml._api.resources.base import TasksAPI +from openml.tasks.task import ( + OpenMLClassificationTask, + OpenMLClusteringTask, + OpenMLLearningCurveTask, + OpenMLRegressionTask, + OpenMLTask, + TaskType, +) + + +class TasksV1(TasksAPI): + def get(self, id, return_response=False): + path = f"task/{id}" + response = self._http.get(path) + xml_content = response.content + task = self._create_task_from_xml(xml_content) + + if return_response: + return task, response + + return task + + def _create_task_from_xml(self, xml: str) -> OpenMLTask: + """Create a task given a xml string. + + Parameters + ---------- + xml : string + Task xml representation. + + Returns + ------- + OpenMLTask + """ + dic = xmltodict.parse(xml)["oml:task"] + estimation_parameters = {} + inputs = {} + # Due to the unordered structure we obtain, we first have to extract + # the possible keys of oml:input; dic["oml:input"] is a list of + # OrderedDicts + + # Check if there is a list of inputs + if isinstance(dic["oml:input"], list): + for input_ in dic["oml:input"]: + name = input_["@name"] + inputs[name] = input_ + # Single input case + elif isinstance(dic["oml:input"], dict): + name = dic["oml:input"]["@name"] + inputs[name] = dic["oml:input"] + + evaluation_measures = None + if "evaluation_measures" in inputs: + evaluation_measures = inputs["evaluation_measures"]["oml:evaluation_measures"][ + "oml:evaluation_measure" + ] + + task_type = TaskType(int(dic["oml:task_type_id"])) + common_kwargs = { + "task_id": dic["oml:task_id"], + "task_type": dic["oml:task_type"], + "task_type_id": task_type, + "data_set_id": inputs["source_data"]["oml:data_set"]["oml:data_set_id"], + "evaluation_measure": evaluation_measures, + } + # TODO: add OpenMLClusteringTask? + if task_type in ( + TaskType.SUPERVISED_CLASSIFICATION, + TaskType.SUPERVISED_REGRESSION, + TaskType.LEARNING_CURVE, + ): + # Convert some more parameters + for parameter in inputs["estimation_procedure"]["oml:estimation_procedure"][ + "oml:parameter" + ]: + name = parameter["@name"] + text = parameter.get("#text", "") + estimation_parameters[name] = text + + common_kwargs["estimation_procedure_type"] = inputs["estimation_procedure"][ + "oml:estimation_procedure" + ]["oml:type"] + common_kwargs["estimation_procedure_id"] = int( + inputs["estimation_procedure"]["oml:estimation_procedure"]["oml:id"] + ) + + common_kwargs["estimation_parameters"] = estimation_parameters + common_kwargs["target_name"] = inputs["source_data"]["oml:data_set"][ + "oml:target_feature" + ] + common_kwargs["data_splits_url"] = inputs["estimation_procedure"][ + "oml:estimation_procedure" + ]["oml:data_splits_url"] + + cls = { + TaskType.SUPERVISED_CLASSIFICATION: OpenMLClassificationTask, + TaskType.SUPERVISED_REGRESSION: OpenMLRegressionTask, + TaskType.CLUSTERING: OpenMLClusteringTask, + TaskType.LEARNING_CURVE: OpenMLLearningCurveTask, + }.get(task_type) + if cls is None: + raise NotImplementedError(f"Task type {common_kwargs['task_type']} not supported.") + return cls(**common_kwargs) # type: ignore + + +class TasksV2(TasksAPI): + def get(self, id): + pass diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py new file mode 100644 index 000000000..80f35587c --- /dev/null +++ b/openml/_api/runtime/core.py @@ -0,0 +1,58 @@ +from __future__ import annotations + +from openml._api.config import ( + API_V1_SERVER, + API_V2_SERVER, +) +from openml._api.http.client import HTTPClient +from openml._api.resources import ( + DatasetsV1, + DatasetsV2, + TasksV1, + TasksV2, +) +from openml._api.runtime.fallback import FallbackProxy + + +class APIBackend: + def __init__(self, *, datasets, tasks): + self.datasets = datasets + self.tasks = tasks + + +def build_backend(version: str, strict: bool) -> APIBackend: + v1_http = HTTPClient(API_V1_SERVER) + v2_http = HTTPClient(API_V2_SERVER) + + v1 = APIBackend( + datasets=DatasetsV1(v1_http), + tasks=TasksV1(v1_http), + ) + + if version == "v1": + return v1 + + v2 = APIBackend( + datasets=DatasetsV2(v2_http), + tasks=TasksV2(v2_http), + ) + + if strict: + return v2 + + return APIBackend( + datasets=FallbackProxy(v2.datasets, v1.datasets), + tasks=FallbackProxy(v2.tasks, v1.tasks), + ) + + +class APIContext: + def __init__(self): + self._backend = build_backend("v1", strict=False) + + def set_version(self, version: str, strict: bool = False): + self._backend = build_backend(version, strict) + + @property + def backend(self): + return self._backend diff --git a/openml/_api/runtime/fallback.py b/openml/_api/runtime/fallback.py new file mode 100644 index 000000000..56e96a966 --- /dev/null +++ b/openml/_api/runtime/fallback.py @@ -0,0 +1,5 @@ +from __future__ import annotations + + +class FallbackProxy: + pass diff --git a/openml/tasks/functions.py b/openml/tasks/functions.py index d2bf5e946..91be65965 100644 --- a/openml/tasks/functions.py +++ b/openml/tasks/functions.py @@ -12,6 +12,7 @@ import openml._api_calls import openml.utils +from openml._api import api_context from openml.datasets import get_dataset from openml.exceptions import OpenMLCacheException @@ -442,11 +443,12 @@ def _get_task_description(task_id: int) -> OpenMLTask: except OpenMLCacheException: _cache_dir = openml.utils._create_cache_directory_for_id(TASKS_CACHE_DIR_NAME, task_id) xml_file = _cache_dir / "task.xml" - task_xml = openml._api_calls._perform_api_call("task/%d" % task_id, "get") + task, response = api_context.backend.tasks.get(task_id, return_response=True) with xml_file.open("w", encoding="utf8") as fh: - fh.write(task_xml) - return _create_task_from_xml(task_xml) + fh.write(response.text) + + return task def _create_task_from_xml(xml: str) -> OpenMLTask: From 52ef37999fad8509e5e85b8512e442bd9dc69e04 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Mon, 5 Jan 2026 12:48:58 +0500 Subject: [PATCH 02/24] fix pre-commit --- openml/_api/__init__.py | 2 +- openml/_api/http/__init__.py | 2 ++ openml/_api/http/client.py | 32 +++++++++++++++++++++++-------- openml/_api/resources/__init__.py | 2 ++ openml/_api/resources/base.py | 13 +++++++++++-- openml/_api/resources/datasets.py | 15 +++++++++++---- openml/_api/resources/tasks.py | 25 +++++++++++++++++++----- openml/_api/runtime/__init__.py | 0 openml/_api/runtime/core.py | 23 +++++++++++----------- openml/_api/runtime/fallback.py | 9 ++++++++- openml/tasks/functions.py | 12 ++++++++---- 11 files changed, 99 insertions(+), 36 deletions(-) create mode 100644 openml/_api/runtime/__init__.py diff --git a/openml/_api/__init__.py b/openml/_api/__init__.py index 5089f94dd..881f40671 100644 --- a/openml/_api/__init__.py +++ b/openml/_api/__init__.py @@ -1,7 +1,7 @@ from openml._api.runtime.core import APIContext -def set_api_version(version: str, strict=False): +def set_api_version(version: str, *, strict: bool = False) -> None: api_context.set_version(version=version, strict=strict) diff --git a/openml/_api/http/__init__.py b/openml/_api/http/__init__.py index fde2a5b0a..8e6d1e4ce 100644 --- a/openml/_api/http/__init__.py +++ b/openml/_api/http/__init__.py @@ -1 +1,3 @@ from openml._api.http.client import HTTPClient + +__all__ = ["HTTPClient"] diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py index 81a9213e3..dea5de809 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/http/client.py @@ -1,23 +1,39 @@ from __future__ import annotations +from typing import Any, Mapping + import requests +from requests import Response from openml.__version__ import __version__ class HTTPClient: - def __init__(self, base_url: str): + def __init__(self, base_url: str) -> None: self.base_url = base_url - self.headers = {"user-agent": f"openml-python/{__version__}"} + self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} - def get(self, path, params=None): + def get( + self, + path: str, + params: Mapping[str, Any] | None = None, + ) -> Response: url = f"{self.base_url}/{path}" - return requests.get(url, params=params, headers=self.headers) + return requests.get(url, params=params, headers=self.headers, timeout=10) - def post(self, path, data=None, files=None): + def post( + self, + path: str, + data: Mapping[str, Any] | None = None, + files: Any = None, + ) -> Response: url = f"{self.base_url}/{path}" - return requests.post(url, data=data, files=files, headers=self.headers) + return requests.post(url, data=data, files=files, headers=self.headers, timeout=10) - def delete(self, path, params=None): + def delete( + self, + path: str, + params: Mapping[str, Any] | None = None, + ) -> Response: url = f"{self.base_url}/{path}" - return requests.delete(url, params=params, headers=self.headers) + return requests.delete(url, params=params, headers=self.headers, timeout=10) diff --git a/openml/_api/resources/__init__.py b/openml/_api/resources/__init__.py index 078fc5998..b1af3c1a8 100644 --- a/openml/_api/resources/__init__.py +++ b/openml/_api/resources/__init__.py @@ -1,2 +1,4 @@ from openml._api.resources.datasets import DatasetsV1, DatasetsV2 from openml._api.resources.tasks import TasksV1, TasksV2 + +__all__ = ["DatasetsV1", "DatasetsV2", "TasksV1", "TasksV2"] diff --git a/openml/_api/resources/base.py b/openml/_api/resources/base.py index 1fae27665..6fbf8977d 100644 --- a/openml/_api/resources/base.py +++ b/openml/_api/resources/base.py @@ -4,7 +4,11 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: + from requests import Response + from openml._api.http import HTTPClient + from openml.datasets.dataset import OpenMLDataset + from openml.tasks.task import OpenMLTask class ResourceAPI: @@ -14,9 +18,14 @@ def __init__(self, http: HTTPClient): class DatasetsAPI(ResourceAPI, ABC): @abstractmethod - def get(self, id: int) -> dict: ... + def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: ... class TasksAPI(ResourceAPI, ABC): @abstractmethod - def get(self, id: int) -> dict: ... + def get( + self, + task_id: int, + *, + return_response: bool = False, + ) -> OpenMLTask | tuple[OpenMLTask, Response]: ... diff --git a/openml/_api/resources/datasets.py b/openml/_api/resources/datasets.py index cd1bb595a..9ff1ec278 100644 --- a/openml/_api/resources/datasets.py +++ b/openml/_api/resources/datasets.py @@ -1,13 +1,20 @@ from __future__ import annotations +from typing import TYPE_CHECKING + from openml._api.resources.base import DatasetsAPI +if TYPE_CHECKING: + from responses import Response + + from openml.datasets.dataset import OpenMLDataset + class DatasetsV1(DatasetsAPI): - def get(self, id): - pass + def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: + raise NotImplementedError class DatasetsV2(DatasetsAPI): - def get(self, id): - pass + def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: + raise NotImplementedError diff --git a/openml/_api/resources/tasks.py b/openml/_api/resources/tasks.py index b0e9afbf8..f494fb9a3 100644 --- a/openml/_api/resources/tasks.py +++ b/openml/_api/resources/tasks.py @@ -1,5 +1,7 @@ from __future__ import annotations +from typing import TYPE_CHECKING + import xmltodict from openml._api.resources.base import TasksAPI @@ -12,12 +14,20 @@ TaskType, ) +if TYPE_CHECKING: + from requests import Response + class TasksV1(TasksAPI): - def get(self, id, return_response=False): - path = f"task/{id}" + def get( + self, + task_id: int, + *, + return_response: bool = False, + ) -> OpenMLTask | tuple[OpenMLTask, Response]: + path = f"task/{task_id}" response = self._http.get(path) - xml_content = response.content + xml_content = response.text task = self._create_task_from_xml(xml_content) if return_response: @@ -109,5 +119,10 @@ def _create_task_from_xml(self, xml: str) -> OpenMLTask: class TasksV2(TasksAPI): - def get(self, id): - pass + def get( + self, + task_id: int, + *, + return_response: bool = False, + ) -> OpenMLTask | tuple[OpenMLTask, Response]: + raise NotImplementedError diff --git a/openml/_api/runtime/__init__.py b/openml/_api/runtime/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 80f35587c..aa09a69db 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -1,5 +1,7 @@ from __future__ import annotations +from typing import TYPE_CHECKING + from openml._api.config import ( API_V1_SERVER, API_V2_SERVER, @@ -11,16 +13,18 @@ TasksV1, TasksV2, ) -from openml._api.runtime.fallback import FallbackProxy + +if TYPE_CHECKING: + from openml._api.resources.base import DatasetsAPI, TasksAPI class APIBackend: - def __init__(self, *, datasets, tasks): + def __init__(self, *, datasets: DatasetsAPI, tasks: TasksAPI): self.datasets = datasets self.tasks = tasks -def build_backend(version: str, strict: bool) -> APIBackend: +def build_backend(version: str, *, strict: bool) -> APIBackend: v1_http = HTTPClient(API_V1_SERVER) v2_http = HTTPClient(API_V2_SERVER) @@ -40,19 +44,16 @@ def build_backend(version: str, strict: bool) -> APIBackend: if strict: return v2 - return APIBackend( - datasets=FallbackProxy(v2.datasets, v1.datasets), - tasks=FallbackProxy(v2.tasks, v1.tasks), - ) + return v1 class APIContext: - def __init__(self): + def __init__(self) -> None: self._backend = build_backend("v1", strict=False) - def set_version(self, version: str, strict: bool = False): - self._backend = build_backend(version, strict) + def set_version(self, version: str, *, strict: bool = False) -> None: + self._backend = build_backend(version=version, strict=strict) @property - def backend(self): + def backend(self) -> APIBackend: return self._backend diff --git a/openml/_api/runtime/fallback.py b/openml/_api/runtime/fallback.py index 56e96a966..1bc99d270 100644 --- a/openml/_api/runtime/fallback.py +++ b/openml/_api/runtime/fallback.py @@ -1,5 +1,12 @@ from __future__ import annotations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from openml._api.resources.base import ResourceAPI + class FallbackProxy: - pass + def __init__(self, primary: ResourceAPI, fallback: ResourceAPI): + self._primary = primary + self._fallback = fallback diff --git a/openml/tasks/functions.py b/openml/tasks/functions.py index ef67f75bf..a794ad56d 100644 --- a/openml/tasks/functions.py +++ b/openml/tasks/functions.py @@ -445,10 +445,14 @@ def _get_task_description(task_id: int) -> OpenMLTask: except OpenMLCacheException: _cache_dir = openml.utils._create_cache_directory_for_id(TASKS_CACHE_DIR_NAME, task_id) xml_file = _cache_dir / "task.xml" - task, response = api_context.backend.tasks.get(task_id, return_response=True) - - with xml_file.open("w", encoding="utf8") as fh: - fh.write(response.text) + result = api_context.backend.tasks.get(task_id, return_response=True) + + if isinstance(result, tuple): + task, response = result + with xml_file.open("w", encoding="utf8") as fh: + fh.write(response.text) + else: + task = result return task From 5dfcbce55a027d19cd502ea7bb3d521c2b1bca29 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 7 Jan 2026 22:14:31 +0500 Subject: [PATCH 03/24] refactor --- openml/_api/config.py | 62 +++++++++++++++++++++++++++++++++++-- openml/_api/http/client.py | 18 +++++++---- openml/_api/runtime/core.py | 9 ++---- 3 files changed, 74 insertions(+), 15 deletions(-) diff --git a/openml/_api/config.py b/openml/_api/config.py index bd93c3cad..1431f66b1 100644 --- a/openml/_api/config.py +++ b/openml/_api/config.py @@ -1,5 +1,61 @@ from __future__ import annotations -API_V1_SERVER = "https://www.openml.org/api/v1/xml" -API_V2_SERVER = "http://127.0.0.1:8001" -API_KEY = "..." +from dataclasses import dataclass +from typing import Literal + +DelayMethod = Literal["human", "robot"] + + +@dataclass +class APIConfig: + server: str + base_url: str + key: str + + +@dataclass +class APISettings: + v1: APIConfig + v2: APIConfig + + +@dataclass +class ConnectionConfig: + retries: int = 3 + delay_method: DelayMethod = "human" + delay_time: int = 1 # seconds + + def __post_init__(self) -> None: + if self.delay_method not in ("human", "robot"): + raise ValueError(f"delay_method must be 'human' or 'robot', got {self.delay_method}") + + +@dataclass +class CacheConfig: + dir: str = "~/.openml/cache" + ttl: int = 60 * 60 * 24 * 7 # one week + + +@dataclass +class Settings: + api: APISettings + connection: ConnectionConfig + cache: CacheConfig + + +settings = Settings( + api=APISettings( + v1=APIConfig( + server="https://www.openml.org/", + base_url="api/v1/xml/", + key="...", + ), + v2=APIConfig( + server="http://127.0.0.1:8001/", + base_url="", + key="...", + ), + ), + connection=ConnectionConfig(), + cache=CacheConfig(), +) diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py index dea5de809..74e08c709 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/http/client.py @@ -1,24 +1,30 @@ from __future__ import annotations -from typing import Any, Mapping +from typing import TYPE_CHECKING, Any, Mapping import requests from requests import Response from openml.__version__ import __version__ +if TYPE_CHECKING: + from openml._api.config import APIConfig + class HTTPClient: - def __init__(self, base_url: str) -> None: - self.base_url = base_url + def __init__(self, config: APIConfig) -> None: + self.config = config self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} + def _create_url(self, path: str) -> str: + return self.config.server + self.config.base_url + path + def get( self, path: str, params: Mapping[str, Any] | None = None, ) -> Response: - url = f"{self.base_url}/{path}" + url = self._create_url(path) return requests.get(url, params=params, headers=self.headers, timeout=10) def post( @@ -27,7 +33,7 @@ def post( data: Mapping[str, Any] | None = None, files: Any = None, ) -> Response: - url = f"{self.base_url}/{path}" + url = self._create_url(path) return requests.post(url, data=data, files=files, headers=self.headers, timeout=10) def delete( @@ -35,5 +41,5 @@ def delete( path: str, params: Mapping[str, Any] | None = None, ) -> Response: - url = f"{self.base_url}/{path}" + url = self._create_url(path) return requests.delete(url, params=params, headers=self.headers, timeout=10) diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index aa09a69db..98b587411 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -2,10 +2,7 @@ from typing import TYPE_CHECKING -from openml._api.config import ( - API_V1_SERVER, - API_V2_SERVER, -) +from openml._api.config import settings from openml._api.http.client import HTTPClient from openml._api.resources import ( DatasetsV1, @@ -25,8 +22,8 @@ def __init__(self, *, datasets: DatasetsAPI, tasks: TasksAPI): def build_backend(version: str, *, strict: bool) -> APIBackend: - v1_http = HTTPClient(API_V1_SERVER) - v2_http = HTTPClient(API_V2_SERVER) + v1_http = HTTPClient(config=settings.api.v1) + v2_http = HTTPClient(config=settings.api.v2) v1 = APIBackend( datasets=DatasetsV1(v1_http), From 2acbe9992cf95bfc103ff4fa0c360a58c1842870 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 7 Jan 2026 22:24:03 +0500 Subject: [PATCH 04/24] implement cache_dir --- openml/_api/http/client.py | 74 +++++++++++++++++++++++++++++++++----- 1 file changed, 66 insertions(+), 8 deletions(-) diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py index 74e08c709..49b05c88e 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/http/client.py @@ -1,36 +1,93 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Mapping +from pathlib import Path +from typing import TYPE_CHECKING, Any +from urllib.parse import urlencode, urljoin, urlparse import requests from requests import Response from openml.__version__ import __version__ +from openml._api.config import settings if TYPE_CHECKING: from openml._api.config import APIConfig -class HTTPClient: +class CacheMixin: + @property + def dir(self) -> str: + return settings.cache.dir + + @property + def ttl(self) -> int: + return settings.cache.ttl + + def _get_cache_directory(self, url: str, params: dict[str, Any]) -> Path: + parsed_url = urlparse(url) + netloc_parts = parsed_url.netloc.split(".")[::-1] # reverse domain + path_parts = parsed_url.path.strip("/").split("/") + + # remove api_key and serialize params if any + filtered_params = {k: v for k, v in params.items() if k != "api_key"} + params_part = [urlencode(filtered_params)] if filtered_params else [] + + return Path(self.dir).joinpath(*netloc_parts, *path_parts, *params_part) + + def _get_cache_response(self, url: str, params: dict[str, Any]) -> Response | None: # noqa: ARG002 + return None + + def _set_cache_response(self, url: str, params: dict[str, Any], response: Response) -> None: # noqa: ARG002 + return None + + +class HTTPClient(CacheMixin): def __init__(self, config: APIConfig) -> None: self.config = config self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} - def _create_url(self, path: str) -> str: - return self.config.server + self.config.base_url + path + @property + def server(self) -> str: + return self.config.server + + @property + def base_url(self) -> str: + return self.config.base_url + + def _create_url(self, path: str) -> Any: + return urljoin(self.server, urljoin(self.base_url, path)) def get( self, path: str, - params: Mapping[str, Any] | None = None, + *, + params: dict[str, Any] | None = None, + use_cache: bool = False, + use_api_key: bool = False, ) -> Response: url = self._create_url(path) - return requests.get(url, params=params, headers=self.headers, timeout=10) + params = dict(params) if params is not None else {} + + if use_api_key: + params["api_key"] = self.config.key + + if use_cache: + response = self._get_cache_response(url, params) + if response: + return response + + response = requests.get(url, params=params, headers=self.headers, timeout=10) + + if use_cache: + self._set_cache_response(url, params, response) + + return response def post( self, path: str, - data: Mapping[str, Any] | None = None, + *, + data: dict[str, Any] | None = None, files: Any = None, ) -> Response: url = self._create_url(path) @@ -39,7 +96,8 @@ def post( def delete( self, path: str, - params: Mapping[str, Any] | None = None, + *, + params: dict[str, Any] | None = None, ) -> Response: url = self._create_url(path) return requests.delete(url, params=params, headers=self.headers, timeout=10) From af99880a9e16a49833c63084c9e9267c112b6b91 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 7 Jan 2026 23:42:17 +0500 Subject: [PATCH 05/24] refactor --- openml/_api/config.py | 1 + openml/_api/http/client.py | 100 +++++++++++++++++++++++++++---------- 2 files changed, 75 insertions(+), 26 deletions(-) diff --git a/openml/_api/config.py b/openml/_api/config.py index 1431f66b1..848fe8da1 100644 --- a/openml/_api/config.py +++ b/openml/_api/config.py @@ -11,6 +11,7 @@ class APIConfig: server: str base_url: str key: str + timeout: int = 10 # seconds @dataclass diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py index 49b05c88e..a90e93933 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/http/client.py @@ -23,7 +23,7 @@ def dir(self) -> str: def ttl(self) -> int: return settings.cache.ttl - def _get_cache_directory(self, url: str, params: dict[str, Any]) -> Path: + def _get_cache_dir(self, url: str, params: dict[str, Any]) -> Path: parsed_url = urlparse(url) netloc_parts = parsed_url.netloc.split(".")[::-1] # reverse domain path_parts = parsed_url.path.strip("/").split("/") @@ -34,10 +34,10 @@ def _get_cache_directory(self, url: str, params: dict[str, Any]) -> Path: return Path(self.dir).joinpath(*netloc_parts, *path_parts, *params_part) - def _get_cache_response(self, url: str, params: dict[str, Any]) -> Response | None: # noqa: ARG002 - return None + def _get_cache_response(self, cache_dir: Path) -> Response: # noqa: ARG002 + return Response() - def _set_cache_response(self, url: str, params: dict[str, Any], response: Response) -> None: # noqa: ARG002 + def _set_cache_response(self, cache_dir: Path, response: Response) -> None: # noqa: ARG002 return None @@ -54,50 +54,98 @@ def server(self) -> str: def base_url(self) -> str: return self.config.base_url - def _create_url(self, path: str) -> Any: - return urljoin(self.server, urljoin(self.base_url, path)) + @property + def key(self) -> str: + return self.config.key - def get( + @property + def timeout(self) -> int: + return self.config.timeout + + def request( self, + method: str, path: str, *, - params: dict[str, Any] | None = None, use_cache: bool = False, use_api_key: bool = False, + **request_kwargs: Any, ) -> Response: - url = self._create_url(path) - params = dict(params) if params is not None else {} + url = urljoin(self.server, urljoin(self.base_url, path)) + params = request_kwargs.pop("params", {}) + params = params.copy() if use_api_key: - params["api_key"] = self.config.key + params["api_key"] = self.key - if use_cache: - response = self._get_cache_response(url, params) - if response: - return response + headers = request_kwargs.pop("headers", {}) + headers = headers.copy() + headers.update(self.headers) + + timeout = request_kwargs.pop("timeout", self.timeout) + cache_dir = self._get_cache_dir(url, params) - response = requests.get(url, params=params, headers=self.headers, timeout=10) + if use_cache: + try: + return self._get_cache_response(cache_dir) + # TODO: handle ttl expired error + except Exception: + raise + + response = requests.request( + method=method, + url=url, + params=params, + headers=headers, + timeout=timeout, + **request_kwargs, + ) if use_cache: - self._set_cache_response(url, params, response) + self._set_cache_response(cache_dir, response) return response - def post( + def get( self, path: str, *, - data: dict[str, Any] | None = None, - files: Any = None, + use_cache: bool = False, + use_api_key: bool = False, + **request_kwargs: Any, ) -> Response: - url = self._create_url(path) - return requests.post(url, data=data, files=files, headers=self.headers, timeout=10) + # TODO: remove override when cache is implemented + use_cache = False + return self.request( + method="GET", + path=path, + use_cache=use_cache, + use_api_key=use_api_key, + **request_kwargs, + ) + + def post( + self, + path: str, + **request_kwargs: Any, + ) -> Response: + return self.request( + method="POST", + path=path, + use_cache=False, + use_api_key=True, + **request_kwargs, + ) def delete( self, path: str, - *, - params: dict[str, Any] | None = None, + **request_kwargs: Any, ) -> Response: - url = self._create_url(path) - return requests.delete(url, params=params, headers=self.headers, timeout=10) + return self.request( + method="DELETE", + path=path, + use_cache=False, + use_api_key=True, + **request_kwargs, + ) From 4c75e16890a76d8fbc0ddc125a267d23ddaded44 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Thu, 15 Jan 2026 14:51:22 +0500 Subject: [PATCH 06/24] undo changes in tasks/functions.py --- openml/tasks/functions.py | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/openml/tasks/functions.py b/openml/tasks/functions.py index a794ad56d..e9b879ae4 100644 --- a/openml/tasks/functions.py +++ b/openml/tasks/functions.py @@ -12,7 +12,6 @@ import openml._api_calls import openml.utils -from openml._api import api_context from openml.datasets import get_dataset from openml.exceptions import OpenMLCacheException @@ -445,16 +444,11 @@ def _get_task_description(task_id: int) -> OpenMLTask: except OpenMLCacheException: _cache_dir = openml.utils._create_cache_directory_for_id(TASKS_CACHE_DIR_NAME, task_id) xml_file = _cache_dir / "task.xml" - result = api_context.backend.tasks.get(task_id, return_response=True) + task_xml = openml._api_calls._perform_api_call("task/%d" % task_id, "get") - if isinstance(result, tuple): - task, response = result - with xml_file.open("w", encoding="utf8") as fh: - fh.write(response.text) - else: - task = result - - return task + with xml_file.open("w", encoding="utf8") as fh: + fh.write(task_xml) + return _create_task_from_xml(task_xml) def _create_task_from_xml(xml: str) -> OpenMLTask: From c6033832e8008d0d8f94fa196d519e35f24030c3 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 21 Jan 2026 10:47:26 +0500 Subject: [PATCH 07/24] add tests directory --- tests/test_api/__init__.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 tests/test_api/__init__.py diff --git a/tests/test_api/__init__.py b/tests/test_api/__init__.py new file mode 100644 index 000000000..e69de29bb From ff6a8b05314e74bba7ad64388304a3708f83dbf0 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 21 Jan 2026 11:40:23 +0500 Subject: [PATCH 08/24] use enum for delay method --- openml/_api/config.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/openml/_api/config.py b/openml/_api/config.py index 848fe8da1..13063df7a 100644 --- a/openml/_api/config.py +++ b/openml/_api/config.py @@ -1,9 +1,12 @@ from __future__ import annotations from dataclasses import dataclass -from typing import Literal +from enum import Enum -DelayMethod = Literal["human", "robot"] + +class DelayMethod(str, Enum): + HUMAN = "human" + ROBOT = "robot" @dataclass @@ -23,13 +26,9 @@ class APISettings: @dataclass class ConnectionConfig: retries: int = 3 - delay_method: DelayMethod = "human" + delay_method: DelayMethod = DelayMethod.HUMAN delay_time: int = 1 # seconds - def __post_init__(self) -> None: - if self.delay_method not in ("human", "robot"): - raise ValueError(f"delay_method must be 'human' or 'robot', got {self.delay_method}") - @dataclass class CacheConfig: From f01898fe88b397b0c981398650664e3ecb3f9b08 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 21 Jan 2026 11:41:33 +0500 Subject: [PATCH 09/24] implement cache --- openml/_api/http/client.py | 76 ++++++++++++++++++++++++++++++++++---- 1 file changed, 69 insertions(+), 7 deletions(-) diff --git a/openml/_api/http/client.py b/openml/_api/http/client.py index a90e93933..f76efe5a1 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/http/client.py @@ -1,5 +1,7 @@ from __future__ import annotations +import json +import time from pathlib import Path from typing import TYPE_CHECKING, Any from urllib.parse import urlencode, urljoin, urlparse @@ -34,11 +36,70 @@ def _get_cache_dir(self, url: str, params: dict[str, Any]) -> Path: return Path(self.dir).joinpath(*netloc_parts, *path_parts, *params_part) - def _get_cache_response(self, cache_dir: Path) -> Response: # noqa: ARG002 - return Response() + def _get_cache_response(self, cache_dir: Path) -> Response: + if not cache_dir.exists(): + raise FileNotFoundError(f"Cache directory not found: {cache_dir}") - def _set_cache_response(self, cache_dir: Path, response: Response) -> None: # noqa: ARG002 - return None + meta_path = cache_dir / "meta.json" + headers_path = cache_dir / "headers.json" + body_path = cache_dir / "body.bin" + + if not (meta_path.exists() and headers_path.exists() and body_path.exists()): + raise FileNotFoundError(f"Incomplete cache at {cache_dir}") + + with meta_path.open("r", encoding="utf-8") as f: + meta = json.load(f) + + created_at = meta.get("created_at") + if created_at is None: + raise ValueError("Cache metadata missing 'created_at'") + + if time.time() - created_at > self.ttl: + raise TimeoutError(f"Cache expired for {cache_dir}") + + with headers_path.open("r", encoding="utf-8") as f: + headers = json.load(f) + + 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"] + + return response + + def _set_cache_response(self, cache_dir: Path, response: Response) -> None: + cache_dir.mkdir(parents=True, exist_ok=True) + + # body + (cache_dir / "body.bin").write_bytes(response.content) + + # headers + with (cache_dir / "headers.json").open("w", encoding="utf-8") as f: + json.dump(dict(response.headers), f) + + # meta + meta = { + "status_code": response.status_code, + "url": response.url, + "reason": response.reason, + "encoding": response.encoding, + "elapsed": response.elapsed.total_seconds(), + "created_at": time.time(), + "request": { + "method": response.request.method if response.request else None, + "url": response.request.url if response.request else None, + "headers": dict(response.request.headers) if response.request else None, + "body": response.request.body if response.request else None, + }, + } + + with (cache_dir / "meta.json").open("w", encoding="utf-8") as f: + json.dump(meta, f) class HTTPClient(CacheMixin): @@ -88,7 +149,10 @@ def request( if use_cache: try: return self._get_cache_response(cache_dir) - # TODO: handle ttl expired error + except FileNotFoundError: + pass + except TimeoutError: + pass except Exception: raise @@ -114,8 +178,6 @@ def get( use_api_key: bool = False, **request_kwargs: Any, ) -> Response: - # TODO: remove override when cache is implemented - use_cache = False return self.request( method="GET", path=path, From 5c4511e60b0bc50aba2509bc48bb931082b0caf5 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 21 Jan 2026 13:36:05 +0500 Subject: [PATCH 10/24] refactor clients --- openml/_api/clients/__init__.py | 6 + .../_api/{http/client.py => clients/http.py} | 126 +++++++++--------- .../_api/{http/utils.py => clients/minio.py} | 0 openml/_api/config.py | 6 +- openml/_api/http/__init__.py | 3 - openml/_api/runtime/core.py | 37 ++++- 6 files changed, 101 insertions(+), 77 deletions(-) create mode 100644 openml/_api/clients/__init__.py rename openml/_api/{http/client.py => clients/http.py} (61%) rename openml/_api/{http/utils.py => clients/minio.py} (100%) delete mode 100644 openml/_api/http/__init__.py diff --git a/openml/_api/clients/__init__.py b/openml/_api/clients/__init__.py new file mode 100644 index 000000000..8a5ff94e4 --- /dev/null +++ b/openml/_api/clients/__init__.py @@ -0,0 +1,6 @@ +from .http import HTTPCache, HTTPClient + +__all__ = [ + "HTTPCache", + "HTTPClient", +] diff --git a/openml/_api/http/client.py b/openml/_api/clients/http.py similarity index 61% rename from openml/_api/http/client.py rename to openml/_api/clients/http.py index f76efe5a1..4e126ee92 100644 --- a/openml/_api/http/client.py +++ b/openml/_api/clients/http.py @@ -10,42 +10,41 @@ from requests import Response from openml.__version__ import __version__ -from openml._api.config import settings if TYPE_CHECKING: - from openml._api.config import APIConfig + from openml._api.config import DelayMethod -class CacheMixin: - @property - def dir(self) -> str: - return settings.cache.dir +class HTTPCache: + def __init__(self, *, path: Path, ttl: int) -> None: + self.path = path + self.ttl = ttl - @property - def ttl(self) -> int: - return settings.cache.ttl - - def _get_cache_dir(self, url: str, params: dict[str, Any]) -> Path: + def get_key(self, url: str, params: dict[str, Any]) -> str: parsed_url = urlparse(url) - netloc_parts = parsed_url.netloc.split(".")[::-1] # reverse domain + netloc_parts = parsed_url.netloc.split(".")[::-1] path_parts = parsed_url.path.strip("/").split("/") - # remove api_key and serialize params if any filtered_params = {k: v for k, v in params.items() if k != "api_key"} params_part = [urlencode(filtered_params)] if filtered_params else [] - return Path(self.dir).joinpath(*netloc_parts, *path_parts, *params_part) + return str(Path(*netloc_parts, *path_parts, *params_part)) + + def _key_to_path(self, key: str) -> Path: + return self.path.joinpath(key) + + def load(self, key: str) -> Response: + path = self._key_to_path(key) - def _get_cache_response(self, cache_dir: Path) -> Response: - if not cache_dir.exists(): - raise FileNotFoundError(f"Cache directory not found: {cache_dir}") + if not path.exists(): + raise FileNotFoundError(f"Cache directory not found: {path}") - meta_path = cache_dir / "meta.json" - headers_path = cache_dir / "headers.json" - body_path = cache_dir / "body.bin" + meta_path = path / "meta.json" + headers_path = path / "headers.json" + body_path = path / "body.bin" if not (meta_path.exists() and headers_path.exists() and body_path.exists()): - raise FileNotFoundError(f"Incomplete cache at {cache_dir}") + raise FileNotFoundError(f"Incomplete cache at {path}") with meta_path.open("r", encoding="utf-8") as f: meta = json.load(f) @@ -55,7 +54,7 @@ def _get_cache_response(self, cache_dir: Path) -> Response: raise ValueError("Cache metadata missing 'created_at'") if time.time() - created_at > self.ttl: - raise TimeoutError(f"Cache expired for {cache_dir}") + raise TimeoutError(f"Cache expired for {path}") with headers_path.open("r", encoding="utf-8") as f: headers = json.load(f) @@ -72,17 +71,15 @@ def _get_cache_response(self, cache_dir: Path) -> Response: return response - def _set_cache_response(self, cache_dir: Path, response: Response) -> None: - cache_dir.mkdir(parents=True, exist_ok=True) + def save(self, key: str, response: Response) -> None: + path = self._key_to_path(key) + path.mkdir(parents=True, exist_ok=True) - # body - (cache_dir / "body.bin").write_bytes(response.content) + (path / "body.bin").write_bytes(response.content) - # headers - with (cache_dir / "headers.json").open("w", encoding="utf-8") as f: + with (path / "headers.json").open("w", encoding="utf-8") as f: json.dump(dict(response.headers), f) - # meta meta = { "status_code": response.status_code, "url": response.url, @@ -98,30 +95,33 @@ def _set_cache_response(self, cache_dir: Path, response: Response) -> None: }, } - with (cache_dir / "meta.json").open("w", encoding="utf-8") as f: + with (path / "meta.json").open("w", encoding="utf-8") as f: json.dump(meta, f) -class HTTPClient(CacheMixin): - def __init__(self, config: APIConfig) -> None: - self.config = config - self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} - - @property - def server(self) -> str: - return self.config.server - - @property - def base_url(self) -> str: - return self.config.base_url - - @property - def key(self) -> str: - return self.config.key +class HTTPClient: + def __init__( # noqa: PLR0913 + self, + *, + server: str, + base_url: str, + api_key: str, + timeout: int, + retries: int, + delay_method: DelayMethod, + delay_time: int, + cache: HTTPCache | None = None, + ) -> None: + self.server = server + self.base_url = base_url + self.api_key = api_key + self.timeout = timeout + self.retries = retries + self.delay_method = delay_method + self.delay_time = delay_time + self.cache = cache - @property - def timeout(self) -> int: - return self.config.timeout + self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} def request( self, @@ -134,27 +134,25 @@ def request( ) -> Response: url = urljoin(self.server, urljoin(self.base_url, path)) - params = request_kwargs.pop("params", {}) - params = params.copy() + # prepare params + params = request_kwargs.pop("params", {}).copy() if use_api_key: - params["api_key"] = self.key + params["api_key"] = self.api_key - headers = request_kwargs.pop("headers", {}) - headers = headers.copy() + # prepare headers + headers = request_kwargs.pop("headers", {}).copy() headers.update(self.headers) timeout = request_kwargs.pop("timeout", self.timeout) - cache_dir = self._get_cache_dir(url, params) - if use_cache: + if use_cache and self.cache is not None: + cache_key = self.cache.get_key(url, params) try: - return self._get_cache_response(cache_dir) - except FileNotFoundError: - pass - except TimeoutError: - pass + return self.cache.load(cache_key) + except (FileNotFoundError, TimeoutError): + pass # cache miss or expired, continue except Exception: - raise + raise # propagate unexpected cache errors response = requests.request( method=method, @@ -165,8 +163,8 @@ def request( **request_kwargs, ) - if use_cache: - self._set_cache_response(cache_dir, response) + if use_cache and self.cache is not None: + self.cache.save(cache_key, response) return response diff --git a/openml/_api/http/utils.py b/openml/_api/clients/minio.py similarity index 100% rename from openml/_api/http/utils.py rename to openml/_api/clients/minio.py diff --git a/openml/_api/config.py b/openml/_api/config.py index 13063df7a..aa153a556 100644 --- a/openml/_api/config.py +++ b/openml/_api/config.py @@ -13,7 +13,7 @@ class DelayMethod(str, Enum): class APIConfig: server: str base_url: str - key: str + api_key: str timeout: int = 10 # seconds @@ -48,12 +48,12 @@ class Settings: v1=APIConfig( server="https://www.openml.org/", base_url="api/v1/xml/", - key="...", + api_key="...", ), v2=APIConfig( server="http://127.0.0.1:8001/", base_url="", - key="...", + api_key="...", ), ), connection=ConnectionConfig(), diff --git a/openml/_api/http/__init__.py b/openml/_api/http/__init__.py deleted file mode 100644 index 8e6d1e4ce..000000000 --- a/openml/_api/http/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from openml._api.http.client import HTTPClient - -__all__ = ["HTTPClient"] diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 98b587411..483b74d3d 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -1,9 +1,10 @@ from __future__ import annotations +from pathlib import Path from typing import TYPE_CHECKING +from openml._api.clients import HTTPCache, HTTPClient from openml._api.config import settings -from openml._api.http.client import HTTPClient from openml._api.resources import ( DatasetsV1, DatasetsV2, @@ -22,20 +23,42 @@ def __init__(self, *, datasets: DatasetsAPI, tasks: TasksAPI): def build_backend(version: str, *, strict: bool) -> APIBackend: - v1_http = HTTPClient(config=settings.api.v1) - v2_http = HTTPClient(config=settings.api.v2) + http_cache = HTTPCache( + path=Path(settings.cache.dir), + ttl=settings.cache.ttl, + ) + v1_http_client = HTTPClient( + server=settings.api.v1.server, + base_url=settings.api.v1.base_url, + api_key=settings.api.v1.api_key, + timeout=settings.api.v1.timeout, + retries=settings.connection.retries, + delay_method=settings.connection.delay_method, + delay_time=settings.connection.delay_time, + cache=http_cache, + ) + v2_http_client = HTTPClient( + server=settings.api.v2.server, + base_url=settings.api.v2.base_url, + api_key=settings.api.v2.api_key, + timeout=settings.api.v2.timeout, + retries=settings.connection.retries, + delay_method=settings.connection.delay_method, + delay_time=settings.connection.delay_time, + cache=http_cache, + ) v1 = APIBackend( - datasets=DatasetsV1(v1_http), - tasks=TasksV1(v1_http), + datasets=DatasetsV1(v1_http_client), + tasks=TasksV1(v1_http_client), ) if version == "v1": return v1 v2 = APIBackend( - datasets=DatasetsV2(v2_http), - tasks=TasksV2(v2_http), + datasets=DatasetsV2(v2_http_client), + tasks=TasksV2(v2_http_client), ) if strict: From 43276d2ac56ba39d195b5d54d72bed2e61da3f79 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Fri, 23 Jan 2026 12:17:53 +0500 Subject: [PATCH 11/24] fix import in resources/base.py --- openml/_api/resources/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openml/_api/resources/base.py b/openml/_api/resources/base.py index 6fbf8977d..54b40a0e0 100644 --- a/openml/_api/resources/base.py +++ b/openml/_api/resources/base.py @@ -6,7 +6,7 @@ if TYPE_CHECKING: from requests import Response - from openml._api.http import HTTPClient + from openml._api.clients import HTTPClient from openml.datasets.dataset import OpenMLDataset from openml.tasks.task import OpenMLTask From 1206f697d09df82ed7f18bfea94a476844e01cb4 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Mon, 26 Jan 2026 13:52:20 +0500 Subject: [PATCH 12/24] refactor and add exception handling --- openml/_api/clients/http.py | 241 +++++++++++++++++++++++++++++++++--- openml/_api/config.py | 5 +- openml/_api/runtime/core.py | 6 +- 3 files changed, 229 insertions(+), 23 deletions(-) diff --git a/openml/_api/clients/http.py b/openml/_api/clients/http.py index 4e126ee92..dc184074d 100644 --- a/openml/_api/clients/http.py +++ b/openml/_api/clients/http.py @@ -1,18 +1,28 @@ from __future__ import annotations import json +import logging +import math +import random import time +import xml +from collections.abc import Mapping from pathlib import Path -from typing import TYPE_CHECKING, Any +from typing import Any from urllib.parse import urlencode, urljoin, urlparse import requests +import xmltodict from requests import Response from openml.__version__ import __version__ - -if TYPE_CHECKING: - from openml._api.config import DelayMethod +from openml._api.config import RetryPolicy +from openml.exceptions import ( + OpenMLNotAuthorizedError, + OpenMLServerError, + OpenMLServerException, + OpenMLServerNoResult, +) class HTTPCache: @@ -108,8 +118,7 @@ def __init__( # noqa: PLR0913 api_key: str, timeout: int, retries: int, - delay_method: DelayMethod, - delay_time: int, + retry_policy: RetryPolicy, cache: HTTPCache | None = None, ) -> None: self.server = server @@ -117,12 +126,194 @@ def __init__( # noqa: PLR0913 self.api_key = api_key self.timeout = timeout self.retries = retries - self.delay_method = delay_method - self.delay_time = delay_time + self.retry_policy = retry_policy self.cache = cache + self.retry_func = ( + self._human_delay if retry_policy == RetryPolicy.HUMAN else self._robot_delay + ) self.headers: dict[str, str] = {"user-agent": f"openml-python/{__version__}"} + def _robot_delay(self, n: int) -> float: + wait = (1 / (1 + math.exp(-(n * 0.5 - 4)))) * 60 + variation = random.gauss(0, wait / 10) + return max(1.0, wait + variation) + + def _human_delay(self, n: int) -> float: + return max(1.0, n) + + def _parse_exception_response( + self, + response: Response, + ) -> tuple[int | None, str]: + content_type = response.headers.get("Content-Type", "").lower() + + if "json" in content_type: + server_exception = response.json() + server_error = server_exception["detail"] + code = server_error.get("code") + message = server_error.get("message") + additional_information = server_error.get("additional_information") + else: + server_exception = xmltodict.parse(response.text) + server_error = server_exception["oml:error"] + code = server_error.get("oml:code") + message = server_error.get("oml:message") + additional_information = server_error.get("oml:additional_information") + + if code is not None: + code = int(code) + + if message and additional_information: + full_message = f"{message} - {additional_information}" + elif message: + full_message = message + elif additional_information: + full_message = additional_information + else: + full_message = "" + + return code, full_message + + def _raise_code_specific_error( + self, + code: int, + message: str, + url: str, + files: Mapping[str, Any] | None, + ) -> None: + if code in [111, 372, 512, 500, 482, 542, 674]: + # 512 for runs, 372 for datasets, 500 for flows + # 482 for tasks, 542 for evaluations, 674 for setups + # 111 for dataset descriptions + raise OpenMLServerNoResult(code=code, message=message, url=url) + + # 163: failure to validate flow XML (https://www.openml.org/api_docs#!/flow/post_flow) + if code in [163] and files is not None and "description" in files: + # file_elements['description'] is the XML file description of the flow + message = f"\n{files['description']}\n{message}" + + if code in [ + 102, # flow/exists post + 137, # dataset post + 350, # dataset/42 delete + 310, # flow/ post + 320, # flow/42 delete + 400, # run/42 delete + 460, # task/42 delete + ]: + raise OpenMLNotAuthorizedError( + message=( + f"The API call {url} requires authentication via an API key.\nPlease configure " + "OpenML-Python to use your API as described in this example:" + "\nhttps://openml.github.io/openml-python/latest/examples/Basics/introduction_tutorial/#authentication" + ) + ) + + # Propagate all server errors to the calling functions, except + # for 107 which represents a database connection error. + # These are typically caused by high server load, + # which means trying again might resolve the issue. + # DATABASE_CONNECTION_ERRCODE + if code != 107: + raise OpenMLServerException(code=code, message=message, url=url) + + def _validate_response( + self, + method: str, + url: str, + files: Mapping[str, Any] | None, + response: Response, + ) -> Exception | None: + if ( + "Content-Encoding" not in response.headers + or response.headers["Content-Encoding"] != "gzip" + ): + logging.warning(f"Received uncompressed content from OpenML for {url}.") + + if response.status_code == 200: + return None + + if response.status_code == requests.codes.URI_TOO_LONG: + raise OpenMLServerError(f"URI too long! ({url})") + + retry_raise_e: Exception | None = None + + try: + code, message = self._parse_exception_response(response) + + except (requests.exceptions.JSONDecodeError, xml.parsers.expat.ExpatError) as e: + if method != "GET": + extra = f"Status code: {response.status_code}\n{response.text}" + raise OpenMLServerError( + f"Unexpected server error when calling {url}. Please contact the " + f"developers!\n{extra}" + ) from e + + retry_raise_e = e + + except Exception as e: + # If we failed to parse it out, + # then something has gone wrong in the body we have sent back + # from the server and there is little extra information we can capture. + raise OpenMLServerError( + f"Unexpected server error when calling {url}. Please contact the developers!\n" + f"Status code: {response.status_code}\n{response.text}", + ) from e + + if code is not None: + self._raise_code_specific_error( + code=code, + message=message, + url=url, + files=files, + ) + + if retry_raise_e is None: + retry_raise_e = OpenMLServerException(code=code, message=message, url=url) + + return retry_raise_e + + def _request( # noqa: PLR0913 + self, + method: str, + url: str, + params: Mapping[str, Any], + headers: Mapping[str, str], + timeout: float | int, + files: Mapping[str, Any] | None, + **request_kwargs: Any, + ) -> tuple[Response | None, Exception | None]: + retry_raise_e: Exception | None = None + response: Response | None = None + + try: + response = requests.request( + method=method, + url=url, + params=params, + headers=headers, + timeout=timeout, + files=files, + **request_kwargs, + ) + except ( + requests.exceptions.ChunkedEncodingError, + requests.exceptions.ConnectionError, + requests.exceptions.SSLError, + ) as e: + retry_raise_e = e + + if response is not None: + retry_raise_e = self._validate_response( + method=method, + url=url, + files=files, + response=response, + ) + + return response, retry_raise_e + def request( self, method: str, @@ -133,6 +324,7 @@ def request( **request_kwargs: Any, ) -> Response: url = urljoin(self.server, urljoin(self.base_url, path)) + retries = max(1, self.retries) # prepare params params = request_kwargs.pop("params", {}).copy() @@ -144,6 +336,9 @@ def request( headers.update(self.headers) timeout = request_kwargs.pop("timeout", self.timeout) + files = request_kwargs.pop("files", None) + + use_cache = False if use_cache and self.cache is not None: cache_key = self.cache.get_key(url, params) @@ -154,14 +349,28 @@ def request( except Exception: raise # propagate unexpected cache errors - response = requests.request( - method=method, - url=url, - params=params, - headers=headers, - timeout=timeout, - **request_kwargs, - ) + for retry_counter in range(1, retries + 1): + response, retry_raise_e = self._request( + method=method, + url=url, + params=params, + headers=headers, + timeout=timeout, + files=files, + **request_kwargs, + ) + + # executed successfully + if retry_raise_e is None: + break + # tries completed + if retry_counter >= retries: + raise retry_raise_e + + delay = self.retry_func(retry_counter) + time.sleep(delay) + + assert response is not None if use_cache and self.cache is not None: self.cache.save(cache_key, response) diff --git a/openml/_api/config.py b/openml/_api/config.py index aa153a556..6cce06403 100644 --- a/openml/_api/config.py +++ b/openml/_api/config.py @@ -4,7 +4,7 @@ from enum import Enum -class DelayMethod(str, Enum): +class RetryPolicy(str, Enum): HUMAN = "human" ROBOT = "robot" @@ -26,8 +26,7 @@ class APISettings: @dataclass class ConnectionConfig: retries: int = 3 - delay_method: DelayMethod = DelayMethod.HUMAN - delay_time: int = 1 # seconds + retry_policy: RetryPolicy = RetryPolicy.HUMAN @dataclass diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 483b74d3d..25f2649ee 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -33,8 +33,7 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: api_key=settings.api.v1.api_key, timeout=settings.api.v1.timeout, retries=settings.connection.retries, - delay_method=settings.connection.delay_method, - delay_time=settings.connection.delay_time, + retry_policy=settings.connection.retry_policy, cache=http_cache, ) v2_http_client = HTTPClient( @@ -43,8 +42,7 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: api_key=settings.api.v2.api_key, timeout=settings.api.v2.timeout, retries=settings.connection.retries, - delay_method=settings.connection.delay_method, - delay_time=settings.connection.delay_time, + retry_policy=settings.connection.retry_policy, cache=http_cache, ) From 4948e991f96821372934c7132f4a695da165d17b Mon Sep 17 00:00:00 2001 From: geetu040 Date: Mon, 26 Jan 2026 20:43:32 +0500 Subject: [PATCH 13/24] refactor resources/base/ --- openml/_api/resources/base/__init__.py | 13 ++++++ openml/_api/resources/base/base.py | 41 +++++++++++++++++++ .../resources/{base.py => base/resources.py} | 16 ++++---- openml/_api/resources/base/versions.py | 23 +++++++++++ openml/_api/resources/datasets.py | 6 +-- openml/_api/resources/tasks.py | 6 +-- 6 files changed, 91 insertions(+), 14 deletions(-) create mode 100644 openml/_api/resources/base/__init__.py create mode 100644 openml/_api/resources/base/base.py rename openml/_api/resources/{base.py => base/resources.py} (64%) create mode 100644 openml/_api/resources/base/versions.py diff --git a/openml/_api/resources/base/__init__.py b/openml/_api/resources/base/__init__.py new file mode 100644 index 000000000..851cfe942 --- /dev/null +++ b/openml/_api/resources/base/__init__.py @@ -0,0 +1,13 @@ +from openml._api.resources.base.base import APIVersion, ResourceAPI, ResourceType +from openml._api.resources.base.resources import DatasetsAPI, TasksAPI +from openml._api.resources.base.versions import ResourceV1, ResourceV2 + +__all__ = [ + "APIVersion", + "DatasetsAPI", + "ResourceAPI", + "ResourceType", + "ResourceV1", + "ResourceV2", + "TasksAPI", +] diff --git a/openml/_api/resources/base/base.py b/openml/_api/resources/base/base.py new file mode 100644 index 000000000..8d85d054b --- /dev/null +++ b/openml/_api/resources/base/base.py @@ -0,0 +1,41 @@ +from __future__ import annotations + +from abc import ABC, abstractmethod +from enum import Enum +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from openml._api.clients import HTTPClient + + +class APIVersion(str, Enum): + V1 = "v1" + V2 = "v2" + + +class ResourceType(str, Enum): + DATASETS = "datasets" + TASKS = "tasks" + + +class ResourceAPI(ABC): + api_version: APIVersion | None = None + resource_type: ResourceType | None = None + + def __init__(self, http: HTTPClient): + self._http = http + + def _raise_not_implemented_error(self, method_name: str | None = None) -> None: + version = getattr(self.api_version, "name", "Unknown version") + resource = getattr(self.resource_type, "name", "Unknown resource") + method_info = f" Method: {method_name}" if method_name else "" + raise NotImplementedError( + f"{self.__class__.__name__}: {version} API does not support this " + f"functionality for resource: {resource}.{method_info}" + ) + + @abstractmethod + def delete(self) -> None: ... + + @abstractmethod + def publish(self) -> None: ... diff --git a/openml/_api/resources/base.py b/openml/_api/resources/base/resources.py similarity index 64% rename from openml/_api/resources/base.py rename to openml/_api/resources/base/resources.py index 54b40a0e0..edb26c91c 100644 --- a/openml/_api/resources/base.py +++ b/openml/_api/resources/base/resources.py @@ -1,27 +1,27 @@ from __future__ import annotations -from abc import ABC, abstractmethod +from abc import abstractmethod from typing import TYPE_CHECKING +from openml._api.resources.base import ResourceAPI, ResourceType + if TYPE_CHECKING: from requests import Response - from openml._api.clients import HTTPClient from openml.datasets.dataset import OpenMLDataset from openml.tasks.task import OpenMLTask -class ResourceAPI: - def __init__(self, http: HTTPClient): - self._http = http - +class DatasetsAPI(ResourceAPI): + resource_type: ResourceType | None = ResourceType.DATASETS -class DatasetsAPI(ResourceAPI, ABC): @abstractmethod def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: ... -class TasksAPI(ResourceAPI, ABC): +class TasksAPI(ResourceAPI): + resource_type: ResourceType | None = ResourceType.TASKS + @abstractmethod def get( self, diff --git a/openml/_api/resources/base/versions.py b/openml/_api/resources/base/versions.py new file mode 100644 index 000000000..8a81517e5 --- /dev/null +++ b/openml/_api/resources/base/versions.py @@ -0,0 +1,23 @@ +from __future__ import annotations + +from openml._api.resources.base import APIVersion, ResourceAPI + + +class ResourceV1(ResourceAPI): + api_version: APIVersion | None = APIVersion.V1 + + def delete(self) -> None: + pass + + def publish(self) -> None: + pass + + +class ResourceV2(ResourceAPI): + api_version: APIVersion | None = APIVersion.V2 + + def delete(self) -> None: + self._raise_not_implemented_error("delete") + + def publish(self) -> None: + self._raise_not_implemented_error("publish") diff --git a/openml/_api/resources/datasets.py b/openml/_api/resources/datasets.py index 9ff1ec278..f3a49a84f 100644 --- a/openml/_api/resources/datasets.py +++ b/openml/_api/resources/datasets.py @@ -2,7 +2,7 @@ from typing import TYPE_CHECKING -from openml._api.resources.base import DatasetsAPI +from openml._api.resources.base import DatasetsAPI, ResourceV1, ResourceV2 if TYPE_CHECKING: from responses import Response @@ -10,11 +10,11 @@ from openml.datasets.dataset import OpenMLDataset -class DatasetsV1(DatasetsAPI): +class DatasetsV1(ResourceV1, DatasetsAPI): def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: raise NotImplementedError -class DatasetsV2(DatasetsAPI): +class DatasetsV2(ResourceV2, DatasetsAPI): def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: raise NotImplementedError diff --git a/openml/_api/resources/tasks.py b/openml/_api/resources/tasks.py index f494fb9a3..a7ca39208 100644 --- a/openml/_api/resources/tasks.py +++ b/openml/_api/resources/tasks.py @@ -4,7 +4,7 @@ import xmltodict -from openml._api.resources.base import TasksAPI +from openml._api.resources.base import ResourceV1, ResourceV2, TasksAPI from openml.tasks.task import ( OpenMLClassificationTask, OpenMLClusteringTask, @@ -18,7 +18,7 @@ from requests import Response -class TasksV1(TasksAPI): +class TasksV1(ResourceV1, TasksAPI): def get( self, task_id: int, @@ -118,7 +118,7 @@ def _create_task_from_xml(self, xml: str) -> OpenMLTask: return cls(**common_kwargs) # type: ignore -class TasksV2(TasksAPI): +class TasksV2(ResourceV2, TasksAPI): def get( self, task_id: int, From a3541675fd6452e68f268127df7c583bb9c2d0ca Mon Sep 17 00:00:00 2001 From: geetu040 Date: Mon, 26 Jan 2026 21:06:20 +0500 Subject: [PATCH 14/24] implement delete --- openml/_api/resources/base/base.py | 23 +++++--- openml/_api/resources/base/resources.py | 4 +- openml/_api/resources/base/versions.py | 76 ++++++++++++++++++++++--- 3 files changed, 86 insertions(+), 17 deletions(-) diff --git a/openml/_api/resources/base/base.py b/openml/_api/resources/base/base.py index 8d85d054b..9b1803508 100644 --- a/openml/_api/resources/base/base.py +++ b/openml/_api/resources/base/base.py @@ -14,28 +14,37 @@ class APIVersion(str, Enum): class ResourceType(str, Enum): - DATASETS = "datasets" - TASKS = "tasks" + DATASET = "dataset" + TASK = "task" + TASK_TYPE = "task_type" + EVALUATION_MEASURE = "evaluation_measure" + ESTIMATION_PROCEDURE = "estimation_procedure" + EVALUATION = "evaluation" + FLOW = "flow" + STUDY = "study" + RUN = "run" + SETUP = "setup" + USER = "user" class ResourceAPI(ABC): - api_version: APIVersion | None = None - resource_type: ResourceType | None = None + api_version: APIVersion + resource_type: ResourceType def __init__(self, http: HTTPClient): self._http = http - def _raise_not_implemented_error(self, method_name: str | None = None) -> None: + def _get_not_implemented_message(self, method_name: str | None = None) -> str: version = getattr(self.api_version, "name", "Unknown version") resource = getattr(self.resource_type, "name", "Unknown resource") method_info = f" Method: {method_name}" if method_name else "" - raise NotImplementedError( + return ( f"{self.__class__.__name__}: {version} API does not support this " f"functionality for resource: {resource}.{method_info}" ) @abstractmethod - def delete(self) -> None: ... + def delete(self, resource_id: int) -> bool: ... @abstractmethod def publish(self) -> None: ... diff --git a/openml/_api/resources/base/resources.py b/openml/_api/resources/base/resources.py index edb26c91c..55cb95c0d 100644 --- a/openml/_api/resources/base/resources.py +++ b/openml/_api/resources/base/resources.py @@ -13,14 +13,14 @@ class DatasetsAPI(ResourceAPI): - resource_type: ResourceType | None = ResourceType.DATASETS + resource_type: ResourceType = ResourceType.DATASET @abstractmethod def get(self, dataset_id: int) -> OpenMLDataset | tuple[OpenMLDataset, Response]: ... class TasksAPI(ResourceAPI): - resource_type: ResourceType | None = ResourceType.TASKS + resource_type: ResourceType = ResourceType.TASK @abstractmethod def get( diff --git a/openml/_api/resources/base/versions.py b/openml/_api/resources/base/versions.py index 8a81517e5..ce7b02057 100644 --- a/openml/_api/resources/base/versions.py +++ b/openml/_api/resources/base/versions.py @@ -1,23 +1,83 @@ from __future__ import annotations -from openml._api.resources.base import APIVersion, ResourceAPI +import xmltodict + +from openml._api.resources.base import APIVersion, ResourceAPI, ResourceType +from openml.exceptions import ( + OpenMLNotAuthorizedError, + OpenMLServerError, + OpenMLServerException, +) class ResourceV1(ResourceAPI): - api_version: APIVersion | None = APIVersion.V1 + api_version: APIVersion = APIVersion.V1 - def delete(self) -> None: - pass + def delete(self, resource_id: int) -> bool: + if self.resource_type == ResourceType.DATASET: + resource_type = "data" + else: + resource_type = self.resource_type.name + + legal_resources = { + "data", + "flow", + "task", + "run", + "study", + "user", + } + if resource_type not in legal_resources: + raise ValueError(f"Can't delete a {resource_type}") + + url_suffix = f"{resource_type}/{resource_id}" + try: + response = self._http.delete(url_suffix) + result = xmltodict.parse(response.content) + return f"oml:{resource_type}_delete" in result + except OpenMLServerException as e: + # https://github.com/openml/OpenML/blob/21f6188d08ac24fcd2df06ab94cf421c946971b0/openml_OS/views/pages/api_new/v1/xml/pre.php + # Most exceptions are descriptive enough to be raised as their standard + # OpenMLServerException, however there are two cases where we add information: + # - a generic "failed" message, we direct them to the right issue board + # - when the user successfully authenticates with the server, + # but user is not allowed to take the requested action, + # in which case we specify a OpenMLNotAuthorizedError. + by_other_user = [323, 353, 393, 453, 594] + has_dependent_entities = [324, 326, 327, 328, 354, 454, 464, 595] + unknown_reason = [325, 355, 394, 455, 593] + if e.code in by_other_user: + raise OpenMLNotAuthorizedError( + message=( + f"The {resource_type} can not be deleted " + "because it was not uploaded by you." + ), + ) from e + if e.code in has_dependent_entities: + raise OpenMLNotAuthorizedError( + message=( + f"The {resource_type} can not be deleted because " + f"it still has associated entities: {e.message}" + ), + ) from e + if e.code in unknown_reason: + raise OpenMLServerError( + message=( + f"The {resource_type} can not be deleted for unknown reason," + " please open an issue at: https://github.com/openml/openml/issues/new" + ), + ) from e + raise e def publish(self) -> None: pass class ResourceV2(ResourceAPI): - api_version: APIVersion | None = APIVersion.V2 + api_version: APIVersion = APIVersion.V2 - def delete(self) -> None: - self._raise_not_implemented_error("delete") + def delete(self, resource_id: int) -> bool: + raise NotImplementedError(self._get_not_implemented_message("publish")) def publish(self) -> None: - self._raise_not_implemented_error("publish") + raise NotImplementedError(self._get_not_implemented_message("publish")) From 1fe7e3ed8561945c20e8433603046a35484c37e7 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Tue, 27 Jan 2026 12:56:35 +0500 Subject: [PATCH 15/24] implement publish and minor refactoring --- openml/_api/clients/http.py | 2 - openml/_api/resources/base/base.py | 15 ++-- openml/_api/resources/base/versions.py | 113 ++++++++++++++++--------- 3 files changed, 82 insertions(+), 48 deletions(-) diff --git a/openml/_api/clients/http.py b/openml/_api/clients/http.py index dc184074d..1622087c9 100644 --- a/openml/_api/clients/http.py +++ b/openml/_api/clients/http.py @@ -338,8 +338,6 @@ def request( timeout = request_kwargs.pop("timeout", self.timeout) files = request_kwargs.pop("files", None) - use_cache = False - if use_cache and self.cache is not None: cache_key = self.cache.get_key(url, params) try: diff --git a/openml/_api/resources/base/base.py b/openml/_api/resources/base/base.py index 9b1803508..f2d7d1e88 100644 --- a/openml/_api/resources/base/base.py +++ b/openml/_api/resources/base/base.py @@ -5,6 +5,9 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: + from collections.abc import Mapping + from typing import Any + from openml._api.clients import HTTPClient @@ -34,6 +37,12 @@ class ResourceAPI(ABC): def __init__(self, http: HTTPClient): self._http = http + @abstractmethod + def delete(self, resource_id: int) -> bool: ... + + @abstractmethod + def publish(self, path: str, files: Mapping[str, Any] | None) -> int: ... + def _get_not_implemented_message(self, method_name: str | None = None) -> str: version = getattr(self.api_version, "name", "Unknown version") resource = getattr(self.resource_type, "name", "Unknown resource") @@ -42,9 +51,3 @@ def _get_not_implemented_message(self, method_name: str | None = None) -> str: f"{self.__class__.__name__}: {version} API does not support this " f"functionality for resource: {resource}.{method_info}" ) - - @abstractmethod - def delete(self, resource_id: int) -> bool: ... - - @abstractmethod - def publish(self) -> None: ... diff --git a/openml/_api/resources/base/versions.py b/openml/_api/resources/base/versions.py index ce7b02057..41f883ebe 100644 --- a/openml/_api/resources/base/versions.py +++ b/openml/_api/resources/base/versions.py @@ -1,5 +1,8 @@ from __future__ import annotations +from collections.abc import Mapping +from typing import Any + import xmltodict from openml._api.resources.base import APIVersion, ResourceAPI, ResourceType @@ -13,6 +16,11 @@ class ResourceV1(ResourceAPI): api_version: APIVersion = APIVersion.V1 + def publish(self, path: str, files: Mapping[str, Any] | None) -> int: + response = self._http.post(path, files=files) + parsed_response = xmltodict.parse(response.content) + return self._extract_id_from_upload(parsed_response) + def delete(self, resource_id: int) -> bool: if self.resource_type == ResourceType.DATASET: resource_type = "data" @@ -30,54 +38,79 @@ def delete(self, resource_id: int) -> bool: if resource_type not in legal_resources: raise ValueError(f"Can't delete a {resource_type}") - url_suffix = f"{resource_type}/{resource_id}" + path = f"{resource_type}/{resource_id}" try: - response = self._http.delete(url_suffix) + response = self._http.delete(path) result = xmltodict.parse(response.content) return f"oml:{resource_type}_delete" in result except OpenMLServerException as e: - # https://github.com/openml/OpenML/blob/21f6188d08ac24fcd2df06ab94cf421c946971b0/openml_OS/views/pages/api_new/v1/xml/pre.php - # Most exceptions are descriptive enough to be raised as their standard - # OpenMLServerException, however there are two cases where we add information: - # - a generic "failed" message, we direct them to the right issue board - # - when the user successfully authenticates with the server, - # but user is not allowed to take the requested action, - # in which case we specify a OpenMLNotAuthorizedError. - by_other_user = [323, 353, 393, 453, 594] - has_dependent_entities = [324, 326, 327, 328, 354, 454, 464, 595] - unknown_reason = [325, 355, 394, 455, 593] - if e.code in by_other_user: - raise OpenMLNotAuthorizedError( - message=( - f"The {resource_type} can not be deleted " - "because it was not uploaded by you." - ), - ) from e - if e.code in has_dependent_entities: - raise OpenMLNotAuthorizedError( - message=( - f"The {resource_type} can not be deleted because " - f"it still has associated entities: {e.message}" - ), - ) from e - if e.code in unknown_reason: - raise OpenMLServerError( - message=( - f"The {resource_type} can not be deleted for unknown reason," - " please open an issue at: https://github.com/openml/openml/issues/new" - ), - ) from e - raise e - - def publish(self) -> None: - pass + self._handle_delete_exception(resource_type, e) + raise + + def _handle_delete_exception( + self, resource_type: str, exception: OpenMLServerException + ) -> None: + # https://github.com/openml/OpenML/blob/21f6188d08ac24fcd2df06ab94cf421c946971b0/openml_OS/views/pages/api_new/v1/xml/pre.php + # Most exceptions are descriptive enough to be raised as their standard + # OpenMLServerException, however there are two cases where we add information: + # - a generic "failed" message, we direct them to the right issue board + # - when the user successfully authenticates with the server, + # but user is not allowed to take the requested action, + # in which case we specify a OpenMLNotAuthorizedError. + by_other_user = [323, 353, 393, 453, 594] + has_dependent_entities = [324, 326, 327, 328, 354, 454, 464, 595] + unknown_reason = [325, 355, 394, 455, 593] + if exception.code in by_other_user: + raise OpenMLNotAuthorizedError( + message=( + f"The {resource_type} can not be deleted because it was not uploaded by you." + ), + ) from exception + if exception.code in has_dependent_entities: + raise OpenMLNotAuthorizedError( + message=( + f"The {resource_type} can not be deleted because " + f"it still has associated entities: {exception.message}" + ), + ) from exception + if exception.code in unknown_reason: + raise OpenMLServerError( + message=( + f"The {resource_type} can not be deleted for unknown reason," + " please open an issue at: https://github.com/openml/openml/issues/new" + ), + ) from exception + raise exception + + def _extract_id_from_upload(self, parsed: Mapping[str, Any]) -> int: + # reads id from + # sample parsed dict: {"oml:openml": {"oml:upload_flow": {"oml:id": "42"}}} + + # xmltodict always gives exactly one root key + ((_, root_value),) = parsed.items() + + if not isinstance(root_value, Mapping): + raise ValueError("Unexpected XML structure") + + # upload node (e.g. oml:upload_task, oml:study_upload, ...) + ((_, upload_value),) = root_value.items() + + if not isinstance(upload_value, Mapping): + raise ValueError("Unexpected upload node structure") + + # ID is the only leaf value + for v in upload_value.values(): + if isinstance(v, (str, int)): + return int(v) + + raise ValueError("No ID found in upload response") class ResourceV2(ResourceAPI): api_version: APIVersion = APIVersion.V2 - def delete(self, resource_id: int) -> bool: + def publish(self, path: str, files: Mapping[str, Any] | None) -> int: raise NotImplementedError(self._get_not_implemented_message("publish")) - def publish(self) -> None: - raise NotImplementedError(self._get_not_implemented_message("publish")) + def delete(self, resource_id: int) -> bool: + raise NotImplementedError(self._get_not_implemented_message("delete")) From 54a3151932e3c50bda983f6d6609a4740e38a0c7 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Tue, 27 Jan 2026 14:17:40 +0500 Subject: [PATCH 16/24] implement tag/untag --- openml/_api/clients/http.py | 10 +++- openml/_api/resources/base/base.py | 6 +++ openml/_api/resources/base/versions.py | 63 ++++++++++++++++++++------ openml/_api/resources/tasks.py | 4 +- 4 files changed, 67 insertions(+), 16 deletions(-) diff --git a/openml/_api/clients/http.py b/openml/_api/clients/http.py index 1622087c9..65d7b2248 100644 --- a/openml/_api/clients/http.py +++ b/openml/_api/clients/http.py @@ -279,6 +279,7 @@ def _request( # noqa: PLR0913 method: str, url: str, params: Mapping[str, Any], + data: Mapping[str, Any], headers: Mapping[str, str], timeout: float | int, files: Mapping[str, Any] | None, @@ -292,6 +293,7 @@ def _request( # noqa: PLR0913 method=method, url=url, params=params, + data=data, headers=headers, timeout=timeout, files=files, @@ -326,11 +328,16 @@ def request( url = urljoin(self.server, urljoin(self.base_url, path)) retries = max(1, self.retries) - # prepare params params = request_kwargs.pop("params", {}).copy() + data = request_kwargs.pop("data", {}).copy() + if use_api_key: params["api_key"] = self.api_key + if method.upper() in {"POST", "PUT", "PATCH"}: + data = {**params, **data} + params = {} + # prepare headers headers = request_kwargs.pop("headers", {}).copy() headers.update(self.headers) @@ -352,6 +359,7 @@ def request( method=method, url=url, params=params, + data=data, headers=headers, timeout=timeout, files=files, diff --git a/openml/_api/resources/base/base.py b/openml/_api/resources/base/base.py index f2d7d1e88..63d4c40eb 100644 --- a/openml/_api/resources/base/base.py +++ b/openml/_api/resources/base/base.py @@ -43,6 +43,12 @@ def delete(self, resource_id: int) -> bool: ... @abstractmethod def publish(self, path: str, files: Mapping[str, Any] | None) -> int: ... + @abstractmethod + def tag(self, resource_id: int, tag: str) -> list[str]: ... + + @abstractmethod + def untag(self, resource_id: int, tag: str) -> list[str]: ... + def _get_not_implemented_message(self, method_name: str | None = None) -> str: version = getattr(self.api_version, "name", "Unknown version") resource = getattr(self.resource_type, "name", "Unknown resource") diff --git a/openml/_api/resources/base/versions.py b/openml/_api/resources/base/versions.py index 41f883ebe..91c1a8c06 100644 --- a/openml/_api/resources/base/versions.py +++ b/openml/_api/resources/base/versions.py @@ -22,19 +22,9 @@ def publish(self, path: str, files: Mapping[str, Any] | None) -> int: return self._extract_id_from_upload(parsed_response) def delete(self, resource_id: int) -> bool: - if self.resource_type == ResourceType.DATASET: - resource_type = "data" - else: - resource_type = self.resource_type.name - - legal_resources = { - "data", - "flow", - "task", - "run", - "study", - "user", - } + resource_type = self._get_endpoint_name() + + legal_resources = {"data", "flow", "task", "run", "study", "user"} if resource_type not in legal_resources: raise ValueError(f"Can't delete a {resource_type}") @@ -47,6 +37,47 @@ def delete(self, resource_id: int) -> bool: self._handle_delete_exception(resource_type, e) raise + def tag(self, resource_id: int, tag: str) -> list[str]: + resource_type = self._get_endpoint_name() + + legal_resources = {"data", "task", "flow", "setup", "run"} + if resource_type not in legal_resources: + raise ValueError(f"Can't tag a {resource_type}") + + path = f"{resource_type}/tag" + data = {f"{resource_type}_id": resource_id, "tag": tag} + response = self._http.post(path, data=data) + + main_tag = f"oml:{resource_type}_tag" + parsed_response = xmltodict.parse(response.content, force_list={"oml:tag"}) + result = parsed_response[main_tag] + tags: list[str] = result.get("oml:tag", []) + + return tags + + def untag(self, resource_id: int, tag: str) -> list[str]: + resource_type = self._get_endpoint_name() + + legal_resources = {"data", "task", "flow", "setup", "run"} + if resource_type not in legal_resources: + raise ValueError(f"Can't tag a {resource_type}") + + path = f"{resource_type}/untag" + data = {f"{resource_type}_id": resource_id, "tag": tag} + response = self._http.post(path, data=data) + + main_tag = f"oml:{resource_type}_untag" + parsed_response = xmltodict.parse(response.content, force_list={"oml:tag"}) + result = parsed_response[main_tag] + tags: list[str] = result.get("oml:tag", []) + + return tags + + def _get_endpoint_name(self) -> str: + if self.resource_type == ResourceType.DATASET: + return "data" + return self.resource_type.name + def _handle_delete_exception( self, resource_type: str, exception: OpenMLServerException ) -> None: @@ -114,3 +145,9 @@ def publish(self, path: str, files: Mapping[str, Any] | None) -> int: def delete(self, resource_id: int) -> bool: raise NotImplementedError(self._get_not_implemented_message("delete")) + + def tag(self, resource_id: int, tag: str) -> list[str]: + raise NotImplementedError(self._get_not_implemented_message("untag")) + + def untag(self, resource_id: int, tag: str) -> list[str]: + raise NotImplementedError(self._get_not_implemented_message("untag")) diff --git a/openml/_api/resources/tasks.py b/openml/_api/resources/tasks.py index a7ca39208..295e7a73d 100644 --- a/openml/_api/resources/tasks.py +++ b/openml/_api/resources/tasks.py @@ -26,7 +26,7 @@ def get( return_response: bool = False, ) -> OpenMLTask | tuple[OpenMLTask, Response]: path = f"task/{task_id}" - response = self._http.get(path) + response = self._http.get(path, use_cache=True) xml_content = response.text task = self._create_task_from_xml(xml_content) @@ -125,4 +125,4 @@ def get( *, return_response: bool = False, ) -> OpenMLTask | tuple[OpenMLTask, Response]: - raise NotImplementedError + raise NotImplementedError(self._get_not_implemented_message("get")) From 2b6fe6507b349703060f060f0184169abf5e20de Mon Sep 17 00:00:00 2001 From: geetu040 Date: Tue, 27 Jan 2026 18:31:39 +0500 Subject: [PATCH 17/24] implement fallback --- openml/_api/resources/__init__.py | 3 +- openml/_api/resources/base/__init__.py | 2 + openml/_api/resources/base/fallback.py | 56 ++++++++++++++++++++++++++ openml/_api/runtime/core.py | 8 +++- openml/_api/runtime/fallback.py | 12 ------ 5 files changed, 66 insertions(+), 15 deletions(-) create mode 100644 openml/_api/resources/base/fallback.py delete mode 100644 openml/_api/runtime/fallback.py diff --git a/openml/_api/resources/__init__.py b/openml/_api/resources/__init__.py index b1af3c1a8..6c0807e0f 100644 --- a/openml/_api/resources/__init__.py +++ b/openml/_api/resources/__init__.py @@ -1,4 +1,5 @@ +from openml._api.resources.base.fallback import FallbackProxy from openml._api.resources.datasets import DatasetsV1, DatasetsV2 from openml._api.resources.tasks import TasksV1, TasksV2 -__all__ = ["DatasetsV1", "DatasetsV2", "TasksV1", "TasksV2"] +__all__ = ["DatasetsV1", "DatasetsV2", "FallbackProxy", "TasksV1", "TasksV2"] diff --git a/openml/_api/resources/base/__init__.py b/openml/_api/resources/base/__init__.py index 851cfe942..bddc09b21 100644 --- a/openml/_api/resources/base/__init__.py +++ b/openml/_api/resources/base/__init__.py @@ -1,10 +1,12 @@ from openml._api.resources.base.base import APIVersion, ResourceAPI, ResourceType +from openml._api.resources.base.fallback import FallbackProxy from openml._api.resources.base.resources import DatasetsAPI, TasksAPI from openml._api.resources.base.versions import ResourceV1, ResourceV2 __all__ = [ "APIVersion", "DatasetsAPI", + "FallbackProxy", "ResourceAPI", "ResourceType", "ResourceV1", diff --git a/openml/_api/resources/base/fallback.py b/openml/_api/resources/base/fallback.py new file mode 100644 index 000000000..253ee3865 --- /dev/null +++ b/openml/_api/resources/base/fallback.py @@ -0,0 +1,56 @@ +from __future__ import annotations + +from collections.abc import Callable +from typing import Any + + +class FallbackProxy: + def __init__(self, *api_versions: Any): + if not api_versions: + raise ValueError("At least one API version must be provided") + self._apis = api_versions + + def __getattr__(self, name: str) -> Any: + api, attr = self._find_attr(name) + if callable(attr): + return self._wrap_callable(name, api, attr) + return attr + + def _find_attr(self, name: str) -> tuple[Any, Any]: + for api in self._apis: + attr = getattr(api, name, None) + if attr is not None: + return api, attr + raise AttributeError(f"{self.__class__.__name__} has no attribute {name}") + + def _wrap_callable( + self, + name: str, + primary_api: Any, + primary_attr: Callable[..., Any], + ) -> Callable[..., Any]: + def wrapper(*args: Any, **kwargs: Any) -> Any: + try: + return primary_attr(*args, **kwargs) + except NotImplementedError: + return self._call_fallbacks(name, primary_api, *args, **kwargs) + + return wrapper + + def _call_fallbacks( + self, + name: str, + skip_api: Any, + *args: Any, + **kwargs: Any, + ) -> Any: + for api in self._apis: + if api is skip_api: + continue + attr = getattr(api, name, None) + if callable(attr): + try: + return attr(*args, **kwargs) + except NotImplementedError: + continue + raise NotImplementedError(f"Could not fallback to any API for method: {name}") diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 25f2649ee..4914179f8 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -8,6 +8,7 @@ from openml._api.resources import ( DatasetsV1, DatasetsV2, + FallbackProxy, TasksV1, TasksV2, ) @@ -17,7 +18,7 @@ class APIBackend: - def __init__(self, *, datasets: DatasetsAPI, tasks: TasksAPI): + def __init__(self, *, datasets: DatasetsAPI | FallbackProxy, tasks: TasksAPI | FallbackProxy): self.datasets = datasets self.tasks = tasks @@ -62,7 +63,10 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: if strict: return v2 - return v1 + return APIBackend( + datasets=FallbackProxy(DatasetsV2(v2_http_client), DatasetsV1(v1_http_client)), + tasks=FallbackProxy(TasksV2(v2_http_client), TasksV1(v1_http_client)), + ) class APIContext: diff --git a/openml/_api/runtime/fallback.py b/openml/_api/runtime/fallback.py deleted file mode 100644 index 1bc99d270..000000000 --- a/openml/_api/runtime/fallback.py +++ /dev/null @@ -1,12 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from openml._api.resources.base import ResourceAPI - - -class FallbackProxy: - def __init__(self, primary: ResourceAPI, fallback: ResourceAPI): - self._primary = primary - self._fallback = fallback From fa53f8d3e10dabde3634c05a97d67560459bcaa6 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 28 Jan 2026 13:50:42 +0500 Subject: [PATCH 18/24] add test_http.py --- openml/testing.py | 88 +++++++++++++++++++++++ tests/test_api/test_http.py | 134 ++++++++++++++++++++++++++++++++++++ 2 files changed, 222 insertions(+) create mode 100644 tests/test_api/test_http.py diff --git a/openml/testing.py b/openml/testing.py index 8d3bbbd5b..b0aaac9be 100644 --- a/openml/testing.py +++ b/openml/testing.py @@ -11,10 +11,13 @@ import unittest from pathlib import Path from typing import ClassVar +from urllib.parse import urljoin import requests import openml +from openml._api.clients import HTTPCache, HTTPClient +from openml._api.config import RetryPolicy from openml.exceptions import OpenMLServerException from openml.tasks import TaskType @@ -276,6 +279,91 @@ def _check_fold_timing_evaluations( # noqa: PLR0913 assert evaluation <= max_val +class TestAPIBase(unittest.TestCase): + server: str + base_url: str + api_key: str + timeout: int + retries: int + retry_policy: RetryPolicy + dir: str + ttl: int + cache: HTTPCache + http_client: HTTPClient + + def setUp(self) -> None: + self.server = "https://test.openml.org/" + self.base_url = "api/v1/xml" + self.api_key = "normaluser" + self.timeout = 10 + self.retries = 3 + self.retry_policy = RetryPolicy.HUMAN + self.dir = "test_cache" + self.ttl = 60 * 60 * 24 * 7 + + self.cache = self._get_http_cache( + path=Path(self.dir), + ttl=self.ttl, + ) + self.http_client = self._get_http_client( + server=self.server, + base_url=self.base_url, + api_key=self.api_key, + timeout=self.timeout, + retries=self.retries, + retry_policy=self.retry_policy, + cache=self.cache, + ) + + if self.cache.path.exists(): + shutil.rmtree(self.cache.path) + + def tearDown(self) -> None: + if self.cache.path.exists(): + shutil.rmtree(self.cache.path) + + def _get_http_cache( + self, + path: Path, + ttl: int, + ) -> HTTPCache: + return HTTPCache( + path=path, + ttl=ttl, + ) + + def _get_http_client( # noqa: PLR0913 + self, + server: str, + base_url: str, + api_key: str, + timeout: int, + retries: int, + retry_policy: RetryPolicy, + cache: HTTPCache | None = None, + ) -> HTTPClient: + return HTTPClient( + server=server, + base_url=base_url, + api_key=api_key, + timeout=timeout, + retries=retries, + retry_policy=retry_policy, + cache=cache, + ) + + def _get_url( + self, + server: str | None = None, + base_url: str | None = None, + path: str | None = None, + ) -> str: + server = server if server else self.server + base_url = base_url if base_url else self.base_url + path = path if path else "" + return urljoin(self.server, urljoin(self.base_url, path)) + + def check_task_existence( task_type: TaskType, dataset_id: int, diff --git a/tests/test_api/test_http.py b/tests/test_api/test_http.py new file mode 100644 index 000000000..98b6fda5a --- /dev/null +++ b/tests/test_api/test_http.py @@ -0,0 +1,134 @@ +from requests import Response, Request +import time +import xmltodict +from openml.testing import TestAPIBase + + +class TestHTTPClient(TestAPIBase): + def test_cache(self): + url = self._get_url(path="task/31") + params = {"param1": "value1", "param2": "value2"} + + key = self.cache.get_key(url, params) + + # validate key + self.assertEqual( + key, + "org/openml/test/api/v1/task/31/param1=value1¶m2=value2", + ) + + # create fake response + req = Request("GET", url).prepare() + response = Response() + response.status_code = 200 + response.url = url + response.reason = "OK" + response._content = b"test" + response.headers = {"Content-Type": "text/xml"} + response.encoding = "utf-8" + response.request = req + response.elapsed = type("Elapsed", (), {"total_seconds": lambda self: 0.1})() + + # save to cache + self.cache.save(key, response) + + # load from cache + cached_response = self.cache.load(key) + + # validate loaded response + self.assertEqual(cached_response.status_code, 200) + self.assertEqual(cached_response.url, url) + self.assertEqual(cached_response.content, b"test") + self.assertEqual( + cached_response.headers["Content-Type"], "text/xml" + ) + + def test_get(self): + response = self.http_client.get("task/1") + + self.assertEqual(response.status_code, 200) + self.assertIn(b" new request + self.assertNotEqual(response1_cache_time_stamp, response2_cache_time_stamp) + self.assertEqual(response2.status_code, 200) + self.assertEqual(response1.content, response2.content) + + def test_post_and_delete(self): + task_xml = """ + + 5 + 193 + 17 + + """ + + task_id = None + try: + # POST the task + post_response = self.http_client.post( + "task", + files={"description": task_xml}, + ) + self.assertEqual(post_response.status_code, 200) + xml_resp = xmltodict.parse(post_response.content) + task_id = int(xml_resp["oml:upload_task"]["oml:id"]) + + # GET the task to verify it exists + get_response = self.http_client.get(f"task/{task_id}") + self.assertEqual(get_response.status_code, 200) + + finally: + # DELETE the task if it was created + if task_id is not None: + try: + del_response = self.http_client.delete(f"task/{task_id}") + # optional: verify delete + if del_response.status_code != 200: + print(f"Warning: delete failed for task {task_id}") + except Exception as e: + print(f"Warning: failed to delete task {task_id}: {e}") From 2b2db962fc252a2b2b23f21bd1d055905ed74588 Mon Sep 17 00:00:00 2001 From: geetu040 Date: Wed, 28 Jan 2026 13:52:43 +0500 Subject: [PATCH 19/24] add uses_test_server marker --- tests/test_api/test_http.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/test_api/test_http.py b/tests/test_api/test_http.py index 98b6fda5a..94ce5ee93 100644 --- a/tests/test_api/test_http.py +++ b/tests/test_api/test_http.py @@ -1,6 +1,7 @@ from requests import Response, Request import time import xmltodict +import pytest from openml.testing import TestAPIBase @@ -43,12 +44,14 @@ def test_cache(self): cached_response.headers["Content-Type"], "text/xml" ) + @pytest.mark.uses_test_server() def test_get(self): response = self.http_client.get("task/1") self.assertEqual(response.status_code, 200) self.assertIn(b" From 4a3a638cb18bb6d0bcd2444dd70226fcf24a804d Mon Sep 17 00:00:00 2001 From: Eman Abdelhaleem Date: Tue, 20 Jan 2026 12:59:45 +0200 Subject: [PATCH 20/24] =?UTF-8?q?[ENH]=20V1=20=E2=86=92=20V2=20API=20Migra?= =?UTF-8?q?tion=20-=20setups?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- openml/_api/resources/__init__.py | 3 +- openml/_api/resources/base/resources.py | 24 +++ openml/_api/resources/setups.py | 199 ++++++++++++++++++++++++ openml/_api/runtime/core.py | 13 +- openml/setups/functions.py | 116 +------------- 5 files changed, 238 insertions(+), 117 deletions(-) create mode 100644 openml/_api/resources/setups.py diff --git a/openml/_api/resources/__init__.py b/openml/_api/resources/__init__.py index 6c0807e0f..d6b3d10d7 100644 --- a/openml/_api/resources/__init__.py +++ b/openml/_api/resources/__init__.py @@ -1,5 +1,6 @@ from openml._api.resources.base.fallback import FallbackProxy from openml._api.resources.datasets import DatasetsV1, DatasetsV2 +from openml._api.resources.setups import SetupsV1, SetupsV2 from openml._api.resources.tasks import TasksV1, TasksV2 -__all__ = ["DatasetsV1", "DatasetsV2", "FallbackProxy", "TasksV1", "TasksV2"] +__all__ = ["DatasetsV1", "DatasetsV2", "FallbackProxy", "SetupsV1", "SetupsV2", "TasksV1", "TasksV2"] diff --git a/openml/_api/resources/base/resources.py b/openml/_api/resources/base/resources.py index 55cb95c0d..55b3666dd 100644 --- a/openml/_api/resources/base/resources.py +++ b/openml/_api/resources/base/resources.py @@ -1,6 +1,7 @@ from __future__ import annotations from abc import abstractmethod +from collections.abc import Iterable from typing import TYPE_CHECKING from openml._api.resources.base import ResourceAPI, ResourceType @@ -9,6 +10,7 @@ from requests import Response from openml.datasets.dataset import OpenMLDataset + from openml.setups.setup import OpenMLSetup from openml.tasks.task import OpenMLTask @@ -29,3 +31,25 @@ def get( *, return_response: bool = False, ) -> OpenMLTask | tuple[OpenMLTask, Response]: ... + + +class SetupsAPI(ResourceAPI, ABC): + @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 _create_setup(self, result_dict: dict) -> OpenMLSetup: ... + + @abstractmethod + def get(self, setup_id: int) -> OpenMLSetup: ... + + @abstractmethod + def exists(self) -> int: ... diff --git a/openml/_api/resources/setups.py b/openml/_api/resources/setups.py new file mode 100644 index 000000000..38f3b22de --- /dev/null +++ b/openml/_api/resources/setups.py @@ -0,0 +1,199 @@ +from __future__ import annotations + +from collections.abc import Iterable + +import xmltodict + +from openml._api.resources.base import SetupsAPI +from openml.setups.setup import OpenMLParameter, OpenMLSetup + + +class SetupsV1(SetupsAPI): + """V1 XML API implementation for setups.""" + + def list( + self, + limit: int, + offset: int, + *, + setup: Iterable[int] | None = None, + flow: int | None = None, + tag: str | None = None, + ) -> list[OpenMLSetup]: + """Perform API call `/setup/list/{filters}` + + Parameters + ---------- + The setup argument that is a list is separated from the single value + filters which are put into the kwargs. + + limit : int + offset : int + setup : list(int), optional + flow : int, optional + tag : str, optional + + Returns + ------- + list + setups that match the filters, going from id to the OpenMLSetup object. + """ + api_call = self._build_url(limit, offset, setup=setup, flow=flow, tag=tag) + setup_response = self._http.get(api_call) + xml_content = setup_response.text + + return self._parse_list_xml(xml_content) + + def _build_url( + self, + limit: int, + offset: int, + *, + setup: Iterable[int] | None = None, + flow: int | None = None, + tag: str | None = None, + ) -> str: + """Construct an OpenML Setup API URL with filtering parameters. + + Parameters + ---------- + The setup argument that is a list is separated from the single value + filters which are put into the kwargs. + + limit : int + offset : int + setup : list(int), optional + flow : int, optional + tag : str, optional + + Returns + ------- + str + A relative API path suitable for an OpenML HTTP request. + """ + api_call = "setup/list" + if limit is not None: + api_call += f"/limit/{limit}" + if offset is not None: + api_call += f"/offset/{offset}" + if setup is not None: + api_call += f"/setup/{','.join([str(int(i)) for i in setup])}" + if flow is not None: + api_call += f"/flow/{flow}" + if tag is not None: + api_call += f"/tag/{tag}" + + return api_call + + def _parse_list_xml(self, xml_content: str) -> list[OpenMLSetup]: + """Helper function to parse API calls which are lists of setups""" + setups_dict = xmltodict.parse(xml_content, force_list=("oml:setup",)) + openml_uri = "http://openml.org/openml" + # Minimalistic check if the XML is useful + if "oml:setups" not in setups_dict: + raise ValueError( + f'Error in return XML, does not contain "oml:setups": {setups_dict!s}', + ) + + if "@xmlns:oml" not in setups_dict["oml:setups"]: + raise ValueError( + f'Error in return XML, does not contain "oml:setups"/@xmlns:oml: {setups_dict!s}', + ) + + if setups_dict["oml:setups"]["@xmlns:oml"] != openml_uri: + raise ValueError( + "Error in return XML, value of " + '"oml:seyups"/@xmlns:oml is not ' + f'"{openml_uri}": {setups_dict!s}', + ) + + assert isinstance(setups_dict["oml:setups"]["oml:setup"], list), type( + setups_dict["oml:setups"] + ) + + return [ + self._create_setup({"oml:setup_parameters": setup_}) + for setup_ in setups_dict["oml:setups"]["oml:setup"] + ] + + def _create_setup(self, result_dict: dict) -> OpenMLSetup: + """Turns an API xml result into a OpenMLSetup object (or dict)""" + setup_id = int(result_dict["oml:setup_parameters"]["oml:setup_id"]) + flow_id = int(result_dict["oml:setup_parameters"]["oml:flow_id"]) + + if "oml:parameter" not in result_dict["oml:setup_parameters"]: + return OpenMLSetup(setup_id, flow_id, parameters=None) + + xml_parameters = result_dict["oml:setup_parameters"]["oml:parameter"] + if isinstance(xml_parameters, dict): + parameters = { + int(xml_parameters["oml:id"]): self._create_setup_parameter_from_xml( + xml_parameters + ), + } + elif isinstance(xml_parameters, list): + parameters = { + int(xml_parameter["oml:id"]): self._create_setup_parameter_from_xml(xml_parameter) + for xml_parameter in xml_parameters + } + else: + raise ValueError( + f"Expected None, list or dict, received something else: {type(xml_parameters)!s}", + ) + + return OpenMLSetup(setup_id, flow_id, parameters) + + def _create_setup_parameter_from_xml(self, result_dict: dict[str, str]) -> OpenMLParameter: + """Create an OpenMLParameter object or a dictionary from an API xml result.""" + return OpenMLParameter( + input_id=int(result_dict["oml:id"]), + flow_id=int(result_dict["oml:flow_id"]), + flow_name=result_dict["oml:flow_name"], + full_name=result_dict["oml:full_name"], + parameter_name=result_dict["oml:parameter_name"], + data_type=result_dict["oml:data_type"], + default_value=result_dict["oml:default_value"], + value=result_dict["oml:value"], + ) + + def get(self, setup_id: int) -> OpenMLSetup: + """ + Downloads the setup (configuration) description from OpenML + and returns a structured object + + Parameters + ---------- + setup_id : int + The Openml setup_id + + Returns + ------- + OpenMLSetup (an initialized openml setup object) + """ + + def exists(self) -> int: + pass + + +class SetupsV2(SetupsAPI): + """V2 JSoN API implementation for setups.""" + + def list( + self, + limit: int, + offset: int, + *, + setup: Iterable[int] | None = None, + flow: int | None = None, + tag: str | None = None, + ) -> list[OpenMLSetup]: + raise NotImplementedError("V2 API implementation is not yet available") + + def _create_setup(self, result_dict: dict) -> OpenMLSetup: + raise NotImplementedError("V2 API implementation is not yet available") + + def get(self, setup_id: int) -> OpenMLSetup: + raise NotImplementedError("V2 API implementation is not yet available") + + def exists(self) -> int: + raise NotImplementedError("V2 API implementation is not yet available") diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 4914179f8..1eb1b5bfc 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -9,18 +9,21 @@ DatasetsV1, DatasetsV2, FallbackProxy, + SetupsV1, + SetupsV2, TasksV1, TasksV2, ) if TYPE_CHECKING: - from openml._api.resources.base import DatasetsAPI, TasksAPI + from openml._api.resources.base import DatasetsAPI, SetupsAPI, TasksAPI class APIBackend: - def __init__(self, *, datasets: DatasetsAPI | FallbackProxy, tasks: TasksAPI | FallbackProxy): + def __init__(self, *, datasets: DatasetsAPI | FallbackProxy, tasks: TasksAPI | FallbackProxy, setups: SetupsAPI | FallbackProxy): self.datasets = datasets self.tasks = tasks + self.setups = setups def build_backend(version: str, *, strict: bool) -> APIBackend: @@ -50,15 +53,13 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: v1 = APIBackend( datasets=DatasetsV1(v1_http_client), tasks=TasksV1(v1_http_client), + setups=SetupsV1(v1_http_client), ) if version == "v1": return v1 - v2 = APIBackend( - datasets=DatasetsV2(v2_http_client), - tasks=TasksV2(v2_http_client), - ) + v2 = APIBackend(datasets=DatasetsV2(v2_http_client), tasks=TasksV2(v2_http_client), setups=SetupsV2(v2_http_client)) if strict: return v2 diff --git a/openml/setups/functions.py b/openml/setups/functions.py index 4bf279ed1..b23d01598 100644 --- a/openml/setups/functions.py +++ b/openml/setups/functions.py @@ -6,7 +6,7 @@ from functools import partial from itertools import chain from pathlib import Path -from typing import Any, Literal +from typing import TYPE_CHECKING, Any, Literal import pandas as pd import xmltodict @@ -15,9 +15,11 @@ import openml.exceptions import openml.utils from openml import config +from openml._api import api_context from openml.flows import OpenMLFlow, flow_exists -from .setup import OpenMLParameter, OpenMLSetup +if TYPE_CHECKING: + from .setup import OpenMLSetup def setup_exists(flow: OpenMLFlow) -> int: @@ -161,7 +163,7 @@ def list_setups( # noqa: PLR0913 "Invalid output format selected. Only 'object', or 'dataframe' applicable.", ) - listing_call = partial(_list_setups, flow=flow, tag=tag, setup=setup) + listing_call = partial(api_context.backend.setups.list, flow=flow, tag=tag, setup=setup) batches = openml.utils._list_all( listing_call, batch_size=1_000, # batch size for setups is lower @@ -176,77 +178,6 @@ def list_setups( # noqa: PLR0913 return pd.DataFrame.from_records(records, index="setup_id") -def _list_setups( - limit: int, - offset: int, - *, - setup: Iterable[int] | None = None, - flow: int | None = None, - tag: str | None = None, -) -> list[OpenMLSetup]: - """Perform API call `/setup/list/{filters}` - - Parameters - ---------- - The setup argument that is a list is separated from the single value - filters which are put into the kwargs. - - limit : int - offset : int - setup : list(int), optional - flow : int, optional - tag : str, optional - - Returns - ------- - The setups that match the filters, going from id to the OpenMLSetup object. - """ - api_call = "setup/list" - if limit is not None: - api_call += f"/limit/{limit}" - if offset is not None: - api_call += f"/offset/{offset}" - if setup is not None: - api_call += f"/setup/{','.join([str(int(i)) for i in setup])}" - if flow is not None: - api_call += f"/flow/{flow}" - if tag is not None: - api_call += f"/tag/{tag}" - - return __list_setups(api_call=api_call) - - -def __list_setups(api_call: str) -> list[OpenMLSetup]: - """Helper function to parse API calls which are lists of setups""" - xml_string = openml._api_calls._perform_api_call(api_call, "get") - setups_dict = xmltodict.parse(xml_string, force_list=("oml:setup",)) - openml_uri = "http://openml.org/openml" - # Minimalistic check if the XML is useful - if "oml:setups" not in setups_dict: - raise ValueError( - f'Error in return XML, does not contain "oml:setups": {setups_dict!s}', - ) - - if "@xmlns:oml" not in setups_dict["oml:setups"]: - raise ValueError( - f'Error in return XML, does not contain "oml:setups"/@xmlns:oml: {setups_dict!s}', - ) - - if setups_dict["oml:setups"]["@xmlns:oml"] != openml_uri: - raise ValueError( - "Error in return XML, value of " - '"oml:seyups"/@xmlns:oml is not ' - f'"{openml_uri}": {setups_dict!s}', - ) - - assert isinstance(setups_dict["oml:setups"]["oml:setup"], list), type(setups_dict["oml:setups"]) - - return [ - _create_setup_from_xml({"oml:setup_parameters": setup_}) - for setup_ in setups_dict["oml:setups"]["oml:setup"] - ] - - def initialize_model(setup_id: int, *, strict_version: bool = True) -> Any: """ Initialized a model based on a setup_id (i.e., using the exact @@ -309,39 +240,4 @@ def _to_dict(flow_id: int, openml_parameter_settings: list[dict[str, Any]]) -> O def _create_setup_from_xml(result_dict: dict) -> OpenMLSetup: """Turns an API xml result into a OpenMLSetup object (or dict)""" - setup_id = int(result_dict["oml:setup_parameters"]["oml:setup_id"]) - flow_id = int(result_dict["oml:setup_parameters"]["oml:flow_id"]) - - if "oml:parameter" not in result_dict["oml:setup_parameters"]: - return OpenMLSetup(setup_id, flow_id, parameters=None) - - xml_parameters = result_dict["oml:setup_parameters"]["oml:parameter"] - if isinstance(xml_parameters, dict): - parameters = { - int(xml_parameters["oml:id"]): _create_setup_parameter_from_xml(xml_parameters), - } - elif isinstance(xml_parameters, list): - parameters = { - int(xml_parameter["oml:id"]): _create_setup_parameter_from_xml(xml_parameter) - for xml_parameter in xml_parameters - } - else: - raise ValueError( - f"Expected None, list or dict, received something else: {type(xml_parameters)!s}", - ) - - return OpenMLSetup(setup_id, flow_id, parameters) - - -def _create_setup_parameter_from_xml(result_dict: dict[str, str]) -> OpenMLParameter: - """Create an OpenMLParameter object or a dictionary from an API xml result.""" - return OpenMLParameter( - input_id=int(result_dict["oml:id"]), - flow_id=int(result_dict["oml:flow_id"]), - flow_name=result_dict["oml:flow_name"], - full_name=result_dict["oml:full_name"], - parameter_name=result_dict["oml:parameter_name"], - data_type=result_dict["oml:data_type"], - default_value=result_dict["oml:default_value"], - value=result_dict["oml:value"], - ) + return api_context.backend.setups._create_setup(result_dict) From d07e4a61bae4d044ece5ff16f2e3dd92d57ecb01 Mon Sep 17 00:00:00 2001 From: Eman Abdelhaleem Date: Wed, 21 Jan 2026 13:03:34 +0200 Subject: [PATCH 21/24] get, exists setup migration --- openml/_api/resources/base/resources.py | 6 ++-- openml/_api/resources/setups.py | 42 +++++++++++++++++++++---- openml/setups/functions.py | 21 +++++-------- 3 files changed, 46 insertions(+), 23 deletions(-) diff --git a/openml/_api/resources/base/resources.py b/openml/_api/resources/base/resources.py index 55b3666dd..dd744ac5d 100644 --- a/openml/_api/resources/base/resources.py +++ b/openml/_api/resources/base/resources.py @@ -2,7 +2,7 @@ from abc import abstractmethod from collections.abc import Iterable -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any from openml._api.resources.base import ResourceAPI, ResourceType @@ -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: ... diff --git a/openml/_api/resources/setups.py b/openml/_api/resources/setups.py index 38f3b22de..5c39dfac4 100644 --- a/openml/_api/resources/setups.py +++ b/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") diff --git a/openml/setups/functions.py b/openml/setups/functions.py index b23d01598..dc47ca419 100644 --- a/openml/setups/functions.py +++ b/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) From 42d067a673a2acf2d752440ac8280d4b4465ca43 Mon Sep 17 00:00:00 2001 From: Eman Abdelhaleem Date: Thu, 29 Jan 2026 06:37:19 +0200 Subject: [PATCH 22/24] sync with pr-1576 --- openml/_api/resources/base/__init__.py | 3 ++- openml/_api/resources/base/resources.py | 4 +++- openml/_api/resources/setups.py | 15 ++++++++------- openml/_api/runtime/core.py | 15 +++++++++++++-- 4 files changed, 26 insertions(+), 11 deletions(-) diff --git a/openml/_api/resources/base/__init__.py b/openml/_api/resources/base/__init__.py index bddc09b21..cee1316bf 100644 --- a/openml/_api/resources/base/__init__.py +++ b/openml/_api/resources/base/__init__.py @@ -1,6 +1,6 @@ from openml._api.resources.base.base import APIVersion, ResourceAPI, ResourceType from openml._api.resources.base.fallback import FallbackProxy -from openml._api.resources.base.resources import DatasetsAPI, TasksAPI +from openml._api.resources.base.resources import DatasetsAPI, SetupsAPI, TasksAPI from openml._api.resources.base.versions import ResourceV1, ResourceV2 __all__ = [ @@ -11,5 +11,6 @@ "ResourceType", "ResourceV1", "ResourceV2", + "SetupsAPI", "TasksAPI", ] diff --git a/openml/_api/resources/base/resources.py b/openml/_api/resources/base/resources.py index dd744ac5d..852ef2890 100644 --- a/openml/_api/resources/base/resources.py +++ b/openml/_api/resources/base/resources.py @@ -33,7 +33,9 @@ def get( ) -> OpenMLTask | tuple[OpenMLTask, Response]: ... -class SetupsAPI(ResourceAPI, ABC): +class SetupsAPI(ResourceAPI): + resource_type: ResourceType = ResourceType.SETUP + @abstractmethod def list( self, diff --git a/openml/_api/resources/setups.py b/openml/_api/resources/setups.py index 5c39dfac4..12caf7a23 100644 --- a/openml/_api/resources/setups.py +++ b/openml/_api/resources/setups.py @@ -1,15 +1,16 @@ from __future__ import annotations +import builtins from collections.abc import Iterable from typing import Any import xmltodict -from openml._api.resources.base import SetupsAPI +from openml._api.resources.base import ResourceV1, ResourceV2, SetupsAPI from openml.setups.setup import OpenMLParameter, OpenMLSetup -class SetupsV1(SetupsAPI): +class SetupsV1(ResourceV1, SetupsAPI): """V1 XML API implementation for setups.""" def list( @@ -20,7 +21,7 @@ def list( setup: Iterable[int] | None = None, flow: int | None = None, tag: str | None = None, - ) -> list[OpenMLSetup]: + ) -> builtins.list[OpenMLSetup]: """Perform API call `/setup/list/{filters}` Parameters @@ -86,7 +87,7 @@ def _build_url( return api_call - def _parse_list_xml(self, xml_content: str) -> list[OpenMLSetup]: + def _parse_list_xml(self, xml_content: str) -> builtins.list[OpenMLSetup]: """Helper function to parse API calls which are lists of setups""" setups_dict = xmltodict.parse(xml_content, force_list=("oml:setup",)) openml_uri = "http://openml.org/openml" @@ -132,7 +133,7 @@ def _create_setup(self, result_dict: dict) -> OpenMLSetup: xml_parameters ), } - elif isinstance(xml_parameters, list): + elif isinstance(xml_parameters, builtins.list): parameters = { int(xml_parameter["oml:id"]): self._create_setup_parameter_from_xml(xml_parameter) for xml_parameter in xml_parameters @@ -205,7 +206,7 @@ def exists(self, file_elements: dict[str, Any]) -> int: return setup_id if setup_id > 0 else False -class SetupsV2(SetupsAPI): +class SetupsV2(ResourceV2, SetupsAPI): """V2 JSoN API implementation for setups.""" def list( @@ -216,7 +217,7 @@ def list( setup: Iterable[int] | None = None, flow: int | None = None, tag: str | None = None, - ) -> list[OpenMLSetup]: + ) -> builtins.list[OpenMLSetup]: raise NotImplementedError("V2 API implementation is not yet available") def _create_setup(self, result_dict: dict) -> OpenMLSetup: diff --git a/openml/_api/runtime/core.py b/openml/_api/runtime/core.py index 1eb1b5bfc..5a3a4a04a 100644 --- a/openml/_api/runtime/core.py +++ b/openml/_api/runtime/core.py @@ -20,7 +20,13 @@ class APIBackend: - def __init__(self, *, datasets: DatasetsAPI | FallbackProxy, tasks: TasksAPI | FallbackProxy, setups: SetupsAPI | FallbackProxy): + def __init__( + self, + *, + datasets: DatasetsAPI | FallbackProxy, + tasks: TasksAPI | FallbackProxy, + setups: SetupsAPI | FallbackProxy, + ): self.datasets = datasets self.tasks = tasks self.setups = setups @@ -59,7 +65,11 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: if version == "v1": return v1 - v2 = APIBackend(datasets=DatasetsV2(v2_http_client), tasks=TasksV2(v2_http_client), setups=SetupsV2(v2_http_client)) + v2 = APIBackend( + datasets=DatasetsV2(v2_http_client), + tasks=TasksV2(v2_http_client), + setups=SetupsV2(v2_http_client), + ) if strict: return v2 @@ -67,6 +77,7 @@ def build_backend(version: str, *, strict: bool) -> APIBackend: return APIBackend( datasets=FallbackProxy(DatasetsV2(v2_http_client), DatasetsV1(v1_http_client)), tasks=FallbackProxy(TasksV2(v2_http_client), TasksV1(v1_http_client)), + setups=FallbackProxy(SetupsV2(v2_http_client), SetupsV1(v1_http_client)), ) From 178cd8b814e4e1e937b87efd34f08489fe3ff3f9 Mon Sep 17 00:00:00 2001 From: Eman Abdelhaleem Date: Thu, 29 Jan 2026 12:38:11 +0200 Subject: [PATCH 23/24] added partial tests --- tests/test_api/test_setups.py | 87 +++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 tests/test_api/test_setups.py diff --git a/tests/test_api/test_setups.py b/tests/test_api/test_setups.py new file mode 100644 index 000000000..9177a8205 --- /dev/null +++ b/tests/test_api/test_setups.py @@ -0,0 +1,87 @@ +# License: BSD 3-Clause +from __future__ import annotations + +import pytest +from openml._api.config import settings + +from openml._api.resources.setups import SetupsV1, SetupsV2 +from openml.setups.setup import OpenMLSetup +from openml.testing import TestAPIBase +from openml._api.resources.base.fallback import FallbackProxy + + + +class TestSetupsV1(TestAPIBase): + """Tests for V1 XML API implementation of setups.""" + + _multiprocess_can_split_ = True + + def setUp(self) -> None: + super().setUp() + self.client = self._get_http_client( + server=settings.api.v1.server, + base_url=settings.api.v1.base_url, + api_key=settings.api.v1.api_key, + timeout=settings.api.v1.timeout, + retries=settings.connection.retries, + retry_policy=settings.connection.retry_policy, + ) + self.resource = SetupsV1(self.client) + + @pytest.mark.uses_test_server() + def test_list(self): + setups = self.resource.list(limit=10, offset=0) + + assert isinstance(setups, list) + assert len(setups) > 0 + assert all(isinstance(s, OpenMLSetup) for s in setups) + + + def test_get(self): + setup_id = 1 + xml_content, setup = self.resource.get(setup_id) + + assert isinstance(xml_content, str) + assert isinstance(setup, OpenMLSetup) + assert setup.setup_id == setup_id + + +class TestSetupsV2(TestAPIBase): + """Tests for V2 JSON API implementation of setups.""" + + _multiprocess_can_split_ = True + + def setUp(self) -> None: + super().setUp() + self.client = self._get_http_client( + server=settings.api.v2.server, + base_url=settings.api.v2.base_url, + api_key=settings.api.v2.api_key, + timeout=settings.api.v2.timeout, + retries=settings.connection.retries, + retry_policy=settings.connection.retry_policy, + ) + self.resource = SetupsV2(self.client) + +class TestSetupsCombined(TestAPIBase): + def setUp(self): + super().setUp() + self.v1_client = self._get_http_client( + server=settings.api.v1.server, + base_url=settings.api.v1.base_url, + api_key=settings.api.v1.api_key, + timeout=settings.api.v1.timeout, + retries=settings.connection.retries, + retry_policy=settings.connection.retry_policy, + ) + self.v2_client = self._get_http_client( + server=settings.api.v2.server, + base_url=settings.api.v2.base_url, + api_key=settings.api.v2.api_key, + timeout=settings.api.v2.timeout, + retries=settings.connection.retries, + retry_policy=settings.connection.retry_policy, + ) + self.resource_v1 = SetupsV1(self.client) + self.resource_v2 = SetupsV2(self.client) + self.resource_fallback = FallbackProxy(self.resource_v2, self.resource_v1) From 8c23ab87b692a6f4747adaa442d41a59a4a6f52c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 29 Jan 2026 10:41:58 +0000 Subject: [PATCH 24/24] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- openml/_api/resources/__init__.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/openml/_api/resources/__init__.py b/openml/_api/resources/__init__.py index d6b3d10d7..cf83edea6 100644 --- a/openml/_api/resources/__init__.py +++ b/openml/_api/resources/__init__.py @@ -3,4 +3,12 @@ from openml._api.resources.setups import SetupsV1, SetupsV2 from openml._api.resources.tasks import TasksV1, TasksV2 -__all__ = ["DatasetsV1", "DatasetsV2", "FallbackProxy", "SetupsV1", "SetupsV2", "TasksV1", "TasksV2"] +__all__ = [ + "DatasetsV1", + "DatasetsV2", + "FallbackProxy", + "SetupsV1", + "SetupsV2", + "TasksV1", + "TasksV2", +]