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!

[marcelzwiers]

Hi, thanks for your tips. I guess I cannot use logger = logging.getLogger('rich') because I have multiple logging handlers (e.g. two file handlers), only one of them is to the terminal (i.e. the richhandler)? So I have to use logging.getLogger(__name__), right? But then my logging calls interrupt the progress output... I don't know how to solve this?

logging setup

def setup_logging(logfile: Path=Path()):
    """
    Set up the logging framework:
    1) Extend the Logger class with custom 'bcdebug', 'verbose' and 'success' logging levels / methods
    2) Add a console streamhandler
    3) If given a log file, then add a regular log + a warning/error filehandler

    :param logfile:     Name of the log file
    """

    # Set the default formats
    if DEBUG:
        fmt = '%(asctime)s - %(name)s | %(message)s'
    else:
        fmt = '%(asctime)s - %(levelname)s | %(message)s'
    datefmt = '%Y-%m-%d %H:%M:%S'

    # Register custom log levels
    for name, level in {'BCDEBUG': 11, 'VERBOSE': 15, 'SUCCESS': 25}.items():
        logging.addLevelName(level, name)
        setattr(logging, name, level)

    # Register custom log methods
    def bcdebug(self, message, *args, **kws):
        if self.isEnabledFor(logging.BCDEBUG):
            self._log(logging.BCDEBUG, message, args, **kws)
    logging.getLoggerClass().bcdebug = bcdebug

    def verbose(self, message, *args, **kws):
        if self.isEnabledFor(logging.VERBOSE):
            self._log(logging.VERBOSE, message, args, **kws)
    logging.getLoggerClass().verbose = verbose

    def success(self, message, *args, **kws):
        if self.isEnabledFor(logging.SUCCESS):
            self._log(logging.SUCCESS, message, args, **kws)
    logging.getLoggerClass().success = success

    # Set the root logging level
    logger = logging.getLogger()
    logger.setLevel('BCDEBUG' if DEBUG else 'VERBOSE')

    # Add the Rich console handler and bring some color to those boring logs! :-)
    console = Console(theme = Theme({
        'logging.level.verbose': 'grey50',
        'logging.level.success': 'green bold',
        'logging.level.bcdebug': 'bright_yellow'
    }))
    consolehandler = RichHandler(
        console = console,
        show_time = False,
        show_level = True,
        show_path = DEBUG,
        rich_tracebacks = True,
        markup = True,
        level = 'BCDEBUG' if DEBUG else 'VERBOSE' if not logfile.name else 'INFO'
    )
    consolehandler.set_name('console')
    logger.addHandler(consolehandler)

    if logfile.name:

        # Add the verbose filehandler
        logfile.parent.mkdir(parents=True, exist_ok=True)
        formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
        loghandler = logging.FileHandler(logfile)
        loghandler.setLevel('BCDEBUG')
        loghandler.setFormatter(formatter)
        loghandler.set_name('loghandler')
        logger.addHandler(loghandler)

        # Add the error/warnings filehandler
        errorhandler = logging.FileHandler(logfile.with_suffix('.errors'), mode='w')
        errorhandler.setLevel('WARNING')
        errorhandler.setFormatter(formatter)
        errorhandler.set_name('errorhandler')
        logger.addHandler(errorhandler)

[marcelzwiers]

Update: It works fine if I remove console = Console() in:

 consolehandler = RichHandler(console = Console(), ...)

So, how can I get RichHandler to work with a (themed) console, in conjunction with Progress()/track()? I would also be happy if I could pass theme=Theme(..) to RichHandler()...

[marcelzwiers]

Here's a test case:

import logging
import time
from rich.logging import RichHandler
from rich.progress import track
from rich.console import Console

logger = logging.getLogger(__name__)
logger.setLevel('DEBUG')


# Test the RichHandler with Console() 
consolehandler = RichHandler(console=Console())
logger.addHandler(consolehandler)
for n in track(range(5), description="Doing work using Console()"):
    logger.info(f"Logging {n} in the middle of progress...")
    time.sleep(0.2)

# Test the RichHandler without Console() 
logger.removeHandler(consolehandler)
consolehandler = RichHandler()
logger.addHandler(consolehandler)
for n in track(range(5), description="Doing work without using Console()"):
    logger.info(f"Logging {n} in the middle of progress...")
    time.sleep(0.2)

Which gives:

Doing work using Console() ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━   0% -:--:--[06/18/25 01:19:20] INFO     Logging 0 in the middle of progress...                                                                                      test_logging.py:18
Doing work using Console() ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━   0% -:--:--[06/18/25 01:19:21] INFO     Logging 1 in the middle of progress...                                                                                      test_logging.py:18
Doing work using Console() ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━   0% -:--:--                    INFO     Logging 2 in the middle of progress...                                                                                      test_logging.py:18
Doing work using Console() ━━━━━━━━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━  40% 0:00:01                    INFO     Logging 3 in the middle of progress...                                                                                      test_logging.py:18
Doing work using Console() ━━━━━━━━━━━━━━━━━━━━━━━━╺━━━━━━━━━━━━━━━  60% 0:00:01                    INFO     Logging 4 in the middle of progress...                                                                                      test_logging.py:18
Doing work using Console() ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
[06/18/25 01:19:21] INFO     Logging 0 in the middle of progress...                                                                                      test_logging.py:27
[06/18/25 01:19:22] INFO     Logging 1 in the middle of progress...                                                                                      test_logging.py:27
                    INFO     Logging 2 in the middle of progress...                                                                                      test_logging.py:27
                    INFO     Logging 3 in the middle of progress...                                                                                      test_logging.py:27
                    INFO     Logging 4 in the middle of progress...                                                                                      test_logging.py:27
Doing work without using Console() ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01

[marcelzwiers]

I now filed a bug report here: #3769