ENH: Add persisted run status CLI - #938
Conversation
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests.
... and 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
Sorry, something went wrong.
Merging this PR will not alter performance✅ 6 untouched benchmarks Comparing feat/run-status-cli (e1d6d41) with main (bd93928) |
Sorry, something went wrong.
| while self._pipeline_task is not None and not self._pipeline_task.done(): | ||
| await asyncio.sleep(self.heartbeat_interval_seconds) | ||
| self.write_now() | ||
| except asyncio.CancelledError: |
Check notice
Code scanning / CodeQL
Empty except Note
Copilot Autofix
AI 6 months ago
In general, empty except blocks should either (a) perform some explicit handling (logging, cleanup, state updates), or (b) include a clear comment explaining why ignoring the exception is safe and intentional. This preserves debuggability and avoids accidentally hiding errors.
For this specific case, the best minimal fix without changing functionality is:
- Keep swallowing asyncio.CancelledError (to avoid noisy tracebacks on expected cancellation).
- Add a short comment explaining that cancellation is expected during normal shutdown and that no further action is necessary, so the coroutine simply exits.
- Optionally, to make the intent even clearer, explicitly return from the coroutine in the except block. This does not change behavior but avoids a completely empty block.
Concretely:
- In pipefunc/_run_status_heartbeat.py, in _heartbeat_loop, replace
74: async def _heartbeat_loop(self) -> None:
75: try:
76: while self._pipeline_task is not None and not self._pipeline_task.done():
77: await asyncio.sleep(self.heartbeat_interval_seconds)
78: self.write_now()
79: except asyncio.CancelledError:
80: passwith an implementation that includes an explanatory comment and exits the coroutine explicitly in the except block, preserving all existing behavior.
No new imports or helper functions are needed.
Autofix patch
cat << 'EOF' | git apply
diff --git a/pipefunc/_run_status_heartbeat.py b/pipefunc/_run_status_heartbeat.py
--- a/pipefunc/_run_status_heartbeat.py
+++ b/pipefunc/_run_status_heartbeat.py
@@ -77,7 +77,9 @@
await asyncio.sleep(self.heartbeat_interval_seconds)
self.write_now()
except asyncio.CancelledError:
- pass
+ # Expected during normal shutdown when the heartbeat task is cancelled.
+ # Swallow the cancellation to allow a clean exit without traceback.
+ return
def _on_task_done(self, task: asyncio.Task[Any]) -> None:
if self._heartbeat_task is not None:
EOF
| @@ -77,7 +77,9 @@ | ||
| await asyncio.sleep(self.heartbeat_interval_seconds) | ||
| self.write_now() | ||
| except asyncio.CancelledError: | ||
| pass | ||
| # Expected during normal shutdown when the heartbeat task is cancelled. | ||
| # Swallow the cancellation to allow a clean exit without traceback. | ||
| return | ||
|
|
||
| def _on_task_done(self, task: asyncio.Task[Any]) -> None: | ||
| if self._heartbeat_task is not None: |
✅ PR Title Formatted CorrectlyThe title of this PR has been updated to match the correct format. Thank you! |
Sorry, something went wrong.
Summary