-
Notifications
You must be signed in to change notification settings - Fork 137
/
cnd.R
629 lines (560 loc) · 16.2 KB
/
cnd.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
#' Errors of class `rlang_error`
#'
#' @description
#' [abort()] and [error_cnd()] create errors of class `"rlang_error"`.
#' The differences with base errors are:
#'
#' - Implementing `conditionMessage()` methods for subclasses of
#' `"rlang_error"` is undefined behaviour. Instead, implement the
#' [cnd_header()] method (and possibly [cnd_body()] and
#' [cnd_footer()]). These methods return character vectors which are
#' assembled by rlang when needed: when
#' [`conditionMessage.rlang_error()`][conditionMessage] is called
#' (e.g. via [try()]), when the error is displayed through [print()]
#' or [format()], and of course when the error is displayed to the
#' user by [abort()].
#'
#' - [cnd_header()], [cnd_body()], and [cnd_footer()] methods can be
#' overridden by storing closures in the `header`, `body`, and
#' `footer` fields of the condition. This is useful to lazily
#' generate messages based on state captured in the closure
#' environment.
#'
#' - `r lifecycle::badge("experimental")` The `use_cli_format`
#' condition field instructs whether to use cli (or rlang's fallback
#' method if cli is not installed) to format the error message at
#' print time.
#'
#' In this case, the `message` field may be a character vector of
#' header and bullets. These are formatted at the last moment to
#' take the context into account (starting position on the screen
#' and indentation).
#'
#' See [local_use_cli()] for automatically setting this field in
#' errors thrown with [abort()] within your package.
#'
#' @name rlang_error
NULL
#' Create a condition object
#'
#' @description
#' These constructors create subclassed conditions, the objects that
#' power the error, warning, and message system in R.
#'
#' * `cnd()` creates bare conditions that only inherit from
#' `condition`.
#'
#' * Conditions created with `error_cnd()`, `warning_cnd()`, and
#' `message_cnd()` inherit from `"error"`, `"warning"`, or `"message"`.
#'
#' * `error_cnd()` creates subclassed errors. See
#' [`"rlang_error"`][rlang_error].
#'
#' Use [cnd_signal()] to emit the relevant signal for a particular
#' condition class.
#'
#' @param class The condition subclass.
#' @param ... <[dynamic][dyn-dots]> Named data fields stored inside
#' the condition object.
#' @param message A default message to inform the user about the
#' condition when it is signalled.
#' @param call A function call to be included in the error message.
#' If an execution environment of a running function, the
#' corresponding function call is retrieved.
#' @param trace A `trace` object created by [trace_back()].
#' @param parent A parent condition object.
#' @param use_cli_format Whether to use the cli package to format
#' `message`. See [local_use_cli()].
#' @seealso [cnd_signal()], [try_fetch()].
#'
#' @keywords internal
#' @export
#' @examples
#' # Create a condition inheriting only from the S3 class "foo":
#' cnd <- cnd("foo")
#'
#' # Signal the condition to potential handlers. Since this is a bare
#' # condition the signal has no effect if no handlers are set up:
#' cnd_signal(cnd)
#'
#' # When a relevant handler is set up, the signal transfers control
#' # to the handler
#' with_handlers(cnd_signal(cnd), foo = function(c) "caught!")
#' tryCatch(cnd_signal(cnd), foo = function(c) "caught!")
cnd <- function(class,
...,
message = "",
call = NULL,
use_cli_format = NULL) {
check_required(class)
if (is_environment(call)) {
call <- error_call(call)
}
fields <- cnd_fields(
...,
call = call,
`_use_cli_format` = use_cli_format,
`_fn` = "cnd",
`_frame` = caller_env()
)
.Call(ffi_new_condition, class, message, fields)
}
#' @rdname cnd
#' @export
error_cnd <- function(class = NULL,
...,
message = "",
call = NULL,
trace = NULL,
parent = NULL,
use_cli_format = NULL) {
if (!is_null(trace) && !inherits(trace, "rlang_trace")) {
stop_input_type(trace, "`NULL` or an rlang backtrace")
}
if (!is_null(parent) && !inherits(parent, "condition")) {
stop_input_type(parent, "`NULL` or a condition object")
}
if (is_environment(call)) {
call <- error_call(call)
}
fields <- error_cnd_fields(
trace = trace,
parent = parent,
...,
use_cli_format = use_cli_format,
call = call
)
.Call(
ffi_new_condition,
c(class, "rlang_error", "error"),
message,
fields
)
}
error_cnd_fields <- function(trace,
parent,
...,
use_cli_format = NULL,
.subclass = NULL,
`_env` = caller_env(),
`_frame` = caller_env(2)) {
if (!is_null(.subclass)) {
deprecate_subclass(.subclass, "error_cnd", `_env`)
}
use_cli_format <- use_cli_format %||% use_cli(`_frame`)[["format"]]
if (is_true(use_cli_format)) {
list2(trace = trace, parent = parent, ..., use_cli_format = TRUE)
} else {
list2(trace = trace, parent = parent, ...)
}
}
#' @rdname cnd
#' @export
warning_cnd <- function(class = NULL,
...,
message = "",
call = NULL,
use_cli_format = NULL) {
if (is_environment(call)) {
call <- error_call(call)
}
fields <- cnd_fields(
...,
call = call,
`_use_cli_format` = use_cli_format,
`_fn` = "warning_cnd",
`_frame` = caller_env()
)
.Call(
ffi_new_condition,
c(class, "rlang_warning", "warning"),
message,
fields
)
}
#' @rdname cnd
#' @export
message_cnd <- function(class = NULL,
...,
message = "",
call = NULL,
use_cli_format = NULL) {
if (is_environment(call)) {
call <- error_call(call)
}
fields <- cnd_fields(
...,
call = call,
`_use_cli_format` = use_cli_format,
`_fn` = "message_cnd",
`_frame` = caller_env()
)
.Call(
ffi_new_condition,
c(class, "rlang_message", "message"),
message,
fields
)
}
cnd_fields <- function(...,
.subclass = NULL,
`_use_cli_format` = NULL,
`_fn` = "cnd",
`_env` = caller_env(),
`_frame` = caller_env(2)) {
if (!is_null(.subclass)) {
deprecate_subclass(.subclass, `_fn`, `_env`)
}
use_cli_format <- `_use_cli_format` %||% use_cli(`_frame`)[["format"]]
if (is_true(use_cli_format)) {
dots_list(..., use_cli_format = use_cli_format)
} else {
dots_list(...)
}
}
#' Is object a condition?
#' @param x An object to test.
#' @keywords internal
#' @export
is_condition <- function(x) {
inherits(x, "condition")
}
#' @rdname is_condition
#' @export
is_error <- function(x) {
inherits(x, "error")
}
#' @rdname is_condition
#' @export
is_warning <- function(x) {
inherits(x, "warning")
}
#' @rdname is_condition
#' @export
is_message <- function(x) {
inherits(x, "message")
}
#' What type is a condition?
#'
#' Use `cnd_type()` to check what type a condition is.
#'
#' @param cnd A condition object.
#' @return A string, either `"condition"`, `"message"`, `"warning"`,
#' `"error"` or `"interrupt"`.
#'
#' @keywords internal
#' @export
#' @examples
#' cnd_type(catch_cnd(abort("Abort!")))
#' cnd_type(catch_cnd(interrupt()))
cnd_type <- function(cnd) {
.Call(ffi_cnd_type, cnd)
}
#' Does a condition or its ancestors inherit from a class?
#'
#' @description
#' Like any R objects, errors captured with catchers like [tryCatch()]
#' have a [class()] which you can test with [inherits()]. However,
#' with chained errors, the class of a captured error might be
#' different than the error that was originally signalled. Use
#' `cnd_inherits()` to detect whether an error or any of its _parent_
#' inherits from a class.
#'
#' Whereas `inherits()` tells you whether an object is a particular
#' kind of error, `cnd_inherits()` answers the question whether an
#' object is a particular kind of error or has been caused by such an
#' error.
#'
#' Some chained conditions carry parents that are not inherited. See
#' the `.inherit` argument of [abort()], [warn()], and [inform()].
#'
#'
#' # Capture an error with `cnd_inherits()`
#'
#' Error catchers like [tryCatch()] and [try_fetch()] can only match
#' the class of a condition, not the class of its parents. To match a
#' class across the ancestry of an error, you'll need a bit of
#' craftiness.
#'
#' Ancestry matching can't be done with `tryCatch()` at all so you'll
#' need to switch to [withCallingHandlers()]. Alternatively, you can
#' use the experimental rlang function [try_fetch()] which is able to
#' perform the roles of both `tryCatch()` and `withCallingHandlers()`.
#'
#'
#' ## `withCallingHandlers()`
#'
#' Unlike `tryCatch()`, `withCallingHandlers()` does not capture an
#' error. If you don't explicitly jump with an _error_ or a _value_
#' throw, nothing happens.
#'
#' Since we don't want to throw an error, we'll throw a value using
#' [callCC()]:
#'
#' ```{r, comment = "#>", collapse = TRUE}
#' f <- function() {
#' parent <- error_cnd("bar", message = "Bar")
#' abort("Foo", parent = parent)
#' }
#'
#' cnd <- callCC(function(throw) {
#' withCallingHandlers(
#' f(),
#' error = function(x) if (cnd_inherits(x, "bar")) throw(x)
#' )
#' })
#'
#' class(cnd)
#' class(cnd$parent)
#' ```
#'
#'
#' ## `try_fetch()`
#'
#' This pattern is easier with [try_fetch()]. Like
#' `withCallingHandlers()`, it doesn't capture a matching error right
#' away. Instead, it captures it only if the handler doesn't return a
#' [zap()] value.
#'
#' ```{r, comment = "#>", collapse = TRUE}
#' cnd <- try_fetch(
#' f(),
#' error = function(x) if (cnd_inherits(x, "bar")) x else zap()
#' )
#'
#' class(cnd)
#' class(cnd$parent)
#' ```
#'
#' Note that `try_fetch()` uses `cnd_inherits()` internally. This
#' makes it very easy to match a parent condition:
#'
#' ```{r, comment = "#>", collapse = TRUE}
#' cnd <- try_fetch(
#' f(),
#' bar = function(x) x
#' )
#'
#' # This is the parent
#' class(cnd)
#' ```
#'
#' @param cnd A condition to test.
#' @param class A class passed to [inherits()].
#'
#' @export
cnd_inherits <- function(cnd, class) {
cnd_some(cnd, inherits, class)
}
cnd_some <- function(cnd, fn, ...) {
while (is_condition(cnd)) {
if (fn(cnd, ...)) {
return(TRUE)
}
inherit <- .subset2(.subset2(cnd, "rlang"), "inherit")
if (is_false(inherit)) {
return(FALSE)
}
cnd <- cnd[["parent"]]
}
FALSE
}
# Methods -----------------------------------------------------------------
#' @export
print.rlang_error <- function(x, ...) {
writeLines(format(x, ...))
invisible(x)
}
is_rlang_error <- function(x) {
inherits(x, "rlang_error")
}
#' @export
format.rlang_error <- function(x,
...,
backtrace = TRUE,
simplify = NULL,
drop = NULL) {
simplify <- arg_match_simplify(simplify)
drop <- arg_match_drop(drop)
# Allow overwriting default display via condition field
simplify <- x$rlang$internal$trace_simplify %||% simplify
drop <- x$rlang$internal$trace_drop %||% drop
simplify <- arg_match_simplify(simplify)
with_error_arg_highlight(
out <- cnd_format(
x,
...,
backtrace = backtrace,
simplify = simplify,
drop = drop
)
)
# Recommend printing the full backtrace if called from `last_error()`
from_last_error <- is_true(x$rlang$internal$from_last_error)
if (from_last_error && !is_null(x$trace)) {
if (drop && !all(x$trace$visible)) {
n_hidden <- sum(!x$trace$visible)
hidden <- ngettext(
n_hidden,
"%d hidden frame",
"%d hidden frames"
)
hidden <- sprintf(hidden, n_hidden)
last_trace <- style_rlang_run("last_trace(drop = FALSE)")
reminder <- col_silver(sprintf("Run %s to see %s.", last_trace, hidden))
out <- paste_line(out, reminder)
} else if (simplify == "branch") {
last_trace <- style_rlang_run("last_trace()")
reminder <- col_silver(paste0("Run `", last_trace, "` to see the full context."))
out <- paste_line(out, reminder)
}
}
out
}
#' @export
summary.rlang_error <- function(object, ...) {
print(object, simplify = "none")
}
#' @export
print.rlang_warning <- function(x, ...) {
writeLines(format(x, ...))
invisible(x)
}
#' @export
summary.rlang_warning <- function(object, ...) {
print(object, ..., simplify = "none")
}
#' @export
format.rlang_warning <- function(x,
...,
backtrace = TRUE,
simplify = "none") {
cnd_format(x, ..., backtrace = backtrace, simplify = simplify)
}
#' @export
print.rlang_message <- print.rlang_warning
#' @export
summary.rlang_message <- summary.rlang_warning
#' @export
format.rlang_message <- format.rlang_warning
cnd_print <- function(x, ...) {
writeLines(cnd_format(x, ...))
invisible(x)
}
cnd_format <- function(x,
...,
backtrace = TRUE,
simplify = NULL,
prefix = TRUE,
alert = NULL,
drop = NULL) {
simplify <- arg_match_simplify(simplify)
drop <- arg_match_drop(drop)
alert <- alert %||% is_error(x)
orig <- x
parent <- x[["parent"]]
style <- cli_box_chars()
header <- cnd_type_header(x)
if (prefix) {
# Skip child errors that have empty messages and calls
while (!length(message <- cnd_message_format_prefixed(x, alert = alert))) {
if (is_condition(parent)) {
x <- parent
parent <- x[["parent"]]
} else {
break
}
}
} else {
message <- cnd_message_format(x, alert = alert)
}
out <- paste_line(
header,
message
)
trace <- x[["trace"]]
last_trace <- NULL
pending_trace <- NULL
# This flushes backtraces lazily so that chained error messages
# accumulate before displaying a backtrace
push_trace <- function(cnd, trace) {
if (!can_paste_trace(backtrace, trace)) {
return()
}
if (is_same_trace()) {
return()
}
flush_trace()
pending_trace <<- list(cnd = cnd, trace = trace)
}
flush_trace <- function() {
if (is_null(pending_trace)) {
return()
}
out <<- paste_line(out, "---")
out <<- paste_trace(
out,
pending_trace[["trace"]],
simplify = simplify,
...,
drop = drop
)
if (!is_null(parent)) {
out <<- paste_line(out, "---")
}
last_trace <<- pending_trace[["trace"]]
pending_trace <<- NULL
}
is_same_trace <- function() {
compare <- if (is_null(pending_trace)) last_trace else pending_trace[["trace"]]
if (!is_trace(trace) || !is_trace(compare)) {
return(FALSE)
}
# NOTE: Should we detect trace subsets as well?
identical(
format(trace, simplify = simplify, drop = drop),
format(compare, simplify = simplify, drop = drop)
)
}
push_trace(x, trace)
while (!is_null(parent)) {
x <- parent
parent <- parent[["parent"]]
trace <- x[["trace"]]
if (!is_null(trace) && !is_same_trace()) {
flush_trace()
}
message <- cnd_message_format_prefixed(x, parent = TRUE)
out <- paste_line(out, message)
push_trace(x, trace)
}
flush_trace()
out
}
can_paste_trace <- function(backtrace, trace) {
backtrace && is_trace(trace) && trace_length(trace)
}
paste_trace <- function(x, trace, simplify, ...) {
trace_lines <- format(
trace,
...,
simplify = simplify
)
paste_line(x, style_bold("Backtrace:"), trace_lines)
}
cnd_type_header <- function(cnd) {
type <- cnd_type(cnd)
class <- class(cnd)[[1]]
if (class != type) {
class <- c(type, class)
}
style_bold(format_cls(class))
}
testthat_print_cnd <- function(x, ...) {
print(x, backtrace = FALSE)
}
on_load({
s3_register("testthat::testthat_print", "rlang_error", testthat_print_cnd)
s3_register("testthat::testthat_print", "rlang_warning", testthat_print_cnd)
s3_register("testthat::testthat_print", "rlang_message", testthat_print_cnd)
})