Bump version

Update avg/eta/eta_td only once per second

MANIFEST.in

@@ -1 +1,2 @@
 include README.rst LICENSE
+include test_*.py

README.rst

@@ -1,19 +1,31 @@
 Easy progress reporting for Python
 ==================================
 
+|pypi|
+
+|demo|
+
+.. |pypi| image:: https://img.shields.io/pypi/v/progress.svg
+   :target: https://pypi.org/project/progress/
+.. |demo| image:: https://raw.github.com/verigak/progress/master/demo.gif
+   :alt: Demo
+
 Bars
 ----
 
-There are 6 progress bars to choose from:
+There are 7 progress bars to choose from:
 
-- Bar
+- ``Bar``
-- ChargingBar
+- ``ChargingBar``
-- FillingSquaresBar
+- ``FillingSquaresBar``
-- FillingCirclesBar
+- ``FillingCirclesBar``
-- IncrementalBar
+- ``IncrementalBar``
-- ShadyBar
+- ``PixelBar``
+- ``ShadyBar``
 
-To use them, just call ``next`` to advance and ``finish`` to finish. ::
+To use them, just call ``next`` to advance and ``finish`` to finish:
+
+.. code-block:: python
 
     from progress.bar import Bar
 
@@ -23,18 +35,33 @@ To use them, just call ``next`` to advance and ``finish`` to finish. ::
         bar.next()
     bar.finish()
 
+or use any bar of this class as a context manager:
+
+.. code-block:: python
+
+    from progress.bar import Bar
+
+    with Bar('Processing', max=20) as bar:
+        for i in range(20):
+            # Do some work
+            bar.next()
+
 The result will be a bar like the following: ::
 
     Processing |#############                   | 42/100
 
 To simplify the common case where the work is done in an iterator, you can
-use the ``iter`` method. ::
+use the ``iter`` method:
+
+.. code-block:: python
 
     for i in Bar('Processing').iter(it):
         # Do some work
 
 Progress bars are very customizable, you can change their width, their fill
-character, their suffix and more. ::
+character, their suffix and more:
+
+.. code-block:: python
 
     bar = Bar('Loading', fill='@', suffix='%(percent)d%%')
 
@@ -44,48 +71,82 @@ This will produce a bar like the following: ::
 
 You can use a number of template arguments in ``message`` and ``suffix``:
 
-=========  =============================
+==========  ================================
-Name       Value
+Name        Value
-=========  =============================
+==========  ================================
-index      current value
+index       current value
-max        maximum value
+max         maximum value
-remaining  max - index
+remaining   max - index
-progress   index / max
+progress    index / max
-percent    progress * 100
+percent     progress * 100
-avg        rolling average time per item (in seconds)
+avg         simple moving average time per item (in seconds)
-eta        avg * remaining
+elapsed     elapsed time in seconds
-=========  =============================
+elapsed_td  elapsed as a timedelta (useful for printing as a string)
+eta         avg * remaining
+eta_td      eta as a timedelta (useful for printing as a string)
+==========  ================================
 
 Instead of passing all configuration options on instatiation, you can create
-your custom subclass. ::
+your custom subclass:
+
+.. code-block:: python
 
     class FancyBar(Bar):
         message = 'Loading'
         fill = '*'
         suffix = '%(percent).1f%% - %(eta)ds'
 
+You can also override any of the arguments or create your own:
+
+.. code-block:: python
+
+    class SlowBar(Bar):
+        suffix = '%(remaining_hours)d hours remaining'
+        @property
+        def remaining_hours(self):
+            return self.eta // 3600
+
 
 Spinners
 ========
 
-For actions with an unknown number of steps you can use a spinner. ::
+For actions with an unknown number of steps you can use a spinner:
+
+.. code-block:: python
 
     from progress.spinner import Spinner
-    
+
     spinner = Spinner('Loading ')
     while state != 'FINISHED':
         # Do some work
         spinner.next()
 
-There are 4 predefined spinners:
+There are 5 predefined spinners:
+
+- ``Spinner``
+- ``PieSpinner``
+- ``MoonSpinner``
+- ``LineSpinner``
+- ``PixelSpinner``
+
+Installation
+============
+
+Download from PyPi
+
+.. code-block:: shell
+
+    pip install progress
 
