Add support for cancelled jobs.

README.md

@@ -3,6 +3,9 @@ Workflows made easy, your way.
 
 > [!CAUTION]
 > Ergate is still in its early stages of development and therefore breaking changes are possible between every version.
+> 
+> For a more stable experience, please consider using the [Ergeatz fork](https://github.com/contrains/ergeats), which
+> will guarantee broken code rather than merely suggesting its possibility.
 
 ## Documentation
 You can find the documentation for Ergate at [ergate.prryplatypus.dev](https://ergate.prryplatypus.dev).

docs/docs/basics/jobs-overview.md

@@ -36,6 +36,7 @@ A `Job` can have any of the following statuses:
 - `JobStatus.COMPLETED`
 - `JobStatus.FAILED`
 - `JobStatus.ABORTED`
+- `JobStatus.CANCELLED`
 
 
 ## Triggering/creating a job

ergate/__init__.py

@@ -2,6 +2,7 @@
 from .app import Ergate
 from .exceptions import (
     AbortJob,
+    CancelJob,
     ErgateError,
     GoToEnd,
     GoToStep,
@@ -19,6 +20,7 @@
 
 __all__ = [
     "AbortJob",
+    "CancelJob",
     "Context",
     "Depends",
     "Ergate",

ergate/exceptions.py

@@ -30,6 +30,10 @@ def __init__(self, message: str) -> None:
         self.message = message
 
 
+class CancelJob(ErgateError):  # noqa: N818
+    """Raised when a workflow is detected as having been cancelled."""
+
+
 class GoToEnd(ErgateError):  # noqa: N818
     """Raised from a step to immediately complete the job."""
 

ergate/job.py

@@ -29,12 +29,18 @@ def get_input_value(self) -> Any:
 
         return copy.deepcopy(input_val)
 
-    def mark_running(self, step: WorkflowStep) -> None:
-        self.status = JobStatus.RUNNING
+    def mark_aborted(self, message: str) -> None:
+        self.status = JobStatus.ABORTED
+
+    def mark_cancelled(self) -> None:
+        self.status = JobStatus.CANCELLED
 
     def mark_failed(self, exception: Exception) -> None:
         self.status = JobStatus.FAILED
 
+    def mark_running(self, step: WorkflowStep) -> None:
+        self.status = JobStatus.RUNNING
+
     def mark_step_n_completed(
         self,
         n: int,
@@ -51,12 +57,10 @@ def mark_step_n_completed(
         )
         self.last_return_value = return_value
 
-    def mark_aborted(self, message: str) -> None:
-        self.status = JobStatus.ABORTED
-
     def should_be_requeued(self) -> bool:
         return self.status not in (
             JobStatus.ABORTED,
+            JobStatus.CANCELLED,
             JobStatus.COMPLETED,
             JobStatus.FAILED,
         )

ergate/job_runner.py

@@ -1,6 +1,6 @@
 from typing import Generic, TypeVar
 
-from .exceptions import AbortJob, GoToEnd, GoToStep, ReverseGoToError
+from .exceptions import AbortJob, CancelJob, GoToEnd, GoToStep, ReverseGoToError
 from .handler import ErrorHookHandler
 from .interrupt import DelayedKeyboardInterrupt
 from .job import Job
@@ -102,6 +102,9 @@ def _run_job(self, job: JobType) -> None:
                 job.mark_step_n_completed(
                     job.current_step + 1, retval, job.steps_completed + remaining_steps
                 )
+        except CancelJob:
+            LOG.exception("Job was cancelled")
+            job.mark_cancelled()
         except Exception as exc:
             LOG.exception("Job raised an exception")
             job.mark_failed(exc)

ergate/job_status.py

@@ -8,3 +8,4 @@ class JobStatus(IntEnum):
     COMPLETED = auto()
     FAILED = auto()
     ABORTED = auto()
+    CANCELLED = auto()

tox.ini

@@ -6,7 +6,7 @@ extras = test
 
 [testenv:check]
 commands =
-    ruff format --check ergate
+    ruff format --diff ergate
     ruff check ergate
     mypy ergate
     flake8 ergate