mirror of
https://gitlab.com/dslackw/slpkg.git
synced 2024-11-16 07:47:35 +01:00
Updated docstrings
This commit is contained in:
parent
48cc76a8e4
commit
432c2dc326
1 changed files with 8 additions and 15 deletions
|
@ -9,11 +9,8 @@ from slpkg.views.asciibox import AsciiBox
|
|||
|
||||
|
||||
class ProgressBar(Configs):
|
||||
|
||||
"""
|
||||
Progress bar that show spinner instead of the
|
||||
of the file progress.
|
||||
"""
|
||||
"""Progress bar that show spinner instead of the
|
||||
of the file progress."""
|
||||
|
||||
def __init__(self):
|
||||
super(Configs, self).__init__()
|
||||
|
@ -26,7 +23,7 @@ class ProgressBar(Configs):
|
|||
self.bar_message: str = ''
|
||||
|
||||
def progress_bar(self, message: str, filename: str = None) -> None:
|
||||
""" Creating progress bar. """
|
||||
"""Creating progress bar."""
|
||||
self.assign_spinner_chars()
|
||||
self.set_spinner()
|
||||
self.assign_spinner_colors()
|
||||
|
@ -45,8 +42,7 @@ class ProgressBar(Configs):
|
|||
raise SystemExit(1) from e
|
||||
|
||||
def assign_spinner_colors(self) -> None:
|
||||
""" Assign spinner colors.
|
||||
"""
|
||||
"""Assign spinner colors. """
|
||||
self.spinners_color: dict = {
|
||||
'green': self.green,
|
||||
'violet': self.violet,
|
||||
|
@ -59,8 +55,7 @@ class ProgressBar(Configs):
|
|||
}
|
||||
|
||||
def assign_spinner_chars(self) -> None:
|
||||
""" Assign for characters.
|
||||
"""
|
||||
"""Assign for characters."""
|
||||
self.spinners: dict = {
|
||||
'spinner': ('-', '\\', '|', '/'),
|
||||
'pie': ('◷', '◶', '◵', '◴'),
|
||||
|
@ -72,7 +67,7 @@ class ProgressBar(Configs):
|
|||
}
|
||||
|
||||
def set_the_spinner_message(self, filename: str, message: str) -> None:
|
||||
""" Set message to the spinner.
|
||||
"""Set message to the spinner.
|
||||
|
||||
Args:
|
||||
filename (str): Name of file.
|
||||
|
@ -84,16 +79,14 @@ class ProgressBar(Configs):
|
|||
f"{message}... ")
|
||||
|
||||
def set_spinner(self) -> None:
|
||||
""" Spinners characters.
|
||||
"""
|
||||
"""Spinners characters."""
|
||||
try:
|
||||
self.spinner: tuple = self.spinners[self.progress_spinner]
|
||||
except KeyError:
|
||||
self.spinner: tuple = self.spinners['spinner']
|
||||
|
||||
def set_color(self) -> None:
|
||||
""" Setting the spinner color.
|
||||
"""
|
||||
"""Setting the spinner color."""
|
||||
try:
|
||||
self.color: str = self.spinners_color[self.spinner_color]
|
||||
except KeyError:
|
||||
|
|
Loading…
Reference in a new issue