Added backend argument 'delete'; removed argument 'future.delete'

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.batchtools
-Version: 0.12.2-9963
+Version: 0.12.2-9964
 Depends:
     R (>= 3.2.0),
     parallelly,

NEWS.md

@@ -5,6 +5,11 @@
  * **future.batchtools** now implements the FutureBackend API
    introduced in **future** 1.40.0 (2025-04-10).
 
+ * Removed option `future.delete`. To control whether batchtools
+   futures should be deleted from the file system, see future backend
+   argument `delete`, which defaults to `"on-success"`, but can also
+   be set to `"never"` and `"always"`.
+
 ## New Features
 
  * Most types of batchtools future can now be interrupted, including

R/BatchtoolsFutureBackend-class.R

@@ -30,6 +30,13 @@
 #' job-script template as variable `resources`.  See Section 'Resources'
 #' in [batchtools::submitJobs()] more details.
 #'
+#' @param delete Controls if and when the batchtools job registry folder is
+#' deleted.
+#' If `"on-success"` (default), it is deleted if the future was resolved
+#' successfully _and_ the expression did not produce an error.
+#' If `"never"`, then it is never deleted.
+#' If `"always"`, then it is always deleted.
+#'
 #' @param \ldots Not used.
 #'
 #' @return A [future::FutureBackend] object of class BatchtoolsFutureBackend 
