[BUG] Progress bar hides cursor and does not restore it if interrupted

[peterjc]

• I've checked docs and closed issues for possible solutions.
• I can't find my issue in the FAQ.

Describe the bug

Rich progress bars hide the cursor, and restore it when finishing normally. However, if interupted by ctrl+c, the cursor remains hidden. I would expect the context manager to restore the cursor even in this situation. The following is a minimal test case after working out why this was happening in my Python application using Rich.

[Cross reference #2333 which was similar but didn't involve interuption.]

Starting with visible cursor (e.g. run reset at the terminal):

Run the progress bar example, python -m "rich.progress_bar":

Let it finish - cursor still visible:

Run the progress bar, but press ctrl+c part way:

Notice the cursor is now hidden. It can be restored using reset (which also clears the screen etc), or python -c "import rich.console; rich.console.Console().show_cursor(True)" works:

Platform

Click to expand

❯ pip freeze | grep rich
platform="Darwin"
rich==13.9.4

❯ python -m rich.diagnose
╭───────────────────────── <class 'rich.console.Console'> ─────────────────────────╮
│ A high level console interface.                                                  │
│                                                                                  │
│ ╭──────────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=123 ColorSystem.TRUECOLOR>                                    │ │
│ ╰──────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                  │
│     color_system = 'truecolor'                                                   │
│         encoding = 'utf-8'                                                       │
│             file = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'> │
│           height = 57                                                            │
│    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=123, height=57),             │
│                        legacy_windows=False,                                     │
│                        min_width=1,                                              │
│                        max_width=123,                                            │
│                        is_terminal=True,                                         │
│                        encoding='utf-8',                                         │
│                        max_height=57,                                            │
│                        justify=None,                                             │
│                        overflow=None,                                            │
│                        no_wrap=False,                                            │
│                        highlight=None,                                           │
│                        markup=None,                                              │
│                        height=None                                               │
│                    )                                                             │
│            quiet = False                                                         │
│           record = False                                                         │
│         safe_box = True                                                          │
│             size = ConsoleDimensions(width=123, height=57)                       │
│        soft_wrap = False                                                         │
│           stderr = False                                                         │
│            style = None                                                          │
│         tab_size = 8                                                             │
│            width = 123                                                           │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭─── <class 'rich._windows.WindowsConsoleFeatures'> ────╮
│ Windows features available.                           │
│                                                       │
│ ╭───────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │
│ ╰───────────────────────────────────────────────────╯ │
│                                                       │
│ truecolor = False                                     │
│        vt = False                                     │
╰───────────────────────────────────────────────────────╯
╭────── Environment Variables ───────╮
│ {                                  │
│     'TERM': 'xterm-ghostty',       │
│     'COLORTERM': 'truecolor',      │
│     'CLICOLOR': None,              │
│     'NO_COLOR': None,              │
│     'TERM_PROGRAM': 'ghostty',     │
│     'COLUMNS': None,               │
│     'LINES': None,                 │
│     'JUPYTER_COLUMNS': None,       │
│     'JUPYTER_LINES': None,         │
│     'JPY_PARENT_PID': None,        │
│     'VSCODE_VERBOSE_LOGGING': None │
│ }                                  │
╰────────────────────────────────────╯

[github-actions]

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

[AClon314]

The temporary solution is atexit.register:

import atexit
def cleanup():
        """
        On linux it makes the scroll bar unuseable, and cause flickering progress.
        And every time you `stop()` brings side effect: breaking 2 new blank lines.
        """
        if 'PROGRESS_DL' in globals():
            PROGRESS_DL.start()
            PROGRESS_DL.stop()
        # if 'CONSOLE' in globals():
        #     CONSOLE.end_capture()

atexit.register(cleanup)
PROGRESS_DL = Progress()

[willmcgugan]

python -m rich.progress_bar will run a test of the progress bar renderable. In an app you would use rich.progress which has a context manager that restores the cursor. Run python -m rich.progress for a demo of the progress bar API. Note it restores the cursor.

[github-actions]

I hope I helped!

Consider sponsoring my work on Rich. I give tech support for free, in addition to maintaining Rich and Textual.

If you like using Rich, you might also enjoy Textual.

Will McGugan

[peterjc]

I hit this big in an app, then reduced it to this test case. I will need to review if the issue still stands. Thank you.