[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 43.11927% with 62 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.67%. Comparing base (e653ef6) to head (d0d8f17).

Files with missing lines	Patch %	Lines
openml/_api/resources/flow.py	44.18%	48 Missing ⚠️
openml/flows/flow.py	26.66%	11 Missing ⚠️
openml/flows/functions.py	62.50%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1609      +/-   ##
==========================================
- Coverage   54.67%   54.67%   -0.01%     
==========================================
  Files          63       63              
  Lines        5108     5149      +41     
==========================================
+ Hits         2793     2815      +22     
- Misses       2315     2334      +19

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

openml/_api/resources/base.py

openml/_api/resources/base/resources.py

openml/_api/resources/flows.py

openml/_api/resources/flow.py

openml/flows/functions.py

tests/test_flows/test_flow_functions.py

tests/test_flows/test_flow_migration.py

openml/_api/resources/flows.py

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.

openml/_api/resources/flows.py

openml/flows/functions.py

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

…-stacked

This reverts commit 2896b41.

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

Copilot

Pull request overview

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

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

Copilot · 2026-03-23T18:55:32Z

openml/_api/resources/flow.py

+        data = {"name": name, "external_version": external_version, "api_key": self._http.api_key}
+        xml_response = self._http.post("flow/exists", data=data).text


FlowV1API.exists() calls HTTPClient.post() with the default use_api_key=True, which raises OpenMLAuthenticationError when no API key is configured. The legacy flow/exists endpoint worked without an API key (it only included api_key when present), so this is a behavior regression for anonymous users. Consider calling self._http.post(..., use_api_key=False) and omit api_key from the payload (or make auth optional).

Suggested change

data = {"name": name, "external_version": external_version, "api_key": self._http.api_key}

xml_response = self._http.post("flow/exists", data=data).text

data = {"name": name, "external_version": external_version}

if self._http.api_key:

data["api_key"] = self._http.api_key

xml_response = self._http.post("flow/exists", data=data, use_api_key=False).text

Copilot · 2026-03-23T18:55:32Z

openml/_api/resources/flow.py

+        if not (isinstance(name, str) and len(name) > 0):
+            raise ValueError("Argument 'name' should be a non-empty string")
+        if not (isinstance(external_version, str) and len(external_version) > 0):
+            raise ValueError("Argument 'version' should be a non-empty string")
+
+        try:
+            response = self._http.get(f"flows/exists/{name}/{external_version}/")
+            result = response.json()


FlowV2API.exists() interpolates name and external_version directly into the URL path. These values can contain characters that require URL escaping, which can break requests or cause ambiguous routing. Quote/escape each path segment (e.g., urllib.parse.quote) or send them as query parameters if supported by the v2 endpoint.

Copilot · 2026-03-23T18:55:32Z

openml/flows/functions.py

 import xmltodict

+import openml
 import openml._api_calls


openml._api_calls is imported but no longer used in this module after switching to the new backend APIs. This will fail linting/static checks; please remove the unused import.

Suggested change

import openml._api_calls

Copilot · 2026-03-23T18:55:33Z

tests/test_flows/test_flow.py

-from openml._api_calls import _perform_api_call
-from openml.testing import SimpleImputer, TestBase
+import requests
+from openml.testing import SimpleImputer, TestBase, create_request_response


Unused import: create_request_response is imported but not used anywhere in this test file. Please remove it to keep the test module clean and avoid lint failures.

Suggested change

from openml.testing import SimpleImputer, TestBase, create_request_response

from openml.testing import SimpleImputer, TestBase

Copilot · 2026-03-23T18:55:33Z

tests/test_api/test_flow.py

+        mock_request.assert_called_once_with(
+            method="POST",
+            url=openml.config.server + "flow/exists",
+            params={},
+            data={
+                "name": flow_name,
+                "external_version": external_version,
+                "api_key": test_apikey_v1,
+            },
+            headers=openml.config._HEADERS,
+            files=None,
+        )
+
+


This test asserts that FlowV1API.exists() sends api_key inside the POST body. If FlowV1API.exists() is adjusted to not require authentication (and rely on HTTPClient to include api_key only when configured), this assertion will become incorrect. Consider relaxing the assertion to not require api_key for the exists call (or explicitly set use_api_key=False in the implementation and test for that behavior).

Suggested change

mock_request.assert_called_once_with(

method="POST",

url=openml.config.server + "flow/exists",

params={},

data={

"name": flow_name,

"external_version": external_version,

"api_key": test_apikey_v1,

},

headers=openml.config._HEADERS,

files=None,

)

mock_request.assert_called_once()

_, kwargs = mock_request.call_args

assert kwargs["method"] == "POST"

assert kwargs["url"] == openml.config.server + "flow/exists"

assert kwargs["params"] == {}

assert kwargs["headers"] == openml.config._HEADERS

assert kwargs["files"] is None

assert kwargs["data"]["name"] == flow_name

assert kwargs["data"]["external_version"] == external_version

Copilot · 2026-03-23T18:55:33Z

openml/flows/functions.py

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


Docstring around ignore_cache/caching behavior still refers to downloading/overwriting a flow.xml file in cache_directory/flows/{id}. Since get_flow() now delegates to HTTPClient caching (request-path-based cache entries), please update the docstring wording to match the new cache mechanism (or avoid specifying the on-disk layout).

Copilot · 2026-03-23T18:55:33Z

tests/test_flows/test_flow.py

-        flow_exists_mock.return_value = False
+        ).encode()
+        mock_request.return_value = response
+        flow_exists_mock.return_value = None  # Flow doesn't exist yet, so try to publish


