finish?

R/join.R

@@ -46,6 +46,13 @@
 #' * `"one-to-many"` expects each row in `y` to match at most 1 row in `x`.
 #' * `"many-to-one"` expects each row in `x` matches at most 1 row in `y`.
 #'
+#' @section Unknown arguments:
+#'
+#' Arguments that are supported by the original implementation in the tidyverse
+#' but are not listed above will throw a warning by default if they are
+#' specified. To change this behavior to error instead, use
+#' `options(tidypolars_unknown_args = "error")`.
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' test <- polars::pl$DataFrame(
@@ -108,9 +115,7 @@
 left_join.RPolarsDataFrame <- function(x, y, by = NULL,
                                        suffix = c(".x", ".y"), ...,
                                        na_matches = "na", relationship = NULL) {
-  check_unsupported_arg("copy", ..., .action = "warn")
-  check_unsupported_arg("keep", ..., .action = "warn")
-  check_dots_empty_ignore(..., .ignore = c("copy", "keep"))
+  check_dots_empty_ignore(..., .unsupported = c("copy", "keep"))
   join_(
     x = x,
     y = y,
@@ -127,9 +132,7 @@ left_join.RPolarsDataFrame <- function(x, y, by = NULL,
 right_join.RPolarsDataFrame <- function(x, y, by = NULL,
                                         suffix = c(".x", ".y"), ...,
                                         na_matches = "na", relationship = NULL) {
-  check_unsupported_arg("copy", ..., .action = "warn")
-  check_unsupported_arg("keep", ..., .action = "warn")
-  check_dots_empty_ignore(..., .ignore = c("copy", "keep"))
+  check_dots_empty_ignore(..., .unsupported = c("copy", "keep"))
   join_(
     x = x,
     y = y,
@@ -146,9 +149,7 @@ right_join.RPolarsDataFrame <- function(x, y, by = NULL,
 full_join.RPolarsDataFrame <- function(x, y, by = NULL,
                                        suffix = c(".x", ".y"), ...,
                                        na_matches = "na", relationship = NULL) {
-  check_unsupported_arg("copy", ..., .action = "warn")
-  check_unsupported_arg("keep", ..., .action = "warn")
-  check_dots_empty_ignore(..., .ignore = c("copy", "keep"))
+  check_dots_empty_ignore(..., .unsupported = c("copy", "keep"))
   join_(
     x = x,
     y = y,
@@ -165,9 +166,7 @@ full_join.RPolarsDataFrame <- function(x, y, by = NULL,
 inner_join.RPolarsDataFrame <- function(x, y, by = NULL,
                                         suffix = c(".x", ".y"), ...,
                                         na_matches = "na", relationship = NULL) {
-  check_unsupported_arg("copy", ..., .action = "warn")
-  check_unsupported_arg("keep", ..., .action = "warn")
-  check_dots_empty_ignore(..., .ignore = c("copy", "keep"))
+  check_dots_empty_ignore(..., .unsupported = c("copy", "keep"))
   join_(
     x = x,
     y = y,
@@ -205,6 +204,8 @@ inner_join.RPolarsLazyFrame <- inner_join.RPolarsDataFrame
 #' @param x,y Two Polars Data/LazyFrames
 #' @inheritParams left_join.RPolarsDataFrame
 #'
+#' @inheritSection left_join.RPolarsDataFrame Unknown arguments
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' test <- polars::pl$DataFrame(
@@ -229,7 +230,7 @@ inner_join.RPolarsLazyFrame <- inner_join.RPolarsDataFrame
 #' # only keep the rows of `test` that don't have matching keys in `test2`
 #' anti_join(test, test2, by = c("x", "y"))
 semi_join.RPolarsDataFrame <- function(x, y, by = NULL, ..., na_matches = "na") {
-  check_dots_empty()
+  check_dots_empty_ignore(..., .unsupported = "copy")
   join_(
     x = x,
     y = y,
@@ -245,7 +246,7 @@ semi_join.RPolarsDataFrame <- function(x, y, by = NULL, ..., na_matches = "na")
 #' @export
 
 anti_join.RPolarsDataFrame <- function(x, y, by = NULL, ..., na_matches = "na") {
-  check_dots_empty()
+  check_dots_empty_ignore(..., .unsupported = "copy")
   join_(
     x = x,
     y = y,
@@ -272,6 +273,8 @@ anti_join.RPolarsLazyFrame <- anti_join.RPolarsDataFrame
 #'
 #' @inheritParams left_join.RPolarsDataFrame
 #'
+#' @inheritSection left_join.RPolarsDataFrame Unknown arguments
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' test <- polars::pl$DataFrame(
@@ -289,7 +292,8 @@ anti_join.RPolarsLazyFrame <- anti_join.RPolarsDataFrame
 #' test2
 #'
 #' cross_join(test, test2)
-cross_join.RPolarsDataFrame <- function(x, y, suffix = c(".x", ".y"), ...) {
+cross_join.RPolarsDataFrame <- function(x, y, ..., suffix = c(".x", ".y")) {
+  check_dots_empty_ignore(..., .unsupported = "copy")
   join_(
     x = x,
     y = y,

R/pivot_longer.R

@@ -11,6 +11,8 @@
 #'  data stored in cell values.
 #' @inheritParams rlang::check_dots_empty0
 #'
+#' @inheritSection left_join.RPolarsDataFrame Unknown arguments
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' pl_relig_income <- polars::pl$DataFrame(tidyr::relig_income)
@@ -32,7 +34,14 @@
 pivot_longer.RPolarsDataFrame <- function(data, cols, ..., names_to = "name",
                                           names_prefix = NULL,
                                           values_to = "value") {
-  check_dots_empty()
+  check_dots_empty_ignore(
+    ...,
+    .unsupported = c(
+      "cols_vary", "names_sep", "names_pattern", "names_ptypes",
+      "names_transform", "names_repair", "values_drop_na", "values_ptypes",
+      "values_transform"
+    )
+  )
   data_names <- names(data)
   on <- tidyselect_named_arg(data, rlang::enquo(cols))
   index <- data_names[!data_names %in% on]

R/pivot_wider.R

@@ -29,6 +29,8 @@
 #'   columns. For example, if you provide a character value to fill numeric
 #'   columns, then all these columns will be converted to character.
 #'
+#' @inheritSection left_join.RPolarsDataFrame Unknown arguments
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' pl_fish_encounters <- polars::pl$DataFrame(tidyr::fish_encounters)
@@ -71,7 +73,13 @@ pivot_wider.RPolarsDataFrame <- function(
     names_sep = "_",
     names_glue = NULL,
     values_fill = NULL) {
-  check_dots_empty()
+  check_dots_empty_ignore(
+    ...,
+    .unsupported = c(
+      "id_expand", "names_sort", "names_vary", "names_expand", "names_repair",
+      "values_fn", "unused_fn"
+    )
+  )
   data_names <- names(data)
   value_vars <- tidyselect_named_arg(data, rlang::enquo(values_from))
   names_vars <- tidyselect_named_arg(data, rlang::enquo(names_from))

R/slice.R

@@ -8,6 +8,8 @@
 #'   is not maintained, use `group_by()` if you want more control over it.
 #' @inheritParams rlang::check_dots_empty0
 #'
+#' @inheritSection left_join.RPolarsDataFrame Unknown arguments
+#'
 #' @export
 #' @examplesIf require("dplyr", quietly = TRUE) && require("tidyr", quietly = TRUE)
 #' pl_test <- polars::as_polars_df(iris)
@@ -81,8 +83,7 @@ slice_head.RPolarsLazyFrame <- slice_head.RPolarsDataFrame
 #' @export
 
 slice_sample.RPolarsDataFrame <- function(.data, ..., n = NULL, prop = NULL, by = NULL, replace = FALSE) {
-  check_unsupported_arg("weight_by", ...)
-  check_dots_empty0(...)
+  check_dots_empty_ignore(..., .unsupported = "weight_by")
 
   grps <- get_grps(.data, rlang::enquo(by), env = rlang::current_env())
   mo <- attributes(.data)$maintain_grp_order

R/utils.R

@@ -111,30 +111,45 @@ select_by_name_or_position <- function(expr, name, position, default, env) {
   }
 }
 
-check_unsupported_arg <- function(.arg_name, ..., .action = "error") {
+check_dots_empty_ignore <- function(..., .unsupported = NULL) {
   dots <- enquos(...)
-  if (.arg_name %in% names(dots)) {
-    if (.action == "error") {
-      fn <- abort
+  rlang_action <- getOption("tidypolars_unknown_args", "warn")
+  unsupported_dots <- names(dots[.unsupported])
+  unsupported_dots <- unsupported_dots[!is.na(unsupported_dots)]
+
+  if (length(unsupported_dots) > 0) {
+    if (length(unsupported_dots) == 1) {
+      msg <- paste0("Argument `", unsupported_dots, "` is not supported by tidypolars.")
     } else {
-      fn <- warn
+      msg <- paste(
+        "Arguments",
+        toString(paste0("`", unsupported_dots, "`")),
+        "are not supported by tidypolars."
+      )
     }
-    do.call(
-      fn,
-      list(
-        paste0("Argument `", .arg_name, "` is not supported by tidypolars yet."),
+    if (rlang_action == "warn") {
+      warn(msg, call = caller_env())
+    } else if (rlang_action == "error") {
+      abort(
+        c(
+          msg,
+          "i" = "Use `options(tidypolars_unknown_args = \"warn\")` to warn when this happens instead of throwing an error."
+        ),
         call = caller_env()
       )
-    )
+    }
   }
-}
-
-check_dots_empty_ignore <- function(..., .ignore = NULL) {
-  dots <- list2(...)
-  for (i in seq_along(.ignore)) {
-    dots[[.ignore[i]]] <- NULL
+  for (i in .unsupported) {
+    dots[[i]] <- NULL
   }
+
   if (length(dots) > 0) {
-    abort("`...` must be empty.", call = caller_env())
+    abort(
+      c(
+        "`...` must be empty."
+        # "i" = paste("Unknown args:", dots))
+      ),
+      call = caller_env()
+    )
   }
 }

tests/testthat/_snaps/collect.md

@@ -6,3 +6,13 @@
       Error in `UseMethod()`:
       ! no applicable method for 'collect' applied to an object of class "RPolarsDataFrame"
 
+# error on unknown args
+
+    Code
+      collect(pl_iris, foo = TRUE)
+    Condition
+      Error in `collect()`:
+      ! `...` must be empty.
+      x Problematic argument:
+      * foo = TRUE
+