[BUG] Command prompt being pushed aside when using rich.progress

[shadowrylander]

Describe the bug

Using the following class:

from autoslot import SlotsMeta
from rich.progress import Progress

class meclair (SlotsMeta):
    def __init__(cls, *args, **kwargs):
        cls.Progress = Progress(auto_refresh=False)

class eclair(metaclass=meclair):
    def __init__(self, iterable, name, color):
        self.color = color
        self.iterable = tuple(iterable)
        self.len = len(iterable)
        self.increment = 100 / self.len
        self.n = 0
        self.name = name

        if len(self.__class__.Progress.task_ids) == 0:
            self.first_task = self.__class__.Progress.add_task(f"[green]start", total = 0, visible = False)

        self.task = self.__class__.Progress.add_task(f"[{self.color}]{self.name}", total = self.len, start = False)

    def __iter__(self):
        self.n = 0

        if len(self.__class__.Progress.task_ids) == 2:
            self.__class__.Progress.start()
            self.__class__.Progress.start_task(self.__class__.Progress.task_ids[1])
        else:
            self.__class__.Progress.start_task(self.task)

        return self

    def __next__(self):
        if self.n < self.len:
            try:
                self.__class__.Progress.update(self.task, advance = self.increment, refresh = True)
                return self.iterable[self.n]
            finally:
                self.n += 1
        else:
            try:
                raise StopIteration
            finally:
                self.__class__.Progress.stop_task(self.task)
                if self.__class__.Progress.finished:
                    self.__class__.Progress.stop()

With the following examples:

def a():
    for i in eclair(range(100), "a", "red"): pass
def b():
    for i in eclair(range(100), "b", "blue"): pass
def c():
    for i in eclair(range(100), "c", "green"): pass
def d():
    for i in eclair(range(100), "d", "yellow"): pass

for f in eclair((a, b, c, d), "total", "orange"): f()

Results in the command prompt being pushed aside after progress bar completion:

I am attempting to set up a wrapper class for multiple Live displays at once.

Platform

Click to expand

I'm using NixOS with the default Gnome terminal

python -m rich.diagnose:

╭───────────────────────── <class 'rich.console.Console'> ─────────────────────────╮
│ A high level console interface.                                                  │
│                                                                                  │
│ ╭──────────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=200 ColorSystem.TRUECOLOR>                                    │ │
│ ╰──────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                  │
│     color_system = 'truecolor'                                                   │
│         encoding = 'utf-8'                                                       │
│             file = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'> │
│           height = 56                                                            │
│    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=200, height=56),             │
│                        legacy_windows=False,                                     │
│                        min_width=1,                                              │
│                        max_width=200,                                            │
│                        is_terminal=True,                                         │
│                        encoding='utf-8',                                         │
│                        max_height=56,                                            │
│                        justify=None,                                             │
│                        overflow=None,                                            │
│                        no_wrap=False,                                            │
│                        highlight=None,                                           │
│                        markup=None,                                              │
│                        height=None                                               │
│                    )                                                             │
│            quiet = False                                                         │
│           record = False                                                         │
│         safe_box = True                                                          │
│             size = ConsoleDimensions(width=200, height=56)                       │
│        soft_wrap = False                                                         │
│           stderr = False                                                         │
│            style = None                                                          │
│         tab_size = 8                                                             │
│            width = 200                                                           │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭─── <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': None,                                                                                                                                                                            │
│     'COLUMNS': None,                                                                                                                                                                                 │
│     'LINES': None,                                                                                                                                                                                   │
│     'JPY_PARENT_PID': None,                                                                                                                                                                          │
│     'VSCODE_VERBOSE_LOGGING': None                                                                                                                                                                   │
│ }                                                                                                                                                                                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
platform="Linux"

pip freeze | grep rich:

rich==11.2.0

[willmcgugan]

You are using Rich in a way that is contrary to the docs. I'm afraid I can't help you debug your code, but I will convert this to a discussion and maybe somebody else can help.

[shadowrylander]

Fair enough!