Skip to content

Quiet progress bars #840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jacciz wants to merge 3 commits into from
+37 −12
Closed

Quiet progress bars #840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
041f5fc
added quiet as an argument in cli_progress_bar, also added a unit test
jacciz Sep 17, 2026
8cf7c41
update unit test for when quiet = TRUE for cli_progress_bar
jacciz Sep 17, 2026
273e48c
Changed quiet == FALSE to !quiet, edited news to reflect arugment
jacciz Sep 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# cli (development version)

* `cli_progress_bar()` has a new argument `quiet`. If TRUE, then progress bar will be suppressed.

* `keypress()` improvements:
- `timeout` argument to wait at most a given number of seconds for a
key press.
Expand Down
29 changes: 17 additions & 12 deletions R/progress-client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,8 @@
#' @param current Whether to use this progress bar as the current progress
#' bar of the calling function. See more at 'The current progress bar'
#' below.
#' @param quiet if `TRUE` suppresses output from this function. Defaults to the `cli.disable_progress` option, or
#' `TRUE` if unset.
Comment thread
jacciz marked this conversation as resolved.

@gaborcsardi gaborcsardi Sep 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs still say 'TRUE' or am I missing something here?

#' @param auto_terminate Whether to terminate the progress bar if the
#' number of current units reaches the number of total units.
#' @param extra Extra data to add to the progress bar. This can be
Expand Down Expand Up @@ -320,6 +322,7 @@ cli_progress_bar <- function(
format_failed = NULL,
clear = getOption("cli.progress_clear", TRUE),
current = TRUE,
quiet = getOption("cli.disable_progress", FALSE),
Comment thread
jacciz marked this conversation as resolved.
auto_terminate = type != "download",
extra = NULL,
.auto_close = TRUE,
Expand Down Expand Up @@ -359,7 +362,7 @@ cli_progress_bar <- function(
bar$extra <- extra
clienv$progress[[id]] <- bar
if (current) {
if (!is.null(clienv$progress_ids[[envkey]])) {
if (!is.null(clienv$progress_ids[[envkey]]) && !quiet) {

@gaborcsardi gaborcsardi Sep 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem correct to me. If we are creating a new progress bar, then that should be the current progress bar, whether it is quiet or not.

cli_progress_done(
clienv$progress_ids[[envkey]],
.envir = .envir,
Expand All @@ -369,19 +372,21 @@ cli_progress_bar <- function(
clienv$progress_ids[[envkey]] <- id
}

if (.auto_close && envkey != clienv$globalenv) {
defer(
cli_progress_done(id = id, .envir = .envir, result = "auto"),
envir = .envir
)
}
if(!quiet){
if (.auto_close && envkey != clienv$globalenv) {
defer(
cli_progress_done(id = id, .envir = .envir, result = "auto"),
envir = .envir
)
}

opt <- options(cli__pb = bar)
on.exit(options(opt), add = TRUE)
opt <- options(cli__pb = bar)
on.exit(options(opt), add = TRUE)

bar$handlers <- cli_progress_select_handlers(bar, .envir)
for (h in bar$handlers) {
if ("create" %in% names(h)) h$create(bar, .envir = .envir)
bar$handlers <- cli_progress_select_handlers(bar, .envir)
for (h in bar$handlers) {
if ("create" %in% names(h)) h$create(bar, .envir = .envir)
}
}

invisible(id)
Expand Down
18 changes: 18 additions & 0 deletions tests/testthat/test-progress-client.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,21 @@ test_that("cli_progress_bar handles Inf like NA", {
capture_cli_messages(fun(total = Inf))
)
})

test_that("no progress bar when quiet = TRUE", {

fun <- function() {
bar <- cli_progress_bar(
name = "name",
quiet = TRUE
)
for (i in 1:100) {
Sys.sleep(5/100)
cli_progress_update(id = bar)
}
}

# No messages to display
expect_snapshot(capture_cli_messages(fun()))
})

Loading