Invisible Progress tasks not transient. [BUG]

Describe the bug I have a function which has a flag to indicate whether a progress bar should be shown or not. By using the visible task kwarg I can effectively hide the progress bar while keeping the rest of the iteration code the same.

However, when the progress bar is hidden, an empty line of output is created when it completes. I thought that setting Progress(transient=True) might suppress the extraneous new line. In my code I use Progress(transient = not show_progress) but set it to always be True here for demonstration purposes.

When Progress(transient=True) and visible=True in the task, the progress bar displayed and then correctly erased upon completion and there is no extra empty line. However, when Progress(transient=True) and visible=False an empty line still appears.

Contents of bug.py:

import sys
import time

from rich.progress import Progress


def scan(show_progress: bool = False) -> None:
    total = 100
    with Progress(transient=True) as progress:
        scan_task = progress.add_task(
            "scanning items", total=total, visible=show_progress
        )

        for i in range(total):
            progress.update(scan_task, advance=1)
            time.sleep(0.01)


if __name__ == "__main__":
    show_progress = bool(int(sys.argv[1]))
    scan(show_progress=show_progress)

Output when showing progress, where displayed progress bar is erased:

$ python bug.py 1
$ 

Output when suppressing progress with extra new line:

$ python bug.py 0

$ 

Is this behavior expected? Is there a better way to easily let the caller enable/disable progress bars that doesn’t use an if/else where one branch uses the Progress context manager and the other doesn’t with otherwise duplicated iteration code? Open to suggestions.

Platform

Click to expand

╭───────────────────────── <class 'rich.console.Console'> ─────────────────────────╮
│ A high level console interface.                                                  │
│                                                                                  │
│ ╭──────────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=167 ColorSystem.TRUECOLOR>                                    │ │
│ ╰──────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                  │
│     color_system = 'truecolor'                                                   │
│         encoding = 'utf-8'                                                       │
│             file = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'> │
│           height = 16                                                            │
│    is_alt_screen = False                                                         │
│ is_dumb_terminal = False                                                         │
│   is_interactive = True                                                          │
│       is_jupyter = False                                                         │
│      is_terminal = True                                                          │
│   legacy_windows = False                                                         │
│         no_color = False                                                         │
│          options = ConsoleOptions(                                               │
│                        size=ConsoleDimensions(width=167, height=16),             │
│                        legacy_windows=False,                                     │
│                        min_width=1,                                              │
│                        max_width=167,                                            │
│                        is_terminal=True,                                         │
│                        encoding='utf-8',                                         │
│                        max_height=16,                                            │
│                        justify=None,                                             │
│                        overflow=None,                                            │
│                        no_wrap=False,                                            │
│                        highlight=None,                                           │
│                        markup=None,                                              │
│                        height=None                                               │
│                    )                                                             │
│            quiet = False                                                         │
│           record = False                                                         │
│         safe_box = True                                                          │
│             size = ConsoleDimensions(width=167, height=16)                       │
│        soft_wrap = False                                                         │
│           stderr = False                                                         │
│            style = None                                                          │
│         tab_size = 8                                                             │
│            width = 167                                                           │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭─── <class 'rich._windows.WindowsConsoleFeatures'> ────╮
│ Windows features available.                           │
│                                                       │
│ ╭───────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │
│ ╰───────────────────────────────────────────────────╯ │
│                                                       │
│ truecolor = False                                     │
│        vt = False                                     │
╰───────────────────────────────────────────────────────╯
╭────── Environment Variables ───────╮
│ {                                  │
│     'TERM': 'xterm-256color',      │
│     'COLORTERM': 'truecolor',      │
│     'CLICOLOR': None,              │
│     'NO_COLOR': None,              │
│     'TERM_PROGRAM': 'vscode',      │
│     'COLUMNS': None,               │
│     'LINES': None,                 │
│     'JPY_PARENT_PID': None,        │
│     'VSCODE_VERBOSE_LOGGING': None │
│ }                                  │
╰────────────────────────────────────╯
platform="Linux"

rich @ file:///home/vscode/.cache/pypoetry/artifacts/75/b2/7e/cbc8a075a6318a98ac06848a183696936d11430bd373be488dc0ef50ce/rich-12.4.4-py3-none-any.whl

[sullivancolin]

Using Progress(disable=not show_progress) solved my issue and I can now get the desired effect without using visible=True! Thank you! 🚀 🎉

I don’t know if the different behavior for transient with respect to visible/not visible progress bars is still an issue worth investigating for you or not.

Itt might be worth highlighting the existence of the disable flag in the docs here. I’m happy to submit a PR in the documentation if you would like.

Thanks again

[github-actions[bot]]

Did I solve your problem?

Why not buy the devs a coffee to say thanks?