Makes ewoksorange.gui.owwidgets.thread returning `TaskFuture` by payno · Pull Request #406 · ewoks-kit/ewoksorange

payno · 2026-06-30T11:42:21Z

This PR benefits from the ewoksorange.gui.concurrency.executor module.

#405 to be merged first.

widgets from ewoksorange.gui.concurrency.threaded now use the executors from ewoksorange.gui.concurrency.executor
execute_ewoks_task API now return a ̀TaskFuture ̀ that we can cancel or abort.

Note to reviewers: as the ewoksorange.gui.owwidgets.threaded module contains a lot of modification this is probably simpler to look at the existing code today than on the diff.

Note on AI: spend some time to force Claude do what I wanted 😇 .

codecov · 2026-06-30T11:45:08Z

Codecov Report

❌ Patch coverage is 85.58559% with 16 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/ewoksorange/gui/owwidgets/threaded.py	91.04%	6 Missing ⚠️
src/ewoksorange/gui/concurrency/threaded.py	0.00%	4 Missing ⚠️
.../gui/concurrency/executor/_EwoksCompletedWorker.py	66.66%	2 Missing ⚠️
src/ewoksorange/gui/concurrency/queued.py	0.00%	2 Missing ⚠️
src/ewoksorange/gui/owwidgets/base.py	71.42%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

payno · 2026-06-30T11:47:46Z

@@ -0,0 +1,9 @@
+class CompletedWorker:


This worker has been added for the specific use case of the OWEwoksWidgetNoThread and in order to propose an homogeneous API (_execute_ewoks_task return a TaskFuture whenever possible)

payno · 2026-06-30T11:51:49Z

+            exception = e
            _logger.error(f"task failed: {e}", exc_info=True)
+        else:
+            exception = None
+


The exception is needed to fill the '_CompletedWorker' downstream.

payno · 2026-06-30T11:59:30Z

+        raw_future = _ConcurrentFuture()
+        if exception is not None:
+            raw_future.set_exception(exception)
+        else:
+            raw_future.set_result(self.__task_executor.output_variables)
+        return TaskFuture(raw_future, _CompletedWorker())


Build a dummy TaskFuture to make sure we have a coherent API.

payno · 2026-06-30T12:45:03Z

-class OWEwoksWidgetOneThread(_OWEwoksThreadedBaseWidget, **ow_build_opts):
-    """
-    Single persistent background thread for task execution.
+class _OWEwoksExecutorWidget(_OWEwoksThreadedBaseWidget, **ow_build_opts):


One of the main advantage of using the executor into a dedicated module is that we can have a widget that can be generalized and from which only the "executor" is changed.

payno · 2026-06-30T12:46:14Z

+        # Note: all the following variable to be removed since executor refactoring
+        self.__current_task_future: Optional[TaskFuture] = None
+        self.__last_output_variables: dict = {}
+        self.__last_task_succeeded: Optional[bool] = None
+        self.__last_task_done: Optional[bool] = None
+        self.__last_task_exception: Optional[Exception] = None


With the new design I think at one point we could get rid of those. It would simplify things and is more aligned with "expectation".

I started to reduce usage but this is not that straightforward so I just added a warning for future.

payno · 2026-06-30T12:54:51Z

    def task_succeeded(self) -> Optional[bool]:
+        warnings.warn(
+            f"'task_succeeded' is deprecated since 6.0 Please use directly the future provided during task submission.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
        return self.__last_task_succeeded

    @property
    def task_done(self) -> Optional[bool]:
+        warnings.warn(
+            f"'task_done' is deprecated since 6.0 Please use directly the future provided during task submission.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
        return self.__last_task_done

    @property
    def task_exception(self) -> Optional[Exception]:
+        warnings.warn(
+            f"'task_exception' is deprecated since 6.0 Please use directly the future provided during task submission.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
        return self.__last_task_exception

    def _get_task_outputs(self) -> dict:
-        """Return the last finished task's outputs."""
+        warnings.warn(
+            f"'cancel_running_task' is deprecated since 6.0 Please use directly the future provided during task submission.",
+            DeprecationWarning,
+            stacklevel=2,
+        )