-- Spinner
-- PieSpinner
-- MoonSpinner
-- LineSpinner
 
 Other
 =====
 
-Thera are a number of other classes available too, please check the source or
+There are a number of other classes available too, please check the source or
 subclass one of them to create your own.
+
+
+License
+=======
+
+progress is licensed under ISC

progress/__init__.py

@@ -12,99 +12,158 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-from __future__ import division
+from __future__ import division, print_function
 
+from collections import deque
+from datetime import timedelta
 from math import ceil
 from sys import stderr
-from time import time
+try:
+    from time import monotonic
+except ImportError:
+    from time import time as monotonic
 
 
-__version__ = '1.0.1'
+__version__ = '1.5'
+
+HIDE_CURSOR = '\x1b[?25l'
+SHOW_CURSOR = '\x1b[?25h'
 
 
 class Infinite(object):
     file = stderr
-    avg_window = 10
+    sma_window = 10         # Simple Moving Average window
-
+    check_tty = True
-    def __init__(self, *args, **kwargs):
+    hide_cursor = True
-        self.ctx = {}
-        for key, val in kwargs.items():
-            if hasattr(self, key):
-                setattr(self, key, val)
-            else:
-                self.ctx[key] = val
 
+    def __init__(self, message='', **kwargs):
         self.index = 0
-        self.avg = None
+        self.start_ts = monotonic()
-        self._ts = time()
+        self.avg = 0
+        self._avg_update_ts = self.start_ts
+        self._ts = self.start_ts
+        self._xput = deque(maxlen=self.sma_window)
+        for key, val in kwargs.items():
+            setattr(self, key, val)
 
-    def update_stats(self):
+        self._width = 0
-        # Calculate moving average
+        self.message = message
-        now = time()
+
-        dt = now - self._ts
+        if self.file and self.is_tty():
-        self._ts = now
+            if self.hide_cursor:
-        w = self.avg_window
+                print(HIDE_CURSOR, end='', file=self.file)
-        self.avg = dt if self.avg is None else (dt + w * self.avg) / (w + 1)
+            print(self.message, end='', file=self.file)
+            self.file.flush()
+
+    def __getitem__(self, key):
+        if key.startswith('_'):
+            return None
+        return getattr(self, key, None)
+
+    @property
+    def elapsed(self):
+        return int(monotonic() - self.start_ts)
+
+    @property
+    def elapsed_td(self):
+        return timedelta(seconds=self.elapsed)
+
+    def update_avg(self, n, dt):
+        if n > 0:
+            xput_len = len(self._xput)
+            self._xput.append(dt / n)
+            now = monotonic()
+            # update when we're still filling _xput, then after every second
+            if (xput_len < self.sma_window or
+                    now - self._avg_update_ts > 1):
+                self.avg = sum(self._xput) / len(self._xput)
+                self._avg_update_ts = now
 
     def update(self):
-        self.update_stats()
-        kv = [(key, val) for key, val in self.__dict__.items()
-                         if not key.startswith('_')]
-        self.ctx.update(kv)
-
-    def finish(self):
         pass
 
-    def next(self):
+    def start(self):
-        self.index = self.index + 1
+        pass
+
+    def clearln(self):
+        if self.file and self.is_tty():
+            print('\r\x1b[K', end='', file=self.file)
+
+    def write(self, s):
+        if self.file and self.is_tty():
+            line = self.message + s.ljust(self._width)
+            print('\r' + line, end='', file=self.file)
+            self._width = max(self._width, len(s))
+            self.file.flush()
+
+    def writeln(self, line):
+        if self.file and self.is_tty():
+            self.clearln()
+            print(line, end='', file=self.file)
+            self.file.flush()
+
+    def finish(self):
+        if self.file and self.is_tty():
+            print(file=self.file)
+            if self.hide_cursor:
+                print(SHOW_CURSOR, end='', file=self.file)
+
+    def is_tty(self):
+        return self.file.isatty() if self.check_tty else True
+
+    def next(self, n=1):
+        now = monotonic()
+        dt = now - self._ts
+        self.update_avg(n, dt)
+        self._ts = now
+        self.index = self.index + n
         self.update()
 
     def iter(self, it):
