Source code for mantidimaging.core.utility.progress_reporting.console_progress_bar

# Copyright (C) 2024 ISIS Rutherford Appleton Laboratory UKRI
# SPDX - License - Identifier: GPL-3.0-or-later
from __future__ import annotations

import sys

from .progress import ProgressHandler


def _print_ascii_progress_bar(progress, bar_len, prefix='', suffix=''):
    filled_len = int(round(bar_len * progress))

    if prefix:
        prefix = prefix + ': '

    bar = '{}[{}{}]{}'.format(prefix, '=' * filled_len, '-' * (bar_len - filled_len), suffix)

    print(bar, end='\r')
    sys.stdout.flush()


# Note: this is not currently used in Mantid Imaging application, but could be used from a script


class ConsoleProgressBar(ProgressHandler):

    def __init__(self, width=70):
        super().__init__()
        self.width = width



    def progress_update(self):
        suffix = f'{self.progress.current_step}/{self.progress.end_step}'

        _print_ascii_progress_bar(self.progress.completion(), self.width, self.progress.task_name, suffix)

        if self.progress.is_completed():
            print()