[ENH] V1 -> V2 Migration : Runs by Omswastik-11 · Pull Request #1616 · openml/openml-python

Omswastik-11 · 2026-01-15T09:09:13Z

Metadata

Reference Issue:
New Tests Added:
Documentation Updated:
Change Log Entry:

Details

codecov-commenter · 2026-01-15T20:58:38Z

Codecov Report

❌ Patch coverage is 57.14286% with 54 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.04%. Comparing base (c62bf51) to head (646ce1b).

Files with missing lines	Patch %	Lines
openml/_api/clients/http.py	16.66%	20 Missing ⚠️
openml/_api/resources/run.py	76.25%	19 Missing ⚠️
openml/runs/run.py	31.57%	13 Missing ⚠️
openml/runs/functions.py	33.33%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1616      +/-   ##
==========================================
- Coverage   54.64%   54.04%   -0.60%     
==========================================
  Files          63       63              
  Lines        5124     5173      +49     
==========================================
- Hits         2800     2796       -4     
- Misses       2324     2377      +53

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

…u040/openml-python into runs-migration-stacked # Conflicts: # openml/_api/resources/__init__.py # openml/_api/runtime/core.py

…into runs-migration-stacked

geetu040

sync with base pr
sdk code look good so far, please take a look at #1575 (comment) and make changes accordingly where needed.
all tests (existing and new) should pass to make sure we are retaining the original functionality of the sdk

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

…into runs-migration-stacked

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

…-11/openml-python into runs-migration-stacked

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

geetu040 · 2026-01-30T14:10:51Z

+    use_cache = not ignore_cache
+    reset_cache = ignore_cache
+    return api_context.backend.runs.get(
+        run_id,
+        use_cache=use_cache,
+        reset_cache=reset_cache,
+    )


use_cache should be true since the method always supports caching
reset_cache should rely on ignore_cache

Omswastik-11 · 2026-04-26T21:30:37Z

Hi @geetu040 . As per discussion in final mentoring meeting isn't it ready to merge ?

geetu040

overall this is close to getting merged, just a few review comments

geetu040 · 2026-05-01T07:07:20Z

following on the last unresolved review comment https://github.com/openml/openml-python/pull/1616/changes#r2988760874
what are these changes? is it a merge fault?

This was because of this https://github.com/openml/openml-python/actions/runs/25209014637/job/73915466617?pr=1616 . I had updated it . Should I look for a alternate solution ?

Hi @geetu040

8da79d3

I have override the publish to pass the tests . Is it good or should I come up with better solution ?

Co-authored-by: Armaghan Shakir <raoarmaghanshakir040@gmail.com>

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

…-11/openml-python into runs-migration-stacked

…rver Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Omswastik-11 · 2026-05-02T13:35:00Z

Hi @geetu040 !! Can you check the replies to reviews and the failing tests and let me know if any changes needed ?

geetu040 · 2026-05-08T08:44:54Z

+def test_run_v1_get(run_v1, with_test_cache):
+    try:
+        run = run_v1.get(run_id=1)
+    except OpenMLServerException as e:
+        if e.code == 236 or "Run not found" in str(e):
+            run = run_v1.get(run_id=25)
+        else:
+            raise
+    _assert_run_shape(run)
+


why simply run_v1.get(run_id=1) doesn't work?

Because Run Id of 1 is not present in test server and run Id of 25 is not present in local server . It is bit weird I tried Finding common ID Manually but couldn't find it .

Okay, I remember it now, I mentioned this to @PGijsbers on slack here.

Didn't we have a way to check whether a local or non-local server configured is being used?
Then I would prefer to use that e.g.,

run_id = 25 if openml config is local else 1

