Adaptive progress bar length (#174)

* Adaptive progress bar length
Signed-off-by: lizz <lizz@sensetime.com>

* it works
Signed-off-by: lizz <lizz@sensetime.com>

* format

* pass test

* :lipstick

* test

* Update test_progressbar.py

* 2.7

* sort import
Signed-off-by: lizz <lizz@sensetime.com>

* try this
Signed-off-by: lizz <lizz@sensetime.com>

.pre-commit-config.yaml

@@ -4,10 +4,10 @@ repos:
   rev: v1.9.3
   hooks:
       - id: seed-isort-config
-# - repo: https://github.com/pre-commit/mirrors-isort
-#   rev: v4.3.21
-#   hooks:
-#       - id: isort
+- repo: https://github.com/pre-commit/mirrors-isort
+  rev: v4.3.21
+  hooks:
+      - id: isort
 - repo: https://github.com/pre-commit/mirrors-yapf
   rev: v0.29.0
   hooks:

docs/conf.py

@@ -14,6 +14,7 @@
 #
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath('..'))
 
 version_file = '../mmcv/version.py'

mmcv/utils/progressbar.py

@@ -11,27 +11,20 @@ class ProgressBar(object):
 
     def __init__(self, task_num=0, bar_width=50, start=True, file=sys.stdout):
         self.task_num = task_num
-        max_bar_width = self._get_max_bar_width()
-        self.bar_width = (
-            bar_width if bar_width <= max_bar_width else max_bar_width)
+        self.bar_width = bar_width
         self.completed = 0
         self.file = file
         if start:
             self.start()
 
-    def _get_max_bar_width(self):
+    @property
+    def terminal_width(self):
         if sys.version_info > (3, 3):
             from shutil import get_terminal_size
         else:
             from backports.shutil_get_terminal_size import get_terminal_size
-        terminal_width, _ = get_terminal_size()
-        max_bar_width = min(int(terminal_width * 0.6), terminal_width - 50)
-        if max_bar_width < 10:
-            print('terminal width is too small ({}), please consider '
-                  'widen the terminal for better progressbar '
-                  'visualization'.format(terminal_width))
-            max_bar_width = 10
-        return max_bar_width
+        width, _ = get_terminal_size()
+        return width
 
     def start(self):
         if self.task_num > 0:
@@ -52,12 +45,17 @@ class ProgressBar(object):
         if self.task_num > 0:
             percentage = self.completed / float(self.task_num)
             eta = int(elapsed * (1 - percentage) / percentage + 0.5)
-            mark_width = int(self.bar_width * percentage)
-            bar_chars = '>' * mark_width + ' ' * (self.bar_width - mark_width)
-            self.file.write(
-                '\r[{}] {}/{}, {:.1f} task/s, elapsed: {}s, ETA: {:5}s'.format(
-                    bar_chars, self.completed, self.task_num, fps,
-                    int(elapsed + 0.5), eta))
+            msg = '\r[{{}}] {}/{}, {:.1f} task/s, elapsed: {}s, ETA: {:5}s' \
+                  ''.format(self.completed, self.task_num, fps,
+                            int(elapsed + 0.5), eta)
+
+            bar_width = min(self.bar_width,
+                            int(self.terminal_width - len(msg)) + 2,
+                            int(self.terminal_width * 0.6))
+            bar_width = max(2, bar_width)
+            mark_width = int(bar_width * percentage)
+            bar_chars = '>' * mark_width + ' ' * (bar_width - mark_width)
+            self.file.write(msg.format(bar_chars))
         else:
             self.file.write(
                 'completed: {}, elapsed: {}s, {:.1f} tasks/s'.format(

setup.py

@@ -2,14 +2,13 @@ import platform
 import re
 import sys
 from io import open  # for Python 2 (identical to builtin in Python 3)
-from setuptools import Extension, dist, find_packages, setup
-
 from pkg_resources import DistributionNotFound, get_distribution
+from setuptools import Extension, dist, find_packages, setup
 
 dist.Distribution().fetch_build_eggs(['Cython', 'numpy>=1.11.1'])
 
-import numpy  # noqa: E402
-from Cython.Distutils import build_ext  # noqa: E402
+import numpy  # NOQA: E402  # isort:skip
+from Cython.Distutils import build_ext  # NOQA: E402  # isort:skip
 
 
 def choose_requirement(primary, secondary):

tests/test_progressbar.py

 # Copyright (c) Open-MMLab. All rights reserved.
+import os
 import sys
 import time
 
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
+
 try:
     from StringIO import StringIO
 except ImportError:
@@ -68,6 +74,26 @@ class TestProgressBar(object):
                                   'elapsed: 1s, ETA:     9s'.format('>' * 2 +
                                                                     ' ' * 18))
 
+    def test_adaptive_length(self):
+        with patch.dict('os.environ', {'COLUMNS': '80'}):
+            out = StringIO()
+            bar_width = 20
+            prog_bar = mmcv.ProgressBar(10, bar_width=bar_width, file=out)
+            time.sleep(1)
+            reset_string_io(out)
+            prog_bar.update()
+            assert len(out.getvalue()) == 66
+
+            os.environ['COLUMNS'] = '30'
+            reset_string_io(out)
+            prog_bar.update()
+            assert len(out.getvalue()) == 48
+
+            os.environ['COLUMNS'] = '60'
+            reset_string_io(out)
+            prog_bar.update()
+            assert len(out.getvalue()) == 60
+
 
 def sleep_1s(num):
     time.sleep(1)