-        for x in it:
+        with self:
-            yield x
+            for x in it:
-            self.next()
+                yield x
+                self.next()
+
+    def __enter__(self):
+        self.start()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
         self.finish()
 
 
 class Progress(Infinite):
-    backtrack = False
-
     def __init__(self, *args, **kwargs):
         super(Progress, self).__init__(*args, **kwargs)
         self.max = kwargs.get('max', 100)
-        self.eta = None
 
-    def update_stats(self):
+    @property
-        if self.delta <= 0:
+    def eta(self):
-            return
+        return int(ceil(self.avg * self.remaining))
 
-        # Calculate moving average
+    @property
-        now = time()
+    def eta_td(self):
-        dt = (now - self._ts) / self.delta
+        return timedelta(seconds=self.eta)
-        self._ts = now
-        w = self.avg_window
-        self.avg = dt if self.avg is None else (dt + w * self.avg) / (w + 1)
 
-        self.progress = min(1, self.index / self.max)
+    @property
-        self.percent = self.progress * 100
+    def percent(self):
-        self.remaining = self.max - self.index
+        return self.progress * 100
-        self.eta = int(ceil(self.avg * self.remaining))
 
-    def next(self):
+    @property
-        prev = self.index
+    def progress(self):
-        self.index = min(self.index + 1, self.max)
+        return min(1, self.index / self.max)
-        self.delta = self.index - prev
+
+    @property
+    def remaining(self):
+        return max(self.max - self.index, 0)
+
+    def start(self):
         self.update()
 
     def goto(self, index):
-        index = min(index, self.max)
+        incr = index - self.index
-        delta = index - self.index
+        self.next(incr)
-        if delta <= 0 and not self.backtrack:
-            return
-
-        self.index = index
-        self.delta = delta
-        self.update()
 
     def iter(self, it):
         try:
@@ -112,7 +171,7 @@ class Progress(Infinite):
         except TypeError:
             pass
 
-        for x in it:
+        with self:
-            yield x
+            for x in it:
-            self.next()
+                yield x
-        self.finish()
+                self.next()

progress/bar.py

@@ -14,13 +14,15 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+from __future__ import unicode_literals
+
+import sys
+
 from . import Progress
-from .helpers import WritelnMixin
 
 
-class Bar(WritelnMixin, Progress):
+class Bar(Progress):
     width = 32
-    message = ''
     suffix = '%(index)d/%(max)d'
     bar_prefix = ' |'
     bar_suffix = '| '
@@ -28,14 +30,13 @@ class Bar(WritelnMixin, Progress):
     fill = '#'
 
     def update(self):
-        super(Bar, self).update()
         filled_length = int(self.width * self.progress)
         empty_length = self.width - filled_length
 
-        message = self.message % self.ctx
+        message = self.message % self
         bar = self.fill * filled_length
         empty = self.empty_fill * empty_length
-        suffix = self.suffix % self.ctx
+        suffix = self.suffix % self
         line = ''.join([message, self.bar_prefix, bar, empty, self.bar_suffix,
                         suffix])
         self.writeln(line)
@@ -45,41 +46,46 @@ class ChargingBar(Bar):
     suffix = '%(percent)d%%'
     bar_prefix = ' '
     bar_suffix = ' '
-    empty_fill = u'∙'
+    empty_fill = '∙'
-    fill = u'█'
+    fill = '█'
 
 
 class FillingSquaresBar(ChargingBar):
-    empty_fill = u'▢'
+    empty_fill = '▢'
-    fill = u'▣'
+    fill = '▣'
 
 
 class FillingCirclesBar(ChargingBar):
-    empty_fill = u'◯'
+    empty_fill = '◯'
-    fill = u'◉'
+    fill = '◉'
 
 
 class IncrementalBar(Bar):
-    phases = (u' ', u'▏', u'▎', u'▍', u'▌', u'▋', u'▊', u'▉', u'█')
+    if sys.platform.startswith('win'):
+        phases = (u' ', u'▌', u'█')
+    else:
+        phases = (' ', '▏', '▎', '▍', '▌', '▋', '▊', '▉', '█')
 
     def update(self):
