MultiRangeBar: Store symbols separately from range size

paulo-raca · paulo-raca · commit 8756b674056c · 2019-09-19T10:14:00.000-03:00
List[(Marker, Amount)] is a bit confusing to work with, and for all
pratical effects the list of intervals doesn't change after the bar has been created
diff --git a/examples.py b/examples.py
@@ -84,29 +84,30 @@ def color_bar_example():
 
 @example
 def multi_range_bar_example():
-    widgets = [progressbar.MultiRangeBar("stages")]
-    stages = [
-        ['\x1b[32m&#9608;\x1b[39m', 0],  # Done
-        ['\x1b[33m#\x1b[39m', 0],  # Processing
-        ['\x1b[31m.\x1b[39m', 0],  # Scheduling
-        [' ',                25],  # Not started
+    markers = [
+        '\x1b[32m&#9608;\x1b[39m',  # Done
+        '\x1b[33m#\x1b[39m',  # Processing
+        '\x1b[31m.\x1b[39m',  # Scheduling
+        ' '                   # Not started
     ]
+    widgets = [progressbar.MultiRangeBar("amounts", markers=markers)]
+    amounts = [0] * (len(markers) - 1) + [25]
 
     with progressbar.ProgressBar(widgets=widgets, max_value=10).start() as bar:
         while True:
             incomplete_items = [
                 idx
-                for idx, (stage_symbol, stage_count) in enumerate(stages)
-                for i in range(stage_count)
+                for idx, amount in enumerate(amounts)
+                for i in range(amount)
                 if idx != 0
             ]
             if not incomplete_items:
                 break
             which = random.choice(incomplete_items)
-            stages[which][1] -= 1
-            stages[which - 1][1] += 1
+            amounts[which] -= 1
+            amounts[which - 1] += 1
 
-            bar.update(stages=stages, force=True)
+            bar.update(amounts=amounts, force=True)
             time.sleep(0.02)
 
 
diff --git a/progressbar/widgets.py b/progressbar/widgets.py
@@ -766,11 +766,15 @@ class MultiRangeBar(Bar, VariableMixin):
     ]
     '''
 
-    def __init__(self, name, **kwargs):
+    def __init__(self, name, markers, **kwargs):
         VariableMixin.__init__(self, name)
         Bar.__init__(self, **kwargs)
+        self.markers = [
+            string_or_lambda(marker)
+            for marker in markers
+        ]
 
-    def get_ranges(self, progress, data):
+    def get_values(self, progress, data):
         return data['variables'][self.name] or []
 
     def __call__(self, progress, data, width):
@@ -779,22 +783,22 @@ def __call__(self, progress, data, width):
         left = converters.to_unicode(self.left(progress, data, width))
         right = converters.to_unicode(self.right(progress, data, width))
         width -= progress.custom_len(left) + progress.custom_len(right)
-        ranges = self.get_ranges(progress, data)
+        values = self.get_values(progress, data)
 
-        items_total = sum([count for symbol, count in ranges])
-        if width and items_total:
+        values_sum = sum(values)
+        if width and values_sum:
             middle = ''
-            items_accumulated = 0
+            values_accumulated = 0
             width_accumulated = 0
-            for item_symbol, item_count in ranges:
-                item_marker = string_or_lambda(item_symbol)
-                item_marker = converters.to_unicode(item_marker(progress, data, width))
-                assert utils.len_color(item_marker) == 1
+            for marker, value in zip(self.markers, values):
+                marker = converters.to_unicode(marker(progress, data, width))
+                assert utils.len_color(marker) == 1
 
-                items_accumulated += item_count
-                item_width = int(items_accumulated / items_total * width) - width_accumulated
+                values_accumulated += value
+                item_width = int(values_accumulated / values_sum * width) - width_accumulated
                 width_accumulated += item_width
-                middle += item_width * item_marker
+                #print(marker, value, values_accumulated, values_sum, item_width, width_accumulated)
+                middle += item_width * marker
         else:
             fill = converters.to_unicode(self.fill(progress, data, width))
             assert utils.len_color(fill) == 1
@@ -804,15 +808,11 @@ def __call__(self, progress, data, width):
 
 
 class MultiProgressBar(MultiRangeBar):
-    def __init__(self, name, progress_symbols=" &#9601;&#9602;&#9603;&#9604;&#9605;&#9606;&#9607;&#9608;", **kwargs):
-        MultiRangeBar.__init__(self, name=name, **kwargs)
-        self.progress_symbols = progress_symbols
-
-    def get_ranges(self, progress, data):
-        ranges = [
-          [symbol, 0]
-          for symbol in self.progress_symbols
-        ]
+    def __init__(self, name, markers=" &#9601;&#9602;&#9603;&#9604;&#9605;&#9606;&#9607;&#9608;", **kwargs):
+        MultiRangeBar.__init__(self, name=name, markers=list(reversed(markers)), **kwargs)
+
+    def get_values(self, progress, data):
+        ranges = [0] * len(self.markers)
         for progress in data['variables'][self.name] or []:
             if not isinstance(progress, (int, float)):
                 # Progress is (value, max)
@@ -822,7 +822,7 @@ def get_ranges(self, progress, data):
                 raise ValueError('Range value needs to be in the range [0..1], got %s' % progress)
 
             range = int(progress * (len(ranges) - 1))
-            ranges[range][1] += 1
+            ranges[range] += 1
 
         if self.fill_left:
             ranges = list(reversed(ranges))
