[ENH] V1 → V2 API Migration - core structure by geetu040 · Pull Request #1576 · openml/openml-python

geetu040 · 2025-12-30T04:38:36Z

Towards #1575

This PR sets up the core folder and file structure along with base scaffolding for the API v1 → v2 migration.

It includes:

Skeleton for the HTTP client, backend, and API context
Abstract resource interfaces and versioned stubs (*V1, *V2)
Minimal wiring to allow future version switching and fallback support

No functional endpoints are migrated yet. This PR establishes a stable foundation for subsequent migration and refactor work.

…into issue1564

codecov-commenter · 2025-12-31T13:50:18Z

Codecov Report

❌ Patch coverage is 51.58850% with 320 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.41%. Comparing base (8a5532f) to head (f926092).

Files with missing lines	Patch %	Lines
openml/_api/clients/http.py	23.11%	163 Missing ⚠️
openml/_api/resources/base/versions.py	31.16%	53 Missing ⚠️
openml/_api/resources/base/fallback.py	26.31%	28 Missing ⚠️
openml/_api/setup/builder.py	44.44%	25 Missing ⚠️
openml/_api/setup/backend.py	66.66%	19 Missing ⚠️
openml/_api/resources/base/base.py	57.14%	15 Missing ⚠️
openml/_config.py	80.64%	12 Missing ⚠️
openml/cli.py	0.00%	4 Missing ⚠️
openml/_api/clients/minio.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #1576 +/- ##
==========================================
- Coverage 52.73% 52.41% -0.33% 
==========================================
Files 37 61 +24 Lines 4399 5037 +638 ==========================================
+ Hits 2320 2640 +320 - Misses 2079 2397 +318

☔ 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.

…into pr/1577

This reverts commit 93155ee.

geetu040 · 2026-03-13T04:04:16Z

FYI: @JATAYU000 @satvshr @omkar-334 @rohansen856 @EmanAbdelhaleem

Please sync with this PR. The CI tests should now be passing in all the stacked PRs (except some sporadic failures), since now they are using the local docker services created in the CI which provides endpoints for v2-api as well.

You can run these tests locally as well, with the following steps:

Run docker services locally:

git clone --depth 1 https://github.com/openml/services.git
cd ./services chmod -R a+rw ./data
chmod -R a+rw ./logs
docker compose --profile rest-api --profile minio --profile evaluation-engine up -d

Run pytest using the local services (add the env var):

OPENML_USE_LOCAL_SERVICES="true" pytest tests/

PGijsbers

🎉

identified in https://github.com/openml/openml-python/actions/runs/23148612114/job/67243650521?pr=1609

identified in https://github.com/openml/openml-python/actions/runs/23430963986/job/68156944423?pr=1576

fkiraly

I am happy whenever @PGijsbers is happy.

Fixes#1623 Depends on #1576 Related to #1575 #### Details This PR implements `Evaluations` resource, and refactor its existing functions --------- Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com> Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com> Co-authored-by: Franz Király <fkiraly@gcos.ai> Co-authored-by: Simon Blanke <simon.blanke@yahoo.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de> Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

Fixes#1593 Depends on #1576 Related to #1575 #### Details This PR implements `EvaluationMeasures` resource, and refactor its existing functions --------- Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com> Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com> Co-authored-by: Franz Király <fkiraly@gcos.ai> Co-authored-by: Simon Blanke <simon.blanke@yahoo.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de> Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

Fixes#1625 Depends on #1576 Related to #1575 Details This PR implements `Setups` resource, and refactor its existing functions --------- Co-authored-by: Franz Király <fkiraly@gcos.ai> Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com> Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Simon Blanke <simon.blanke@yahoo.com> Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de> Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

Fixes#1622 Depends on #1576 Related to: #1575 #### Details This PR implements `EstimationProcedures` resource, and refactor its existing functions --------- Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com> Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com> Co-authored-by: Franz Király <fkiraly@gcos.ai> Co-authored-by: Simon Blanke <simon.blanke@yahoo.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de> Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

#### Metadata * Reference Issue: #1594 (towards #1575) * New Tests Added: No * Documentation Updated: No #### Details Stackend PR, Depends on #1576 This PR adds `Studies v2` migration. A question: Due to the pre commit hook i could not put 6 arguments in a function, so i had to workaround that with this instead: openml\_api\resources\studies.py (line 10-15) ```py limit = kwargs.get("limit") offset = kwargs.get("offset") status = kwargs.get("status") main_entity_type = kwargs.get("main_entity_type") uploader = kwargs.get("uploader") benchmark_suite = kwargs.get("benchmark_suite") ``` I would like to confirm if this approach is correct or not. Raising a draft PR for now. --------- Signed-off-by: rohansen856 <rohansen856@gmail.com> Co-authored-by: Satvik Mishra <112589278+satvshr@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: geetu040 <raoarmaghanshakir040@gmail.com> Co-authored-by: Franz Király <fkiraly@gcos.ai> Co-authored-by: Simon Blanke <simon.blanke@yahoo.com> Co-authored-by: Matthias Feurer <lists@matthiasfeurer.de> Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

