Use progressbar2 instead of tqdm

This fixes #18 and works beautifully in interactive Jupyter, but not
with Jupyter Book (every update of the progress bars get included as a
new line).

Author: marktsuchida

pyproject.toml

@@ -29,8 +29,8 @@ classifiers = [
 
 dependencies = [
     "click >= 8.0",
+    "progressbar2 >= 4.0",
     "requests >= 2.24",
-    "tqdm >= 4.0",
 ]
 
 [project.optional-dependencies]

src/cjdk/_cache.py

@@ -8,7 +8,7 @@
 from contextlib import contextmanager
 from pathlib import Path
 
-from tqdm.auto import tqdm
+import progressbar
 
 from . import _compat
 
@@ -211,13 +211,10 @@ def _swap_in_fetched_file(target, tmpfile, timeout, progress=False):
     WINDOWS_ERROR_ACCESS_DENIED = 5
 
     target.parent.mkdir(parents=True, exist_ok=True)
-    with tqdm(
-        desc="Waiting for another process",
-        # Intentionally not showing total; percentage makes no sense here
-        disable=(None if progress else True),
-        unit="s",
-        delay=0.5,
-    ) as tq:
+    barclass = progressbar.ProgressBar if progress else progressbar.NullBar
+    with barclass(
+        max_value=progressbar.UnknownLength, prefix="File busy; waiting "
+    ) as pbar:
         for wait_seconds in _backoff_seconds(0.001, 0.5, timeout):
             try:
                 tmpfile.replace(target)
@@ -228,7 +225,7 @@ def _swap_in_fetched_file(target, tmpfile, timeout, progress=False):
                     and wait_seconds > 0
                 ):
                     time.sleep(wait_seconds)
-                    tq.update(wait_seconds)
+                    pbar.update()
                     continue
                 raise
             else:
@@ -246,12 +243,11 @@ def _add_url_file(keydir, key_url):
 
 
 def _wait_for_dir_to_vanish(directory, timeout, progress=True):
-    with tqdm(
-        desc="Waiting for another download",
-        # Intentionally not showing total; percentage makes no sense here
-        disable=(None if progress else True),
-        unit="s",
-    ) as tq:
+    barclass = progressbar.ProgressBar if progress else progressbar.NullBar
+    with barclass(
+        max_value=progressbar.UnknownLength,
+        prefix="Already downloading; waiting ",
+    ) as pbar:
         for wait_seconds in _backoff_seconds(0.001, 0.5, timeout):
             if not directory.is_dir():
                 return
@@ -260,7 +256,7 @@ def _wait_for_dir_to_vanish(directory, timeout, progress=True):
                     f"Timeout while waiting for directory {directory} to disappear"
                 )
             time.sleep(wait_seconds)
-            tq.update(wait_seconds)
+            pbar.update()
 
 
 def _backoff_seconds(initial_interval, max_interval, max_total, factor=1.5):

src/cjdk/_download.py

@@ -8,8 +8,8 @@
 from pathlib import Path
 from urllib.parse import urlparse
 
+import progressbar
 import requests
-from tqdm.auto import tqdm
 
 from . import _compat
 
@@ -79,18 +79,17 @@ def download_file(
 
     response = requests.get(url, stream=True)
     response.raise_for_status()
-    size = int(response.headers.get("content-length", None))
-    with tqdm(
-        desc="Downloading",
-        total=size,
-        disable=(None if progress else True),
-        unit="B",
-        unit_scale=True,
-    ) as tq:
+    total = int(response.headers.get("content-length", None))
+    if not total:
+        total = progressbar.UnknownLength
+    barclass = progressbar.DataTransferBar if progress else progressbar.NullBar
+    size = 0
+    with barclass(max_value=total, prefix="Download ") as pbar:
         with open(dest, "wb") as outfile:
             for chunk in response.iter_content(chunk_size=16384):
                 outfile.write(chunk)
-                tq.update(len(chunk))
+                size += len(chunk)
+                pbar.update(size)
 
     if checkfunc:
         checkfunc(dest)
@@ -99,13 +98,8 @@ def download_file(
 def _extract_zip(destdir, srcfile, progress=True):
     with zipfile.ZipFile(srcfile) as zf:
         infolist = zf.infolist()
-        for member in tqdm(
-            infolist,
-            desc="Extracting",
-            total=len(infolist),
-            disable=(None if progress else True),
-            unit="files",
-        ):
+        barclass = progressbar.ProgressBar if progress else progressbar.NullBar
+        for member in barclass(prefix="Extract ")(infolist):
             extracted = Path(zf.extract(member, destdir))
 
             # Recover executable bits; see https://stackoverflow.com/a/46837272
@@ -116,10 +110,8 @@ def _extract_zip(destdir, srcfile, progress=True):
 
 def _extract_tgz(destdir, srcfile, progress=True):
     with tarfile.open(srcfile, "r:gz", bufsize=65536) as tf:
-        for member in tqdm(
-            tf,
-            desc="Extracting",
-            disable=(None if progress else True),
-            unit="files",
-        ):
+        barclass = progressbar.ProgressBar if progress else progressbar.NullBar
+        for member in barclass(
+            prefix="Extract ", max_value=progressbar.UnknownLength
+        )(tf):
             tf.extract(member, destdir)