Using logging with rich.progress

[d-k-bo]

Hi,
I would like to display the output of the built-in logging module above a progress bar.
The documentation states that stdout is redirected without breaking the bar.
So I thought i could just do this:

import logging
import time

from rich.logging import RichHandler
from rich.progress import Progress

logging.basicConfig(handlers=[RichHandler()])
logger = logging.getLogger('rich')

with Progress(expand=True) as progress:
    task = progress.add_task("Loading...",)
    while not progress.finished:
        logger.info('some log output')
        progress.update(task, advance=10)
        time.sleep(0.1)

Unfortunately, the progress bar breaks on each log entry.
While using print() or progress.log() works, I can't get it to work with logging. I tried using a common Console object for my RichHandler and Progress, but that didn't help.

How can I accomplish this?

[willmcgugan]

Your example didn't run as is because you didn't set the level on basicConfig, but the following works as expected for me:

import logging
import time

from rich.logging import RichHandler
from rich.progress import Progress

logging.basicConfig(level="NOTSET", handlers=[RichHandler(level="NOTSET")])
logger = logging.getLogger('rich')

with Progress(expand=True) as progress:
    task = progress.add_task("Loading...",)
    while not progress.finished:
        logger.info('some log output')
        progress.update(task, advance=0.1)
        time.sleep(1)

[d-k-bo]

Thank you for your reply!
Now I realized that this mistake wasn't what caused my main problem.
I used python -m mypackage.test to run my test script instead of calling python test.py and in my init.py I imported some functions from a module that uses the coloredlogs package, which must have interfered somehow with the logger of my test file.
And setting the log level is of course needed to see any output at all. 😅

[mezhgano]

Hello, thanks for the tip
Can we expect same behavior with console.status?

logging.basicConfig(level="NOTSET", handlers=[RichHandler(level="NOTSET")])
logger = logging.getLogger('rich')

with console.status('Parsing...'):
    for x in range(5):
        logger.info('some log output')
        sleep(1)

I've tried example above with latest rich release (13.7.7) and unfortunately log messages breaks console.status animation...

[willmcgugan]

Pass your console to the RichHandler constructor.

[mezhgano]

I should just spend another minutes to figure it out by myself...
Thank You!