ats_utilities.splash.progress_bar module

Module
progress_bar.py
Copyright
Copyright (C) 2021 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
Defined class ProgressBar with attribute(s) and method(s). Load a progressbar as part of splashscreen.
class ats_utilities.splash.progress_bar.ProgressBar(end, start=0)[source]

Bases: object

Defined class ProgressBar with attribute(s) and method(s). Load a progressbar as part of splashscreen. It defines:

attributes:
DEFAULT_BAR_LENGTH - length of progressbar.
DEFAULT_CHAR_ON - loaded progress element.
DEFAULT_CHAR_OFF - unloaded progress element.
start - start of level.
end - end of level.
_bar_length - progress length.
_level - progress level.
_plotted - plotted progress.
_level_chars - level progress chars.
methods:
__init__ - initial constructor.
set_level - set level of progress.
plot_progress - plot progress.
set_and_plot - set and plot progress.
__del__ - dunder method for ProgressBar.
DEFAULT_BAR_LENGTH = 60
DEFAULT_CHAR_OFF = ' '
DEFAULT_CHAR_ON = '█'
plot_progress(columns)[source]

Plot progress.

Parameters:columns (<int>) – colums for open console session.
Exceptions:None
set_and_plot(level, columns)[source]

Set and plot progress.

Parameters:
  • level (<int>) – level of progress.
  • columns (<int>) – colums for open console session.
Exceptions:

None

set_level(level)[source]

Set level.

Parameters:level (<int>) – level of progress.
Exceptions:None