[ENH] V1 -> V2 Migration - Flows (module) by Omswastik-11 · Pull Request #1609 · openml/openml-python

Omswastik-11 · 2026-01-08T12:58:31Z

added a Create method in FlowAPI for publishing flow but not refactored with old publish . (Needs discussion on this)
Added tests using fake_methods so that we can test without local V2 server . I have tested the FlowsV2 methods (get and exists ) and delete and list were not implemented in V2 server so I skipped them .

codecov-commenter · 2026-01-12T13:26:15Z

Codecov Report

❌ Patch coverage is 39.82301% with 68 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.57%. Comparing base (e653ef6) to head (18baa19).

Files with missing lines	Patch %	Lines
openml/_api/resources/flow.py	40.21%	55 Missing ⚠️
openml/flows/flow.py	26.66%	11 Missing ⚠️
openml/flows/functions.py	66.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1609      +/-   ##
==========================================
- Coverage   54.67%   54.57%   -0.11%     
==========================================
  Files          63       63              
  Lines        5108     5153      +45     
==========================================
+ Hits         2793     2812      +19     
- Misses       2315     2341      +26

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

geetu040

Nicely done overall.

Omswastik-11 · 2026-01-14T18:01:01Z

Hi @geetu040 !! Can you review the pre-commit failure It was due to merge conflicts more specifically for tasks . Should I change it on my branch ?

geetu040 · 2026-01-15T09:54:51Z

Hi @geetu040 !! Can you review the pre-commit failure It was due to merge conflicts more specifically for tasks . Should I change it on my branch ?

can you try again, sync your branch with mine? It should be fixed now.

Omswastik-11 · 2026-01-15T10:14:00Z

I think that due to conflicts it did not synced properly . I have to revert it manually

geetu040

Nice overall, few changes needed. I'll look at the tests later when the implementation is final.

…-stacked

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

…into flow-migration-stacked # Conflicts: # openml/_api/resources/__init__.py # openml/_api/resources/base/__init__.py # openml/_api/runtime/core.py

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 12 comments.

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

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

openml/flows/functions.py:67

