[ENH] V1 → V2 API Migration
@geetu040 已经在做这个了。
开始于 2026年1月22日。
评估
这个 Issue 还没有评估数据。
描述
This issue tracks the migration of the openml-python SDK from the legacy OpenML API v1 (PHP-based) in openml/OpenML to the newer API v2 (Python-based) in openml/server-api, along with a structural refactor of the codebase to support both APIs during the transition.
The SDK currently relies on the v1 API, which should be progressively replaced by v2 while keeping backward compatibility and fallback where v2 endpoints are incomplete.
Goals
- Separate API interaction from SDK logic by introducing clear abstraction layers
- Modularize HTTP handling, API resources, and SDK-facing interfaces
- Allow easy switching between API v1 and v2
- Provide a transparent fallback to v1 for missing or unimplemented v2 endpoints
Proposed design (high level)
- A shared
HTTPClientresponsible for:- retries
- proxy configurations
- caching
- exception handling
- thread safety
- Abstract API "blueprints" (e.g.
DatasetsAPI,TasksAPI) defining SDK-facing methods - Version-specific implementations (
*V1,*V2) mapping those methods to concrete endpoints - A fallback proxy that routes calls to v1 if a v2 endpoint is unavailable (unless
strict=True) - A central backend/context that controls API version selection and exposes resources internally
A draft implementation sketch is included below to illustrate the architecture (not final API).
# handles HTTP requests, retries, and proxy configuration
class HTTPClient:
def __init__(self, base_url: str):
self.base_url = base_url
def get(self, path, params=None):
return requests.get(f"{self.base_url}{path}", params=params)
def post(self, path, params=None, files=None):
return requests.post(f"{self.base_url}{path}", params=params, files=files)
# abstract blueprints defining SDK-exposed API endpoints and methods
class DatasetsAPI(ABC):
@abstractmethod
def get(self, id: int) -> dict: ...
class TasksAPI(ABC):
@abstractmethod
def get(self, id: int) -> dict: ...
@abstractmethod
def list(self, id: int) -> dict: ...
# version-specific implementations built on top of the API blueprints
class DatasetsV1(DatasetsAPI):
def __init__(self, http: HTTPClient):
self._http = http
def get(self, id: int) -> dict:
r = self._http.get(f"/api/v1/json/data/{id}")
d = r.json()["data_set_description"]
return {
"id": d["data_set_description"]["id"],
"name": d["data_set_description"]["name"],
"version": d["data_set_description"]["version"],
}
class DatasetsV2(DatasetsAPI):
def __init__(self, http: HTTPClient):
self._http = http
def get(self, id: int) -> dict:
r = self._http.get(f"/datasets/{id}")
d = r.json()
return {
"id": d["id"],
"name": d["name"],
"version": d["version"],
}
class TasksV1(TasksAPI):
pass
class TasksV2(TasksAPI):
pass
# proxy that falls back to v1 when v2 endpoints are missing or unimplemented
class FallbackProxy:
def __init__(self, primary, fallback, *, strict: bool):
self._primary = primary
self._fallback = fallback
self._strict = strict
def __getattr__(self, name):
primary_attr = getattr(self._primary, name)
if not callable(primary_attr):
return primary_attr
def wrapper(*args, **kwargs):
try:
return primary_attr(*args, **kwargs)
except NotImplementedError:
if self._strict:
raise
return getattr(self._fallback, name)(*args, **kwargs)
return wrapper
# core backend holding API bindings, exposed internally and to the SDK
class APIBackend:
def __init__(self, *, datasets, tasks):
self.datasets = datasets
self.tasks = tasks
def build_backend(version: str, strict: bool) -> APIBackend:
v1_http = HTTPClient("https://www.openml.org")
v2_http = HTTPClient("http://127.0.0.1:8001")
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
# SDK-facing entry points and version switching helpers
api_context = APIContext()
def set_api_version(version: str, strict=False):
api_context.set_version(version=version, strict=strict)
openml.set_api_version("v2", strict=True)
api_context.backend.data.get(31)
api_context.backend.tasks.list()
Work Items / Refactor scope
Base Scaffolding
Foundation: Establish the initial folder and file structure along with minimal base implementations for core components (HTTP client, backend, resource interfaces, versioned stubs). This provides a stable scaffold that subsequent refactor and migration work can build on.
HTTPClient features: Extend the shared HTTP client to provide consistent, reusable infrastructure concerns across all API versions and resources.
Fallback policy: Define and implement the fallback behavior that transparently redirects calls from v2 to v1 when endpoints are missing or unimplemented, with strict mode disabling fallback and surfacing errors.
- Base Scaffolding #1576
- Folder/file structure and base scaffolding
- retries
- proxy configuration
- caching
- exception handling
- v2 → v1 fallback support
Resource implementations
Implement resource classes that define SDK-facing methods and map them to concrete API endpoints. Each resource should have a clear abstract interface and version-specific implementations (*V1, *V2).
- Datasets https://github.com/openml/openml-python/pull/1608
- Tasks https://github.com/openml/openml-python/pull/1611
-
TaskTypes(not used in sdk) - EvaluationMeasures https://github.com/openml/openml-python/pull/1603
- EstimationProcedures https://github.com/openml/openml-python/pull/1604
- Evaluations https://github.com/openml/openml-python/pull/1606
- Flows https://github.com/openml/openml-python/pull/1609
- Studies https://github.com/openml/openml-python/pull/1610
- Runs https://github.com/openml/openml-python/pull/1616
- Setups https://github.com/openml/openml-python/pull/1619
-
Users(not used in sdk - though questionable, since spotted in evaluations)
- 主要语言
- Python
- 星标
- 361
- 派生
- 296
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
openml/openml-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
openml/openml-python#1750 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
openml/openml-python#1749 ·
-
难度 1/5 1 小时以内 新手友好度 92/100
openml/openml-python#1746 ·
-
Documentation Good First Issue
难度 2/5 1-3 小时 新手友好度 74/100
openml/openml-python#1708 · 7 条评论 ·
-
Good First Issue module:Run testing
难度 2/5 1-3 小时 新手友好度 82/100
openml/openml-python#1646 · 7 条评论 · 2 个 reaction ·
查看 openml/openml-python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
stephrobert/dsoxlab#238 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
sublimehq/package_control#1780 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 70/100
nwg-piotr/nwg-displays#145 ·