@@ -46,6 +53,7 @@ BatchtoolsFutureBackend <- function(
                              registry = list(),
                              conf.file = findConfFile(),
                              interrupts = TRUE,
+			     delete = "on-success",
                              ...) {
   assert_no_positional_args_but_first()
 
@@ -75,7 +83,9 @@ BatchtoolsFutureBackend <- function(
   }
 
   stop_if_not(is.list(resources))
-  
+  stop_if_not(is.character(delete))
+  delete <- match.arg(delete, choices = c("on-success", "never", "always"))
+
   core <- FutureBackend(
     reg = "workers-batchtools",
     workers = workers,
@@ -85,6 +95,7 @@ BatchtoolsFutureBackend <- function(
     registry = registry,
     finalize = finalize,
     interrupts = interrupts,
+    delete = delete,
     future.wait.timeout = getOption("future.wait.timeout", 30 * 24 * 60 * 60),
     future.wait.interval = getOption("future.wait.interval", 0.01),
     future.wait.alpha = getOption("future.wait.alpha", 1.01),
@@ -200,6 +211,7 @@ launchFuture.BatchtoolsFutureBackend <- local({
       mprint(list(config = config))
     }
     future[["config"]] <- config
+    future[["delete"]] <- backend[["delete"]]
 
     ## Register finalizer?
     if (backend[["finalize"]]) future <- add_finalizer(future)
@@ -309,12 +321,14 @@ launchFuture.BatchtoolsFutureBackend <- local({
         submitJobs(reg = reg, ids = jobid, resources = resources)
       })
     }, error = function(ex) {
+      path <- reg$file.dir
       msg <- conditionMessage(ex)
       label <- sQuoteLabel(future)
       msg <- sprintf("Failed to submit %s (%s). The reason was: %s", class(future)[1], label, msg)
       info <- capture.output(str(resources))
       info <- paste(info, collapse = "\n")
-      msg <- sprintf("%s\nTROUBLESHOOTING INFORMATION:\nbatchtools::submitJobs() was called with the following 'resources' argument:\n%s\n", msg, info)
+      msg <- sprintf("%s\nTROUBLESHOOTING INFORMATION:\nbatchtools::submitJobs() was called with the following 'resources' argument:\n%s", msg, info)
+      msg <- sprintf("%s\nDETAILS:\nThe batchtools registry path: %s", msg, sQuote(path))
       stop(FutureLaunchError(msg, future = future))
     })
 
@@ -944,11 +958,12 @@ delete.BatchtoolsFuture <- function(future,
 
   ## To simplify post mortem troubleshooting in non-interactive sessions,
   ## should the batchtools registry files be removed or not?
+  delete <- future[["delete"]]
   if (debug) {
-    mdebugf("delete(): Option 'future.delete = %s",
-            sQuote(getOption("future.delete", "<NULL>")))
+    mdebugf("delete(): Future backend argument 'delete' is %s", sQuote(delete))
   }
-  if (!getOption("future.delete", interactive())) {
+  
+  if (delete != "never") {
     status <- status(future)
     res <- future$result
     if (inherits(res, "FutureResult")) {
@@ -959,16 +974,18 @@ delete.BatchtoolsFuture <- function(future,
               paste(sQuote(status), collapse = ", "))
     }
     if (any(c("error", "expired") %in% status)) {
-      msg <- sprintf("Will not remove batchtools registry, because the status of the batchtools was %s and option 'future.delete' is FALSE or running in an interactive session: %s", paste(sQuote(status), collapse = ", "), sQuote(path)) #nolint
-      if (debug) mdebugf("delete(): %s", msg)
-      warning(msg)
-      return(invisible(FALSE))
+      if (delete == "on-success") {
+        msg <- sprintf("Will not remove batchtools registry, because the status of the batchtools was %s and future backend argument 'delete' is %s: %s", paste(sQuote(status), collapse = ", "), sQuote(delete), sQuote(path)) #nolint
+        if (debug) mdebugf("delete(): %s", msg)
+        warning(msg)
+        return(invisible(FALSE))
+      }	
     }
   }
 
   ## Have user disabled deletions?
-  if (!getOption("future.delete", TRUE)) {
-    msg <- sprintf("Option 'future.delete' is FALSE - will not delete batchtools registry: %s", sQuote(path))
+  if (delete == "never") {
+    msg <- sprintf("Future backend argument 'delete' is %s - will not delete batchtools registry: %s", sQuote(delete), sQuote(path))
     if (debug) mdebugf("delete(): %s", msg)
     return(invisible(FALSE))
   }

R/BatchtoolsTemplateFutureBackend-class.R

@@ -47,7 +47,7 @@
 #' @importFrom batchtools makeClusterFunctionsSlurm
 #' @importFrom batchtools makeClusterFunctionsTORQUE
 #' @export
-BatchtoolsTemplateFutureBackend <- function(type, scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), template = NULL, makeClusterFunctions = NULL, workers = getOption("future.batchtools.workers", default = 100L), ...) {
+BatchtoolsTemplateFutureBackend <- function(type, scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), delete = "on-success", template = NULL, makeClusterFunctions = NULL, workers = getOption("future.batchtools.workers", default = 100L), ...) {
   assert_no_positional_args_but_first()
   stop_if_not(
     is.character(type),
@@ -105,6 +105,7 @@ BatchtoolsTemplateFutureBackend <- function(type, scheduler.latency = 1.0, fs.la
   args <- dotdotdot
   args[["cluster.functions"]] <- cluster.functions
   args[["workers"]] <- workers
+  args[["delete"]] <- delete
 
   core <- do.call(BatchtoolsMultiprocessFutureBackend, args = args)
 

R/batchtools_bash.R

@@ -76,7 +76,7 @@ BatchtoolsBashFutureBackend <- function(..., template = "bash", fs.latency = 0.0
 #' print(info)
 #' 
 #' @export
-batchtools_bash <- function(..., template = "bash", fs.latency = 0.0, resources = list()) {
+batchtools_bash <- function(..., template = "bash", fs.latency = 0.0, resources = list(), delete = "on-success") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_bash() must never be called directly")
 }
 class(batchtools_bash) <- c(

R/batchtools_interactive.R

@@ -62,7 +62,7 @@ BatchtoolsInteractiveFutureBackend <- function(fs.latency = 0.0, ...) {
 #' @inheritParams BatchtoolsInteractiveFutureBackend
 #'
 #' @export
-batchtools_interactive <- function(..., fs.latency = 0.0) {
+batchtools_interactive <- function(..., fs.latency = 0.0, delete = "on-success") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_interactive() must never be called directly")
 }
 class(batchtools_interactive) <- c(

R/batchtools_local.R

@@ -92,7 +92,7 @@ BatchtoolsLocalFutureBackend <- function(fs.latency = 0.0, ...) {
 #' print(info)
 #' 
 #' @export
-batchtools_local <- function(..., fs.latency = 0.0) {
+batchtools_local <- function(..., fs.latency = 0.0, delete = "on-success") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_local() must never be called directly")
 }
 class(batchtools_local) <- c(

R/batchtools_lsf.R

@@ -59,7 +59,7 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #' * <https://en.wikipedia.org/wiki/IBM_Spectrum_LSF>
 #'
 #' @export
-batchtools_lsf <- function(..., template = "lsf", scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), workers = getOption("future.batchtools.workers", default = 100L)) {
+batchtools_lsf <- function(..., template = "lsf", scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), delete = "on-success", workers = getOption("future.batchtools.workers", default = 100L)) {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_lsf() must never be called directly")
 }
 class(batchtools_lsf) <- c(

R/batchtools_multicore.R

@@ -31,7 +31,7 @@
 #' @importFrom parallelly availableCores supportsMulticore
 #' @importFrom tools pskill
 #' @export
-BatchtoolsMulticoreFutureBackend <- function(workers = availableCores(constraints = "multicore"), fs.latency = 0.0, ...) {
+BatchtoolsMulticoreFutureBackend <- function(workers = availableCores(constraints = "multicore"), fs.latency = 0.0, delete = "on-success", ...) {
   assert_no_positional_args_but_first()
 
   if (is.function(workers)) workers <- workers()
@@ -103,7 +103,7 @@ BatchtoolsMulticoreFutureBackend <- function(workers = availableCores(constraint
 #' print(info)
 #' 
 #' @export
-batchtools_multicore <- function(..., workers = availableCores(constraints = "multicore"), fs.latency = 0.0) {
+batchtools_multicore <- function(..., workers = availableCores(constraints = "multicore"), fs.latency = 0.0, delete = "on-success") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_multicore() must never be called directly")
 }
 class(batchtools_multicore) <- c(

R/batchtools_openlava.R

@@ -59,7 +59,7 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #' * <https://en.wikipedia.org/wiki/OpenLava>
 #'
 #' @export
-batchtools_openlava <- function(..., template = "openlava", scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), workers = getOption("future.batchtools.workers", default = 100L)) {
+batchtools_openlava <- function(..., template = "openlava", scheduler.latency = 1.0, fs.latency = 65.0, resources = list(), delete = "on-success", workers = getOption("future.batchtools.workers", default = 100L)) {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_openlava() must never be called directly")
 }
 class(batchtools_openlava) <- c(