Made all widgets min-width/max-width configurable. THanks to @ritze

wolph · wolph · commit fb8a8ddc1eca · 2019-09-15T02:19:03.000+02:00
diff --git a/progressbar/bar.py b/progressbar/bar.py
@@ -486,7 +486,7 @@ def _format_widgets(self):
 
         for index, widget in enumerate(self.widgets):
             if isinstance(widget, widgets.WidgetBase) \
-                    and not widget.is_fitting(self):
+                    and not widget.check_size(self):
                 continue
             elif isinstance(widget, widgets.AutoWidthWidgetBase):
                 result.append(widget)
diff --git a/progressbar/widgets.py b/progressbar/widgets.py
@@ -82,7 +82,45 @@ def __call__(self, progress, data, format=None):
             raise
 
 
-class WidgetBase(object):
+class WidthWidgetMixin(object):
+    '''Mixing to make sure widgets are only visible if the screen is within a
+    specified size range so the progressbar fits on both large and small
+    screens..
+
+    Variables available:
+     - min_width: Only display the widget if at least `min_width` is left
+     - max_width: Only display the widget if at most `max_width` is left
+
+    >>> class Progress(object):
+    ...     term_width = 0
+
+    >>> WidthWidgetMixin(5, 10).check_size(Progress)
+    False
+    >>> Progress.term_width = 5
+    >>> WidthWidgetMixin(5, 10).check_size(Progress)
+    True
+    >>> Progress.term_width = 10
+    >>> WidthWidgetMixin(5, 10).check_size(Progress)
+    True
+    >>> Progress.term_width = 11
+    >>> WidthWidgetMixin(5, 10).check_size(Progress)
+    False
+    '''
+
+    def __init__(self, min_width=None, max_width=None, **kwargs):
+        self.min_width = min_width
+        self.max_width = max_width
+
+    def check_size(self, progress):
+        if self.min_width and self.min_width > progress.term_width:
+            return False
+        elif self.max_width and self.max_width < progress.term_width:
+            return False
+        else:
+            return True
+
+
+class WidgetBase(WidthWidgetMixin):
     __metaclass__ = abc.ABCMeta
     '''The base class for all widgets
 
@@ -108,25 +146,13 @@ class WidgetBase(object):
        with a lower one
     '''
 
-    def __init__(self, min_width=None, max_width=None, **kwargs):
-        self.min_width = min_width
-        self.max_width = max_width
-
     @abc.abstractmethod
     def __call__(self, progress, data):
         '''Updates the widget.
 
         progress - a reference to the calling ProgressBar
         '''
 
-    def is_fitting(self, progress):
-        if self.min_width and self.min_width > progress.term_width:
-            return False
-        elif self.max_width and self.max_width < progress.term_width:
-            return False
-        else:
-            return True
-
 
 class AutoWidthWidgetBase(WidgetBase):
     '''The base class for all variable width widgets.
@@ -160,7 +186,6 @@ class FormatLabel(FormatWidgetMixin, WidgetBase):
     >>> label = FormatLabel('%(value)s', min_width=5, max_width=10)
     >>> class Progress(object):
     ...     pass
-
     >>> label = FormatLabel('{value} :: {value:^6}', new_style=True)
     >>> str(label(Progress, dict(value='test')))
     'test ::  test '
