Do not add outputs when results = 'hide' is set

R/knitr-engine.R

@@ -197,7 +197,7 @@ eng_python <- function(options) {
 
   # Stash some options.
   is_hold <- identical(options$results, "hold")
-  is_include <- isTRUE(options$include)
+  is_hidden <- identical(options$results, "hide")
   jupyter_compat <- isTRUE(options$jupyter_compat)
 
   # line index from which source should be emitted
@@ -305,8 +305,8 @@ eng_python <- function(options) {
         outputs$push(output)
       }
 
-      # append captured outputs (respecting 'include' option)
-      if (is_include) {
+      # append captured outputs (respecting 'results = "hide"' option)
+      if (!is_hidden) {
         # append captured output
         if (!identical(captured, ""))
           outputs_target$push(captured)
@@ -348,10 +348,11 @@ eng_python <- function(options) {
       plt$show()
   }
 
-  for (plot in .engine_context$pending_plots$data())
-    outputs_target$push(plot)
-  .engine_context$pending_plots$clear()
-
+  if (!is_hidden) {
+    for (plot in .engine_context$pending_plots$data())
+      outputs_target$push(plot)
+    .engine_context$pending_plots$clear()
+  }
 
   # if we were using held outputs, we just inject the source in now
   if (is_hold) {

tests/testthat/_snaps/python-knitr-engine/knitr-results-hide.md

@@ -0,0 +1,5 @@
+    class MyClass:
+        def _repr_html_(self):
+            return "<p>uh-oh</p>"
+
+    MyClass()

tests/testthat/resources/knitr-results-hide.Rmd

@@ -0,0 +1,16 @@
+---
+title: "Hide and include"
+output: md_document
+---
+
+```{python, results = 'hide'}
+class MyClass:
+    def _repr_html_(self):
+        return "<p>uh-oh</p>"
+
+MyClass()
+```
+
+```{python, include = FALSE}
+1 + 1
+```

tests/testthat/test-python-knitr-engine.R

@@ -86,6 +86,23 @@ test_that("knitr 'warning=FALSE' option", {
 
 })
 
+test_that("knitr results='hide' and include = FALSE options", {
+
+  skip_on_cran()
+  skip_if_not_installed("rmarkdown")
+
+  local_edition(3) # needed for expect_snapshot_file()
+
+  owd <- setwd(test_path("resources"))
+  rmarkdown::render("knitr-results-hide.Rmd", quiet = TRUE)
+  setwd(owd)
+
+  rendered <- test_path("resources", "knitr-results-hide.md")
+
+  expect_snapshot_file(rendered)
+
+})
+
 test_that("Output streams are remaped when kniting", {
 
   skip_on_cran()