refactor!: feature flags reorganizization

NEWS.md

@@ -24,6 +24,8 @@
 
 ### Other breaking changes
 
+-   The `simd` feature of the Rust library is removed in favor of
+    the new `nightly` feature (#800).
 -   The following functions were deprecated in 0.13.0 and are now removed (#783):
     -   `$list$lengths()` -> `$list$len()`
     -   `pl$from_arrow()` -> `as_polars_df()` or `as_polars_series()`
@@ -51,6 +53,10 @@
 -   `pl$threadpool_size()` is deprecated and will be removed in 0.15.0. Use
     `pl$thread_pool_size()` instead (#784).
 
+### Other improvements
+
+-   The `sql` feature is included in the default feature (#800).
+
 ## Polars R Package 0.13.1
 
 ### New features

R/expr__array.R

@@ -16,19 +16,16 @@ ExprArr_sum = function() .pr$Expr$arr_sum(self)
 #' Find the maximum value in an array
 #'
 #' @return Expr
-#' @details
-#' This method is only available with the "simd" feature.
-#' See [polars_info] for more details.
+#' @inherit ExprStr_to_titlecase details
 #' @aliases arr_max
-#' @examplesIf polars_info()$features$simd
+#' @examplesIf polars_info()$features$nightly
 #' df = pl$DataFrame(
 #'   values = list(c(1, 2), c(3, 4), c(5, 6)),
 #'   schema = list(values = pl$Array(pl$Float64, 2))
 #' )
 #' df$with_columns(max = pl$col("values")$arr$max())
 ExprArr_max = function() {
-  # TODO: not to check simd here
-  check_feature("simd", "in $arr$max():")
+  check_feature("nightly", "in $arr$max():")
 
   .pr$Expr$arr_max(self)
 }
@@ -38,18 +35,17 @@ ExprArr_max = function() {
 
 #' Find the minimum value in an array
 #'
-#' @inherit ExprArr_max details
+#' @inherit ExprStr_to_titlecase details
 #' @return Expr
 #' @aliases arr_min
-#' @examplesIf polars_info()$features$simd
+#' @examplesIf polars_info()$features$nightly
 #' df = pl$DataFrame(
 #'   values = list(c(1, 2), c(3, 4), c(5, 6)),
 #'   schema = list(values = pl$Array(pl$Float64, 2))
 #' )
 #' df$with_columns(min = pl$col("values")$arr$min())
 ExprArr_min = function() {
-  # TODO: not to check simd here
-  check_feature("simd", "in $arr$min():")
+  check_feature("nightly", "in $arr$min():")
 
   .pr$Expr$arr_min(self)
 }

R/expr__string.R

@@ -266,12 +266,12 @@ ExprStr_to_lowercase = function() {
 #' @keywords ExprStr
 #' @return Expr of String titlecase chars
 #' @details
-#' This method is only available with the "simd" feature.
-#' See [polars_info] for more details.
-#' @examplesIf polars_info()$features$simd
+#' This method is only available with the "nightly" feature.
+#' See [polars_info()] for more details.
+#' @examplesIf polars_info()$features$nightly
 #' pl$lit(c("hello there", "HI, THERE", NA))$str$to_titlecase()$to_series()
 ExprStr_to_titlecase = function() {
-  check_feature("simd", "in $to_titlecase():")
+  check_feature("nightly", "in $to_titlecase():")
 
   .pr$Expr$str_to_titlecase(self) |>
     unwrap("in $to_titlecase():")

R/polars_info.R

@@ -11,7 +11,7 @@
 #'
 #' polars_info()$rust_polars
 #'
-#' polars_info()$features$simd
+#' polars_info()$features$nightly
 polars_info = function() {
   # Similar to arrow::arrow_info()
   out = list(
@@ -58,7 +58,7 @@ print.polars_info = function(x, ...) {
 #' @return TRUE invisibly if the feature is enabled
 #' @examples
 #' tryCatch(
-#'   check_feature("simd", "in example"),
+#'   check_feature("nightly", "in example"),
 #'   error = \(e) cat(as.character(e))
 #' )
 #' tryCatch(

src/rust/Cargo.toml

@@ -9,11 +9,13 @@ publish = false
 crate-type = ['staticlib']
 
 [features]
-default = []
-full_features = ["simd", "sql", "disable_limit_max_threads"]
+default = ["sql"]
+full_features = ["default", "nightly", "disable_limit_max_threads"]
 disable_limit_max_threads = []
-simd = ["polars/simd"]
 sql = ["polars/sql"]
+# also includes simd, requires nightly
+nightly = ["polars/nightly"]
+
 rpolars_debug_print = []
 
 [workspace]

src/rust/src/info.rs

@@ -5,12 +5,11 @@ use polars;
 fn cargo_rpolars_feature_info() -> List {
     list!(
         default = cfg!(feature = "default"),
-        // `full_features` is a combination of `simd` and `sql` features
-        full_features = cfg!(feature = "simd")
+        full_features = cfg!(feature = "nightly")
             & cfg!(feature = "sql")
             & cfg!(feature = "disable_limit_max_threads"),
         disable_limit_max_threads = cfg!(feature = "disable_limit_max_threads"),
-        simd = cfg!(feature = "simd"),
+        nightly = cfg!(feature = "nightly"),
         sql = cfg!(feature = "sql"),
         rpolars_debug_print = cfg!(feature = "rpolars_debug_print"),
     )

src/rust/src/lazy/dsl.rs

@@ -2573,16 +2573,16 @@ impl RPolarsExpr {
     }
 }
 
-// handle varition in implementation if not simd
+// handle varition in implementation if not the nightly feature
 // could not get cfg feature flags conditions to work inside extendr macro
 // Therefore place it outside here instead
 #[allow(unused)]
 fn f_str_to_titlecase(expr: &RPolarsExpr) -> RResult<RPolarsExpr> {
-    #[cfg(feature = "simd")]
+    #[cfg(feature = "nightly")]
     return (Ok(expr.0.clone().str().to_titlecase().into()));
 
-    #[cfg(not(feature = "simd"))]
-    rerr().plain("$to_titlecase() is only available with the 'simd' feature")
+    #[cfg(not(feature = "nightly"))]
+    rerr().plain("$to_titlecase() is only available with the 'nightly' feature")
 }
 
 //allow proto expression that yet only are strings

tests/testthat/_snaps/polars_info.md

@@ -12,7 +12,7 @@
       default                   FALSE
       full_features             FALSE
       disable_limit_max_threads FALSE
-      simd                      FALSE
+      nightly                   FALSE
       sql                       FALSE
       rpolars_debug_print       FALSE
 

tests/testthat/test-expr_array.R

@@ -18,8 +18,7 @@ test_that("arr$sum", {
 })
 
 test_that("arr$max and arr$min", {
-  # TODO: not to check simd here
-  skip_if_not(polars_info()$features$simd)
+  skip_if_not(polars_info()$features$nightly)
 
   df = pl$DataFrame(
     ints = list(1:2, c(1L, NA_integer_), c(NA_integer_, NA_integer_)),
@@ -50,9 +49,8 @@ test_that("arr$max and arr$min", {
   )
 })
 
-test_that("arr$max and arr$min error if the simd feature is false", {
-  # TODO: not to check simd here
-  skip_if(polars_info()$features$simd)
+test_that("arr$max and arr$min error if the nightly feature is false", {
+  skip_if(polars_info()$features$nightly)
 
   df = pl$DataFrame(
     ints = list(1:2, c(1L, NA_integer_), c(NA_integer_, NA_integer_)),

tests/testthat/test-expr_string.R

@@ -184,17 +184,17 @@ test_that("to_uppercase, to_lowercase", {
   )
 })
 
-test_that("to_titlecase - enabled via the simd feature", {
-  skip_if_not(polars_info()$features$simd)
+test_that("to_titlecase - enabled via the nightly feature", {
+  skip_if_not(polars_info()$features$nightly)
   df2 = pl$DataFrame(foo = c("hi there", "HI, THERE", NA))
   expect_identical(
     df2$select(pl$col("foo")$str$to_titlecase())$to_list()$foo,
     c("Hi There", "Hi, There", NA)
   )
 })
 
-test_that("to_titlecase - enabled via the simd feature", {
-  skip_if(polars_info()$features$simd)
+test_that("to_titlecase - enabled via the nightly feature", {
+  skip_if(polars_info()$features$nightly)
   expect_error(pl$col("foo")$str$to_titlecase())
 })
 

vignettes/install.Rmd

@@ -136,13 +136,14 @@ For example, to enable the `full_features` feature, set the environment variable
 
 Currently `full_features` would work as a combination of the following features.
 
+- The `default` feature
+  - `sql` for enable `pl$SQLContext()`.
 - Features for CRAN compatibility
   - `disable_limit_max_threads`, this feature disables the automatic limit of the maximum number of threads to 2 for CRAN compatibility,
     and the maximum number of threads is used by default.
     See `?pl_thread_pool_size` for details.
 - Features for nightly toolchain
-  - `simd` for SIMD support.
-  - `sql` for enable `pl$SQLContext()`.
+  - `nightly` for nightly toolchain features and SIMD.
 
 Note that nightly features requires the Rust nightly toolchain `r rust_toolchain_version`.