Merge pull request #5 from ModelCloud/auto-iterable

simplify usage: auto convert int and dict/set into common iterables

Author: Qubitium

logbar/progress.py

@@ -17,12 +17,13 @@
 import datetime
 import time
 from enum import Enum
-from typing import Iterable, Optional
+from typing import Iterable, Optional, Union
 from warnings import warn
 
 from . import LogBar
 from .logbar import update_last_pb_instance
 from .terminal import terminal_size
+from .util import auto_iterable
 
 logger = LogBar.shared()
 
@@ -40,7 +41,7 @@ class RenderMode(str, Enum):
 
 
 class ProgressBar:
-    def __init__(self, iterable: Iterable):
+    def __init__(self, iterable: Union[Iterable, int, dict, set]):
         self._iterating = False # state: in init or active iteration
 
         self._render_mode = RenderMode.AUTO
@@ -54,7 +55,9 @@ def __init__(self, iterable: Iterable):
         self.max_title_len = 0
         self.max_subtitle_len = 0
 
-        self.iterable = iterable
+        # auto convert simple types into iterable
+        auto_iter = auto_iterable(iterable)
+        self.iterable = auto_iter if auto_iter else iterable
 
         self.bar_length = 0
         self.current_iter_step = 0

logbar/util.py

@@ -0,0 +1,18 @@
+from typing import Iterable, Optional, Union
+
+# simplify user usage so instead of this: pb(range(10))
+# they use: pb(10)
+def auto_iterable(input) -> Optional[Iterable]:
+    if isinstance(input, Iterable):
+        return input
+
+    if isinstance(input, int):
+        return range(input)
+
+    # when you iterate dict/sets, 99% of the time you want to call items()
+    # and for loop k,v
+    if isinstance(input, (dict, set)):
+        return input.items()
+
+    return None
+

setup.py

@@ -18,7 +18,7 @@
 
 from setuptools import find_packages, setup
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 
 with open("requirements.txt") as f:
     requirements = f.read().splitlines()

tests/test_progress.py

@@ -58,33 +58,42 @@ def test_title_dynamic_subtitle_fixed(self):
 
     def test_title_dynamic_subtitle_dynamic(self):
         pb = log.pb(SAMPLES).manual()
+        count = 1
         for i in pb:
+            log.info(f"random log: {count}")
+            count += 1
             pb.title(f"[TITLE: {i}]").subtitle(f"[SUBTITLE: {i}]").draw()
-            sleep(0.1)
+            sleep(0.2)
 
     def test_range_manual(self):
         pb = log.pb(range(100)).manual()
         for _ in pb:
             pb.draw()
             sleep(0.1)
 
-    def test_range_auto(self):
-        pb = log.pb(range(100))
+    def test_range_auto_int(self):
+        pb = log.pb(100)
+        for _ in pb:
+            sleep(0.1)
+
+    def test_range_auto_dict(self):
+        pb = log.pb({"1": 2, "2": 2})
+
         for _ in pb:
             sleep(0.1)
 
     def test_range_auto_disable_ui_left_steps(self):
-        pb = log.pb(range(100)).set(show_left_steps=False)
+        pb = log.pb(100).set(show_left_steps=False)
         for _ in pb:
             sleep(0.1)
 
     def test_title(self):
-        pb = log.pb(range(100)).title("TITLE: FIXED")
+        pb = log.pb(100).title("TITLE: FIXED")
         for _ in pb:
             sleep(0.1)
 
     def test_title_subtitle(self):
-        pb = log.pb(range(100)).title("[TITLE: FIXED]").manual()
+        pb = log.pb(100).title("[TITLE: FIXED]").manual()
         for _ in pb:
             pb.subtitle(f"[SUBTITLE: FIXED]").draw()
             sleep(0.1)