Implement a running status.

Author: tobiasraabe

docs/source/changes.md

@@ -47,6 +47,8 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`603` fixes an example in the documentation about capturing warnings.
 - {pull}`604` fixes some examples with `PythonNode`s in the documentation.
 - {pull}`605` improves checks and CI.
+- {pull}`606` allows a pending status for tasks. Useful for async backends implemented
+  in pytask-parallel.
 
 ## 0.4.7 - 2024-03-19
 

src/_pytask/execute.py

@@ -25,6 +25,7 @@
 from _pytask.exceptions import ExecutionError
 from _pytask.exceptions import NodeLoadError
 from _pytask.exceptions import NodeNotFoundError
+from _pytask.logging_utils import TaskExecutionStatus
 from _pytask.mark import Mark
 from _pytask.mark_utils import has_mark
 from _pytask.node_protocols import PNode
@@ -98,7 +99,9 @@ def pytask_execute_build(session: Session) -> bool | None:
 @hookimpl
 def pytask_execute_task_protocol(session: Session, task: PTask) -> ExecutionReport:
     """Follow the protocol to execute each task."""
-    session.hook.pytask_execute_task_log_start(session=session, task=task)
+    session.hook.pytask_execute_task_log_start(
+        session=session, task=task, status=TaskExecutionStatus.RUNNING
+    )
     try:
         session.hook.pytask_execute_task_setup(session=session, task=task)
         session.hook.pytask_execute_task(session=session, task=task)

src/_pytask/hookspecs.py

@@ -18,6 +18,7 @@
     import click
     from pluggy import PluginManager
 
+    from _pytask.logging_utils import TaskExecutionStatus
     from _pytask.models import NodeInfo
     from _pytask.node_protocols import PNode
     from _pytask.node_protocols import PProvisionalNode
@@ -255,7 +256,9 @@ def pytask_execute_task_protocol(session: Session, task: PTask) -> ExecutionRepo
 
 
 @hookspec(firstresult=True)
-def pytask_execute_task_log_start(session: Session, task: PTask) -> None:
+def pytask_execute_task_log_start(
+    session: Session, task: PTask, status: TaskExecutionStatus
+) -> None:
     """Start logging of task execution.
 
     This hook can be used to provide more verbose output during the execution.

src/_pytask/live.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from enum import Enum
 from typing import TYPE_CHECKING
 from typing import Any
 from typing import Generator
@@ -25,6 +24,7 @@
 from _pytask.pluginmanager import hookimpl
 
 if TYPE_CHECKING:
+    from _pytask.logging_utils import TaskExecutionStatus
     from _pytask.node_protocols import PTask
     from _pytask.reports import CollectionReport
     from _pytask.reports import ExecutionReport
@@ -130,14 +130,9 @@ def is_started(self) -> bool:
         return self._live.is_started
 
 
-class _TaskStatus(Enum):
-    PENDING = "pending"
-    RUNNING = "running"
-
-
 class _TaskEntry(NamedTuple):
     task: PTask
-    status: _TaskStatus
+    status: TaskExecutionStatus
 
 
 class _ReportEntry(NamedTuple):
@@ -173,9 +168,11 @@ def pytask_execute_build(self) -> Generator[None, None, None]:
         return result
 
     @hookimpl(tryfirst=True)
-    def pytask_execute_task_log_start(self, task: PTask) -> bool:
+    def pytask_execute_task_log_start(
+        self, task: PTask, status: TaskExecutionStatus
+    ) -> bool:
         """Mark a new task as running."""
-        self.update_running_tasks(task)
+        self.update_running_tasks(new_running_task=task, status=status)
         return True
 
     @hookimpl
@@ -268,10 +265,12 @@ def _update_table(
         )
         self.live_manager.update(table)
 
-    def update_running_tasks(self, new_running_task: PTask) -> None:
+    def update_running_tasks(
+        self, new_running_task: PTask, status: TaskExecutionStatus
+    ) -> None:
         """Add a new running task."""
         self._running_tasks[new_running_task.signature] = _TaskEntry(
-            task=new_running_task, status=_TaskStatus.RUNNING
+            task=new_running_task, status=status
         )
         self._update_table()
 

src/pytask/__init__.py

@@ -7,6 +7,7 @@
 from _pytask.build import build
 from _pytask.capture_utils import CaptureMethod
 from _pytask.capture_utils import ShowCapture
+from _pytask.logging_utils import TaskExecutionStatus
 
 
 from _pytask.click import ColoredCommand
@@ -129,6 +130,7 @@
     "SkippedUnchanged",
     "State",
     "Task",
+    "TaskExecutionStatus",
     "TaskOutcome",
     "TaskWithoutPath",
     "Traceback",

tests/test_live.py

@@ -6,6 +6,7 @@
 import pytest
 from _pytask.live import LiveExecution
 from _pytask.live import LiveManager
+from _pytask.logging_utils import TaskExecutionStatus
 from pytask import ExecutionReport
 from pytask import ExitCode
 from pytask import Task
@@ -41,7 +42,7 @@ def test_live_execution_sequentially(capsys, tmp_path):
     )
 
     live_manager.start()
-    live.update_running_tasks(task)
+    live.update_running_tasks(task, status=TaskExecutionStatus.RUNNING)
     live_manager.pause()
 
     # Test pause removes the table.
@@ -99,7 +100,7 @@ def test_live_execution_displays_skips_and_persists(capsys, tmp_path, verbose, o
     )
 
     live_manager.start()
-    live.update_running_tasks(task)
+    live.update_running_tasks(task, status=TaskExecutionStatus.RUNNING)
     live_manager.pause()
 
     report = ExecutionReport(task=task, outcome=outcome, exc_info=None)
@@ -149,7 +150,7 @@ def test_live_execution_displays_subset_of_table(capsys, tmp_path, n_entries_in_
     )
 
     live_manager.start()
-    live.update_running_tasks(running_task)
+    live.update_running_tasks(running_task, status=TaskExecutionStatus.RUNNING)
     live_manager.stop(transient=False)
 
     captured = capsys.readouterr()
@@ -161,7 +162,7 @@ def test_live_execution_displays_subset_of_table(capsys, tmp_path, n_entries_in_
 
     completed_task = Task(base_name="task_completed", path=path, function=lambda x: x)
     completed_task.name = "task_module.py::task_completed"
-    live.update_running_tasks(completed_task)
+    live.update_running_tasks(completed_task, status=TaskExecutionStatus.RUNNING)
     report = ExecutionReport(
         task=completed_task, outcome=TaskOutcome.SUCCESS, exc_info=None
     )
@@ -202,7 +203,7 @@ def test_live_execution_skips_do_not_crowd_out_displayed_tasks(capsys, tmp_path)
     )
 
     live_manager.start()
-    live.update_running_tasks(task)
+    live.update_running_tasks(task, status=TaskExecutionStatus.RUNNING)
     live_manager.stop()
 
     # Test table with running task.
@@ -224,9 +225,9 @@ def test_live_execution_skips_do_not_crowd_out_displayed_tasks(capsys, tmp_path)
         tasks.append(skipped_task)
 
     live_manager.start()
-    live.update_running_tasks(successful_task)
+    live.update_running_tasks(successful_task, status=TaskExecutionStatus.RUNNING)
     for task in tasks:
-        live.update_running_tasks(task)
+        live.update_running_tasks(task, status=TaskExecutionStatus.RUNNING)
     live_manager.stop()
 
     captured = capsys.readouterr()