Replace halo spinner with rich

[s-ff]

This PR is a candidate replacement for Halo spinner as discussed in #1812. It uses Rich module.

If we end up adopting rich, we could maybe use some of its other features to reduce dependencies, for example replacing tqdm with rich.progress and tabulate with rich.table. It could also serve to implement a pager functionality for long output texts.

Checklist

• No CHANGELOG update needed

• No new tests needed

• No documentation update needed

[github-actions]

Please add bug fixes, new features, breaking changes and anything else you think is worthwhile mentioning to the master (unreleased) section of CHANGELOG.md. If no CHANGELOG update is needed add the following to the PR description: [x] No CHANGELOG update needed

CHANGELOG updated or no update needed, thanks! 😄

[williballenthin]

does the rich Console expect to own stderr and that all writes to it go through the console instance? Or can a console be freely mixed with raw print calls (to stderr)?

[williballenthin]

we can test by having an active spinner (or rich progress bar) and also writing to the output stream directly, and then observing if the spinner is correctly cleaned up/rendered near the new lines.

[s-ff]

does the rich Console expect to own stderr and that all writes to it go through the console instance? Or can a console be freely mixed with raw print calls (to stderr)?

we can test by having an active spinner (or rich progress bar) and also writing to the output stream directly, and then observing if the spinner is correctly cleaned up/rendered near the new lines.

I did an expriment for this, and concluded that rich.console.Console can freely be mixed with raw print to stderr.

Test if rich.console can be mixed with raw prints to stderr

import sys
import time

from rich.console import Console

console = Console(stderr=True)

with console.status("Spinner...", spinner="dots"):
    time.sleep(1)
    print("This text is printed to stdout")
    time.sleep(1)
    print("This text is printed to stderr", file=sys.stderr)
    time.sleep(1)

Result:

Does this answer your question @williballenthin?

[williballenthin]

wow that's great!

thanks @s-ff!

[mr-tz]

please also remove the halo entry from .github/mypy/mypy.ini

[mr-tz]

awesome, thanks!