RichHandler logging interaction with ProgressBar

[tjnd89]

ProgressBar() does not seem to play well with logging using RichHandler(). Logger output appears at the right edge of the ProgressBar display, rather than on a new line below the ProgressBar. It's not clear to me whether this is a bug or my misunderstanding of how they should play together.

Here's sample code to reproduce the problem:

import logging
from pathlib import Path
from time import sleep

from rich.console import Console
from rich.logging import RichHandler
from rich.progress import (
    Progress,
    BarColumn,
    MofNCompleteColumn,
    TextColumn,
    TimeRemainingColumn,
    TimeElapsedColumn,
)


def get_file_handler(log_dir: Path):
    log_format = f"%(asctime)s - [%(levelname)s] - %(name)s - (%(funcName)s(%(lineno)d)) - %(message)s"
    log_file = log_dir / 'test.log'
    file_handler = logging.FileHandler(log_file)
    file_handler.setFormatter(logging.Formatter(log_format))
    return file_handler


def get_rich_handler():
    rich_format = f"%(name)s - %(message)s"
    console = Console()
    rh = RichHandler(console=console)
    rh.setFormatter(logging.Formatter(rich_format))
    return rh


def get_logger(log_dir: Path):
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    logger.addHandler(get_file_handler(log_dir))
    logger.addHandler(get_rich_handler())
    logger.propagate = False
    return logger


def main():

    my_progress_bar = Progress(
        TextColumn("{task.description}"),
        BarColumn(),
        MofNCompleteColumn(),
        TimeElapsedColumn(),
        TimeRemainingColumn(),
        refresh_per_second=2,
    )

    logger = get_logger(Path(r'c:\temp'))

    logger.info("I'm logging!")

    with my_progress_bar as progress:
        my_counter = range(10)
        first_task = progress.add_task("First task", total=len(my_counter))
        for count in my_counter:
            sleep(1)
            logger.info(f"I made it to count {count}.")
            progress.advance(first_task)

    logger.info("Done logging.")


if __name__ == "__main__":
    main()

This results in output that looks like:

The desired output would be to have just one progress bar that stays at the bottom while the logger output accumulates above it.

Platform

Click to expand

Running in Windows 11 using the Terminal. Here's the output of rich.diagnose:

╭───────────────────────── <class 'rich.console.Console'> ─────────────────────────╮
│ A high level console interface.                                                  │
│                                                                                  │
│ ╭──────────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=155 ColorSystem.TRUECOLOR>                                    │ │
│ ╰──────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                  │
│     color_system = 'truecolor'                                                   │
│         encoding = 'utf-8'                                                       │
│             file = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'> │
│           height = 28                                                            │
│    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=155, height=28),             │
│                        legacy_windows=False,                                     │
│                        min_width=1,                                              │
│                        max_width=155,                                            │
│                        is_terminal=True,                                         │
│                        encoding='utf-8',                                         │
│                        max_height=28,                                            │
│                        justify=None,                                             │
│                        overflow=None,                                            │
│                        no_wrap=False,                                            │
│                        highlight=None,                                           │
│                        markup=None,                                              │
│                        height=None                                               │
│                    )                                                             │
│            quiet = False                                                         │
│           record = False                                                         │
│         safe_box = True                                                          │
│             size = ConsoleDimensions(width=155, height=28)                       │
│        soft_wrap = False                                                         │
│           stderr = False                                                         │
│            style = None                                                          │
│         tab_size = 8                                                             │
│            width = 155                                                           │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭── <class 'rich._windows.WindowsConsoleFeatures'> ───╮
│ Windows features available.                         │
│                                                     │
│ ╭─────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=True, truecolor=True) │ │
│ ╰─────────────────────────────────────────────────╯ │
│                                                     │
│ truecolor = True                                    │
│        vt = True                                    │
╰─────────────────────────────────────────────────────╯
╭────── Environment Variables ───────╮
│ {                                  │
│     'TERM': None,                  │
│     'COLORTERM': None,             │
│     'CLICOLOR': None,              │
│     'NO_COLOR': None,              │
│     'TERM_PROGRAM': None,          │
│     'COLUMNS': None,               │
│     'LINES': None,                 │
│     'JUPYTER_COLUMNS': None,       │
│     'JUPYTER_LINES': None,         │
│     'JPY_PARENT_PID': None,        │
│     'VSCODE_VERBOSE_LOGGING': None │
│ }                                  │
╰────────────────────────────────────╯
platform="Windows"

and the rich version is

rich                      12.5.1

[willmcgugan]

The logging handler and the Progress should use the same Console.

[tjnd89]

Beautiful. I just updated the code to create one console and pass it around. Works like a champ. Thanks!

Updated code (for posterity) is:

import logging
from pathlib import Path
from time import sleep

from rich.console import Console
from rich.logging import RichHandler
from rich.progress import (
    Progress,
    BarColumn,
    MofNCompleteColumn,
    TextColumn,
    TimeRemainingColumn,
    TimeElapsedColumn,
)


def get_file_handler(log_dir: Path):
    log_format = f"%(asctime)s - [%(levelname)s] - %(name)s - (%(funcName)s(%(lineno)d)) - %(message)s"
    log_file = log_dir / 'test.log'
    file_handler = logging.FileHandler(log_file)
    file_handler.setFormatter(logging.Formatter(log_format))
    return file_handler


def get_rich_handler(console: Console):
    rich_format = f"%(name)s - %(message)s"
    rh = RichHandler(console=console)
    rh.setFormatter(logging.Formatter(rich_format))
    return rh


def get_logger(log_dir: Path, console: Console):
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    logger.addHandler(get_file_handler(log_dir))
    logger.addHandler(get_rich_handler(console))
    logger.propagate = False
    return logger


def main():

    console = Console()

    my_progress_bar = Progress(
        TextColumn("{task.description}"),
        BarColumn(),
        MofNCompleteColumn(),
        TimeElapsedColumn(),
        TimeRemainingColumn(),
        refresh_per_second=2,
        console=console,
    )

    logger = get_logger(Path(r'c:\temp'), console)

    logger.info("I'm logging!")

    with my_progress_bar as progress:
        my_counter = range(10)
        first_task = progress.add_task("First task", total=len(my_counter))
        for count in my_counter:
            sleep(1)
            logger.info(f"I made it to count {count}.")
            progress.advance(first_task)

    logger.info("Done logging.")


if __name__ == "__main__":
    main()