ats_utilities.splasher.iprogress_bar module

Module

iprogress_bar.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines abstract class IProgressBar with method(s). Interface for progress bar component.

class ats_utilities.splasher.iprogress_bar.IProgressBar[source]

Bases: ABC

Defines abstract class IProgressBar with method(s). Interface for progress bar component.

It defines:

attributes:

None

methods:
set_level - Sets level of progress.
plot_progress - Plots progress.
set_and_plot - Sets and plots progress.
__str__ - Returns the progress bar as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod plot_progress(columns: int) → None[source]

Plots progress.

Parameters:

columns (<int>) – Columns for open console session.

Exceptions:

NotImplementedError.

abstractmethod set_and_plot(level: int, columns: int) → None[source]

Sets and plots progress.

Parameters:

  • level (<int>) – Level of progress.

  • columns (<int>) – Columns for open console session.

Exceptions:

NotImplementedError.

abstractmethod set_level(level: int) → None[source]

Sets level of progress.

Parameters:

level (<int>) – Level of progress.

Exceptions:

NotImplementedError.