[BUG] Flashing Progress Bars (Colorama?)

Describe the bug When I utilize functions/classes within the pyNastran library, my progress bars start flashing and lose the bar color. pyNastran seems to use a custom logger written by @SteveDoyle2, which uses Colorama. I suspect there’s some clash with the built-in logging from PyNastran, and the colors my own code uses from Rich.

To Reproduce From the docs and slightly expanded:

from rich.progress import track
import time

for n in track(range(20), description="Processing..."):
    time.sleep(0.5)

Now with just a BDF object from the pyNastran library instantiated, do exactly the same thing:

from rich.progress import track
import time
from pyNastran.bdf.bdf import BDF

_ = BDF()

for n in track(range(20), description="Processing..."):
    time.sleep(0.25)

Color goes away until it’s completed, and with more complex progress trackers the spinners/time columns seem to flash.

Platform What platform (Win/Linux/Mac) are you running on? What terminal software are you using?

Windows 10. Windows Terminal (calling cmd.exe). Python 3.8.5. Rich 10.1.0

Diagnose

python -m rich.diagnose
python -m rich._windows
pip freeze | grep rich

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

platform="Windows"
WindowsConsoleFeatures(vt=True, truecolor=True)

(I don’t have grep or cygWin/gitBash installed at all)

'grep' is not recognized as an internal or external command,
operable program or batch file.

[Czarified]

@willmcgugan That seems to fix it!

Conclusion: If any code or imported libraries use Colorama, it can cause graphical glitches with colors, spinners, and progress bars. If you know you have this “conflict” add the following to your imports section:

import colorama
colorama.deinit()

Thanks so much Will and Steven for your help here! I’ll close this issue.

[SteveDoyle2]

I’ve never tried rich outside of my quick test today, so I’m not sure how rich is supposed to look, but I think it’s due to the difference in how we call colorinit. I use autoreset=True in cpylog (imported by pyNastran) and rich uses strip=False and they’re both called.

The behavior under powershell seems strange (the line changing after it’s done), but that’s consistently weird. Terminal changes the color of the line during runtime based on the init flags.

There’s probably an update init call that needs to be done, that probably should be handled externally from either package.