Remove argument 'run' from resolved()

Author: HenrikBengtsson

.github/workflows/R-CMD-check.yaml

@@ -137,6 +137,7 @@ jobs:
             Sys.setenv(R_FUTURE_FUTURE_LOCAL = "defunct")
             Sys.setenv(R_FUTURE_FUTURE_GC = "defunct")
             Sys.setenv(R_FUTURE_PLAN_EARLYSIGNAL = "defunct")
+            Sys.setenv(R_FUTURE_RESOLVED_RUN = "defunct")
           }
           if (nzchar(Sys.getenv("R_FUTURE_PLAN")) || getRversion() < "3.5.0") Sys.setenv(RCMDCHECK_ERROR_ON = "error")
           rcmdcheck::rcmdcheck(
@@ -158,6 +159,7 @@ jobs:
             Sys.setenv(R_FUTURE_FUTURE_LOCAL = "defunct")
             Sys.setenv(R_FUTURE_FUTURE_GC = "defunct")
             Sys.setenv(R_FUTURE_PLAN_EARLYSIGNAL = "defunct")
+            Sys.setenv(R_FUTURE_RESOLVED_RUN = "defunct")
           }
           rcmdcheck::rcmdcheck(
             args = c("--no-manual", "--as-cran",

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future
-Version: 1.68.0-9031
+Version: 1.68.0-9032
 Title: Unified Parallel and Distributed Processing in R for Everyone
 Depends:
     R (>= 3.2.0)

NEWS.md

@@ -22,6 +22,10 @@
 
 ## Deprecated and Defunct
 
+ * The `cluster` backend now defaults to `earlySignal = FALSE`. This
+   was effectively already the case, because of an internal thinko
+   bug.
+
  * Remove arguments `earlySignal` and `gc` from `future()`,
    `futureAssign()`, and `futureCall()`. Attempts to set them produce
    deprecation warnings. Deprecated also hidden argument `local`,
@@ -30,9 +34,8 @@
  * Use of `plan(..., earlySignal = ...)` is now defunct and produces a
    deprecation warning.
 
- * The `cluster` backend now defaults to `earlySignal = FALSE`. This
-   was effectively already the case, because of an internal thinko
-   bug.
+ * Remove argument `run` from `resolved()`. Attempts to set it
+   produces a deprecation warning.
 
  * Remove internal future field `envir`.
 

R/009.deprecation.R

@@ -1,5 +1,5 @@
 deprecateArgument <- function(fcn, name, value) {
-  fcn <- match.arg(fcn, choices = c("future", "plan"))
+  fcn <- match.arg(fcn, choices = c("future", "plan", "resolved"))
   option <- sprintf("future.%s.%s", fcn, name)
   action <- getOption(option, "deprecated")
   action <- match.arg(action, choices = c("deprecated", "defunct", "ignore"))

R/backend_api-11.ClusterFutureBackend-class.R

@@ -580,18 +580,25 @@ getSocketSelectTimeout <- function(future, timeout = NULL) {
 #' @rdname resolved
 #' @importFrom parallelly connectionId isConnectionValid
 #' @export
-resolved.ClusterFuture <- function(x, run = TRUE, timeout = NULL, ...) {
+resolved.ClusterFuture <- function(x, timeout = NULL, ...) {
   debug <- isTRUE(getOption("future.debug"))
 
   future <- x
   backend <- future[["backend"]]
   stop_if_not(inherits(backend, "FutureBackend"))
   workers <- backend[["workers"]]
   reg <- backend[["reg"]]
-  
+
+  args <- list(...)
+  run <- args[["run"]]
+
+  if (!is.null(run)) {
+    deprecateArgument("resolved", "run", run)
+  }
+
   ## A lazy future not even launched?
   if (future[["state"]] == "created") {
-    if (run) {
+    if (!isFALSE(run)) {
       nworkers <- length(workers)
 
       ## Collect one resolved future, if one exists
@@ -612,7 +619,7 @@ resolved.ClusterFuture <- function(x, run = TRUE, timeout = NULL, ...) {
 
       ## 4. Launch this lazy future
       if (any(avail)) future <- run(future)
-    } ## if (run)
+    } ## if (!isFALSE(run))
 
     ## Consider future non-resolved
     return(FALSE)

R/backend_api-11.MulticoreFutureBackend-class.R

@@ -280,10 +280,17 @@ nbrOfFreeWorkers.MulticoreFutureBackend <- function(evaluator, background = FALS
 resolved.MulticoreFuture <- local({
   selectChildren <- import_parallel_fcn("selectChildren")
 
-  function(x, run = TRUE, timeout = NULL, ...) {
+  function(x, timeout = NULL, ...) {
+    args <- list(...)
+    run <- args[["run"]]
+
+    if (!is.null(run)) {
+      deprecateArgument("resolved", "run", run)
+    }
+  
     ## A lazy future not even launched?
     if (x[["state"]] == "created") {
-      if (run) {
+      if (!isFALSE(run)) {
         ## If free cores are available, then launch this lazy future
         if (x[["workers"]] > usedCores()) x <- run(x)
       }

R/core_api-resolved.R

@@ -3,9 +3,6 @@
 #' @param x A \link{Future}, a list, or an environment (which also
 #' includes \link[listenv:listenv]{list environment}).
 #'
-#' @param run (logical) If TRUE, any lazy futures is launched,
-#' otherwise not.
-#'
 #' @param \ldots Not used.
 #'
 #' @return
@@ -15,13 +12,13 @@
 #' It never signals an error.
 #'
 #' @details
-#' `resolved(..., run = TRUE)` attempts to launch a lazy future, if there is
-#' an available worker, otherwise not.
+#' `resolved()` attempts to launch a lazy future, if there is an available
+#' worker, otherwise not.
 #'
 #' `resolved()` methods must always return `TRUE` or `FALSE` values, must
-#' always launch lazy futures by default (`run = TRUE`), and must never block
-#' indefinitely. This is because it should always be possible to poll futures
-#' until they are resolved using `resolved()`, e.g.
+#' always launch lazy futures, and must never block indefinitely. This is
+#' because it should always be possible to poll futures until they are
+#' resolved using `resolved()`, e.g.
 #' `while (!all(resolved(futures))) Sys.sleep(5)`.
 #'
 #' Each future backend must implement a `resolved()` method. It should return
@@ -122,19 +119,26 @@ resolved.environment <- function(x, ...) {
 
 #' @rdname resolved
 #' @export
-resolved.Future <- function(x, run = TRUE, ...) {
+resolved.Future <- function(x, ...) {
   future <- x
+  args <- list(...)
+  run <- args[["run"]]
+
   debug <- isTRUE(getOption("future.debug"))
   if (debug) {
     mdebugf_push("resolved() for %s (%s) ...", class(future)[1], sQuoteLabel(future))
     on.exit(mdebug_pop())
     mdebug("state: ", sQuote(future[["state"]]))
-    mdebug("run: ", run)
+    mdebug("run: ", deparse(run))
   }
-  
+
+  if (!is.null(run)) {
+    deprecateArgument("resolved", "run", run)
+  }
+
   ## A lazy future not even launched?
   if (future[["state"]] == "created") {
-    if (!run) return(FALSE)
+    if (isFALSE(run)) return(FALSE)
     if (debug) mdebug_push("run() ...")
     future <- run(future)
     if (debug) {

R/utils-options.R

@@ -471,5 +471,6 @@ update_package_options <- function(debug = FALSE) {
   update_package_option("future.future.gc", mode = "character", debug = debug)
   update_package_option("future.future.local", mode = "character", debug = debug)
   update_package_option("future.plan.earlySignal", mode = "character", debug = debug)
+  update_package_option("future.resolved.run", mode = "character", debug = debug)
   update_package_option("future.Future.envir.keep", mode = "logical", debug = debug)
 }