flow_exists() is documented/typed to return int | bool (with False indicating non-existence). This test sets flow_exists_mock.return_value = None, which is outside the contract and can mask type/logic issues. Please return False here to match the real API behavior and keep the test faithful to production semantics.

Suggested change

flow_exists_mock.return_value = None # Flow doesn't exist yet, so try to publish

flow_exists_mock.return_value = False # Flow doesn't exist yet, so try to publish

Copilot · 2026-03-23T18:55:33Z

openml/flows/functions.py

    >>> openml.flows.delete_flow(23)  # doctest: +SKIP
    """
-    return openml.utils._delete_entity("flow", flow_id)
+    return openml._backend.flow.delete(flow_id)  # type: ignore


This # type: ignore on the return from openml._backend.flow.delete(flow_id) looks unnecessary now that FlowAPI inherits delete() from ResourceAPI. If type checking is complaining, it may be better to fix the underlying type (e.g., ensure FlowAPI exposes delete with the right signature) rather than suppressing it here.

Suggested change

return openml._backend.flow.delete(flow_id) # type: ignore

return openml._backend.flow.delete(flow_id)

Copilot · 2026-03-23T18:55:34Z

openml/flows/functions.py

 FLOWS_CACHE_DIR_NAME = "flows"




FLOWS_CACHE_DIR_NAME is now unused after removing the filesystem flow cache helpers. Please remove it (and any related unused imports) to avoid lint/static-analysis failures.

Suggested change

FLOWS_CACHE_DIR_NAME = "flows"

openml/_api/clients/http.py

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

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 · 2026-03-24T17:20:49Z

openml/_api/resources/flow.py

+        except (OpenMLServerError, KeyError):
+            # v2 returns 404 when flow doesn't exist, which raises OpenMLServerError
+            return False


FlowV2API.exists() currently catches OpenMLServerError and returns False, which will also hide real failures (e.g., authentication/authorization problems, 500s) by reporting "flow does not exist". Only treat the specific "not found" case as non-existence (e.g., catch OpenMLServerNoResult / an OpenMLServerException with the v2 not-found code or 404) and re-raise all other exceptions.

Suggested change

except (OpenMLServerError, KeyError):

# v2 returns 404 when flow doesn't exist, which raises OpenMLServerError

return False

except OpenMLServerError as err:

# v2 returns HTTP 404 when the flow doesn't exist; only treat that case

# as "not found" and propagate all other server errors.

if getattr(err, "code", None) == 404:

return False

raise

Copilot · 2026-03-24T17:20:49Z

openml/flows/flow.py

+        if self.flow_id is None:
+            raise ValueError("Flow does not have an ID. Please publish the flow before untagging.")
+        openml._backend.flow.untag(self.flow_id, tag)


Same as push_tag(): raising ValueError for an unpublished flow changes the public exception contract compared to OpenMLBase.remove_tag() (which raises ObjectNotPublishedError). Align the exception type/message (or delegate to the base implementation) for consistency across entities.

Copilot · 2026-03-24T17:20:50Z

tests/test_flows/test_flow.py

-        flow_exists_mock.return_value = False
+        ).encode()
+        mock_request.return_value = response
+        flow_exists_mock.return_value = None  # Flow doesn't exist yet, so try to publish


flow_exists_mock is typed/used as int | bool across the codebase; returning None here can mask type/logic issues (e.g., code paths that explicitly check is False). Prefer returning False to represent non-existence.

Suggested change

flow_exists_mock.return_value = None # Flow doesn't exist yet, so try to publish

flow_exists_mock.return_value = False # Flow doesn't exist yet, so try to publish

Copilot · 2026-03-24T17:20:50Z

tests/test_flows/test_flow_functions.py

+    openml.config.start_using_configuration_for_example()
    content_file = test_files_directory / "mock_responses" / "flows" / "flow_delete_not_owned.xml"


start_using_configuration_for_example() emits a warning and mutates global config state; this test suite already uses the with_server autouse fixture to switch to test servers. Consider removing this call (and the other occurrences below) to avoid unnecessary warnings/global state changes, or ensure you restore the prior config via stop_using_configuration_for_example() in a finally block.

Copilot · 2026-03-24T17:20:50Z

tests/test_flows/test_flow_functions.py

-def test_delete_flow_with_run(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_flow_with_run(mock_request, test_files_directory, test_apikey_v1):
+    openml.config.start_using_configuration_for_example()


Same issue as above: start_using_configuration_for_example() is redundant here (given the autouse server fixtures) and adds warnings/global state mutation. Prefer relying on fixtures or restoring config after the test.

Copilot · 2026-03-24T17:20:51Z

tests/test_api/test_flow.py

+    ):
+        flow_v2.publish(path="flow", files={"description": "<flow/>"})
+
+


flow_v1.get(...) here triggers a real HTTP request (and the test output depends on live server state). Please mark this as @pytest.mark.test_server() or mock the V1 GET response so this comparison test is deterministic/offline.

Suggested change

@pytest.mark.test_server()

Copilot · 2026-03-24T17:20:51Z

openml/flows/flow.py

+        if self.flow_id is None:
+            raise ValueError("Flow does not have an ID. Please publish the flow before tagging.")
+        openml._backend.flow.tag(self.flow_id, tag)
+


OpenMLBase.push_tag() raises ObjectNotPublishedError when the entity has no server id. This override raises ValueError instead, which is an observable API behavior change for flows. Consider preserving the exception type/message (e.g., raise openml.exceptions.ObjectNotPublishedError here, or delegate to the base implementation) so tagging an unpublished flow behaves consistently with other OpenML entities.

Copilot · 2026-03-24T17:20:51Z

tests/test_flows/test_flow_functions.py

-def test_delete_subflow(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_subflow(mock_request, test_files_directory, test_apikey_v1):
+    openml.config.start_using_configuration_for_example()


Same issue as above: start_using_configuration_for_example() is redundant here (given the autouse server fixtures) and adds warnings/global state mutation. Prefer relying on fixtures or restoring config after the test.

Copilot · 2026-03-24T17:20:52Z

tests/test_flows/test_flow_functions.py

-def test_delete_flow_success(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_flow_success(mock_request, test_files_directory, test_apikey_v1):
+    openml.config.start_using_configuration_for_example()


Same issue as above: start_using_configuration_for_example() is redundant here (given the autouse server fixtures) and adds warnings/global state mutation. Prefer relying on fixtures or restoring config after the test.

Copilot · 2026-03-24T17:20:52Z

tests/test_flows/test_flow_functions.py

 @pytest.mark.xfail(reason="failures_issue_1544", strict=False)
-def test_delete_unknown_flow(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+def test_delete_unknown_flow(mock_request, test_files_directory, test_apikey_v1):
+    openml.config.start_using_configuration_for_example()


Same issue as above: start_using_configuration_for_example() is redundant here (given the autouse server fixtures) and adds warnings/global state mutation. Prefer relying on fixtures or restoring config after the test.

geetu040 · 2026-03-25T14:20:38Z

openml/flows/functions.py

+    flow_id: int,
+    reinstantiate: bool = False,  # noqa: FBT002
+    strict_version: bool = True,  # noqa: FBT002
+    ignore_cache: bool = False,  # noqa: FBT002


I would not recommend adding this parameter: ignore_cache

Suggested change

ignore_cache: bool = False, # noqa: FBT002

geetu040 · 2026-03-25T14:20:46Z

openml/flows/functions.py

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


as said above

Suggested change

geetu040 · 2026-03-25T14:20:49Z

openml/flows/functions.py

    """
    flow_id = int(flow_id)
