Merge branch 'release/3.51.1'

Author: wolph

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: WoLpH

progressbar/__about__.py

@@ -19,7 +19,7 @@
 long running operations.
 '''.strip().split())
 __email__ = 'wolph@wol.ph'
-__version__ = '3.51.0'
+__version__ = '3.51.1'
 __license__ = 'BSD'
 __copyright__ = 'Copyright 2015 Rick van Hattem (Wolph)'
 __url__ = 'https://github.com/WoLpH/python-progressbar'

progressbar/bar.py

@@ -308,7 +308,19 @@ def __init__(self, min_value=0, max_value=None, widgets=None,
         self.min_value = min_value
         self.max_value = max_value
         self.max_error = max_error
-        self.widgets = deepcopy(widgets)
+
+        # Only copy the widget if it's safe to copy. Most widgets are so we
+        # assume this to be true
+        if widgets is None:
+            self.widgets = widgets
+        else:
+            self.widgets = []
+            for widget in widgets:
+                if getattr(widget, 'copy', True):
+                    widget = deepcopy(widget)
+                self.widgets.append(widget)
+
+        self.widgets = widgets
         self.prefix = prefix
         self.suffix = suffix
         self.widget_kwargs = widget_kwargs or {}

progressbar/widgets.py

@@ -189,7 +189,11 @@ class WidgetBase(WidthWidgetMixin):
      - max_width: Only display the widget if at most `max_width` is left
      - weight: Widgets with a higher `weigth` will be calculated before widgets
        with a lower one
+    - copy: Copy this widget when initializing the progress bar so the
+      progressbar can be reused. Some widgets such as the FormatCustomText
+      require the shared state so this needs to be optional
     '''
+    copy = True
 
     @abc.abstractmethod
     def __call__(self, progress, data):
@@ -782,6 +786,7 @@ def __call__(self, progress, data, width):
 
 class FormatCustomText(FormatWidgetMixin, WidgetBase):
     mapping = {}
+    copy = False
 
     def __init__(self, format, mapping=mapping, **kwargs):
         self.format = format

tests/test_custom_widgets.py

@@ -61,3 +61,22 @@ def test_variable_widget_widget():
     i += 1
     p.update(i, text=True, error='a')
     p.finish()
+
+
+def test_format_custom_text_widget():
+    widget = progressbar.FormatCustomText(
+        'Spam: %(spam).1f kg, eggs: %(eggs)d',
+        dict(
+            spam=0.25,
+            eggs=3,
+        ),
+    )
+
+    bar = progressbar.ProgressBar(widgets=[
+        widget,
+    ])
+
+    for i in bar(range(5)):
+        widget.update_mapping(eggs=i * 2)
+        assert widget.mapping['eggs'] == bar.widgets[0].mapping['eggs']
+