That embeds this knowledge into the code so it's clear for future maintainers.
We probably do not have the time to address this on our end for a while longer :(

we could actually use the env var OPENML_USE_LOCAL_SERVICES, that should be fine

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

geetu040

Nicely done @Omswastik-11.

@PGijsbers, could you please review/merge this PR when you get a chance?

There is currently one issue caused by differences between the test-server and local-server database entities, which is temporarily patched here: #1616 (comment).

I had mentioned this earlier on Slack as well here, we can continue discussion there

PGijsbers

small changes or clarifications requested, please see comments.

PGijsbers · 2026-05-20T12:43:58Z

+        path_parts = parsed_url.path.strip("/").split("/")
+
+        filtered_params = {k: v for k, v in params.items() if k != "api_key"}
+        params_part = [urlencode(filtered_params)] if filtered_params else []


This is a good remark, but seeing as this code isn't touched by this PR, I would advocate fixing this in a separate PR.

PGijsbers · 2026-05-20T12:51:43Z

+        if response.content.startswith(b"PK\x03\x04"):
+            return "body.zip"
+
+        try:
+            arff.loads(response.text)
+            return "body.arff"
+        except arff.ArffException:
+            pass


Is there no HTTP header data that would allow us to tell what the content (and file name) should be?
Otherwise, at least for ARFF, the spec states that the first non-comment line of the file should be (not case sensitive): @relation <relation name>. So we could look for that instead of parsing the entire file content.

Is there no HTTP header data that would allow us to tell what the content (and file name) should be?

I tried but didn't find anything

Otherwise, at least for ARFF, the spec states that the first non-comment line of the file should be (not case sensitive): @relation <relation name>.

sounds good I could give this a try

PGijsbers · 2026-05-20T13:06:07Z

+        OpenMLHashException
+            If checksum verification fails.
+        """
+        url = urljoin(self.server, path)


ignore: If this isn't the case already, this should be normalized when openml.config.server is set, not each site which uses it.

PGijsbers · 2026-05-20T13:08:20Z

+        candidates = []
+        for p in path.iterdir():
+            if p.name.startswith("body.") and len(p.suffixes) == 1:
+                candidates.append(p)


Suggested change

candidates = []

for p in path.iterdir():

if p.name.startswith("body.") and len(p.suffixes) == 1:

candidates.append(p)

candidates = [p for p in path.glob("body.*") if len(p.suffixes) == 1]

see glob

PGijsbers · 2026-05-20T13:10:55Z

+        if use_api_key:
+            params["api_key"] = self.api_key
+
+        if method.upper() in {"POST", "PUT", "PATCH"}:
+            data = {**params, **data}


ignore: It raises an exception if api_key is None, it's the statement preceding this line..

PGijsbers · 2026-05-20T13:12:28Z

+        self,
+        limit: int,
+        offset: int,
+        *,
+        ids: builtins.list[int] | None = None,


please address or explain; i see you have dismissed previous comments about this so presumably there is a reason?

PGijsbers · 2026-05-20T13:15:37Z

+
+        # Fall back to generic oml:id (used by other resources)
+        if "oml:id" in root_value:
+            return int(root_value["oml:id"])


If run responses always return oml:run_id, when do we expect this code path to be correct to run?

@Omswastik-11 since this method is overriden for runs, we shouldn't expect to handle other resources here, therefore logically this path should be unreachable as Pieter has said

PGijsbers · 2026-05-20T13:25:15Z

+def test_run_v1_get(run_v1, with_test_cache):
+    try:
+        run = run_v1.get(run_id=1)
+    except OpenMLServerException as e:
+        if e.code == 236 or "Run not found" in str(e):
+            run = run_v1.get(run_id=25)
+        else:
+            raise
+    _assert_run_shape(run)
+


Didn't we have a way to check whether a local or non-local server configured is being used?
Then I would prefer to use that e.g.,

run_id = 25 if openml config is local else 1

That embeds this knowledge into the code so it's clear for future maintainers.
We probably do not have the time to address this on our end for a while longer :(

geetu040 · 2026-05-21T19:34:56Z

@Omswastik-11 could you go through the above comments, we'd need to close these discussions.

geetu040 mentioned this pull request Jan 15, 2026

[ENH] V1 → V2 API Migration #1575

Open

18 tasks

geetu040 assigned Omswastik-11 Jan 19, 2026

Omswastik-11 and others added 9 commits January 28, 2026 09:35

Merge branches 'migration' and 'migration' of https://github.com/geet…

29fd985

…u040/openml-python into runs-migration-stacked # Conflicts: # openml/_api/resources/__init__.py # openml/_api/runtime/core.py

add test_http.py

fa53f8d

add uses_test_server marker

2b2db96

Merge branch 'migration' of https://github.com/geetu040/openml-python …

0135ba2

…into runs-migration-stacked

implement reset_cache

c9617f9

fixes with publish/delete

5bc37b8

fix cache_key in tests

08d9916

Merge branch 'migration' of https://github.com/geetu040/openml-python …

37a468f

…into runs-migration-stacked

update _not_supported

8caba11

geetu040 suggested changes Jan 30, 2026

View reviewed changes

Comment thread openml/_api/resources/runs.py Outdated

Comment thread openml/_api/resources/runs.py Outdated

Comment thread openml/_api/resources/runs.py Outdated

Comment thread openml/runs/functions.py Outdated

Omswastik-11 added 3 commits January 30, 2026 14:56

tests:added tests for migration

a70a33f

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Merge branch 'migration' of https://github.com/geetu040/openml-python …

d08b1fe

…into runs-migration-stacked

tests:added tests for migration

aaf9d4b

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Omswastik-11 requested a review from geetu040 January 30, 2026 09:50

Merge branch 'main' into runs-migration-stacked

84d43a9

Omswastik-11 marked this pull request as ready for review January 30, 2026 09:50

Omswastik-11 added 6 commits January 30, 2026 18:29

tests:modified old chache tests to use new caching

761ef9e

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Merge branch 'runs-migration-stacked' of https://github.com/Omswastik…

cf37a75

…-11/openml-python into runs-migration-stacked

tests:modified old chache tests to use new caching

2eb7c7a

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

tests:modified old chache tests to use new caching

d9476c8

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

tests:skip the production related tests

f4718c1

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

tests:modify skip messgaes

4560b6b

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

geetu040 suggested changes Jan 30, 2026

View reviewed changes

SimonBlanke added 4 commits January 30, 2026 19:27

add 'get_api_config' skeleton method

1913c10

remove 'APISettings'

7681949

impl. 'get_api_config'

01840a5

add singleton pattern for settings

26ed4c1

geetu040 suggested changes May 1, 2026

View reviewed changes

Update tests/test_api/test_run.py

15d3403

Co-authored-by: Armaghan Shakir <raoarmaghanshakir040@gmail.com>

Copilot AI review requested due to automatic review settings May 1, 2026 08:44

Copilot started reviewing on behalf of Omswastik-11 May 1, 2026 08:44 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

Comment thread openml/runs/run.py

Comment thread openml/_api/clients/http.py

Comment thread openml/_api/resources/run.py

Omswastik-11 added 2 commits May 1, 2026 14:30

remove old apicalls

6da5428

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

fix the merge issues on versions file

91ef60c

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Copilot AI review requested due to automatic review settings May 1, 2026 09:04

Copilot started reviewing on behalf of Omswastik-11 May 1, 2026 09:05 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

Comment thread openml/runs/run.py

Comment thread tests/test_api/test_run.py

Comment thread openml/_api/clients/http.py

Comment thread openml/_api/clients/http.py

Comment thread openml/_api/resources/base/resources.py

Omswastik-11 added 2 commits May 1, 2026 15:41

override publish and add runid falllback

8da79d3

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Merge branch 'runs-migration-stacked' of https://github.com/Omswastik…

1bad874

…-11/openml-python into runs-migration-stacked

Omswastik-11 requested a review from geetu040 May 1, 2026 10:17

modified the test to use runid 25 which is available on local test se…

ce66423

…rver Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

Copilot AI review requested due to automatic review settings May 1, 2026 11:29

Copilot started reviewing on behalf of Omswastik-11 May 1, 2026 11:30 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

add fallback for unavailable runs on local and test server

74eb7ae

Signed-off-by: Omswastik-11 <omswastikpanda11@gmail.com>

geetu040 suggested changes May 8, 2026

View reviewed changes

Merge branch 'main' into runs-migration-stacked

65ee864

Copilot AI review requested due to automatic review settings May 11, 2026 12:35

Copilot started reviewing on behalf of Omswastik-11 May 11, 2026 12:35 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread openml/_api/clients/http.py

Comment thread openml/_api/clients/http.py

Comment thread openml/_api/resources/run.py

Comment thread openml/_api/resources/base/resources.py

Comment thread tests/test_api/test_run.py

only overrid _extract_id_from_upload

646ce1b

Omswastik-11 requested a review from geetu040 May 11, 2026 12:47

geetu040 approved these changes May 11, 2026

View reviewed changes

PGijsbers requested changes May 20, 2026

View reviewed changes

Uh oh!

Conversation

Omswastik-11 commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Metadata

Details

Uh oh!

codecov-commenter commented Jan 15, 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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Omswastik-11 commented Apr 26, 2026

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Omswastik-11 May 1, 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!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Omswastik-11 commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Omswastik-11 May 11, 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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Omswastik-11 commented Jan 15, 2026 •

edited

Loading

codecov-commenter commented Jan 15, 2026 •

edited

Loading

Omswastik-11 May 1, 2026 •

edited

Loading

Omswastik-11 commented May 2, 2026 •

edited

Loading

Omswastik-11 May 11, 2026 •

edited

Loading