abstract out common transfer speed method

Adds common method used by upload and download progress bars.

Author: johnbradley

ddsc/core/download.py

@@ -7,7 +7,7 @@
 import queue
 from ddsc.core.localstore import HashUtil
 from ddsc.core.ddsapi import DDS_TOTAL_HEADER
-from ddsc.core.util import humanize_bytes
+from ddsc.core.util import humanize_bytes, transfer_speed_str
 
 SWIFT_EXPIRED_STATUS_CODE = 401
 S3_EXPIRED_STATUS_CODE = 403
@@ -324,11 +324,11 @@ def make_spinner_char(self, current_time):
         return self.spinner_chars[half_seconds % 4]
 
     def make_download_speed(self, current_time, total_bytes_downloaded):
-        elapsed_seconds = current_time - self.start_time
-        if elapsed_seconds > 0 and total_bytes_downloaded > 0:
-            bytes_per_second = float(total_bytes_downloaded) / (elapsed_seconds + 0.5)
-            return '@ {}/s'.format(humanize_bytes(bytes_per_second))
-        return ''
+        return transfer_speed_str(
+            current_time=current_time,
+            start_time=self.start_time,
+            transfered_bytes=total_bytes_downloaded
+        )
 
     def get_download_progress(self):
         files_downloaded = 0

ddsc/core/tests/test_util.py

@@ -26,10 +26,10 @@ def test_verify_terminal_encoding_none_is_ok(self):
 
 class TestProgressBar(TestCase):
     @patch('ddsc.core.util.sys.stdout')
-    def test_show_no_waiting(self, mock_stdout):
+    @patch('ddsc.core.util.transfer_speed_str')
+    def test_show_no_waiting(self, mock_transfer_speed_str, mock_stdout):
         progress_bar = ProgressBar()
-        progress_bar._speed = Mock()
-        progress_bar._speed.return_value = ' @ 100 MB/s'
+        mock_transfer_speed_str.return_value = ' @ 100 MB/s'
 
         # replace line with our progress
         progress_bar.update(percent_done=0, details='sending really_long_filename.txt', transfered_bytes=0)
@@ -55,10 +55,10 @@ def test_show_no_waiting(self, mock_stdout):
         mock_stdout.write.assert_called_with(expected)
 
     @patch('ddsc.core.util.sys.stdout')
-    def test_show_with_waiting(self, mock_stdout):
+    @patch('ddsc.core.util.transfer_speed_str')
+    def test_show_with_waiting(self, mock_transfer_speed_str, mock_stdout):
         progress_bar = ProgressBar()
-        progress_bar._speed = Mock()
-        progress_bar._speed.return_value = ' @ 100 MB/s'
+        mock_transfer_speed_str.return_value = ' @ 100 MB/s'
 
         # we make some progress
         progress_bar.update(percent_done=10, details='sending short.txt', transfered_bytes=100)

ddsc/core/util.py

@@ -154,20 +154,14 @@ def set_state(self, state):
         self.state = state
 
     def _get_line(self):
+        speed = transfer_speed_str(current_time=time.time(), start_time=self.start_time,
+                                   transfered_bytes=self.transfered_bytes)
         if self.state == self.STATE_DONE:
-            return 'Done: 100%{}'.format(self._speed())
+            return 'Done: 100%{}'.format(speed)
         details = self.current_item_details
         if self.state == self.STATE_WAITING:
             details = self.wait_msg
-        return 'Progress: {}%{} - {}'.format(self.percent_done, self._speed(), details)
-
-    def _speed(self):
-        current_time = time.time()
-        elapsed_seconds = current_time - self.start_time
-        if elapsed_seconds > 0 and self.transfered_bytes > 0:
-            bytes_per_second = float(self.transfered_bytes) / (elapsed_seconds + 0.5)
-            return ' @ {}/s'.format(humanize_bytes(bytes_per_second))
-        return ''
+        return 'Progress: {}%{} - {}'.format(self.percent_done, speed, details)
 
     def show(self):
         line = self._get_line()
@@ -466,3 +460,18 @@ def join_with_commas_and_and(items):
         return ' and '.join([head_items_str, last_item])
     else:
         return last_item
+
+
+def transfer_speed_str(current_time, start_time, transfered_bytes):
+    """
+    Return transfer speed str based
+    :param current_time: float: current time
+    :param start_time: float: starting time
+    :param transfered_bytes: int: bytes transferred
+    :return: str: end user str
+    """
+    elapsed_seconds = current_time - start_time
+    if elapsed_seconds > 0 and transfered_bytes > 0:
+        bytes_per_second = float(transfered_bytes) / (elapsed_seconds + 0.5)
+        return '@ {}/s'.format(humanize_bytes(bytes_per_second))
+    return ''