[ENH] V1 → V2 API Migration - Tasks #1611

satvshr · 2026-01-09T09:06:07Z

Metadata

Reference Issue: stacks on [ENH] V1 → V2 API Migration - core structure #1576, fixes [ENH] V1 → V2 API Migration - tasks #1621
New Tests Added: No
Documentation Updated: No

ported functions to APIv1

codecov-commenter · 2026-01-09T09:13:33Z

Codecov Report

❌ Patch coverage is 65.10360% with 320 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.16%. Comparing base (d421b9e) to head (1d3cf95).

Files with missing lines	Patch %	Lines
openml/_api/clients/http.py	58.41%	89 Missing ⚠️
openml/_api/resources/base/versions.py	24.71%	67 Missing ⚠️
openml/_api/resources/task.py	72.41%	40 Missing ⚠️
openml/_api/setup/backend.py	65.16%	31 Missing ⚠️
openml/_api/resources/base/fallback.py	26.31%	28 Missing ⚠️
openml/_api/resources/base/resources.py	68.75%	15 Missing ⚠️
openml/tasks/task.py	18.75%	13 Missing ⚠️
openml/testing.py	55.55%	12 Missing ⚠️
openml/_api/setup/_utils.py	56.00%	11 Missing ⚠️
openml/_api/setup/builder.py	81.08%	7 Missing ⚠️
... and 3 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1611      +/-   ##
==========================================
+ Coverage   52.04%   54.16%   +2.12%     
==========================================
  Files          36       63      +27     
  Lines        4333     5092     +759     
==========================================
+ Hits         2255     2758     +503     
- Misses       2078     2334     +256

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

for more information, see https://pre-commit.ci

geetu040

From a high-level review, I noticed a few points that need adjustment:

Caching can likely be removed from the SDK, since these concerns should be handled by the base client.
I don't see the api_context being used in tasks/functions, so it's not clear to me how the SDK is actually using the new API interface here.
Instead of moving entire methods out of tasks/functions.py, it would be better to stick to the goal of minimal SDK changes while enabling v2 support.
API calls should be updated at the specific root functions (for example _get_task_description, OpenMLTask._download_split).
For listing tasks, please follow the approach discussed in #1575 comment.

examples/Advanced/fetch_evaluations_tutorial.py

for more information, see https://pre-commit.ci

… tasks

geetu040

I have left some comments, please take a look and make sure the signature of all methods in TasksAPI, TasksV1 and TasksV2 stay same.

openml/_api/resources/base.py

openml/_api/resources/tasks.py

openml/tasks/functions.py

for more information, see https://pre-commit.ci

source: openml#1606 (comment)

- removing this since it was not part of the sdk previously - some tests fail because of the timeout in stacked PRs - this option can easily be added if needed in future

… tasks

EmanAbdelhaleem · 2026-02-04T17:25:26Z

openml/_api/resources/task.py

+
+        return pd.DataFrame.from_dict(tasks, orient="index")
+
+    def _get_estimation_procedure_list(self) -> builtins.list[dict[str, Any]]:


@geetu040 We already have implemented this function in the estimation_procedure resource, so I think we don't need it to be here, right?

Just checked, once we merge your PR we can replace it with the _get_details function yes.

yes, that's the plan

EmanAbdelhaleem · 2026-02-04T17:28:52Z

openml/_api/resources/task.py

+        task_type: TaskType | int | None = None,
+        **kwargs: Any,
+    ) -> pd.DataFrame:
+        raise NotImplementedError(self._not_supported(method="list"))


You can just use self._not_supported(method="list")

no need for raise NotImplementedError()

EmanAbdelhaleem · 2026-02-04T17:35:10Z

tests/test_api/test_task.py

+        assert isinstance(procs, list)
+        assert len(procs) > 0
+        assert "id" in procs[0]
+


I think you need to add TestTasksV2 class, and also add v1 and v2 matching tests and fallback tests as mentioned here: #1575 (comment)

I dont need to add TestTasksV2 given those tests are a subset of TestTasksV1. Matching tests are in the shared class.

you still need TestTasksV2 and check if they raise the not implemented error
i think you should use this design then, since there are many common utilities
tests/test_api/test_versions.py

EmanAbdelhaleem · 2026-02-04T17:42:54Z

openml/_api/resources/task.py

