1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
#
# Copyright 2004, 2005, 2010 Zuza Software Foundation
#
# This file is part of translate.
#
# translate 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 2 of the License, or
# (at your option) any later version.
#
# translate 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/>.
"""
Progress bar utilities for reporting feedback on the progress of an
application.
"""
import sys
import time
class ProgressBase:
def __init__(self, minValue=0, maxValue=100, totalWidth=50) -> None:
self.min = minValue
self.max = maxValue
self.width = totalWidth
self.amount = 0 # When amount == max, we are 100% done
self.stderr = sys.stderr
def show(self, verbosemessage) -> None:
raise NotImplementedError
def close(self) -> None:
pass
def __del__(self) -> None:
self.close()
class DotsProgressBar(ProgressBase):
"""
An ultra-simple progress indicator that just writes a dot for each
action.
"""
def show(self, verbosemessage) -> None:
"""Show a dot for progress :-)."""
# pylint: disable=W0613
self.stderr.write(".")
self.stderr.flush()
def close(self) -> None:
self.stderr.write("\n")
self.stderr.flush()
class NoProgressBar(ProgressBase):
"""An invisible indicator that does nothing."""
def show(self, verbosemessage) -> None:
"""Show nothing for progress :-)."""
class ProgressBar(ProgressBase):
"""A plain progress bar that doesn't know very much about output."""
def __init__(self, minValue=0, maxValue=100, totalWidth=50) -> None:
super().__init__(minValue=minValue, maxValue=maxValue, totalWidth=totalWidth)
self.progBar = "[]"
self.span = maxValue - minValue
def __str__(self) -> str:
"""Produces the string representing the progress bar."""
self.amount = max(self.amount, self.min)
self.amount = min(self.amount, self.max)
# Figure out the new percent done, round to an integer
diffFromMin = float(self.amount - self.min)
percentDone = (diffFromMin / float(self.span)) * 100.0
percentDone = round(percentDone)
percentDone = int(percentDone)
# Figure out how many hash bars the percentage should be
allFull = self.width - 7
numHashes = (percentDone / 100.0) * allFull
numHashes = round(numHashes)
# build a progress bar with hashes and spaces
self.progBar = (
f"[{'#' * numHashes}{' ' * (allFull - numHashes)}] {percentDone:3d}%"
)
return str(self.progBar)
def show(self, verbosemessage) -> None:
"""Displays the progress bar."""
# pylint: disable=W0613
print(self)
class MessageProgressBar(ProgressBar):
"""
A ProgressBar that just writes out the messages without any progress
display.
"""
def show(self, verbosemessage) -> None:
self.stderr.write(f"{verbosemessage}\n")
self.stderr.flush()
class HashProgressBar(ProgressBar):
"""A ProgressBar which knows how to go back to the beginning of the line."""
def show(self, verbosemessage) -> None:
self.stderr.write(f"{self}\r")
self.stderr.flush()
def close(self) -> None:
self.stderr.write("\n")
self.stderr.flush()
class VerboseProgressBar(HashProgressBar):
def __init__(self, minValue=0, maxValue=100, totalWidth=50) -> None:
super().__init__(minValue=minValue, maxValue=maxValue, totalWidth=totalWidth)
self.lastwidth = 0
def show(self, verbosemessage) -> None:
output = str(self)
self.stderr.write(f"\r{' ' * self.lastwidth}")
self.stderr.write(f"\r{verbosemessage}\n")
self.lastwidth = len(output)
self.stderr.write(f"\r{output}")
self.stderr.flush()
def test(progressbar) -> None:
for n in range(progressbar.min, progressbar.max + 1, 5):
progressbar.amount = n
progressbar.show("Some message")
time.sleep(0.2)
if __name__ == "__main__":
p = HashProgressBar(0, 100, 50)
test(p)
|
