CLEANUP: Remove argument gc from future(), futureAssign(), and futureCall()

Author: HenrikBengtsson

DESCRIPTION

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

NEWS.md

@@ -22,9 +22,9 @@
 
 ## Deprecated and Defunct
 
- * Remove argument `earlySignal` from `future()`, `futureAssign()`,
-   and `futureCall()`.  Attempts to set it is now ignored and will
-   produce a deprecation warning.
+ * Remove arguments `earlySignal` and `gc` from `future()`,
+   `futureAssign()`, and `futureCall()`.  Attempts to set them are now
+   ignored and will produce deprecation warnings.
 
  * The `cluster` backend now defaults to `earlySignal = FALSE`. This
    was effectively already the case, because of an internal thinko

R/backend_api-Future-class.R

@@ -70,12 +70,6 @@
 #' @param lazy If FALSE (default), the future is resolved
 #' eagerly (starting immediately), otherwise not.
 #'
-#' @param gc If TRUE, the garbage collector run (in the process that
-#' evaluated the future) only after the value of the future is collected.
-#' Exactly when the values are collected may depend on various factors,
-#' including the number of free workers.
-#' _Some future backends may ignore this argument._
-#'
 #' @param label A character string label attached to the future.
 #'
 #' @param \ldots Additional named elements of the future.
@@ -97,7 +91,7 @@
 #' @export
 #' @keywords internal
 #' @name Future-class
-Future <- function(expr = NULL, envir = parent.frame(), substitute = TRUE, stdout = TRUE, conditions = "condition", globals = list(), packages = NULL, seed = FALSE, lazy = FALSE, gc = FALSE, label = NULL, ...) {
+Future <- function(expr = NULL, envir = parent.frame(), substitute = TRUE, stdout = TRUE, conditions = "condition", globals = list(), packages = NULL, seed = FALSE, lazy = FALSE, label = NULL, ...) {
   if (substitute) expr <- substitute(expr)
   t_start <- Sys.time()
 
@@ -220,7 +214,6 @@ Future <- function(expr = NULL, envir = parent.frame(), substitute = TRUE, stdou
 
   ## Future miscellaneous
   core[["label"]] <- label
-  core[["gc"]] <- gc
 
   core[["onReference"]] <- onReference
   core[["owner"]] <- session_uuid()

R/core_api-future.R

@@ -160,14 +160,13 @@
 #' @aliases futureCall
 #' @rdname future
 #' @export
-future <- function(expr, envir = parent.frame(), substitute = TRUE, lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, gc = FALSE, ...) {
+future <- function(expr, envir = parent.frame(), substitute = TRUE, lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, ...) {
   debug <- isTRUE(getOption("future.debug"))
   if (debug) {
     mdebugf_push("future(..., label = %s) ...", sQuoteLabel(label))
     mdebugf("lazy: %s", lazy)
     mdebugf("stdout: %s", stdout)
     mdebugf("conditions: [n=%d] %s", length(conditions), commaq(conditions))
-    mdebugf("gc: %s", gc)
     on.exit(mdebugf_pop())
   }
 
@@ -198,14 +197,13 @@ future <- function(expr, envir = parent.frame(), substitute = TRUE, lazy = FALSE
                    stdout = stdout,
                    conditions = conditions,
                    label = label,
-                   gc = gc,
                    onReference = onReference,
                    ...)
 
   args_names <- names(list(...))
 
-  ## Deprecation of arguments 'earlySignal'
-  for (name in c("earlySignal")) {
+  ## Deprecation of arguments 'earlySignal' and 'gc'
+  for (name in c("earlySignal", "gc")) {
     if (!is.null(future[[name]])) {
       if (is.element(name, args_names)) {
         deprecateFutureArgument(name, future[[name]])

R/delayed_api-futureAssign.R

@@ -185,14 +185,14 @@
 #'
 #' @rdname futureAssign
 #' @export
-futureAssign <- function(x, value, envir = parent.frame(), substitute = TRUE, lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, gc = FALSE, ..., assign.env = envir) {
+futureAssign <- function(x, value, envir = parent.frame(), substitute = TRUE, lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, ..., assign.env = envir) {
   stop_if_not(is.character(x), !is.na(x), nzchar(x))
   if (substitute) value <- substitute(value)
 
   ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   ## (1) Arguments passed to future()
   ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-  future.args <- list(value, envir = envir, lazy = lazy, seed = seed, globals = globals, packages = packages, stdout = stdout, conditions = conditions, label = label, gc = gc, ...)
+  future.args <- list(value, envir = envir, lazy = lazy, seed = seed, globals = globals, packages = packages, stdout = stdout, conditions = conditions, label = label, ...)
   ## Any arguments set via disposible option?
   args <- getOption("future.disposable")
   if (!is.null(args)) {

R/utils-options.R

@@ -468,4 +468,5 @@ update_package_options <- function(debug = FALSE) {
 
   ## future (> 1.68.0)
   update_package_option("future.future.earlySignal", mode = "character", debug = debug)
+  update_package_option("future.future.gc", mode = "character", debug = debug)
 }

R/utils_api-futureCall.R

@@ -16,7 +16,7 @@
 #'
 #' @rdname future
 #' @export
-futureCall <- function(FUN, args = list(), envir = parent.frame(), lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, gc = FALSE, ...) {
+futureCall <- function(FUN, args = list(), envir = parent.frame(), lazy = FALSE, seed = FALSE, globals = TRUE, packages = NULL, stdout = TRUE, conditions = "condition", label = NULL, ...) {
   stop_if_not(is.function(FUN))
   stop_if_not(is.list(args))
 
@@ -96,7 +96,7 @@ futureCall <- function(FUN, args = list(), envir = parent.frame(), lazy = FALSE,
     mstr(globals)
   }
 
-  f <- future(expr, substitute = FALSE, envir = envir, lazy = lazy, seed = seed, globals = globals, packages = packages, stdout = stdout, conditions = conditions, label = label, gc = gc, ...)
+  f <- future(expr, substitute = FALSE, envir = envir, lazy = lazy, seed = seed, globals = globals, packages = packages, stdout = stdout, conditions = conditions, label = label, ...)
 
   if (debug) mdebug_pop()
 

inst/testme/test-future.R

@@ -31,15 +31,6 @@ local({
 
 message("*** future() w/ lazy = TRUE in local() ... DONE")
 
-message("*** future() w/ gc = TRUE ...")
-
-f <- future(42L, gc = TRUE, lazy = TRUE)
-print(f)
-y <- value(f)
-print(y)
-stopifnot(y == 42L)
-
-message("*** future() w/ gc = TRUE ... DONE")
 message("*** future() ... DONE")
 
 message("*** future() ...")
@@ -54,17 +45,6 @@ print(y)
 stopifnot(y == 42L)
 
 
-message("*** future() w/ gc = TRUE ...")
-
-f <- future(42L, gc = TRUE, lazy = TRUE)
-print(f)
-y <- value(f)
-print(y)
-stopifnot(y == 42L)
-
-message("*** future() w/ gc = TRUE ... DONE")
-
-
 message("*** future() - exceptions ...")
 
 target <- list(name = "<unknown>", envir = new.env(), code = "Yo!", exists = TRUE)