+        task_type: TaskType | int | None = None,
+        **kwargs: Any,
+    ) -> pd.DataFrame:
+        """


@geetu040
Should we all use the same style or not?
for me, I have splitted this this into 3 functions for more readability and less coupling

list()

_build_url()

_parse_list_xml()

I don't think we need private functions to match each other in terms of nomenclature or functionality as long as we share the same common function names (which we do).

same nomenclature is preferred
I would say you should do this, will make it better anyways

Will do, but I don't necessarily agree. Something similar happened in another project where we were working on 2 algorithms and I suggested something similar but Franz mentioned it is not something that can consistently be maintained across the entire codebase hence does not need change. Given we have 8-9 resources it does not feel fruitful to have people share the same nomenclature for private functions across all PRs, I don't have a strong opinion on this though and I will be making the requested change.

yeah if your function is lengthy then it's always better to break it into components, otherwise agreed this is not necessary

Oh yeah I agree if the function is lengthy, over here (eman's suggestion) we are just removing 15 lines of code and replacing with 1, hence the hesitance. Anyways, I did change it so the pr is ready for review again :D

geetu040

rename tasks to task, in TestTasksV1, `test_tasks.py just for consistency
and other comments from @EmanAbdelhaleem's review

geetu040

\

geetu040 · 2026-02-06T19:10:30Z

tests/test_tasks/test_task_functions.py

-    @pytest.mark.uses_test_server()
-    def test_get_task(self):
-        task = openml.tasks.get_task(1, download_data=True)  # anneal; crossvalidation
-        assert isinstance(task, OpenMLTask)


I would say you keep this test and only remove the lines that check for cache, basically remove all the lines after these 2

Since all tests that were testing get function used cache so all were removed and there was no unit-test left for get_task method, therefore, keep this test as said above

geetu040 and others added 10 commits December 30, 2025 09:11

set up folder structure and base code

0159f47

Merge branch 'main' into migration

58e9175

Merge branch 'main' into migration

bdd65ff

fix pre-commit

52ef379

refactor

5dfcbce

implement cache_dir

2acbe99

refactor

af99880

Merge branch 'main' into pr/1576

74ab366

git commit --no-verify

17a7178

ported functions to APIv1

Merge branch 'main' into tasks

510b286

geetu040 mentioned this pull request Jan 9, 2026

[ENH] V1 → V2 API Migration #1575

Open

25 tasks

satvshr and others added 4 commits January 12, 2026 01:35

commiting latest cahnges

c2b9e1a

[pre-commit.ci] auto fixes from pre-commit.com hooks

056cf3a

for more information, see https://pre-commit.ci

Merge remote-tracking branch 'geetu040/migration' into tasks

fb1ff40

bug fixing

17ab23c

satvshr marked this pull request as ready for review January 12, 2026 15:29

geetu040 suggested changes Jan 13, 2026

View reviewed changes

examples/Advanced/fetch_evaluations_tutorial.py Show resolved Hide resolved

satvshr added 3 commits January 14, 2026 16:51

commiting intermediate changes

e07ef73

removed caching

fb57a3e

removed uneccesary imports

8e041a4

satvshr marked this pull request as draft January 14, 2026 20:25

satvshr and others added 6 commits January 15, 2026 01:59

merge main

61ca98c

[pre-commit.ci] auto fixes from pre-commit.com hooks

e5dd2d9

for more information, see https://pre-commit.ci

undo changes in tasks/functions.py

4c75e16

Merge branch 'main' into migration

5762185

small comments

202314e

Merge branch 'tasks' of https://github.com/satvshr/openml-python into…

3a2f1c4

… tasks

satvshr changed the title ~~[ENH] Tasks Migration~~ [ENH] V1 → V2 API Migration - Tasks Jan 15, 2026

geetu040 suggested changes Jan 15, 2026

View reviewed changes

geetu040 and others added 14 commits February 3, 2026 13:39

add MinIOClient in TestBase

bfb2d3e

fix linting for builder

cabaecf

merge migration

0be93cf

[pre-commit.ci] auto fixes from pre-commit.com hooks

8e5c4eb

for more information, see https://pre-commit.ci

adjusting to new changes

021c1ed

adjusting to new changes

5e6c56e

adjusting to new changes

1fec002

adjusting to new changes

1877c07

fix unbound variables: "code", "message"

85c1113

source: openml#1606 (comment)

use requests.Session()

39bf86a

remove "timeout_seconds" entirely

7b66677

- removing this since it was not part of the sdk previously - some tests fail because of the timeout in stacked PRs - this option can easily be added if needed in future

adjusting to new changes

b61741f

Merge branch 'tasks' of https://github.com/satvshr/openml-python into…

2a51495

… tasks

Updated tests

2bf1d1e

satvshr marked this pull request as ready for review February 4, 2026 15:57

EmanAbdelhaleem reviewed Feb 4, 2026

View reviewed changes

satvshr marked this pull request as draft February 4, 2026 17:37

update/refactor tests

d2224c4

EmanAbdelhaleem reviewed Feb 4, 2026

View reviewed changes

satvshr added 5 commits February 4, 2026 23:46

bug fixing and cached tests removal

f89230a

updated tests

0708966

updated tests

122bd21

Merge remote-tracking branch 'geetu040/migration' into tasks

d6565f1

latest core changes

f7aa11e

geetu040 suggested changes Feb 5, 2026

View reviewed changes

requested changes

1d3cf95

satvshr marked this pull request as ready for review February 5, 2026 16:19

geetu040 suggested changes Feb 6, 2026

View reviewed changes


		return pd.DataFrame.from_dict(tasks, orient="index")

		def _get_estimation_procedure_list(self) -> builtins.list[dict[str, Any]]:

Uh oh!

[ENH] V1 → V2 API Migration - Tasks #1611

Are you sure you want to change the base?

[ENH] V1 → V2 API Migration - Tasks #1611

Uh oh!

Conversation

satvshr commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Metadata

Uh oh!

codecov-commenter commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EmanAbdelhaleem Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

satvshr Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

satvshr Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

geetu040 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

satvshr commented Jan 9, 2026 •

edited

Loading

codecov-commenter commented Jan 9, 2026 •

edited

Loading

EmanAbdelhaleem Feb 4, 2026 •

edited

Loading

satvshr Feb 4, 2026 •

edited

Loading

satvshr Feb 5, 2026 •

edited

Loading

geetu040 left a comment •

edited

Loading