Remove lazy since it has no effect

NEWS.md

@@ -1,5 +1,9 @@
 # furrr (development version)
 
+* The `lazy` argument of `furrr_options()` has been completely removed. This
+  argument had no effect, as futures are always resolved before the
+  corresponding furrr function returns (#222).
+
 * Condition objects are now dropped from future results before they are returned
   to the main process (#216).
 

R/furrr-options.R

@@ -29,9 +29,6 @@
 #'   packages that are guaranteed to be attached in the R environment where the
 #'   future is evaluated.
 #'
-#' @param lazy A logical. Specifies whether futures should be resolved
-#'   lazily or eagerly.
-#'
 #' @param seed A logical, an integer of length `1` or `7`, a list of
 #'   `length(.x)` with pre-generated random seeds, or `NULL`. For details, see
 #'   the `Reproducible random number generation (RNG)` section below.
@@ -128,7 +125,6 @@ furrr_options <- function(...,
                           conditions = "condition",
                           globals = TRUE,
                           packages = NULL,
-                          lazy = FALSE,
                           seed = FALSE,
                           scheduling = 1.0,
                           chunk_size = NULL,
@@ -139,7 +135,6 @@ furrr_options <- function(...,
   conditions <- validate_conditions(conditions)
   globals <- validate_globals(globals)
   packages <- validate_packages(packages)
-  lazy <- validate_lazy(lazy)
   seed <- validate_seed(seed)
   scheduling <- validate_scheduling(scheduling)
   chunk_size <- validate_chunk_size(chunk_size)
@@ -150,7 +145,6 @@ furrr_options <- function(...,
     conditions = conditions,
     globals = globals,
     packages = packages,
-    lazy = lazy,
     seed = seed,
     scheduling = scheduling,
     chunk_size = chunk_size,
@@ -184,15 +178,13 @@ print.furrr_options <- function(x, ...) {
 future_options <- function(globals = TRUE,
                            packages = NULL,
                            seed = FALSE,
-                           lazy = FALSE,
                            scheduling = 1.0) {
   lifecycle::deprecate_warn("0.2.0", "future_options()", "furrr_options()")
 
   furrr_options(
     globals = globals,
     packages = packages,
     seed = seed,
-    lazy = lazy,
     scheduling = scheduling
   )
 }
@@ -277,17 +269,6 @@ validate_packages <- function(x) {
   x
 }
 
-validate_lazy <- function(x) {
-  vctrs::vec_assert(x, size = 1, arg = "lazy")
-  x <- vctrs::vec_cast(x, logical(), x_arg = "lazy")
-
-  if (is.na(x)) {
-    abort("`lazy` can't be `NA`.")
-  }
-
-  x
-}
-
 validate_seed <- function(x) {
   if (is.null(x)) {
     return(x)

R/template.R

@@ -370,7 +370,6 @@ furrr_template <- function(args,
       globals = chunk_globals,
       packages = chunk_packages,
       seed = options$seed,
-      lazy = options$lazy,
       label = labels[[i]]
     )
   }

tests/testthat/test-deprecation.R

@@ -9,8 +9,8 @@ test_that("can use deprecated `future_options()`", {
   )
   expect_warning(
     expect_identical(
-      future_options(globals = "x", packages = "dplyr", seed = 1, lazy = TRUE, scheduling = 2),
-      furrr_options(globals = "x", packages = "dplyr", seed = 1, lazy = TRUE, scheduling = 2)
+      future_options(globals = "x", packages = "dplyr", seed = 1, scheduling = 2),
+      furrr_options(globals = "x", packages = "dplyr", seed = 1, scheduling = 2)
     )
   )
 })

tests/testthat/test-furrr-options.R

@@ -157,20 +157,6 @@ test_that("validates `conditions`", {
   })
 })
 
-# ------------------------------------------------------------------------------
-# furrr_options(lazy =)
-
-furrr_test_that("can use lazy futures", {
-  opts <- furrr_options(lazy = TRUE)
-  expect_identical(future_map(1:5, ~.x, .options = opts), as.list(1:5))
-})
-
-test_that("validates `lazy`", {
-  expect_error(furrr_options(lazy = 2))
-  expect_error(furrr_options(lazy = NA))
-  expect_error(furrr_options(lazy = c(TRUE, FALSE)))
-})
-
 # ------------------------------------------------------------------------------
 # furrr_options(seed =)