Add Classed error conditions for programmatic error handling #7139
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Ensure that data.table condition classes in code match documentation | ||
| condition_classes_documentation_linter = function(rd_file) { | ||
| if (!grepl("\\name{datatable-condition-classes}", readChar(rd_file, 100L), fixed = TRUE)) return(invisible()) | ||
|
|
||
| # Find condition classes in R code | ||
| walk_r_ast_for_classes = function(expr) { | ||
| if (is.call(expr) && length(expr) >= 2L && identical(expr[[1L]], quote(stopf)) && "class" %in% names(expr) && is.character(class_arg <- expr[["class"]]) && startsWith(class_arg, "dt_") && endsWith(class_arg, "_error")) { | ||
| class_arg | ||
| } else if (is.recursive(expr)) { | ||
| unlist(lapply(expr, walk_r_ast_for_classes)) | ||
| } | ||
| } | ||
|
|
||
| # Find condition classes in documentation | ||
| walk_rd_ast_for_classes = function(rd_element) { | ||
| if (!is.list(rd_element)) return(character()) | ||
|
|
||
| result = character() | ||
| if (isTRUE(attr(rd_element, "Rd_tag") == "\\code") && length(rd_element) >= 1L) { | ||
| content = rd_element[[1L]] | ||
| if (is.character(content) && startsWith(content, "dt_") && endsWith(content, "_error")) { | ||
| result = content | ||
| } | ||
| } | ||
| c(result, unlist(lapply(rd_element, walk_rd_ast_for_classes))) | ||
| } | ||
|
|
||
| code_classes = list.files("R", pattern = "\\.R$", full.names = TRUE) |> | ||
| lapply(\(f) lapply(parse(f), walk_r_ast_for_classes)) |> | ||
| unlist() |> | ||
| unique() | ||
|
|
||
| doc_classes = rd_file |> | ||
| tools::parse_Rd() |> | ||
| walk_rd_ast_for_classes() |> | ||
| unique() | ||
|
|
||
| miss_in_doc = setdiff(code_classes, doc_classes) | ||
| miss_in_code = setdiff(doc_classes, code_classes) | ||
|
|
||
| if (length(miss_in_doc) > 0L || length(miss_in_code) > 0L) { | ||
| if (length(miss_in_doc) > 0L) { | ||
| cat(sprintf("Condition classes in code but missing from docs: %s\n", toString(miss_in_doc))) | ||
| } | ||
| if (length(miss_in_code) > 0L) { | ||
| cat(sprintf("Condition classes in docs but not in code: %s\n", toString(miss_in_code))) | ||
| } | ||
| stop("Please sync man/datatable-condition-classes.Rd with code condition classes") | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| \name{data.table-error-handling} | ||
| \alias{data.table-error-handling} | ||
| \title{Error Handling with Classed Conditions} | ||
|
MichaelChirico marked this conversation as resolved.
Outdated
|
||
| \description{ | ||
| \code{data.table} provides specific condition classes for common operations, making it easier to handle errors programmatically. This is particularly useful when writing robust code or packages that use \code{data.table}. Relying on the exact text of error messages is fragile (it is not uncommon to change the wording slightly, or for the user's session not to be in English); prefer using the signal class where possible. | ||
| } | ||
| \details{ | ||
| \subsection{Available Error Classes}{ | ||
| \code{data.table} provides four specific error classes: | ||
|
|
||
| \itemize{ | ||
| \item \code{dt_missing_column_error}: When referencing columns that don't exist | ||
| \item \code{dt_invalid_input_error}: When providing invalid input types or empty required arguments | ||
| \item \code{dt_unsortable_type_error}: When trying to sort/key unsupported types | ||
| \item \code{dt_join_type_mismatch_error}: When column types are incompatible in joins/set operations | ||
| } | ||
| } | ||
|
|
||
| \subsection{Backward Compatibility}{ | ||
| All error classes inherit from base R's condition system, so existing \code{tryCatch(..., error = ...)} code continues to work unchanged. The new classes simply provide more specific handling options when needed. | ||
| } | ||
| } | ||
| \examples{ | ||
|
|
||
| # Handle missing column errors specifically | ||
| DT <- data.table(a = 1:3, b = 4:6) | ||
| tryCatch({ | ||
| setkey(DT, nonexistent_col) | ||
| }, dt_missing_column_error = function(e) { | ||
| cat("Missing column detected:", conditionMessage(e), "\n") | ||
| }, error = function(e) { | ||
| cat("Other error:", conditionMessage(e), "\n") | ||
| }) | ||
| } | ||
| \seealso{ | ||
| \code{\link{tryCatch}}, \url{https://adv-r.hadley.nz/conditions.html} | ||
|
Member
There was a problem hiding this comment. While this reference is not bad, it unnecessarily uses third party packages. If there is an alternative that uses base R packages only, then I would prefer to use that one.
Contributor
Author
There was a problem hiding this comment. Would using ?warning and ?signalCondition be appropriate here?
Member
There was a problem hiding this comment. Haven't read them. data.table/R/test.data.table.R Line 435 in 2f0d12f
Member
There was a problem hiding this comment. It's a good idea to link our
Member
There was a problem hiding this comment. What about the first edition of Advanced R? There are mentions of |
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.