satvshrand others added 2 commits December 30, 2025 02:07

changes made
bf6e000

set up folder structure and base code
0159f47

geetu040 mentioned this pull request Dec 30, 2025
[ENH] V1 → V2 API Migration #1575
Open
18 tasks

satvshrand others added 8 commits December 30, 2025 11:58

Merge branch 'issue1564' ofhttps://github.com/satvshr/openml-python…
8b6af81
…into issue1564

bug fixing
834782c

test failures fix
38ae9be

Update flow_id_tutorial.py
93ab9c2

_defaults bug fixing
aa25dd6

Merge branch 'main' into migration
58e9175

removed __setattr__ given it is not supported
a98b6b1

Merge branch 'main' into issue1564
7c82054

geetu040and others added 7 commits January 1, 2026 20:12

Merge branch 'main' into migration
bdd65ff

Merge branch 'main' into issue1564
f8fbe1e

Merge branch 'main' into issue1564
4fdcb64

Merge branch 'main' into issue1564
b3513f0

fix pre-commit
52ef379

Update all files
146dd21

Update introduction_tutorial.py
7a67bf0

This was referenced Jan 7, 2026
[ENH] V1 → V2 API Migration - estimation procedures #1604
Merged
[ENH] V1 → V2 API Migration - evaluation measures #1603
Merged
[ENH] V1 → V2 API Migration - evaluations #1606
Merged

geetu040and others added 6 commits January 7, 2026 22:14

refactor
5dfcbce

implement cache_dir
2acbe99

refactor
af99880

Merge branch 'main' into pr/1577
b111905

Merge branch 'issue1564' ofhttps://github.com/satvshr/openml-python…
83f36c2
…into pr/1577

Merge branch 'main' into pr/1576
74ab366

JATAYU000 mentioned this pull request Jan 8, 2026
[ENH] V1 → V2 API Migration - datasets #1608
Open

rohansen856 mentioned this pull request Jan 8, 2026
[ENH] V1 → V2 API Migration - studies #1610
Merged

satvshrand others added 13 commits March 6, 2026 21:01

Trigger CI
39eb823

Merge branch 'main' into migration
50eed37

Merge branch 'main' into issue1564
7a000eb

Merge branch 'main' into issue1564
79f6187

Merge branch 'pr-1577' into migration (merge conflicts)
b1a9e7f

update server methods in config
d716ecf

fix api-version leakage in tests
3c29e71

remove unused migration code
b4ff0b2

debug ci: separate cache for each test-case
93155ee

update port for localhost
d3cc9a7

Revert "debug ci: separate cache for each test-case"
a6b82f4
This reverts commit 93155ee.

rerun CI
3419973

Merge branch 'main' into migration
8de99b7

PGijsbers reviewed Mar 13, 2026
View reviewed changes

Comment threadopenml/_config.py
Comment threadopenml/_config.py Outdated

geetu040 added 4 commits March 16, 2026 20:12

create enum ServerMode
7d61107

update config for ServerMode
1ecbbba

update tests for ServerMode
65472ed

udpate apikey in _TEST_SERVERS_LOCAL
44b48b5

geetu040 requested a review from PGijsbers March 17, 2026 14:29

PGijsbers approved these changes Mar 18, 2026
View reviewed changes

geetu040 added 2 commits March 23, 2026 14:42

fix: remove duplicate server name in cache path
04bc83b
identified in https://github.com/openml/openml-python/actions/runs/23148612114/job/67243650521?pr=1609

test: remove check for ":" since windows CI expects it
f926092
identified in https://github.com/openml/openml-python/actions/runs/23430963986/job/68156944423?pr=1576

fkiraly approved these changes Mar 23, 2026
View reviewed changes

PGijsbers merged commit 8185ccc into openml:mainMar 23, 2026
50 of 51 checks passed

Navigation Menu

Uh oh!

Uh oh!

[ENH] V1 → V2 API Migration - core structure - #1576

[ENH] V1 → V2 API Migration - core structure#1576
PGijsbers merged 225 commits into
openml:mainfrom
geetu040:migration

geetu040 commented Dec 30, 2025

Uh oh!

codecov-commenter commented Dec 31, 2025•
edited
Loading

Uh oh!

geetu040 commented Mar 13, 2026•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

PGijsbers left a comment

Uh oh!

fkiraly left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Uh oh!

Uh oh!

Conversation

geetu040 commented Dec 30, 2025

Uh oh!

codecov-commenter commented Dec 31, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

geetu040 commented Mar 13, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PGijsbers left a comment

Choose a reason for hiding this comment

Uh oh!

fkiraly left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

codecov-commenter commented Dec 31, 2025•
edited
Loading

geetu040 commented Mar 13, 2026•
edited
Loading