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.

Sign up for GitHub

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

Jump to bottom

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

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

wants to merge 3 commits into from
+49 −14

Conversation

paleolimbot
Copy link
Member

@paleolimbot paleolimbot commented Sep 20, 2024 •
edited
Loading

Closes #631.

# Using pak::pak("apache/arrow-nanoarrow/r#632")
library(nanoarrow)
array <- as_nanoarrow_array(data.frame(x = 1:5, y = letters[1:5]))
array$children$z <- nanoarrow_extension_array(letters[1:5], "some_extension")

# warns!
tibble::as_tibble(array)
#> Warning in warn_unregistered_extension_type(x): z: Converting unknown extension
#> some_extension{string} as storage type
#> Warning in warn_unregistered_extension_type(storage): z: Converting unknown
#> extension some_extension{string} as storage type
#> # A tibble: 5 × 3
#>       x y     z    
#>   <int> <chr> <chr>
#> 1     1 a     a    
#> 2     2 b     b    
#> 3     3 c     c    
#> 4     4 d     d    
#> 5     5 e     e

# doesn't!
options(nanoarrow.warn_unregistered_extension = FALSE)
tibble::as_tibble(array)
#> # A tibble: 5 × 3
#>       x y     z    
#>   <int> <chr> <chr>
#> 1     1 a     a    
#> 2     2 b     b    
#> 3     3 c     c    
#> 4     4 d     d    
#> 5     5 e     e

Created on 2024-09-20 with reprex v2.1.1

@paleolimbot paleolimbot marked this pull request as ready for review September 20, 2024 22:49
@paleolimbot paleolimbot mentioned this pull request Sep 21, 2024
Open
amoeba
amoeba approved these changes Sep 21, 2024
View reviewed changes
Copy link
Member

@amoeba amoeba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Did you consider extending the "Converting unknown extension %s as storage type" warning to include instructions for disabling the warning? Considering the report in the original issue, it seems likely that the user who gets the warning may not really know where to go for help or what they should do to hide the warning beyond suppressing warnings for the entire call.

So where the current warning is,

Warning message:
In warn_unregistered_extension_type(storage) :
  z: Converting unknown extension some_extension{string} as storage type

A possible improvement could be:

Warning message:
In warn_unregistered_extension_type(storage) :
  z: Converting unknown extension some_extension{string} as storage type. Disable warning with options(nanoarrow.warn_unregistered_extension = FALSE).

or to make it shorter, "See Details section in ?nanoarrow::convert_array.".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amoeba amoeba amoeba approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide some way to suppress warning about unknown extension?
2 participants
@paleolimbot @amoeba