From 7be576d8c08683945cced8937c2be367569192e5 Mon Sep 17 00:00:00 2001
From: Tomasz Kalinowski <kalinowskit@gmail.com>
Date: Thu, 11 May 2023 14:16:05 -0400
Subject: [PATCH] print simplified traces in `py_last_error()`

---
 R/python.R | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 R/utils.R  | 28 ---------------------------
 2 files changed, 54 insertions(+), 31 deletions(-)

diff --git a/R/python.R b/R/python.R
index db6151f0..e86c3cbb 100644
--- a/R/python.R
+++ b/R/python.R
@@ -1793,20 +1793,71 @@ type_sum.python.builtin.object <- function(x) {
 }
 
 #' @export
-print.py_error <- function(x, ...) {
+print.py_error <- function(x, ..., simplify = getOption("reticulate.print_simplified_traceback", FALSE)) {
 
   py_error_message <- x$message
+  if(simplify) {
+    py_error_message <- strsplit(py_error_message, "\n", fixed = TRUE)[[1L]]
+    reticulate_internal <-
+      grep(
+        'File ".+reticulate[/\\]python[/\\]rpytools[/\\]call.py", line [0-9]+, in python_function',
+        py_error_message)
+    if(length(reticulate_internal))
+      py_error_message <- py_error_message[-c(reticulate_internal, reticulate_internal + 1)]
+    py_error_message <- paste0(py_error_message, collapse = "\n")
+  }
 
   if (identical(.Platform$GUI, "RStudio") &&
       requireNamespace("cli", quietly = TRUE) &&
-      length(etb <- attr(x, "exception")$`__traceback__`))
+      length(etb <- attr(x, "exception")$`__traceback__`)) {
     py_error_message <- make_filepaths_clickable(py_error_message)
+  }
 
   cat_h1("Python Exception Message")
   cat(py_error_message)
 
   cat_h1("R Traceback")
-  print(x$r_trace)
+  r_trace <- x$r_trace
+  if(simplify) {
+
+    internal_frames <- with(r_trace, which(namespace == "reticulate" & scope == ":::"))
+    frames_to_hide <-  unlist(lapply(internal_frames, function(i) {
+      s <- r_trace$call[[i]][[1L]]
+      if(identical(s, quote(call_r_func))) {
+        #  8. ├─reticulate:::call_r_func(`<initialize>`, `<named list>`) at reticulate/R/RcppExports.R:158:4
+        #  9. │ ├─base::withRestarts(...) at reticulate/R/utils.R:7:2
+        # 10. │ │ └─base (local) withOneRestart(expr, restarts[[1L]])
+        # 11. │ │   └─base (local) doWithOneRestart(return(expr), restart)
+        # 12. │ ├─base::withCallingHandlers(...) at reticulate/R/utils.R:7:2
+        # 13. │ ├─base::do.call(fn, args) at reticulate/R/utils.R:7:2"
+        ## keep the call_r_func frame since the r func name (pillar label) can be actionable, but
+        ## drop the calling handler + restart + do.call frames
+        return(i + (1:5))
+      }
+
+      if(identical(s, quote(py_call_impl)))
+        return(i) # drop py_call_impl frame
+
+      NULL
+    }))
+
+    if(length(frames_to_hide)) {
+      r_trace$visible[frames_to_hide] <- FALSE
+      # # last frame must be visible due to bug in rlang:::print.rlang_trace()
+      # r_trace$visible[length(r_trace$visible)] <- TRUE
+    }
+
+  }
+
+  tryCatch(print(r_trace, drop = TRUE),
+           error = function(e) {
+             warning("Print of R Traceback w/o reticulate internal frames failed",
+                     call. = FALSE)
+             print(r_trace)
+           }) #simplify = if(simplify) "branch" else "none")
+
+  invisible(x)
+
 }
 
 cat_h1 <- function(x) {
diff --git a/R/utils.R b/R/utils.R
index d497f034..8dfb4b8c 100644
--- a/R/utils.R
+++ b/R/utils.R
@@ -52,34 +52,6 @@ get_r_trace <- function(maybe_use_cached = FALSE, trim_tail = 1L) {
   ## track down where an error occurred.
   t$full_call <- sys.calls()[seq_len(nrow(t))]
 
-  # Drop reticulate internal frames that are not useful to the user
-  ## (this works, except [ method for traces does not adjust the parent
-  ## correctly when slicing out frames where parent == 0, and
-  ## then the tree that gets printed is not useful.
-  ## TODO: file an issue with rlang)
-  # i <- 1L
-  # while(i < nrow(t)) {
-  #   if(identical(t$call[[i]][[1L]], quote(call_r_function))) {
-  #     # drop frames:
-  #     # withRestarts(withCallingHandlers(return(list(do.call(fn, c(args, named_args)), NULL)), python.builtin.BaseException = function(e) {     r_tra…
-  #     # withOneRestart(expr, restarts[[1L]])
-  #     # doWithOneRestart(return(expr), restart)
-  #     # withCallingHandlers(return(list(do.call(fn, c(args, named_args)), NULL)), python.builtin.BaseException = function(e) {     r_trace <- py_get_…
-  #     # do.call(fn, c(args, named_args))
-  #     i <- i + 1L
-  #     t <- t[-seq.int(from = i, length.out = 5L), ]
-  #   }
-  #
-  #   # drop py_call_impl() frame
-  #   else if(identical(t$call[[i]][[1L]], quote(py_call_impl))) {
-  #     t <- t[-i, ]
-  #   }
-  #
-  #   else {
-  #     i <- i + 1L
-  #   }
-  # }
-
   if(!maybe_use_cached)
     return((.globals$last_r_trace <- t))