HyukjinKwon commented on a change in pull request #29947:
URL: https://github.com/apache/spark/pull/29947#discussion_r501561059
##########
File path: python/pyspark/sql/functions.pyi
##########
@@ -137,6 +137,8 @@ def sha1(col: ColumnOrName) -> Column: ...
def sha2(col: ColumnOrName, numBits: int) -> Column: ...
def hash(*cols: ColumnOrName) -> Column: ...
def xxhash64(*cols: ColumnOrName) -> Column: ...
+def assert_true(col: ColumnOrName, errMsg: Union[Column, str] = ...): ...
Review comment:
I think doing `Column` is fine.
##########
File path: R/pkg/R/functions.R
##########
@@ -826,6 +826,55 @@ setMethod("xxhash64",
column(jc)
})
+#' @details
+#' \code{assert_true}: Returns null if the input column is true; throws an
exception
+#' with the provided error message otherwise.
+#'
+#' @param errMsg (optional) The error message to be thrown.
+#'
+#' @rdname column_misc_functions
+#' @aliases assert_true assert_true,Column-method
+#' @examples
+#' \dontrun{
+#' tmp <- mutate(df, v1 = assert_true(df$vs < 2),
+#' v2 = assert_true(df$vs < 2, "custom error message"),
+#' v3 = assert_true(df$vs < 2, df$vs))
+#' head(tmp)}
+#' @note assert_true since 3.1.0
+setMethod("assert_true",
+ signature(x = "Column"),
+ function(x, errMsg = NULL) {
+ jc <- if (is.null(errMsg)) {
+ callJStatic("org.apache.spark.sql.functions", "assert_true",
x@jc)
+ } else {
+ if (is.character(errMsg) && length(errMsg) == 1) {
Review comment:
Yeah, more checks should be fine.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