-        super(IncrementalBar, self).update()
-
         nphases = len(self.phases)
-        expanded_length = int(nphases * self.width * self.progress)
+        filled_len = self.width * self.progress
-        filled_length = int(self.width * self.progress)
+        nfull = int(filled_len)                      # Number of full chars
-        empty_length = self.width - filled_length
+        phase = int((filled_len - nfull) * nphases)  # Phase of last char
-        phase = expanded_length - (filled_length * nphases)
+        nempty = self.width - nfull                  # Number of empty chars
 
-        message = self.message % self.ctx
+        message = self.message % self
-        bar = self.phases[-1] * filled_length
+        bar = self.phases[-1] * nfull
         current = self.phases[phase] if phase > 0 else ''
-        empty = self.empty_fill * max(0, empty_length - len(current))
+        empty = self.empty_fill * max(0, nempty - len(current))
-        suffix = self.suffix % self.ctx
+        suffix = self.suffix % self
         line = ''.join([message, self.bar_prefix, bar, current, empty,
                         self.bar_suffix, suffix])
         self.writeln(line)
 
 
+class PixelBar(IncrementalBar):
+    phases = ('⡀', '⡄', '⡆', '⡇', '⣇', '⣧', '⣷', '⣿')
+
+
 class ShadyBar(IncrementalBar):
-    phases = (u' ', u'░', u'▒', u'▓', u'█')
+    phases = (' ', '░', '▒', '▓', '█')

progress/counter.py

@@ -14,33 +14,28 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+from __future__ import unicode_literals
 from . import Infinite, Progress
-from .helpers import WriteMixin
 
 
-class Counter(WriteMixin, Infinite):
+class Counter(Infinite):
-    message = ''
-
     def update(self):
-        super(Counter, self).update()
         self.write(str(self.index))
 
 
-class Countdown(WriteMixin, Progress):
+class Countdown(Progress):
     def update(self):
-        super(Countdown, self).update()
         self.write(str(self.remaining))
 
 
-class Stack(WriteMixin, Progress):
+class Stack(Progress):
-    phases = (u' ', u'▁', u'▂', u'▃', u'▄', u'▅', u'▆', u'▇', u'█')
+    phases = (' ', '▁', '▂', '▃', '▄', '▅', '▆', '▇', '█')
 
     def update(self):
-        super(Stack, self).update()
         nphases = len(self.phases)
         i = min(nphases - 1, int(self.progress * nphases))
         self.write(self.phases[i])
 
 
 class Pie(Stack):
-    phases = (u'○', u'◔', u'◑', u'◕', u'●')
+    phases = ('○', '◔', '◑', '◕', '●')

progress/helpers.py

@@ -1,57 +0,0 @@
-# Copyright (c) 2012 Giorgos Verigakis <verigak@gmail.com>
-#
-# Permission to use, copy, modify, and distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-from __future__ import print_function
-
-
-class WriteMixin(object):
-    def __init__(self, message=None, **kwargs):
-        super(WriteMixin, self).__init__(**kwargs)
-        self._width = 0
-        if message:
-            self.message = message
-
-        if self.file.isatty():
-            print(self.message, end='', file=self.file)
-            self.file.flush()
-
-    def write(self, s):
-        if self.file.isatty():
-            b = '\b' * self._width
-            print(b + s.ljust(self._width), end='', file=self.file)
-            self._width = max(self._width, len(s))
-            self.file.flush()
-
-
-class WritelnMixin(object):
-    def __init__(self, message=None, **kwargs):
-        super(WritelnMixin, self).__init__(**kwargs)
-        self.max_line_width = 0
-        if message:
-            self.message = message
-
-    def writeln(self, line):
-        if not self.file.isatty():
-            return
-        if len(line) > self.max_line_width:
-            self.max_line_width = len(line)
-        else:
-            line += ' ' * (self.max_line_width - len(line))     # Add padding
-
-        print('\r' + line, end='', file=self.file)
-        self.file.flush()
-
-    def finish(self):
-        if self.file.isatty():
-            print(file=self.file)

progress/spinner.py

