[ENH] V1 → V2 API Migration - setups by EmanAbdelhaleem · Pull Request #1619 · openml/openml-python

EmanAbdelhaleem · 2026-01-20T11:01:28Z

Fixes #1625
Depends on #1576
Related to #1575

Details
This PR implements Setups resource, and refactor its existing functions

…into pr/1577

…into issue1564

codecov-commenter · 2026-01-20T11:07:49Z

Codecov Report

❌ Patch coverage is 68.68687% with 31 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.26%. Comparing base (8ff14eb) to head (801c16f).

Files with missing lines	Patch %	Lines
openml/_api/resources/setup.py	71.42%	24 Missing ⚠️
openml/setups/setup.py	25.00%	6 Missing ⚠️
openml/setups/functions.py	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1619      +/-   ##
==========================================
+ Coverage   53.96%   54.26%   +0.29%     
==========================================
  Files          61       61              
  Lines        5051     5070      +19     
==========================================
+ Hits         2726     2751      +25     
+ Misses       2325     2319       -6

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

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

geetu040

To check: Does #1611 (review) affect this PR?

geetu040

some old tests will fail because the cache path has changed

old: tests/files/org/openml/test/tasks/1882
new: tests/files/org/openml/test/api/v1/xml/task/1882

regarding this we can do the following, as i've done in this PR

populate the files in new directory - reference
- you can copy meta.json and headers.json as they are and update the URLs (this is trivial, anything should be fine here)
- rename the description.xml file to body.bin
- move other downloadable files from minio and HTTPClient.download accordingly
if there are any tests that rely on cache, update them by mocking Session.request - reference
update conftest.py with new file paths, for now you can manually hardcode the new paths and remove this resource from the code earlier, we can later clean this up - reference

FYI: @satvshr @Omswastik-11 @JATAYU000

geetu040

@EmanAbdelhaleem Thanks for the PR. Nicely done!
I have updated the PR to sync with latest changes in base PR.

@PGijsbers please review/merge.

PGijsbers

I left a few remarks, additionally the ability to add and remove tags was added, but I did not see any tests added that test this new functionality. Those tests should be added.

I believe we had briefly discussed this before on a different PR, but I can't find it easily. Why store the response body as a binary file? The response is always text (either xml or json, potentially also some error text but text regardless). I do not think it is good to store these files as binary because it doesn't play well with git -and- because it makes it hard to review the file content (see for example the recent xz/ssh exploit). I would prefer these files have an extension that matches their content, and if that needs to be more generic, then we should use .txt.

openml/_api/resources/setup.py

PGijsbers · 2026-03-24T11:04:11Z

openml/_api/resources/setup.py

+    def _to_dict(
+        self, flow_id: int, openml_parameter_settings: builtins.list[dict[str, Any]]
+    ) -> OrderedDict:


Please turn it into a static method since it doesn't use the object's state.

PGijsbers · 2026-03-24T11:05:44Z

openml/_api/resources/setup.py

+            )
+        return OpenMLSetup(setup_id, flow_id, parameters)
+
+    def _create_setup_parameter_from_xml(self, result_dict: dict[str, str]) -> OpenMLParameter:


Please turn it into a static method since it doesn't use the object's state.

PGijsbers · 2026-03-24T11:06:57Z

openml/_api/resources/setup.py

+            for setup_ in setups_dict["oml:setups"]["oml:setup"]
+        ]
+
+    def _create_setup(self, result_dict: dict) -> OpenMLSetup:


Please turn it into a static method since it doesn't use the object's state.

PGijsbers · 2026-03-24T11:16:30Z

tests/test_api/test_setup.py

+    md5 = hashlib.md5()
+    md5.update(str(time.time()).encode("utf-8"))
+    sentinel = md5.hexdigest()[:10]
+    return f"TEST{sentinel}"  


Suggested change

md5 = hashlib.md5()

md5.update(str(time.time()).encode("utf-8"))

sentinel = md5.hexdigest()[:10]

return f"TEST{sentinel}"

sentinel = uuid.uuid4().hex[:10]

return f"TEST{sentinel}"

(and import uuid)

The generated string is deterministic based on the current time. That means that if this is used for multiple tests, and they are executed in parallel, there is a non-zero chance the same value is generated (or when the clock is set back). Admittedly, the precision of time.time() is enough that this likely doesn't happen, but it's good to avoid the chance. Moreover, generating it with uuid clearly signals the intent that we are just looking for a random string.

good catch, updated

openml#1619 (comment) Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

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

…ps-mig

geetu040 and others added 25 commits January 5, 2026 12:48

fix pre-commit

52ef379

Update all files

146dd21

Update introduction_tutorial.py

7a67bf0

refactor

5dfcbce

implement cache_dir

2acbe99

refactor

af99880

Merge branch 'main' into pr/1577

b111905

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

83f36c2

…into pr/1577

Merge branch 'main' into pr/1576

74ab366

bug fixing

4241624

Update test_utils.py

f01c1e9

Update test_config.py

07cc1c8

merge main

1dbc780

undo changes in tasks/functions.py

4c75e16

Merge branch 'main' into migration

5762185

made requested changes

021a1e1

Merge branch 'main' into issue1564

4c4a12c

made requested changes

1d91220

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

3e26ace

…into issue1564

fixed bugs

0060b2e

fixed bugs

65ba66b

fixed bugs

317c6e9

fixed bugs

503ab82

Merge branch 'main' into issue1564

fd7ea2b

bug fixing

fa3cd40

geetu040 assigned EmanAbdelhaleem Jan 20, 2026

geetu040 added 2 commits January 21, 2026 10:47

Merge branch 'main' into migration

7e9bc1f

add tests directory

c603383

geetu040 mentioned this pull request Jan 21, 2026

[ENH] V1 → V2 API Migration #1575

Open

18 tasks

geetu040 added 5 commits March 16, 2026 20:12

update config for ServerMode

1ecbbba

update tests for ServerMode

65472ed

udpate apikey in _TEST_SERVERS_LOCAL

44b48b5

Merge branch 'migration' into setups-mig

5943720

fix marker

1cfacac

geetu040 self-assigned this Mar 23, 2026

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

geetu040 reviewed Mar 23, 2026

View reviewed changes

geetu040 added 7 commits March 23, 2026 21:02

Merge branch 'migration' into setups-mig

a72d73a

Merge branch 'main' into setups-mig

8105a1d

remove _create_setup

354e86f

add cache test

18e1046

update cache test

23963ff

update cache files for setup::1

98a50fd

update _expected_static_cache_state

fcf7c0f

geetu040 reviewed Mar 24, 2026

View reviewed changes

This was referenced Mar 24, 2026

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

Open

[ENH] V1 -> V2 Migration : Runs #1616

Open

[ENH] V1 → V2 API Migration - datasets #1608

Open

geetu040 approved these changes Mar 24, 2026

View reviewed changes

Merge branch 'main' into setups-mig

bc10ac6

PGijsbers requested changes Mar 24, 2026

View reviewed changes

geetu040 and others added 7 commits March 24, 2026 18:05

Update openml/_api/resources/setup.py

14f4853

openml#1619 (comment) Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>

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

ddf79ff

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

make private methods static

9575480

update v2 tests

80e8fd4

use uuid in tests

be4e652

Merge remote-tracking branch 'refs/remotes/eman/setups-mig' into setu…

fd1a5f4

…ps-mig

rerun ci

801c16f

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

PGijsbers left a comment

Choose a reason for hiding this comment

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

EmanAbdelhaleem commented Jan 20, 2026 •

edited

Loading

codecov-commenter commented Jan 20, 2026 •

edited

Loading