Those are using internally one of the following variables that we would like to remove in the future:

__current_task_future

__last_output_variables

__last_task_succeeded

__last_task_done

__last_task_exception

The best would be to able to deprecate them all and use the ̀TaskFuture ̀ instead but this is not that direct so I only reduce usage of it when this was direct.
To be considered in the future.

payno · 2026-06-30T13:04:09Z

-        super().__init__(*args, **kwargs)
-        self.__task_executor_queue = TaskExecutorQueue(
-            ewokstaskclass=self.ewokstaskclass
+    def cancel_running_task(self) -> None:


We should now use future. Internally we are only using it for test that will be removed once TaskExecutorQueue class is removed.

payno · 2026-06-30T13:35:56Z

replaced by test_executor (from previous PR)

payno · 2026-06-30T14:51:49Z

Removed as all the classes it was testing are now deprecated. It also avoid having some modifications of the .github/workflows/test.yml to ignore deprecation warning. A bit violent but way simpler.

payno · 2026-06-30T14:53:01Z

Added test for OWEwoksWidgetNoThread that were not existing. Simple test to make sure the new API using future is working for this widget.

payno · 2026-06-30T14:53:36Z

+        # wait for the future to be started. Should be done through a QtEvent
+        sleep(0.2)


I was considering using an Event but this is probably overkilled.

payno · 2026-06-30T15:04:43Z

 [project]
 name = "ewoksorange"
-version = "5.0.1"
+version = "6.0.0"


I tried to minimize API break but this is huge modification. So for sure it will break existing behavior under the hood. More honest to consider this will part of a major release.

# Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessWorker.py # Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessWorker.py # Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessHandle.py

…ainer

…ead submission. # Conflicts: # src/ewoksorange/gui/concurrency/executor/EwoksExecutor.py

…gui.concurrency

…ange.tests.utils

…sed when aborted # Conflicts: # src/ewoksorange/gui/owwidgets/threaded.py

…ting downstream.

… try/finally signal.

…inside the try / finally. This is not the purpose of this PR

…WEwoksWidgetWithTaskStack' under the generic '_OWEwoksExecutorWidget'

…ne', 'task_exception', '_get_task_outputs' and 'cancel_running_task'

…_done', 'task_exception', '_get_task_outputs'

…eeded'

payno self-assigned this Jun 30, 2026

payno changed the base branch from main to 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-3 June 30, 2026 11:43

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-4 branch from e1b9c68 to b3938f0 Compare June 30, 2026 11:46

payno commented Jun 30, 2026

View reviewed changes

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-4 branch from c7cbe0b to a78a7ff Compare June 30, 2026 13:27

payno commented Jun 30, 2026

View reviewed changes

Comment thread src/ewoksorange/tests/test_task_executor.py Outdated

payno Jun 30, 2026

Copy link
Copy Markdown

Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replaced by test_executor (from previous PR)

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-4 branch 2 times, most recently from 8b58459 to b2edd60 Compare June 30, 2026 15:02

payno commented Jun 30, 2026

View reviewed changes

payno changed the title ~~Draft: 387 owewokswidgetwithtaskstack provide api to cancel a task 4~~ Makes ewoksorange.gui.owwidgets.thread returning TaskFuture Jun 30, 2026

This was referenced Jun 30, 2026

add ewoksorange.gui.concurrency.executor module #405

Merged

Make executors return a Future that allows cancelling and aborting #404

Closed

Split multithreaded executor #403

Closed

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-3 branch from 57e77b8 to e9d5528 Compare July 1, 2026 15:25

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-4 branch 5 times, most recently from f70b3e2 to 18977fd Compare July 2, 2026 11:41

payno and others added 10 commits July 17, 2026 15:27

EwoksProcessWorker: add typing

fefe19c

# Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessWorker.py # Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessWorker.py # Conflicts: # src/ewoksorange/gui/concurrency/executor/_EwoksProcessHandle.py

ewoksorange.gui.concurrency.executor: add docstring for the module

e6ec06c

update changelog

804813e

TaskFuture: make 'result' return directly results instead of the cont…

eb16a09

…ainer

EwoksExecutor: move back 'setting 'ready' event at the end of the thr…

5f0b99f

…ead submission. # Conflicts: # src/ewoksorange/gui/concurrency/executor/EwoksExecutor.py

ewoksorange.gui.owwidgets.threaded: rework widget to use ewoksorange.…

3639b29

…gui.concurrency

Move DummyTask from ewoksorange.tests.test_OneThreadPerRun to ewoksor…

757e745

…ange.tests.utils

add ewoksorange.tests.test_nothread.py

5118494

fix 1dc10d576c46784ee2d91881e3c934dec04403f3

c798a6a

ewoksorange.gui: make 'execute_ewoks_task' return a TaskFuture.

6b5fe3c

payno added 25 commits July 17, 2026 15:27

update changelog

b9cf56d

OWEwoksWidgetNoThread: makes "_execute_ewoks_task" return a "TaskFuture"

65e51d9

OWEwoksWidgetOneThreadPerRun: update test because no exception is rai…

77eb787

…sed when aborted # Conflicts: # src/ewoksorange/gui/owwidgets/threaded.py

OWEwoksWidgets: add try / finally as it was originally before propaga…

1fdfba8

…ting downstream.

OWEwoksWidgetNoThread: move "__post_task_exception" reset outside the…

c736b13

… try/finally signal.

CompletedWorker: improve docstring.

03fbea0

OWEwoksWidgetNoThread: move back 'self.__post_task_exception = None' …

accc453

…inside the try / finally. This is not the purpose of this PR

Move to 6.0.0 version.

65ae8cd

TaskExecutorQueue: deprecate usage to the benefit of 'EwoksExecutor'

207e03f

ThreadedTaskExecutor: deprecate usage to the benefit of 'EwoksExecutor'

49033d0

Group 'OWEwoksWidgetOneThread', 'OWEwoksWidgetOneThreadPerRun' and 'O…

89e3eb0

…WEwoksWidgetWithTaskStack' under the generic '_OWEwoksExecutorWidget'

Clean _OWEwoksExecutorWidget classe variables.

bd3425f

_OWEwoksExecutorWidget: deprecate old API: 'task_succeeded', 'task_do…

2badcc1

…ne', 'task_exception', '_get_task_outputs' and 'cancel_running_task'

_OWEwoksExecutorWidget: make sure 'succeeded' is always provided.

b2a51c2

_OWEwoksExecutorWidget: remove deprecation of 'task_succeeded', 'task…

75ad378

…_done', 'task_exception', '_get_task_outputs'

OWEwoksBaseWidget.propagate_downstream: deprecate not providing 'succ…

2eee3ed

…eeded'

fix some warnings 'f-string is missing placeholders'

2c6dd48

OWEwoksWidgetWithTaskStack: deprecate 'task_executor_queue'

a92378a

_OWEwoksExecutorWidget: improve handling of warnings

3422408

_OWEwoksExecutorWidget: improve doc string.

5febd84

isort

4368dbc

Remove test_task_executor.

0a86de7

propagate_downstream: make sure a bool is always pass

f7fb707

_OWEwoksThreadedBaseWidget: remove unused function

1519a69

CompletedWorker: make it inherit from "EwoksWorkerBase"

00e253a

payno force-pushed the 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-4 branch from 18977fd to 00e253a Compare July 17, 2026 13:27

payno changed the base branch from 387-owewokswidgetwithtaskstack-provide-api-to-cancel-a-task-3 to main July 17, 2026 13:27

		# wait for the future to be started. Should be done through a QtEvent
		sleep(0.2)

Uh oh!

Conversation

payno commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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!

payno Jun 30, 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!

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!

1 participant

payno commented Jun 30, 2026 •

edited

Loading

codecov Bot commented Jun 30, 2026 •

edited

Loading

payno Jun 30, 2026 •

edited

Loading