Merge branch 'release/3.54.0'

Author: wolph

.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: tox
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions
+    - name: Test with tox
+      run: tox

README.rst

@@ -2,10 +2,11 @@
 Text progress bar library for Python.
 ##############################################################################
 
-Travis status:
+Build status:
 
-.. image:: https://travis-ci.org/WoLpH/python-progressbar.svg?branch=master
-  :target: https://travis-ci.org/WoLpH/python-progressbar
+.. image:: https://github.com/WoLpH/python-progressbar/actions/workflows/main.yml/badge.svg
+    :alt: python-progressbar test status 
+    :target: https://github.com/WoLpH/python-progressbar/actions
 
 Coverage:
 
@@ -58,7 +59,9 @@ of widgets:
  - `FileTransferSpeed <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FileTransferSpeed>`_
  - `FormatCustomText <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatCustomText>`_
  - `FormatLabel <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatLabel>`_
+ - `FormatLabelBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatLabel>`_
  - `Percentage <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#Percentage>`_
+ - `PercentageLabelBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#PercentageLabelBar>`_
  - `ReverseBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#ReverseBar>`_
  - `RotatingMarker <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#RotatingMarker>`_
  - `SimpleProgress <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#SimpleProgress>`_

examples.py

@@ -177,6 +177,17 @@ def multi_progress_bar_example(left=True):
             time.sleep(0.02)
 
 
