Added class for easy granular marker configuration

wolph · wolph · commit c1fcabf83d05 · 2023-08-21T03:10:57.000+02:00
diff --git a/examples.py b/examples.py
@@ -176,9 +176,10 @@ def multi_progress_bar_example(left=True):
             bar.update(progress, jobs=jobs, force=True)
             time.sleep(0.02)
 
+
 @example
 def granular_progress_example():
-    widgets=[
+    widgets = [
         progressbar.GranularBar(markers=" &#9615;&#9614;&#9613;&#9612;&#9611;&#9610;&#9609;&#9608;", left='', right='|'),
         progressbar.GranularBar(markers=" &#9601;&#9602;&#9603;&#9604;&#9605;&#9606;&#9607;&#9608;", left='', right='|'),
         progressbar.GranularBar(markers=" &#9622;&#9612;&#9627;&#9608;", left='', right='|'),
diff --git a/progressbar/utils.py b/progressbar/utils.py
@@ -192,7 +192,7 @@ def __init__(self, target, capturing=False, listeners=set()):
         self.listeners = listeners
         self.needs_clear = False
 
-    def isatty(self):
+    def isatty(self):  # pragma: no cover
         return self.target.isatty()
 
     def write(self, value):
diff --git a/progressbar/widgets.py b/progressbar/widgets.py
@@ -909,6 +909,15 @@ def get_values(self, progress, data):
         return ranges
 
 
+class GranularMarkers:
+    smooth = ' &#9615;&#9614;&#9613;&#9612;&#9611;&#9610;&#9609;&#9608;'
+    bar = ' &#9601;&#9602;&#9603;&#9604;&#9605;&#9606;&#9607;&#9608;'
+    snake = ' &#9622;&#9612;&#9627;&#9608;'
+    fade_in = ' &#9617;&#9618;&#9619;&#9608;'
+    dots = ' &#10304;&#10308;&#10310;&#10311;&#10439;&#10471;&#10487;&#10495;'
+    growing_circles = ' .oO'
+
+
 class GranularBar(AutoWidthWidgetBase):
     '''A progressbar that can display progress at a sub-character granularity
     by using multiple marker characters.
@@ -920,14 +929,18 @@ class GranularBar(AutoWidthWidgetBase):
      - Fade in: ` &#9617;&#9618;&#9619;&#9608;`
      - Dots: ` &#10304;&#10308;&#10310;&#10311;&#10439;&#10471;&#10487;&#10495;`
      - Growing circles: ` .oO`
+
+    The markers can be accessed through GranularMarkers. GranularMarkers.dots
+    for example
     '''
 
-    def __init__(self, markers=' &#9615;&#9614;&#9613;&#9612;&#9611;&#9610;&#9609;&#9608;', left='|', right='|', **kwargs):
+    def __init__(self, markers=GranularMarkers.smooth, left='|', right='|',
+                 **kwargs):
         '''Creates a customizable progress bar.
 
         markers - string of characters to use as granular progress markers. The
                   first character should represent 0% and the last 100%.
-                  Ex: ` .oO`
+                  Ex: ` .oO`.
         left - string or callable object to use as a left border
         right - string or callable object to use as a right border
         '''
diff --git a/tests/test_monitor_progress.py b/tests/test_monitor_progress.py
@@ -213,7 +213,8 @@ def test_granular_bar(testdir):
         items=list(range(5)),
     )))
     pprint.pprint(result.stderr.lines, width=70)
-    assert result.stderr.lines == [u'',
+    assert result.stderr.lines == [
+        u'',
         u'|                                                          |',
         u'|OOOOOOOOOOO.                                              |',
         u'|OOOOOOOOOOOOOOOOOOOOOOO                                   |',
