Pass through additional arguments from HfApi.hf_hub_download

Author: schmrlng

src/huggingface_hub/hf_api.py

@@ -5216,6 +5216,7 @@ def hf_hub_download(
         etag_timeout: float = constants.DEFAULT_ETAG_TIMEOUT,
         token: Union[bool, str, None] = None,
         local_files_only: bool = False,
+        tqdm_class: Optional[type[base_tqdm]] = None,
         dry_run: Literal[False] = False,
     ) -> str: ...
 
@@ -5234,6 +5235,7 @@ def hf_hub_download(
         etag_timeout: float = constants.DEFAULT_ETAG_TIMEOUT,
         token: Union[bool, str, None] = None,
         local_files_only: bool = False,
+        tqdm_class: Optional[type[base_tqdm]] = None,
         dry_run: Literal[True],
     ) -> DryRunFileInfo: ...
 
@@ -5252,6 +5254,7 @@ def hf_hub_download(
         etag_timeout: float = constants.DEFAULT_ETAG_TIMEOUT,
         token: Union[bool, str, None] = None,
         local_files_only: bool = False,
+        tqdm_class: Optional[type[base_tqdm]] = None,
         dry_run: bool = False,
     ) -> Union[str, DryRunFileInfo]:
         """Download a given file if it's not already present in the local cache.
@@ -5320,6 +5323,11 @@ def hf_hub_download(
             local_files_only (`bool`, *optional*, defaults to `False`):
                 If `True`, avoid downloading the file and return the path to the
                 local cached file if it exists.
+            tqdm_class (`tqdm`, *optional*):
+                If provided, overwrites the default behavior for the progress bar. Passed
+                argument must inherit from `tqdm.auto.tqdm` or at least mimic its behavior.
+                Defaults to the custom HF progress bar that can be disabled by setting
+                `HF_HUB_DISABLE_PROGRESS_BARS` environment variable.
             dry_run (`bool`, *optional*, defaults to `False`):
                 If `True`, perform a dry run without actually downloading the file. Returns a
                 [`DryRunFileInfo`] object containing information about what would be downloaded.
@@ -5369,6 +5377,8 @@ def hf_hub_download(
             token=token,
             headers=self.headers,
             local_files_only=local_files_only,
+            tqdm_class=tqdm_class,
+            dry_run=dry_run,
         )
 
     @validate_hf_hub_args