-    flow = _get_flow_description(flow_id)
+    flow = openml._backend.flow.get(flow_id, reset_cache=ignore_cache)


as said above

Suggested change

flow = openml._backend.flow.get(flow_id, reset_cache=ignore_cache)

flow = openml._backend.flow.get(flow_id)

geetu040 · 2026-03-25T14:20:50Z

openml/flows/functions.py

-
-        return _create_flow_from_xml(flow_xml)
+                return cast("OpenMLFlow", new_flow)
+    return cast("OpenMLFlow", flow)


no need for explicit cast now

Suggested change

return cast("OpenMLFlow", flow)

return new_flow

return flow

geetu040 · 2026-03-25T14:20:53Z

openml/flows/functions.py

    if not (isinstance(name, str) and len(name) > 0):
        raise ValueError("Argument 'name' should be a non-empty string")
-    if not (isinstance(name, str) and len(external_version) > 0):
+    if not (isinstance(external_version, str) and len(external_version) > 0):


Suggested change

if not (isinstance(external_version, str) and len(external_version) > 0):

if not (isinstance(name, str) and len(external_version) > 0):

geetu040 · 2026-03-25T14:21:15Z

tests/test_flows/test_flow_functions.py

-@mock.patch.object(requests.Session, "delete")
-def test_delete_flow_not_owned(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_flow_not_owned(mock_request, test_files_directory, test_apikey_v1):


there is no need for openml.config.start_using_configuration_for_example()

keep test_server_v1 in params

you have removed the check for url

geetu040 · 2026-03-25T14:21:18Z

tests/test_flows/test_flow_functions.py

-@mock.patch.object(requests.Session, "delete")
-def test_delete_flow_with_run(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_flow_with_run(mock_request, test_files_directory, test_apikey_v1):


same as above

geetu040 · 2026-03-25T14:21:20Z

tests/test_flows/test_flow_functions.py

-@mock.patch.object(requests.Session, "delete")
-def test_delete_subflow(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_subflow(mock_request, test_files_directory, test_apikey_v1):


same as above

geetu040 · 2026-03-25T14:21:23Z

tests/test_flows/test_flow_functions.py

-@mock.patch.object(requests.Session, "delete")
-def test_delete_flow_success(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):
+@mock.patch.object(requests.Session, "request")
+def test_delete_flow_success(mock_request, test_files_directory, test_apikey_v1):


same as above

geetu040 · 2026-03-25T14:21:25Z

tests/test_flows/test_flow_functions.py

-@mock.patch.object(requests.Session, "delete")
+@mock.patch.object(requests.Session, "request")
 @pytest.mark.xfail(reason="failures_issue_1544", strict=False)
-def test_delete_unknown_flow(mock_delete, test_files_directory, test_server_v1, test_apikey_v1):


same as above

geetu040 · 2026-03-25T15:55:42Z

openml/_api/resources/flow.py

+            The server-assigned flow id.
+        """
+        path = "flow"
+        return super().publish(path, files)


not needed

Suggested change

return super().publish(path, files)

geetu040 · 2026-03-25T15:55:46Z

openml/flows/flow.py

-            super().publish()
-            assert self.flow_id is not None  # for mypy
-            flow_id = self.flow_id
+
+            file_elements = self._get_file_elements()
+            if "description" not in file_elements:
+                file_elements["description"] = self._to_xml()
+
+            # Use openml._backend.flow.publish which internally calls ResourceV1.publish
+            flow_id = openml._backend.flow.publish(path="flow", files=file_elements)
+            self.flow_id = flow_id


nice, this is how it's expected to work

geetu040 · 2026-03-25T15:55:48Z

openml/flows/flow.py

+            Tag to attach to the flow.
+        """
+        if self.flow_id is None:
+            raise ValueError("Flow does not have an ID. Please publish the flow before tagging.")


use ObjectNotPublishedError as in _tag_openml_base

geetu040 · 2026-03-25T15:55:51Z

openml/flows/flow.py

+            Tag to remove from the flow.
+        """
+        if self.flow_id is None:
+            raise ValueError("Flow does not have an ID. Please publish the flow before untagging.")


use ObjectNotPublishedError as in _tag_openml_base

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.

Copilot · 2026-03-31T14:32:10Z

tests/test_api/test_flow.py

+def test_flow_v1_get(flow_v1):
+    flow = flow_v1.get(flow_id=1)
+    _assert_flow_shape(flow)
+
+
+def test_flow_v1_list(flow_v1):
+    limit = 5
+    flows_df = flow_v1.list(limit=limit)
+
+    assert len(flows_df) == limit
+    assert "id" in flows_df.columns
+    assert "name" in flows_df.columns
+    assert "version" in flows_df.columns
+    assert "external_version" in flows_df.columns
+    assert "full_name" in flows_df.columns
+    assert "uploader" in flows_df.columns
+
+
+def test_flow_v1_list_with_offset(flow_v1):
+    limit = 5
+    flows_df = flow_v1.list(limit=limit, offset=10)
+
+    assert len(flows_df) == limit
+


These tests call the real test server (flow_v1.get/list) but are missing the @pytest.mark.test_server() marker that other API tests use. Without the marker they’ll run in offline/unit-only environments and fail due to network dependency; either mark them as test_server or mock Session.request like the other tests in this file.

Copilot · 2026-03-31T14:32:11Z

tests/test_flows/test_flow.py

+        response = requests.Response()
+        response.status_code = 200
+        response._content = (
            "<oml:upload_flow>\n" "    <oml:id>1</oml:id>\n" "</oml:upload_flow>"


The mocked upload XML in this test uses the oml: prefix but does not declare the xmlns:oml namespace, which makes the XML invalid and will cause xmltodict.parse() (used by ResourceV1API.publish) to fail with an “unbound prefix” parse error. Use a valid response payload (e.g., include xmlns:oml="http://openml.org/openml" like other tests do, or reuse create_request_response fixtures).

Suggested change

"<oml:upload_flow>\n" " <oml:id>1</oml:id>\n" "</oml:upload_flow>"

'<oml:upload_flow xmlns:oml="http://openml.org/openml">\n'

" <oml:id>1</oml:id>\n"

"</oml:upload_flow>"

Copilot · 2026-03-31T14:32:11Z

tests/test_flows/test_flow.py

-from openml._api_calls import _perform_api_call
-from openml.testing import SimpleImputer, TestBase
+import requests
+from openml.testing import SimpleImputer, TestBase, create_request_response


create_request_response is imported here but not used anywhere in this test module after the refactor. Please drop the unused import to keep the test file clean and avoid lint failures.

Suggested change

from openml.testing import SimpleImputer, TestBase, create_request_response

from openml.testing import SimpleImputer, TestBase

Copilot · 2026-03-31T14:32:11Z

tests/test_flows/test_flow_functions.py

@@ -466,15 +467,15 @@ def test_delete_flow_not_owned(mock_delete, test_files_directory, test_server_v1
    ):
        openml.flows.delete_flow(40_000)

-    flow_url = test_server_v1 + "flow/40000"
-    assert flow_url == mock_delete.call_args.args[0]
-    assert test_apikey_v1 == mock_delete.call_args.kwargs.get("params", {}).get("api_key")
+    assert mock_request.call_args.kwargs.get("method") == "DELETE"
+    assert test_apikey_v1 == mock_request.call_args.kwargs.get("params", {}).get("api_key")


These delete_flow unit tests now only assert the HTTP method and api_key, but they no longer assert the request URL/path. Given other HTTPClient tests assert the full URL, this weakens coverage and could miss regressions in endpoint construction; also, start_using_configuration_for_example() emits warnings and is redundant here since the autouse fixture already configures test servers. Prefer asserting the url kwarg and using openml.config.use_test_servers()/existing fixtures instead of start_using_configuration_for_example().

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

Copilot · 2026-03-31T17:53:50Z

openml/_api/resources/flow.py

+    @staticmethod
+    def _convert_v2_to_v1_format(v2_json: dict[str, Any]) -> dict[str, dict]:
+        """Convert v2 JSON response to v1 XML-dict format for OpenMLFlow._from_dict().
+


_convert_v2_to_v1_format is annotated as returning dict[str, dict], but the returned structure contains non-dict values (e.g., strings, lists). This type annotation is incorrect and can break static type checking; consider using dict[str, Any] or dict[str, dict[str, Any]] (or a dedicated TypedDict) instead.

Copilot · 2026-03-31T17:53:52Z

tests/test_flows/test_flow.py

        TestBase._mark_entity_for_removal("flow", flow.flow_id, flow.name)
        TestBase.logger.info(f"collected from {__file__.split('/')[-1]}: {flow.flow_id}")

+


This blank line contains trailing whitespace. Please remove the whitespace to satisfy common linters (e.g., W293) and keep diffs clean.

Suggested change

Copilot · 2026-03-31T17:53:53Z

tests/test_flows/test_flow.py

        model = sklearn.ensemble.RandomForestClassifier()
        flow = self.extension.model_to_flow(model)
-        api_call_mock.return_value = (
+


This blank line contains trailing whitespace. Please remove the whitespace to satisfy common linters (e.g., W293) and keep diffs clean.

Copilot · 2026-03-31T17:53:54Z

tests/test_flows/test_flow.py

        get_flow_mock.return_value = flow

        flow.publish()
        # Not collecting flow_id for deletion since this is a test for failed upload


The comment says this is a test for a “failed upload”, but the mocked response is a successful <oml:upload_flow> with an id and flow.publish() is expected to succeed initially. Please update/remove the comment to reflect the actual test behavior.

Suggested change

# Not collecting flow_id for deletion since this is a test for failed upload

# The first publish is expected to succeed; cleanup is handled after the error scenario

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

openml/_api/resources/flows.py Outdated Show resolved Hide resolved

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

openml/_api/resources/flows.py Outdated Show resolved Hide resolved

openml/flows/functions.py Outdated Show resolved Hide resolved

openml/flows/functions.py Outdated Show resolved Hide resolved

geetu040 assigned Omswastik-11 Jan 19, 2026

geetu040 and others added 2 commits January 21, 2026 13:36

refactor clients

5c4511e

migrating v1 -> v2 flows

29fac2c

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

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

Omswastik-11 and others added 9 commits January 22, 2026 00:01

migrating v1 -> v2 flows

bdf53f3

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

Merge branch 'main' into issue1564

9d0098f

Merge branch 'main' into flow-migration-stacked

a1a706c

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 4 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

Omswastik-11 added 5 commits March 23, 2026 23:35

Merge branch 'main' into flow-migration-stacked

d274cb5

updated the tests

2896b41

Revert "updated the tests"

df67df1

This reverts commit 2896b41.

updated the tests

2a7e9ce

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

d0dc185

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

Copilot AI review requested due to automatic review settings March 23, 2026 18:45

Copilot started reviewing on behalf of Omswastik-11 March 23, 2026 18:45 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

updated the test_flow

3eabc19

geetu040 suggested changes Mar 24, 2026

View reviewed changes

openml/_api/clients/http.py Outdated Show resolved Hide resolved

merge the changes

299cbda

Copilot AI review requested due to automatic review settings March 24, 2026 17:10

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

Omswastik-11 and others added 2 commits March 24, 2026 22:47

Merge branch 'main' into flow-migration-stacked

a942d52

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

b89a084

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

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

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

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

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

		data = {"name": name, "external_version": external_version, "api_key": self._http.api_key}
		xml_response = self._http.post("flow/exists", data=data).text

-        data = {"name": name, "external_version": external_version, "api_key": self._http.api_key}
-        xml_response = self._http.post("flow/exists", data=data).text
+        data = {"name": name, "external_version": external_version}
+        if self._http.api_key:
+            data["api_key"] = self._http.api_key
+        xml_response = self._http.post("flow/exists", data=data, use_api_key=False).text

	from openml.testing import SimpleImputer, TestBase, create_request_response
	from openml.testing import SimpleImputer, TestBase

	flow_exists_mock.return_value = None # Flow doesn't exist yet, so try to publish
	flow_exists_mock.return_value = False # Flow doesn't exist yet, so try to publish

	return openml._backend.flow.delete(flow_id) # type: ignore
	return openml._backend.flow.delete(flow_id)

		openml.config.start_using_configuration_for_example()
		content_file = test_files_directory / "mock_responses" / "flows" / "flow_delete_not_owned.xml"

		):
		flow_v2.publish(path="flow", files={"description": "<flow/>"})

	flow = openml._backend.flow.get(flow_id, reset_cache=ignore_cache)
	flow = openml._backend.flow.get(flow_id)

	if not (isinstance(external_version, str) and len(external_version) > 0):
	if not (isinstance(name, str) and len(external_version) > 0):

		TestBase._mark_entity_for_removal("flow", flow.flow_id, flow.name)
		TestBase.logger.info(f"collected from {__file__.split('/')[-1]}: {flow.flow_id}")

	# Not collecting flow_id for deletion since this is a test for failed upload
	# The first publish is expected to succeed; cleanup is handled after the error scenario

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!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Omswastik-11 commented Jan 8, 2026 •

edited

Loading

codecov-commenter commented Jan 12, 2026 •

edited

Loading