Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(r): Allow opt-out of warning for unregistered extension types #632

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions r/R/convert-array.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
#' dispatching on `to`: developers may implement their own S3 methods for
#' custom vector types.
#'
#' Note that unregistered extension types will by default issue a warning.
#' Use `options(nanoarrow.warn_unregistered_extension = FALSE)` to disable
#' this behaviour.
#'
#' @param array A [nanoarrow_array][as_nanoarrow_array].
#' @param to A target prototype object describing the type to which `array`
#' should be converted, or `NULL` to use the default conversion as
Expand Down
33 changes: 19 additions & 14 deletions r/R/extension.R
Original file line number Diff line number Diff line change
Expand Up @@ -164,23 +164,28 @@ nanoarrow_extension_array <- function(storage_array, extension_name,
}

warn_unregistered_extension_type <- function(x) {
# Allow an opt-out of this warning for consumers that don't have
# control over their source and want to drop unknown extensions
if (!getOption("nanoarrow.warn_unregistered_extension", TRUE)) {
return()
}

# Warn that we're about to ignore an extension type
message <- sprintf(
paste0(
"Converting unknown extension %s as storage type\n",
"Disable warning with ",
"options(nanoarrow.warn_unregistered_extension = FALSE)"
),
nanoarrow_schema_formatted(x)
)

# Add the field name if we know it
if (!is.null(x$name) && !identical(x$name, "")) {
warning(
sprintf(
"%s: Converting unknown extension %s as storage type",
x$name,
nanoarrow_schema_formatted(x)
)
)
} else {
warning(
sprintf(
"Converting unknown extension %s as storage type",
nanoarrow_schema_formatted(x)
)
)
message <- paste0(x$name, ": ", message)
}

warning(message)
}

# Mutable registry to look up extension specifications
Expand Down
4 changes: 4 additions & 0 deletions r/man/convert_array.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions r/tests/testthat/test-extension.R
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,28 @@ test_that("as_nanoarrow_array() dispatches on registered extension spec", {
)
})

test_that("inferring the type of an unregistered extension warns", {
unknown_extension <- na_extension(na_int32(), "definitely not registered")
expect_warning(
infer_nanoarrow_ptype(unknown_extension),
"Converting unknown extension"
)

# Check that warning contains a field name if present
struct_with_unknown_ext <- na_struct(list(some_col = unknown_extension))
expect_warning(
infer_nanoarrow_ptype(struct_with_unknown_ext),
"some_col: Converting unknown extension"
)

previous_opts <- options(nanoarrow.warn_unregistered_extension = FALSE)
on.exit(options(previous_opts))
expect_warning(
infer_nanoarrow_ptype(unknown_extension),
NA
)
})

test_that("extensions can infer a schema of a nanoarrow_vctr() subclass", {
register_nanoarrow_extension(
"some_ext",
Expand Down
Loading