get_flow’s docstring still describes the old per-flow XML cache (writing to cache_directory/flows/{flow_id}/flow.xml and raising OpenMLCacheException). The implementation now delegates to openml._backend.flow.get and uses HTTPClient caching, so the documented side effects/raised exceptions are no longer accurate; please update the docstring to match current behavior (and describe the new cache location/semantics if relevant).

    """Fetch an OpenMLFlow by its server-assigned ID.

    Queries the OpenML REST API for the flow metadata and returns an
    :class:`OpenMLFlow` instance. If the flow is already cached locally,
    the cached copy is returned. Optionally the flow can be re-instantiated
    into a concrete model instance using the registered extension.

    Parameters
    ----------
    flow_id : int
        The OpenML flow id.
    reinstantiate : bool, optional (default=False)
        If True, convert the flow description into a concrete model instance
        using the flow's extension (e.g., sklearn). If conversion fails and
        ``strict_version`` is True, an exception will be raised.
    strict_version : bool, optional (default=True)
        When ``reinstantiate`` is True, whether to enforce exact version
        requirements for the extension/model. If False, a new flow may
        be returned when versions differ.

    ignore_cache : bool, default=False
        Whether to ignore the cache. If ``true`` this will download and overwrite the flow xml
        even if the requested flow is already cached.

    Returns
    -------
    OpenMLFlow
        The flow object with metadata; ``model`` may be populated when
        ``reinstantiate=True``.

    Raises
    ------
    OpenMLCacheException
        When cached flow files are corrupted or cannot be read.
    OpenMLServerException
        When the REST API call fails.

    Side Effects
    ------------
    - Writes to ``openml.config.cache_directory/flows/{flow_id}/flow.xml``
      when the flow is downloaded from the server.

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

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

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

openml/flows/functions.py:59

The get_flow docstring still describes the legacy per-flow XML cache (openml.config.cache_directory/flows/{flow_id}/flow.xml) and lists OpenMLCacheException, but get_flow now delegates to openml._backend.flow.get(...) which uses the HTTP client cache instead. Please update the docstring (side effects + raises section) to match the new caching/error behavior.

    Queries the OpenML REST API for the flow metadata and returns an
    :class:`OpenMLFlow` instance. If the flow is already cached locally,
    the cached copy is returned. Optionally the flow can be re-instantiated
    into a concrete model instance using the registered extension.

    Parameters
    ----------
    flow_id : int
        The OpenML flow id.
    reinstantiate : bool, optional (default=False)
        If True, convert the flow description into a concrete model instance
        using the flow's extension (e.g., sklearn). If conversion fails and
        ``strict_version`` is True, an exception will be raised.
    strict_version : bool, optional (default=True)
        When ``reinstantiate`` is True, whether to enforce exact version
        requirements for the extension/model. If False, a new flow may
        be returned when versions differ.

    Returns
    -------
    OpenMLFlow
        The flow object with metadata; ``model`` may be populated when
        ``reinstantiate=True``.

    Raises
    ------
    OpenMLCacheException
        When cached flow files are corrupted or cannot be read.
    OpenMLServerException
        When the REST API call fails.

    Side Effects
    ------------
    - Writes to ``openml.config.cache_directory/flows/{flow_id}/flow.xml``
      when the flow is downloaded from the server.

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

Omswastik-11 · 2026-04-26T21:29:38Z

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

geetu040

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

I think this should be ready to merge once the remaining review comments are addressed:

Most of these are related to the tests. Other than that, the implementation looks good to me and should be ready for merge once those points are resolved.

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

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Comments suppressed due to low confidence (1)

openml/flows/functions.py:60

get_flow's docstring still references the removed flows-specific filesystem cache (e.g. .../flows/{flow_id}/flow.xml) and OpenMLCacheException, but the implementation now delegates to openml._backend.flow.get() (HTTP client cache) and no longer raises that exception. Please update the docstring (Raises/Side Effects/Notes) to reflect the new caching behavior and actual exceptions.

    Queries the OpenML REST API for the flow metadata and returns an
    :class:`OpenMLFlow` instance. If the flow is already cached locally,
    the cached copy is returned. Optionally the flow can be re-instantiated
    into a concrete model instance using the registered extension.

    Parameters
    ----------
    flow_id : int
        The OpenML flow id.
    reinstantiate : bool, optional (default=False)
        If True, convert the flow description into a concrete model instance
        using the flow's extension (e.g., sklearn). If conversion fails and
        ``strict_version`` is True, an exception will be raised.
    strict_version : bool, optional (default=True)
        When ``reinstantiate`` is True, whether to enforce exact version
        requirements for the extension/model. If False, a new flow may
        be returned when versions differ.

    Returns
    -------
    OpenMLFlow
        The flow object with metadata; ``model`` may be populated when
        ``reinstantiate=True``.

    Raises
    ------
    OpenMLCacheException
        When cached flow files are corrupted or cannot be read.
    OpenMLServerException
        When the REST API call fails.

    Side Effects
    ------------
    - Writes to ``openml.config.cache_directory/flows/{flow_id}/flow.xml``
      when the flow is downloaded from the server.

💡 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 flow-migration-stacked

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.

Omswastik-11 · 2026-05-02T13:22:39Z

I think Github is having some issues . The diff of this PR looks outdated
Hi @geetu040 !! Can you check the replies to reviews and the failing tests and let me know if any changes needed ?

Omswastik-11 changed the title ~~[ENH] V1 -> V2 Migration~~ [ENH] V1 -> V2 Migration - Flows (module) Jan 8, 2026

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

geetu040 mentioned this pull request Jan 9, 2026

[ENH] V1 → V2 API Migration #1575

Open

18 tasks

geetu040 suggested changes Jan 13, 2026

View reviewed changes

Omswastik-11 commented Jan 14, 2026

View reviewed changes

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

Omswastik-11 force-pushed the flow-migration-stacked branch from 614411f to 36184e5 Compare January 14, 2026 14:56

Omswastik-11 requested a review from geetu040 January 14, 2026 15:10

geetu040 suggested changes Jan 15, 2026

View reviewed changes

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

Comment thread openml/flows/functions.py Outdated

Comment thread openml/flows/functions.py Outdated

geetu040 assigned Omswastik-11 Jan 19, 2026

Omswastik-11 requested a review from geetu040 January 21, 2026 18:25

geetu040 and others added 6 commits January 23, 2026 12:17

fix import in resources/base.py

43276d2

refactor and add exception handling

1206f69

Merge branch 'main' into issue1564

bde5942

refactor resources/base/

4948e99

implement delete

a354167

Merge remote-tracking branch 'geetu040/migration' into flow-migration…

c4e713f

…-stacked

Omswastik-11 marked this pull request as draft January 27, 2026 07:30

Omswastik-11 and others added 5 commits January 27, 2026 13:00

Merge branch 'main' into flow-migration-stacked

95fc75f

implement publish and minor refactoring

1fe7e3e

implement tag/untag

54a3151

implement fallback

2b6fe65

added tests

685c19a

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

Omswastik-11 marked this pull request as ready for review January 27, 2026 15:13

Omswastik-11 and others added 3 commits January 28, 2026 12:51

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

920ff21

…into flow-migration-stacked # Conflicts: # openml/_api/resources/__init__.py # openml/_api/resources/base/__init__.py # openml/_api/runtime/core.py

add test_http.py

fa53f8d

add uses_test_server marker

2b2db96

Copilot AI reviewed Mar 24, 2026

View reviewed changes

geetu040 suggested changes Mar 25, 2026

View reviewed changes

Merge branch 'main' into flow-migration-stacked

67271be

geetu040 suggested changes Mar 25, 2026

View reviewed changes

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

Comment thread openml/flows/flow.py

Comment thread openml/flows/flow.py Outdated

Comment thread openml/flows/flow.py Outdated

Merge branch 'main' into flow-migration-stacked

de49f47

Copilot AI review requested due to automatic review settings March 31, 2026 14:20

Copilot started reviewing on behalf of Omswastik-11 March 31, 2026 14:20 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Comment thread tests/test_api/test_flow.py

Comment thread tests/test_flows/test_flow.py Outdated

Comment thread tests/test_flows/test_flow.py Outdated

Comment thread tests/test_flows/test_flow_functions.py

Omswastik-11 added 3 commits March 31, 2026 22:42

final changes

73b4893

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

d0d8f17

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

implement the suggestions

f9530f1

Copilot AI review requested due to automatic review settings March 31, 2026 17:45

Copilot started reviewing on behalf of Omswastik-11 March 31, 2026 17:46 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Comment thread openml/_api/resources/flow.py

Comment thread tests/test_flows/test_flow.py Outdated

Comment thread tests/test_flows/test_flow.py

Comment thread tests/test_flows/test_flow.py Outdated

Omswastik-11 requested a review from geetu040 March 31, 2026 17:55

geetu040 suggested changes May 1, 2026

View reviewed changes

Update openml/flows/functions.py

d9f9523

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

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

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

Copilot AI reviewed May 1, 2026

View reviewed changes

Comment thread openml/_api/resources/flow.py

Comment thread tests/test_api/test_flow.py

Comment thread openml/flows/functions.py

Comment thread openml/flows/flow.py

Comment thread openml/flows/flow.py

Comment thread openml/_api/resources/flow.py

Omswastik-11 added 3 commits May 1, 2026 17:34

remove old test changes and old mock tests

1c8bd58

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

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

57123f4

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

fix tests

f4e2bd2

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

Copilot AI review requested due to automatic review settings May 1, 2026 12:45

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

fix tests

18baa19

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

Omswastik-11 requested a review from geetu040 May 1, 2026 13:00

Copilot AI reviewed May 1, 2026

View reviewed changes

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Omswastik-11 commented Jan 14, 2026

Uh oh!

geetu040 commented Jan 15, 2026

Uh oh!

Omswastik-11 commented Jan 15, 2026

Uh oh!

geetu040 left a comment

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

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!

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

Uh oh!

Omswastik-11 commented Jan 8, 2026 •

edited

Loading

codecov-commenter commented Jan 12, 2026 •

edited

Loading

Omswastik-11 commented Apr 26, 2026 •

edited

Loading

Omswastik-11 commented May 2, 2026 •

edited

Loading