clean up progressbar

Author: FynnBe

src/bioimageio/spec/_internal/io.py

@@ -296,7 +296,9 @@ def validate_sha256(self, force_recompute: bool = False) -> None:
             )
 
     def get_reader(
-        self, *, progressbar: Union[Progressbar, Callable[[], Progressbar], bool] = True
+        self,
+        *,
+        progressbar: Union[Progressbar, Callable[[], Progressbar], bool, None] = None,
     ):
         """open the file source (download if needed)"""
         return get_reader(self.source, progressbar=progressbar, sha256=self.sha256)
@@ -690,7 +692,7 @@ def get_reader(
 def _open_url(
     source: HttpUrl,
     /,
-    progressbar: Union[Progressbar, Callable[[], Progressbar], bool, None] = None,
+    progressbar: Union[Progressbar, Callable[[], Progressbar], bool, None],
     **kwargs: Unpack[HashKwargs],
 ) -> BytesReader:
     cache = (
@@ -724,40 +726,39 @@ def _open_url(
 def _fetch_url(
     source: RootHttpUrl,
     *,
-    progressbar: Union[Progressbar, Callable[[], Progressbar], bool, None] = None,
+    progressbar: Union[Progressbar, Callable[[], Progressbar], bool, None],
 ):
     if source.scheme not in ("http", "https"):
         raise NotImplementedError(source.scheme)
 
+    if progressbar is None:
+        # chose progressbar option from validation context
+        progressbar = get_validation_context().progressbar
+
+    if progressbar is None:
+        # default to no progressbar in CI environments
+        progressbar = not settings.CI
+
     if callable(progressbar):
         progressbar = progressbar()
 
-    if settings.CI:
-        headers = {"User-Agent": "ci"}
-        if progressbar is None:
-            progressbar = False
-    else:
-        headers = {}
-        if progressbar is None:
-            progressbar = True
-
-    if isinstance(progressbar, bool):
-        # setup progressbar
-        if progressbar:
-            use_ascii = bool(sys.platform == "win32")
-            progressbar = tqdm(
-                ncols=79,
-                ascii=use_ascii,
-                unit="B",
-                unit_scale=True,
-                leave=True,
-            )
+    if isinstance(progressbar, bool) and progressbar:
+        progressbar = tqdm(
+            ncols=79,
+            ascii=bool(sys.platform == "win32"),
+            unit="B",
+            unit_scale=True,
+            leave=True,
+        )
 
     if progressbar is not False:
         progressbar.set_description(f"Downloading {extract_file_name(source)}")
 
+    headers: Dict[str, str] = {}
     if settings.user_agent is not None:
         headers["User-Agent"] = settings.user_agent
+    elif settings.CI:
+        headers["User-Agent"] = "ci"
 
     r = httpx.get(str(source), follow_redirects=True, headers=headers)
     _ = r.raise_for_status()

src/bioimageio/spec/_internal/validation_context.py

@@ -92,10 +92,16 @@ class ValidationContext(ValidationContextBase):
         of a generated `bioimageio.spec.ValidationSummary`.
     """
 
-    progressbar_factory: Optional[Callable[[], Progressbar]] = None
-    """Callable to return a tqdm-like progressbar.
-
-    Currently this is only used for file downloads."""
+    progressbar: Union[None, bool, Callable[[], Progressbar]] = None
+    """Control any progressbar.
+    (Currently this is only used for file downloads.)
+
+    Can be:
+    - `None`: use a default tqdm progressbar (if not settings.CI)
+    - `True`: use a default tqdm progressbar
+    - `False`: disable the progressbar
+    - `callable`: A callable that returns a tqdm-like progressbar.
+    """
 
     raise_errors: bool = False
     """Directly raise any validation errors