+@example
+def percentage_label_bar_example():
+    widgets = [progressbar.PercentageLabelBar()]
+    bar = progressbar.ProgressBar(widgets=widgets, max_value=10).start()
+    for i in range(10):
+        # do something
+        time.sleep(0.1)
+        bar.update(i + 1)
+    bar.finish()
+
+
 @example
 def file_transfer_example():
     widgets = [

progressbar/__about__.py

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

progressbar/__init__.py

@@ -26,6 +26,8 @@
     VariableMixin,
     MultiRangeBar,
     MultiProgressBar,
+    FormatLabelBar,
+    PercentageLabelBar,
     Variable,
     DynamicMessage,
     FormatCustomText,
@@ -72,6 +74,8 @@
     'VariableMixin',
     'MultiRangeBar',
     'MultiProgressBar',
+    'FormatLabelBar',
+    'PercentageLabelBar',
     'Variable',
     'DynamicMessage',
     'FormatCustomText',

progressbar/base.py

@@ -15,3 +15,7 @@ def __cmp__(self, other):  # pragma: no cover
 
 class UnknownLength(six.with_metaclass(FalseMeta, object)):
     pass
+
+
+class Undefined(six.with_metaclass(FalseMeta, object)):
+    pass

progressbar/widgets.py

@@ -114,15 +114,19 @@ def __init__(self, format, new_style=False, **kwargs):
         self.new_style = new_style
         self.format = format
 
+    def get_format(self, progress, data, format=None):
+        return format or self.format
+
     def __call__(self, progress, data, format=None):
         '''Formats the widget into a string'''
+        format = self.get_format(progress, data, format)
         try:
             if self.new_style:
-                return (format or self.format).format(**data)
+                return format.format(**data)
             else:
-                return (format or self.format) % data
+                return format % data
         except (TypeError, KeyError):
-            print('Error while formatting %r' % self.format, file=sys.stderr)
+            print('Error while formatting %r' % format, file=sys.stderr)
             pprint.pprint(data, stream=sys.stderr)
             raise
 
@@ -628,17 +632,18 @@ def __call__(self, progress, data, format=None):
 class Percentage(FormatWidgetMixin, WidgetBase):
     '''Displays the current percentage as a number with a percent sign.'''
 
-    def __init__(self, format='%(percentage)3d%%', **kwargs):
+    def __init__(self, format='%(percentage)3d%%', na='N/A%%', **kwargs):
+        self.na = na
         FormatWidgetMixin.__init__(self, format=format, **kwargs)
         WidgetBase.__init__(self, format=format, **kwargs)
 
-    def __call__(self, progress, data, format=None):
+    def get_format(self, progress, data, format=None):
         # If percentage is not available, display N/A%
-        if 'percentage' in data and not data['percentage']:
-            return FormatWidgetMixin.__call__(self, progress, data,
-                                              format='N/A%%')
+        percentage = data.get('percentage', base.Undefined)
+        if not percentage and percentage != 0:
+            return self.na
 
-        return FormatWidgetMixin.__call__(self, progress, data)
+        return FormatWidgetMixin.get_format(self, progress, data, format)
 
 
 class SimpleProgress(FormatWidgetMixin, WidgetBase):
@@ -904,6 +909,32 @@ def get_values(self, progress, data):
         return ranges
 
 
+class FormatLabelBar(FormatLabel, Bar):
+    '''A bar which has a formatted label in the center.'''
+    def __init__(self, format, **kwargs):
+        FormatLabel.__init__(self, format, **kwargs)
+        Bar.__init__(self, **kwargs)
+
+    def __call__(self, progress, data, width, format=None):
+        center = FormatLabel.__call__(self, progress, data, format=format)
+        bar = Bar.__call__(self, progress, data, width)
+
+        # Aligns the center of the label to the center of the bar
+        center_len = progress.custom_len(center)
+        center_left = int((width - center_len) / 2)
+        center_right = center_left + center_len
+        return bar[:center_left] + center + bar[center_right:]
+
+
+class PercentageLabelBar(Percentage, FormatLabelBar):
+    '''A bar which displays the current percentage in the center.'''
+    # %3d adds an extra space that makes it look off-center
+    # %2d keeps the label somewhat consistently in-place
+    def __init__(self, format='%(percentage)2d%%', na='N/A%%', **kwargs):
+        Percentage.__init__(self, format, na=na, **kwargs)
+        FormatLabelBar.__init__(self, format, **kwargs)
+
+
 class Variable(FormatWidgetMixin, VariableMixin, WidgetBase):
     '''Displays a custom variable.'''
 

tests/test_monitor_progress.py

@@ -65,7 +65,7 @@ def test_list_example(testdir):
                            if l.strip()]
     pprint.pprint(result.stderr.lines, width=70)
     result.stderr.fnmatch_lines([
-        'N/A% (0 of 9) |            | Elapsed Time: ?:00:00 ETA:  --:--:--',
+        '  0% (0 of 9) |            | Elapsed Time: ?:00:00 ETA:  --:--:--',
         ' 11% (1 of 9) |#           | Elapsed Time: ?:00:01 ETA:   ?:00:08',
         ' 22% (2 of 9) |##          | Elapsed Time: ?:00:02 ETA:   ?:00:07',
         ' 33% (3 of 9) |####        | Elapsed Time: ?:00:03 ETA:   ?:00:06',
@@ -117,7 +117,7 @@ def test_rapid_updates(testdir):
     result.stderr.lines = [l for l in result.stderr.lines if l.strip()]
     pprint.pprint(result.stderr.lines, width=70)
     result.stderr.fnmatch_lines([
-        'N/A% (0 of 10) |      | Elapsed Time: ?:00:00 ETA:  --:--:--',
+        '  0% (0 of 10) |      | Elapsed Time: ?:00:00 ETA:  --:--:--',
         ' 10% (1 of 10) |      | Elapsed Time: ?:00:01 ETA:   ?:00:09',
         ' 20% (2 of 10) |#     | Elapsed Time: ?:00:02 ETA:   ?:00:08',
         ' 30% (3 of 10) |#     | Elapsed Time: ?:00:03 ETA:   ?:00:07',
@@ -139,7 +139,7 @@ def test_non_timed(testdir):
     result.stderr.lines = [l for l in result.stderr.lines if l.strip()]
     pprint.pprint(result.stderr.lines, width=70)
     result.stderr.fnmatch_lines([
-        'N/A%|                                                      |',
+        '  0%|                                                      |',
         ' 20%|##########                                            |',
         ' 40%|#####################                                 |',
         ' 60%|################################                      |',
@@ -156,7 +156,7 @@ def test_line_breaks(testdir):
     )))
     pprint.pprint(result.stderr.str(), width=70)
     assert result.stderr.str() == u'\n'.join((
-        u'N/A%|                                                      |',
+        u'  0%|                                                      |',
         u' 20%|##########                                            |',
         u' 40%|#####################                                 |',
         u' 60%|################################                      |',
@@ -175,7 +175,7 @@ def test_no_line_breaks(testdir):
     pprint.pprint(result.stderr.lines, width=70)
     assert result.stderr.lines == [
         u'',
-        u'N/A%|                                                      |',
+        u'  0%|                                                      |',
         u' 20%|##########                                            |',
         u' 40%|#####################                                 |',
         u' 60%|################################                      |',
@@ -186,6 +186,26 @@ def test_no_line_breaks(testdir):
     ]
 
 
+def test_percentage_label_bar(testdir):
+    result = testdir.runpython(testdir.makepyfile(_create_script(
+        widgets='[progressbar.PercentageLabelBar()]',
+        line_breaks=False,
+        items=list(range(5)),
+    )))
+    pprint.pprint(result.stderr.lines, width=70)
+    assert result.stderr.lines == [
+        u'',
+        u'|                            0%                            |',
+        u'|###########                20%                            |',
+        u'|#######################    40%                            |',
+        u'|###########################60%####                        |',
+        u'|###########################80%################            |',
+        u'|###########################100%###########################|',
+        u'',
+        u'|###########################100%###########################|'
+    ]
+
+
 def test_colors(testdir):
     kwargs = dict(
         items=range(1),