Add new "steps" background task type

docs/source/changes.rst

@@ -16,6 +16,14 @@ Release 0.4.0
 Release date: XXXX-XX-XX
 
 
+Features
+~~~~~~~~
+
+* New "steps" background task type for cancellable progress-reporting tasks.
+  This has a richer interface than the existing progress background task type.
+  It can be used via the new |submit_steps| convenience function, which
+  returns a |StepsFuture| object. (#484)
+
 Documentation
 ~~~~~~~~~~~~~
 
@@ -472,9 +480,11 @@ and progress-reporting tasks for Traits UI applications based on Qt.
 .. |run| replace:: :meth:`~.BaseTask.run`
 .. |send| replace:: :meth:`~.BaseTask.send`
 .. |shutdown| replace:: :meth:`~.TraitsExecutor.shutdown`
+.. |StepsFuture| replace:: :class:`~.StepsFuture`
 .. |submit_call| replace:: :func:`~.submit_call`
 .. |submit_iteration| replace:: :func:`~.submit_iteration`
 .. |submit_progress| replace:: :func:`~.submit_progress`
+.. |submit_steps| replace:: :func:`~.submit_steps`
 .. |task| replace:: :meth:`~.ITaskSpecification.task`
 .. |TaskCancelled| replace:: :exc:`~.TaskCancelled`
 .. |TestAssistant| replace:: :exc:`~.TestAssistant`

traits_futures/api.py

@@ -28,13 +28,16 @@
 - :func:`~.submit_call`
 - :func:`~.submit_iteration`
 - :func:`~.submit_progress`
+- :func:`~.submit_steps`
+- :class:`~.IStepsReporter`
 
 Types of futures
 ----------------
 
 - :class:`~.CallFuture`
 - :class:`~.IterationFuture`
 - :class:`~.ProgressFuture`
+- :class:`~.StepsFuture`
 - :exc:`~.TaskCancelled`
 
 Future states
@@ -86,6 +89,11 @@
     submit_iteration,
 )
 from traits_futures.background_progress import ProgressFuture, submit_progress
+from traits_futures.background_steps import (
+    IStepsReporter,
+    StepsFuture,
+    submit_steps,
+)
 from traits_futures.base_future import BaseFuture, BaseTask, TaskCancelled
 from traits_futures.ets_event_loop import ETSEventLoop
 from traits_futures.executor_states import (
@@ -115,6 +123,8 @@
     "CallFuture",
     "IterationFuture",
     "ProgressFuture",
+    "StepsFuture",
+    "IStepsReporter",
     "TaskCancelled",
     # Future states
     "FutureState",
@@ -135,6 +145,7 @@
     "submit_call",
     "submit_iteration",
     "submit_progress",
+    "submit_steps",
     # Support for creating new task types
     "BaseFuture",
     "BaseTask",