Merge pull request #10 from soda480/0.2.7

feat: calculate and show duration

Author: soda480

README.md

@@ -107,7 +107,7 @@ with ProgressBar(total=75, completed_message=completed_message, clear_alias=True
 
 #### [example3](https://github.com/soda480/progress1bar/tree/master/examples/example3.py)
 
-Configure `ProgressBar` with a non-default ticker, do not use color, and use regular expressions to determine the `total`, `count` and `alias` attributes:
+Configure `ProgressBar` with a custom ticker, show duration, do not use color, and use regular expressions to determine the `total`, `count` and `alias` attributes:
 
 <details><summary>Code</summary>
 
@@ -121,7 +121,7 @@ regex = {
     'count': r'^processed .*$',
     'alias': r'^processor is (?P<value>.*)$'
 }
-with ProgressBar(ticker=10148, regex=regex, use_color=False) as pb:
+with ProgressBar(ticker=9616, regex=regex, use_color=False, show_duration=True) as pb:
     pb.match(f'processor is {names.get_full_name()}')
     total = random.randint(500, 1000)
     pb.match(f'processing total of {total}')

build.py

@@ -15,7 +15,7 @@
 authors = [Author('Emilio Reyes', 'soda480@gmail.com')]
 summary = 'A simple ANSI-based progress bar'
 url = 'https://github.com/soda480/progress1bar'
-version = '0.2.6'
+version = '0.2.7'
 default_task = [
     'clean',
     'analyze',
@@ -59,7 +59,7 @@ def set_properties(project):
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: System :: Networking',
         'Topic :: System :: Systems Administration'])
-    project.set_property('radon_break_build_average_complexity_threshold', 4)
+    project.set_property('radon_break_build_average_complexity_threshold', 5)
     project.set_property('radon_break_build_complexity_threshold', 10)
     project.set_property('bandit_break_build', True)
     project.set_property('anybadge_exclude', 'coverage, complexity')

docs/images/example3.gif

@@ -8,7 +8,7 @@
     'count': r'^processed .*$',
     'alias': r'^processor is (?P<value>.*)$'
 }
-with ProgressBar(ticker=10148, regex=regex, use_color=False) as pb:
+with ProgressBar(ticker=9616, regex=regex, use_color=False, show_duration=True) as pb:
     pb.match(f'processor is {names.get_full_name()}')
     total = random.randint(500, 1000)
     pb.match(f'processing total of {total}')

examples/example3.py

@@ -1,7 +1,7 @@
 import re
 import sys
 import logging
-
+import datetime
 import cursor
 from colorama import Style
 from colorama import Fore
@@ -34,7 +34,8 @@ def __init__(self, **kwargs):
             'show_prefix': True,
             'show_fraction': True,
             'show_percentage': True,
-            'use_color': True
+            'use_color': True,
+            'show_duration': False
         }
         for (attribute, default) in defaults.items():
             setattr(self, attribute, kwargs.get(attribute, default))
@@ -43,7 +44,8 @@ def __init__(self, **kwargs):
             raise ValueError('ticker value not in supported range')
         self._ticker = chr(ticker)
         # self.complete boolean to track if progress bar has completed
-        self.complete = False
+        # self.complete = False
+        self.__dict__['complete'] = False
         # self._completed int to track the number of progress bar completions
         # it's typically just 1 but can be multiple when using .reset()
         self._completed = 0
@@ -60,6 +62,7 @@ def __init__(self, **kwargs):
         # execute after total is set
         self._fill = self._get_fill(kwargs.get('fill', {}))
         if total:
+            self._start_time = datetime.datetime.now()
             # print progress bar if total specified in constructor
             self._print(False)
 
@@ -92,14 +95,27 @@ def __setattr__(self, name, value):
         if name == 'count' and self.total is None:
             return
         super(ProgressBar, self).__setattr__(name, value)
-        if name in ['total', 'count']:
+        if name in ['total', 'count', 'complete']:
             if name == 'count':
                 self._modulus_count = round(round(self.count / self.total, 2) * PROGRESS_WIDTH)
-            else:
+                self._print(True)
+            elif name == 'total':
                 if not self._fill['total']:
                     # only set fill for total if is is not set
                     self._fill['total'] = len(str(value))
-            self._print(name == 'count')
+                if value and not self._completed:
+                    # only start the timer once even if reset
+                    self._start_time = datetime.datetime.now()
+                self._print(False)
+            else:
+                if value:
+                    # if complete is true then set stop time and compute duration
+                    self._stop_time = datetime.datetime.now()
+                    start = self._start_time.time().strftime('%H:%M:%S')
+                    stop = self._stop_time.time().strftime('%H:%M:%S')
+                    self.duration = str(datetime.datetime.strptime(stop, '%H:%M:%S') - datetime.datetime.strptime(start, '%H:%M:%S'))
+                else:
+                    self.duration = None
 
     def __enter__(self):
         """ on entry - hide cursor if show and stderr is attached to tty
@@ -193,7 +209,7 @@ def _get_complete(self):
         progress = 'Processing complete'
         if self.completed_message:
             progress = self.completed_message
-        if self.duration:
+        if self.duration and self.show_duration:
             progress = f'{progress} - {self.duration}'
         return progress
 

src/main/python/progress1bar/progressbar.py

@@ -231,7 +231,7 @@ def test__match_count_ShouldReturnNone_When_NoRegexMatch(self, *patches):
     @patch('progress1bar.progressbar.sys.stderr.isatty', return_value=False)
     @patch('progress1bar.progressbar.colorama_init')
     def test__get_complete_Should_ReturnExpected_When_MessageAndDuration(self, *patches):
-        pbar = ProgressBar()
+        pbar = ProgressBar(show_duration=True)
         pbar.completed_message = 'All done'
         pbar.duration = '01:23:45'
         result = pbar._get_complete()
@@ -241,7 +241,7 @@ def test__get_complete_Should_ReturnExpected_When_MessageAndDuration(self, *patc
     @patch('progress1bar.progressbar.sys.stderr.isatty', return_value=False)
     @patch('progress1bar.progressbar.colorama_init')
     def test__get_complete_Should_ReturnExpected_When_NoMessageAndDuration(self, *patches):
-        pbar = ProgressBar()
+        pbar = ProgressBar(show_duration=True)
         pbar.duration = '01:23:45'
         result = pbar._get_complete()
         expected_result = 'Processing complete - 01:23:45'
@@ -259,7 +259,7 @@ def test__get_complete_Should_ReturnExpected_When_NoMessageAndNoDuration(self, *
     @patch('progress1bar.progressbar.colorama_init')
     @patch('progress1bar.progressbar.ProgressBar._get_complete')
     def test__get_progress_Should_ReturnExpected_When_Complete(self, get_complete_patch, *patches):
-        pbar = ProgressBar()
+        pbar = ProgressBar(total=10)
         pbar.complete = True
         result = pbar._get_progress()
         self.assertEqual(result, get_complete_patch.return_value)