@@ -14,27 +14,30 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+from __future__ import unicode_literals
 from . import Infinite
-from .helpers import WriteMixin
 
 
-class Spinner(WriteMixin, Infinite):
+class Spinner(Infinite):
-    message = ''
     phases = ('-', '\\', '|', '/')
+    hide_cursor = True
 
     def update(self):
-        super(Spinner, self).update()
         i = self.index % len(self.phases)
         self.write(self.phases[i])
 
 
 class PieSpinner(Spinner):
-    phases = [u'◷', u'◶', u'◵', u'◴']
+    phases = ['◷', '◶', '◵', '◴']
 
 
 class MoonSpinner(Spinner):
-    phases = [u'◑', u'◒', u'◐', u'◓']
+    phases = ['◑', '◒', '◐', '◓']
 
 
 class LineSpinner(Spinner):
-    phases = [u'⎺', u'⎻', u'⎼', u'⎽', u'⎼', u'⎻']
+    phases = ['⎺', '⎻', '⎼', '⎽', '⎼', '⎻']
+
+
+class PixelSpinner(Spinner):
+    phases = ['⣾', '⣷', '⣯', '⣟', '⡿', '⢿', '⣻', '⣽']

setup.py

@@ -21,6 +21,9 @@ setup(
         'License :: OSI Approved :: ISC License (ISCL)',
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.3'
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
     ]
 )

test_progress.py

@@ -2,35 +2,46 @@
 
 from __future__ import print_function
 
-from random import randint
+import random
-from time import sleep
+import time
 
 from progress.bar import (Bar, ChargingBar, FillingSquaresBar,
-                          FillingCirclesBar, IncrementalBar, ShadyBar)
+                          FillingCirclesBar, IncrementalBar, PixelBar,
-from progress.spinner import Spinner, PieSpinner, MoonSpinner, LineSpinner
+                          ShadyBar)
+from progress.spinner import (Spinner, PieSpinner, MoonSpinner, LineSpinner,
+                              PixelSpinner)
 from progress.counter import Counter, Countdown, Stack, Pie
 
 
-for bar in (Bar, ChargingBar, FillingSquaresBar, FillingCirclesBar):
+def sleep():
-    for i in bar(bar.__name__).iter(range(100)):
+    t = 0.01
-        sleep(0.04)
+    t += t * random.uniform(-0.1, 0.1)  # Add some variance
+    time.sleep(t)
 
-for bar in (IncrementalBar, ShadyBar):
-    for i in bar(bar.__name__).iter(range(200)):
-        sleep(0.02)
 
-for spin in (Spinner, PieSpinner, MoonSpinner, LineSpinner):
+for bar_cls in (Bar, ChargingBar, FillingSquaresBar, FillingCirclesBar):
-    for i in spin(spin.__name__ + ' ').iter(range(30)):
+    suffix = '%(index)d/%(max)d [%(elapsed)d / %(eta)d / %(eta_td)s]'
-        sleep(0.1)
+    bar = bar_cls(bar_cls.__name__, suffix=suffix)
-    print()
+    for i in bar.iter(range(200)):
+        sleep()
+
+for bar_cls in (IncrementalBar, PixelBar, ShadyBar):
+    suffix = '%(percent)d%% [%(elapsed_td)s / %(eta)d / %(eta_td)s]'
+    with bar_cls(bar_cls.__name__, suffix=suffix, max=200) as bar:
+        for i in range(200):
+            bar.next()
+            sleep()
+
+for spin in (Spinner, PieSpinner, MoonSpinner, LineSpinner, PixelSpinner):
+    for i in spin(spin.__name__ + ' ').iter(range(100)):
+        sleep()
 
 for singleton in (Counter, Countdown, Stack, Pie):
     for i in singleton(singleton.__name__ + ' ').iter(range(100)):
-        sleep(0.04)
+        sleep()
-    print()
 
-bar = IncrementalBar('Random', backtrack=True, suffix='')
+bar = IncrementalBar('Random', suffix='%(index)d')
 for i in range(100):
-    bar.goto(randint(0, 100))
+    bar.goto(random.randint(0, 100))
-    sleep(0.1)
+    sleep()
 bar.finish()