prefect.server.services.cancellation_cleanup

The CancellationCleanup service. Responsible for cancelling tasks and subflows that haven’t finished.

Classes

CancellationCleanup

Cancels tasks and subflows of flow runs that have been cancelled Methods:

clean_up_cancelled_flow_run_task_runs

clean_up_cancelled_flow_run_task_runs(self, db: PrefectDBInterface) -> None

clean_up_cancelled_subflow_runs

clean_up_cancelled_subflow_runs(self, db: PrefectDBInterface) -> None

run_once

run_once(self, db: PrefectDBInterface) -> None
  • cancels active tasks belonging to recently cancelled flow runs
  • cancels any active subflow that belongs to a cancelled flow

run_once

run_once(self) -> None
Represents one loop of the service. Subclasses must override this method. To actually run the service once, call LoopService().start(loops=1) instead of LoopService().run_once(), because this method will not invoke setup and teardown methods properly.

service_settings

service_settings(cls) -> ServicesBaseSetting

start

start(self, loops: None = None) -> NoReturn
Run the service indefinitely.

stop

stop(self, block: bool = True) -> None
Gracefully stops a running LoopService and optionally blocks until the service stops. Args:
  • block: if True, blocks until the service is finished running. Otherwise it requests a stop and returns but the service may still be running a final loop.