[ENH] Reduce complexity of `run_flow_on_task` func by Omswastik-11 · Pull Request #1596 · openml/openml-python

Omswastik-11 · 2026-01-04T12:23:08Z

Summary

This PR refactors run_flow_on_task, which had grown to ~160 lines with high cyclomatic complexity, by extracting small helper functions with clear, single responsibilities. The main function is now a readable orchestrator with clearly defined steps.

Changes

Extracted helper functions

_validate_flow_and_task_inputs
Handles input validation and backward-compatible argument handling
_sync_flow_with_server
Synchronizes the flow with the server and checks for duplicate runs
_prepare_run_environment
Prepares environment information and run tags
_create_run_from_results
Builds the OpenMLRun object from execution results

Internal structure improvements

Introduced a _RunResults NamedTuple to bundle execution outputs
(data_content, trace, evaluations) and reduce long parameter lists

Type Safety Improvements

Replaced assert statements with explicit ValueError / TypeError exceptions
Added type guards before accessing attributes that may be None
Made boolean parameters keyword-only where appropriate

Fixes #1580

codecov-commenter · 2026-01-06T12:43:32Z

Codecov Report

❌ Patch coverage is 9.37500% with 58 lines in your changes missing coverage. Please review.
✅ Project coverage is 51.95%. Comparing base (da993f7) to head (68f9d0d).

Files with missing lines	Patch %	Lines
openml/runs/functions.py	9.37%	58 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1596      +/-   ##
==========================================
- Coverage   53.09%   51.95%   -1.15%     
==========================================
  Files          37       37              
  Lines        4362     4383      +21     
==========================================
- Hits         2316     2277      -39     
- Misses       2046     2106      +60

☔ 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

Looks really nice, I have left a few comments with only minor changes requested.

openml/runs/functions.py

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

…ython into issue-1580

Omswastik-11 · 2026-01-13T09:25:29Z

added cast(int , task_id) because of mypy pre-commit error .

geetu040

Nicely refactored, LGTM.

CC: @fkiraly, @SimonBlanke for review/merge.

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

SimonBlanke

@Omswastik-11 Do you see a way to increase the test coverage here? This is not a hard requirement.

openml/runs/functions.py

geetu040

Actually there is no unit test for the function openml.runs.run_flow_on_task, could you please add one. There are some tests that use openml.runs.run_flow_on_task internally, but it would be nice to have an independent test that only checks this functionality. You can add this test in tests/test_runs.
Also if the helper functions in openml.runs.run_flow_on_task can be tested at unit (suggested in #1596 (review)), that would be nice, but again, it's not a hard requirement.

geetu040

LGTM!
@fkiraly please review/merge.

fkiraly · 2026-02-16T16:00:23Z

openml/runs/functions.py

+        task, flow = flow, task
+
+    if not isinstance(flow, OpenMLFlow):
+        raise TypeError("Flow must be OpenMLFlow after validation")


please include error location, and correct reference to variable

fkiraly · 2026-02-16T16:00:38Z

openml/runs/functions.py

+    if isinstance(flow, OpenMLTask) and isinstance(task, OpenMLFlow):
+        # We want to allow either order of argument (to avoid confusion).
+        warnings.warn(
+            "The old argument order (Flow, model) is deprecated and "


please capitalize variable names correctly. Include source of warning.

fkiraly · 2026-02-16T16:03:12Z

openml/runs/functions.py

+    """
+    # We only need to sync with the server right now if we want to upload the flow,
+    # or ensure no duplicate runs exist. Otherwise it can be synced at upload time.
+    flow_id = None


code smell, too many indentations. Please simplify this further

fkiraly · 2026-02-16T16:03:56Z

openml/runs/functions.py

+    # We only need to sync with the server right now if we want to upload the flow,
+    # or ensure no duplicate runs exist. Otherwise it can be synced at upload time.
+    flow_id = None
+    if upload_flow or avoid_duplicate_runs:


for example, this could be if not upload_flow and not avoid_duplicate_runs: return flow_id, then one indentation less below.

fkiraly · 2026-02-16T16:04:46Z

openml/runs/functions.py

+        task=task,
+        flow=flow,
        flow_id=flow_id,
-        dataset_id=dataset.dataset_id,


why is it fine to delete these args?

fkiraly

Nice! I left some recommendations on how to further simplify the code flow.

Omswastik-11 added 2 commits January 4, 2026 17:51

reduce complexity of un_on_flow func

35b0977

Merge branch 'main' into issue-1580

5a4a089

Omswastik-11 marked this pull request as ready for review January 5, 2026 14:14

Merge branch 'main' into pr/1596

1a006fb

geetu040 suggested changes Jan 12, 2026

View reviewed changes

Omswastik-11 added 3 commits January 13, 2026 12:30

refactor the helping functions for un_on_flow func

93aa877

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

Merge branch 'issue-1580' of https://github.com/Omswastik-11/openml-p…

331b4be

…ython into issue-1580

remove redudandent checkings

6771fb4

Omswastik-11 requested a review from geetu040 January 13, 2026 09:23

geetu040 approved these changes Jan 13, 2026

View reviewed changes

Omswastik-11 and others added 4 commits January 14, 2026 16:44

Merge branch 'main' into issue-1580

22f52a8

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

04a6e0f

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

Merge branch 'main' into issue-1580

d3460d0

Merge branch 'main' into issue-1580

1ec0302

SimonBlanke suggested changes Jan 17, 2026

View reviewed changes

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

geetu040 assigned Omswastik-11 Jan 19, 2026

Omswastik-11 added 2 commits January 26, 2026 15:42

Merge branch 'main' into issue-1580

df9a36a

Merge branch 'main' into issue-1580

cefae00

geetu040 suggested changes Feb 4, 2026

View reviewed changes

Omswastik-11 requested a review from geetu040 February 12, 2026 11:22

Omswastik-11 added 2 commits February 12, 2026 17:02

added the tests

8d05331

correct the tests

5a683da

geetu040 approved these changes Feb 12, 2026

View reviewed changes

fkiraly reviewed Feb 16, 2026

View reviewed changes

fkiraly requested changes Feb 16, 2026

View reviewed changes

Omswastik-11 added 5 commits February 16, 2026 23:08

Merge branch 'main' into issue-1580

c56e49d

Merge branch 'main' into issue-1580

111c134

improve error messages and simplfy the control flow

c80b6c2

merge

cfe048c

Merge branch 'main' into issue-1580

68f9d0d

Omswastik-11 requested a review from fkiraly February 17, 2026 08:53

Uh oh!

Conversation

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

Uh oh!

Summary

Changes

Extracted helper functions

Internal structure improvements

Type Safety Improvements

Uh oh!

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

Omswastik-11 commented Jan 13, 2026

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

SimonBlanke left a comment

Choose a reason for hiding this comment

Uh oh!

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!

fkiraly Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

fkiraly Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

fkiraly Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

fkiraly Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

fkiraly Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

fkiraly left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Omswastik-11 commented Jan 4, 2026 •

edited

Loading

codecov-commenter commented Jan 6, 2026 •

edited

Loading