cstar.execution.local_process.LocalProcess.cancel

Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.execution.local_process.LocalProcess.cancel#

LocalProcess.cancel()#

Cancel the local process.

This method terminates the subprocess if it is currently running. A graceful shutdown is attempted using terminate (SIGTERM). If the subprocess does not terminate within a timeout period, it is forcefully killed using kill (SIGKILL).

Notes

  • The status of the subprocess is updated to ExecutionStatus.CANCELLED after termination or killing.

  • The method ensures that the output file handle is closed after cancelling the process.

See also

wait

Wait for the local process to finish