How to have progress bar nicely at the bottom of screen and additional messages scrolling up while using echo, echo_error and verbose and not progress.print?

[oPromessa]

How to have progress bar nicely at the bottom of screen and additional messages scrolling up while using echo, echo_error and verbose and not progress.print?

This is beyond the scope of osxphotos... thought I'd try my luck.

Based on cli_example_2.py and cli_example_3.py I have a for loop to process some photos.

• I want the effect you have on push-exif with progress bar nicely at the bottom of screen and additional messages scrolling up with the use of progress.print
• Thing is that while processing each photo I resort to echo, echo_error, verbose from osxphotos which I've not been able to make it compatible with rich.progress.
• I'm poking around from osxphotos.cli.verbose import get_verbose_console and passing it into Progress(console=get_verbose_console,...) and playing with options redirect_stdout and redirect_stderr but getting nowhere!
• Do you know of any possibility to have this accomplished, short of changing all echo, echo_error and verbose to progress.print

Imports

from osxphotos.cli import echo, echo_error  # abort, logger
from osxphotos.cli.verbose import verbose_print
from osxphotos.timeutils import utc_offset_string_to_seconds

from rich.progress import Progress, TextColumn

from rich.progress import (
    Progress,
    TextColumn,
    BarColumn,
    MofNCompleteColumn,
    TimeElapsedColumn,
    TimeRemainingColumn
)

Setting up verbose from verbose_print

    global verbose

    # verbose output into stderr
    verbose = verbose_print(verbose=verbose_flag, file=sys.stderr)

• I use verbose_flag on click.option

@click.option('--verbose', '-v', 'verbose_flag',
              count=True, help="Increase verbosity level.")

Setting up the Progress Bar

        with Progress(
            TextColumn("Processing {task.total} photos:"), 
            TextColumn("•"),
            TextColumn("[progress.percentage]{task.percentage:>3.0f}%"), 
            BarColumn(),
            MofNCompleteColumn(),
            TextColumn("•"),
            TimeElapsedColumn(),
            TextColumn("•"),
            TimeRemainingColumn(),
            TextColumn("•"),
            TextColumn("Current item: {task.fields[current_item]}"),
            console = get_verbose_console(),
            auto_refresh = True,
            redirect_stdout = False,
            redirect_stderr = False,
            ) as progress:

            (...)
            task = progress.add_task(f"Processing photos",
                                    total=num_photos,
                                    current_item="...")   

            for row in reader:

               progress.print("this messages is presented correctly")

               # this messes up the output
               verbose(f"\\[v4] Processing row: [{row}]", level=4)
(...)
               progress.update(task, 
                                advance=1, 
                                current_item=row['2-FileName']
                                )

[RhetTbull]

I don't know why your example isn't working but here is a minimal example that does work. I suggest starting from this then adding the additional Progress options (perhaps it's one or more of those that are affecting this). It more likely may be how you're configuring verbose (the file=sys.stderr is likely bypassing the Console object and just going straight to stderr. For Progress to work with nice output, everything must go through the Console object).

The rich / echo / verbose / progress code in OSXPhotos is a bit of a mess and requires some hacking such as setting up verbose and using get_verbose_console() to work with themes, Progress, etc. It's one area I would completely rewrite if I had time. Unfortunately I barely have time to do minimal maintenance on OSXPhotos these days!

"""Sample query command for osxphotos """

from __future__ import annotations

import time

from rich.progress import Progress

import osxphotos
from osxphotos.cli import query_command, verbose
from osxphotos.cli.verbose import get_verbose_console
from osxphotos.utils import pluralize


@query_command
def example(photos: list[osxphotos.PhotoInfo], **kwargs):
    """Sample query command for osxphotos. Prints out the filename and date of each photo.

    Whatever text you put in the function's docstring here, will be used as the command's
    help text when run via `osxphotos run cli_example_1.py --help` or `python cli_example_1.py --help`
    """

    # verbose() will print to stdout if --verbose option is set
    # you can optionally provide a level (default is 1) to print only if --verbose is set to that level
    # for example: -VV or --verbose --verbose == level 2
    verbose(f"Found {len(photos)} photo(s)")
    verbose("This message will only be printed if verbose level 2 is set", level=2)

    with Progress(console=get_verbose_console()) as progress:
        num_photos = len(photos)
        task = progress.add_task(
            f"Processing [num]{num_photos}[/] {pluralize(num_photos, 'photo', 'photos')}",
            total=num_photos,
        )

        for photo in photos:
            photo_str = (
                f"[filename]{photo.original_filename}[/] ([uuid]{photo.uuid}[/])"
            )
            progress.print(f"Processing {photo_str}")
            verbose(f"Photo UUID: {photo.uuid}")
            verbose(f"Photo filename: {photo.original_filename}", level=2)
            time.sleep(1)  # simulate processing time
            progress.advance(task)


if __name__ == "__main__":
    # call your function here
    # you do not need to pass any arguments to the function
    # as the decorator will handle parsing the command line arguments
    example()

[RhetTbull]

Also note that verbose is used here without configuration -- the configuration happens in the QueryCommand class used by the @query_command decorator.

In cli/cli_commands.py note the callback option. You could use a callback for your verbose configuration if you need to do customization of the verbose command.

        self.params.append(
            click.Option(
                param_decls=["--verbose", "-V", "verbose_flag"],
                count=True,
                help="Print verbose output; may be specified multiple times for more verbose output.",
                callback=config_verbose_callback,
            )
        )

[oPromessa]

Thanks for the support.

Was not able to have echo play nice with verbose. I guess they're working with different Consoles!

So I ended up doing a bit of hacking...

echo_error still messes up the output... but that's understandable as it writes to stderr. So that's ok!

    global echo

        # Save echo for compatibility with progress
        _old_echo = echo
(...)

        with Progress(
            (...)
            console = get_verbose_console(),
            ) as progress:
            
            # Redefine echo for compatibility with progress
            echo = progress.print
            
            (...)
            # calling functions that use echo and verbose
            # echo_error writes to stderr and messes progress output. But that's ok!
            (...)

        # Restore echo for compatibility with progress
        echo = _old_echo