huggingface-hub 0.34.4__py3-none-any.whl → 1.0.0rc0__py3-none-any.whl

huggingface_hub/cli/repo.py

@@ -25,8 +25,6 @@ import argparse
 from argparse import _SubParsersAction
 from typing import Optional
 
-from requests.exceptions import HTTPError
-
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
 from huggingface_hub.commands._cli_utils import ANSI
 from huggingface_hub.constants import REPO_TYPES, SPACES_SDK_TYPES
@@ -183,7 +181,9 @@ class RepoTagCommand:
 
 class RepoTagCreateCommand(RepoTagCommand):
     def run(self):
-        print(f"You are about to create tag {ANSI.bold(self.args.tag)} on {self.repo_type} {ANSI.bold(self.repo_id)}")
+        print(
+            f"You are about to create tag {ANSI.bold(str(self.args.tag))} on {self.repo_type} {ANSI.bold(self.repo_id)}"
+        )
         try:
             self.api.create_tag(
                 repo_id=self.repo_id,
@@ -196,14 +196,14 @@ class RepoTagCreateCommand(RepoTagCommand):
             print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
             exit(1)
         except RevisionNotFoundError:
-            print(f"Revision {ANSI.bold(getattr(self.args, 'revision', None))} not found.")
+            print(f"Revision {ANSI.bold(str(getattr(self.args, 'revision', None)))} not found.")
             exit(1)
         except HfHubHTTPError as e:
             if e.response.status_code == 409:
-                print(f"Tag {ANSI.bold(self.args.tag)} already exists on {ANSI.bold(self.repo_id)}")
+                print(f"Tag {ANSI.bold(str(self.args.tag))} already exists on {ANSI.bold(self.repo_id)}")
                 exit(1)
             raise e
-        print(f"Tag {ANSI.bold(self.args.tag)} created on {ANSI.bold(self.repo_id)}")
+        print(f"Tag {ANSI.bold(str(self.args.tag))} created on {ANSI.bold(self.repo_id)}")
 
 
 class RepoTagListCommand(RepoTagCommand):
@@ -216,7 +216,7 @@ class RepoTagListCommand(RepoTagCommand):
         except RepositoryNotFoundError:
             print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
             exit(1)
-        except HTTPError as e:
+        except HfHubHTTPError as e:
             print(e)
             print(ANSI.red(e.response.text))
             exit(1)

huggingface_hub/cli/repo_files.py

@@ -35,7 +35,7 @@ Usage:
 """
 
 from argparse import _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
@@ -52,7 +52,7 @@ class DeleteFilesSubCommand:
         self.repo_type: Optional[str] = args.repo_type
         self.revision: Optional[str] = args.revision
         self.api: HfApi = HfApi(token=args.token, library_name="hf")
-        self.patterns: List[str] = args.patterns
+        self.patterns: list[str] = args.patterns
         self.commit_message: Optional[str] = args.commit_message
         self.commit_description: Optional[str] = args.commit_description
         self.create_pr: bool = args.create_pr

huggingface_hub/cli/upload.py

@@ -50,7 +50,7 @@ import os
 import time
 import warnings
 from argparse import Namespace, _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub._commit_scheduler import CommitScheduler
@@ -144,9 +144,9 @@ class UploadCommand(BaseHuggingfaceCLICommand):
         self.revision: Optional[str] = args.revision
         self.private: bool = args.private
 
-        self.include: Optional[List[str]] = args.include
-        self.exclude: Optional[List[str]] = args.exclude
-        self.delete: Optional[List[str]] = args.delete
+        self.include: Optional[list[str]] = args.include
+        self.exclude: Optional[list[str]] = args.exclude
+        self.delete: Optional[list[str]] = args.delete
 
         self.commit_message: Optional[str] = args.commit_message
         self.commit_description: Optional[str] = args.commit_description

huggingface_hub/cli/upload_large_folder.py

@@ -16,7 +16,7 @@
 
 import os
 from argparse import Namespace, _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
@@ -76,8 +76,8 @@ class UploadLargeFolderCommand(BaseHuggingfaceCLICommand):
         self.revision: Optional[str] = args.revision
         self.private: bool = args.private
 
-        self.include: Optional[List[str]] = args.include
-        self.exclude: Optional[List[str]] = args.exclude
+        self.include: Optional[list[str]] = args.include
+        self.exclude: Optional[list[str]] = args.exclude
 
         self.api: HfApi = HfApi(token=args.token, library_name="hf")
 

huggingface_hub/commands/_cli_utils.py

@@ -14,7 +14,7 @@
 """Contains a utility for good-looking prints."""
 
 import os
-from typing import List, Union
+from typing import Union
 
 
 class ANSI:
@@ -52,7 +52,7 @@ class ANSI:
         return f"{code}{s}{cls._reset}"
 
 
-def tabulate(rows: List[List[Union[str, int]]], headers: List[str]) -> str:
+def tabulate(rows: list[list[Union[str, int]]], headers: list[str]) -> str:
     """
     Inspired by:
 

huggingface_hub/commands/delete_cache.py

@@ -22,7 +22,7 @@ Usage:
 
 NOTE:
     This command is based on `InquirerPy` to build the multiselect menu in the terminal.
-    This dependency has to be installed with `pip install huggingface_hub[cli]`. Since
+    This dependency has to be installed with `pip install "huggingface_hub[cli]"`. Since
     we want to avoid as much as possible cross-platform issues, I chose a library that
     is built on top of `python-prompt-toolkit` which seems to be a reference in terminal
     GUI (actively maintained on both Unix and Windows, 7.9k stars).
@@ -60,7 +60,7 @@ import os
 from argparse import Namespace, _SubParsersAction
 from functools import wraps
 from tempfile import mkstemp
-from typing import Any, Callable, Iterable, List, Literal, Optional, Union
+from typing import Any, Callable, Iterable, Literal, Optional, Union
 
 from ..utils import CachedRepoInfo, CachedRevisionInfo, HFCacheInfo, scan_cache_dir
 from . import BaseHuggingfaceCLICommand
@@ -88,7 +88,7 @@ def require_inquirer_py(fn: Callable) -> Callable:
         if not _inquirer_py_available:
             raise ImportError(
                 "The `delete-cache` command requires extra dependencies to work with"
-                " the TUI.\nPlease run `pip install huggingface_hub[cli]` to install"
+                ' the TUI.\nPlease run `pip install "huggingface_hub[cli]"` to install'
                 " them.\nOtherwise, disable TUI using the `--disable-tui` flag."
             )
 
@@ -197,9 +197,9 @@ def _get_repo_sorting_key(repo: CachedRepoInfo, sort_by: Optional[SortingOption_
 @require_inquirer_py
 def _manual_review_tui(
     hf_cache_info: HFCacheInfo,
-    preselected: List[str],
+    preselected: list[str],
     sort_by: Optional[SortingOption_T] = None,
-) -> List[str]:
+) -> list[str]:
     """Ask the user for a manual review of the revisions to delete.
 
     Displays a multi-select menu in the terminal (TUI).
@@ -254,15 +254,15 @@ def _ask_for_confirmation_tui(message: str, default: bool = True) -> bool:
 
 def _get_tui_choices_from_scan(
     repos: Iterable[CachedRepoInfo],
-    preselected: List[str],
+    preselected: list[str],
     sort_by: Optional[SortingOption_T] = None,
-) -> List:
+) -> list:
     """Build a list of choices from the scanned repos.
 
     Args:
         repos (*Iterable[`CachedRepoInfo`]*):
             List of scanned repos on which we want to delete revisions.
-        preselected (*List[`str`]*):
+        preselected (*list[`str`]*):
             List of revision hashes that will be preselected.
         sort_by (*Optional[SortingOption_T]*):
             Sorting direction. Choices: "alphabetical", "lastUpdated", "lastUsed", "size".
@@ -270,7 +270,7 @@ def _get_tui_choices_from_scan(
     Return:
         The list of choices to pass to `inquirer.checkbox`.
     """
-    choices: List[Union[Choice, Separator]] = []
+    choices: list[Union[Choice, Separator]] = []
 
     # First choice is to cancel the deletion
     choices.append(
@@ -312,9 +312,9 @@ def _get_tui_choices_from_scan(
 
 def _manual_review_no_tui(
     hf_cache_info: HFCacheInfo,
-    preselected: List[str],
+    preselected: list[str],
     sort_by: Optional[SortingOption_T] = None,
-) -> List[str]:
+) -> list[str]:
     """Ask the user for a manual review of the revisions to delete.
 
     Used when TUI is disabled. Manual review happens in a separate tmp file that the
@@ -390,7 +390,7 @@ def _ask_for_confirmation_no_tui(message: str, default: bool = True) -> bool:
         print(f"Invalid input. Must be one of {ALL}")
 
 
-def _get_expectations_str(hf_cache_info: HFCacheInfo, selected_hashes: List[str]) -> str:
+def _get_expectations_str(hf_cache_info: HFCacheInfo, selected_hashes: list[str]) -> str:
     """Format a string to display to the user how much space would be saved.
 
     Example:
@@ -405,7 +405,7 @@ def _get_expectations_str(hf_cache_info: HFCacheInfo, selected_hashes: List[str]
     return f"{len(selected_hashes)} revisions selected counting for {strategy.expected_freed_size_str}."
 
 
-def _read_manual_review_tmp_file(tmp_path: str) -> List[str]:
+def _read_manual_review_tmp_file(tmp_path: str) -> list[str]:
     """Read the manually reviewed instruction file and return a list of revision hash.
 
     Example:

huggingface_hub/commands/download.py

@@ -38,7 +38,7 @@ Usage:
 
 import warnings
 from argparse import Namespace, _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub._snapshot_download import snapshot_download
@@ -125,24 +125,17 @@ class DownloadCommand(BaseHuggingfaceCLICommand):
     def __init__(self, args: Namespace) -> None:
         self.token = args.token
         self.repo_id: str = args.repo_id
-        self.filenames: List[str] = args.filenames
+        self.filenames: list[str] = args.filenames
         self.repo_type: str = args.repo_type
         self.revision: Optional[str] = args.revision
-        self.include: Optional[List[str]] = args.include
-        self.exclude: Optional[List[str]] = args.exclude
+        self.include: Optional[list[str]] = args.include
+        self.exclude: Optional[list[str]] = args.exclude
         self.cache_dir: Optional[str] = args.cache_dir
         self.local_dir: Optional[str] = args.local_dir
         self.force_download: bool = args.force_download
-        self.resume_download: Optional[bool] = args.resume_download or None
         self.quiet: bool = args.quiet
         self.max_workers: int = args.max_workers
 
-        if args.local_dir_use_symlinks is not None:
-            warnings.warn(
-                "Ignoring --local-dir-use-symlinks. Downloading to a local directory does not use symlinks anymore.",
-                FutureWarning,
-            )
-
     def run(self) -> None:
         show_deprecation_warning("huggingface-cli download", "hf download")
 
@@ -173,7 +166,6 @@ class DownloadCommand(BaseHuggingfaceCLICommand):
                 revision=self.revision,
                 filename=self.filenames[0],
                 cache_dir=self.cache_dir,
-                resume_download=self.resume_download,
                 force_download=self.force_download,
                 token=self.token,
                 local_dir=self.local_dir,
@@ -194,7 +186,6 @@ class DownloadCommand(BaseHuggingfaceCLICommand):
             revision=self.revision,
             allow_patterns=allow_patterns,
             ignore_patterns=ignore_patterns,
-            resume_download=self.resume_download,
             force_download=self.force_download,
             cache_dir=self.cache_dir,
             token=self.token,

huggingface_hub/commands/lfs.py

@@ -21,7 +21,7 @@ import os
 import subprocess
 import sys
 from argparse import _SubParsersAction
-from typing import Dict, List, Optional
+from typing import Optional
 
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
 from huggingface_hub.lfs import LFS_MULTIPART_UPLOAD_COMMAND
@@ -89,14 +89,14 @@ class LfsEnableCommand:
         print("Local repo set up for largefiles")
 
 
-def write_msg(msg: Dict):
+def write_msg(msg: dict):
     """Write out the message in Line delimited JSON."""
     msg_str = json.dumps(msg) + "\n"
     sys.stdout.write(msg_str)
     sys.stdout.flush()
 
 
-def read_msg() -> Optional[Dict]:
+def read_msg() -> Optional[dict]:
     """Read Line delimited JSON from stdin."""
     msg = json.loads(sys.stdin.readline().strip())
 
@@ -146,7 +146,7 @@ class LfsUploadCommand:
             completion_url = msg["action"]["href"]
             header = msg["action"]["header"]
             chunk_size = int(header.pop("chunk_size"))
-            presigned_urls: List[str] = list(header.values())
+            presigned_urls: list[str] = list(header.values())
 
             # Send a "started" progress event to allow other workers to start.
             # Otherwise they're delayed until first "progress" event is reported,

huggingface_hub/commands/repo_files.py

@@ -35,7 +35,7 @@ Usage:
 """
 
 from argparse import _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
@@ -54,7 +54,7 @@ class DeleteFilesSubCommand:
         self.repo_type: Optional[str] = args.repo_type
         self.revision: Optional[str] = args.revision
         self.api: HfApi = HfApi(token=args.token, library_name="huggingface-cli")
-        self.patterns: List[str] = args.patterns
+        self.patterns: list[str] = args.patterns
         self.commit_message: Optional[str] = args.commit_message
         self.commit_description: Optional[str] = args.commit_description
         self.create_pr: bool = args.create_pr

huggingface_hub/commands/scan_cache.py

@@ -77,7 +77,7 @@ class ScanCacheCommand(BaseHuggingfaceCLICommand):
             if self.verbosity >= 3:
                 print(ANSI.gray(message))
                 for warning in hf_cache_info.warnings:
-                    print(ANSI.gray(warning))
+                    print(ANSI.gray(str(warning)))
             else:
                 print(ANSI.gray(message + " Use -vvv to print details."))
 

huggingface_hub/commands/tag.py

@@ -32,8 +32,6 @@ Usage Examples:
 
 from argparse import Namespace, _SubParsersAction
 
-from requests.exceptions import HTTPError
-
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
 from huggingface_hub.constants import (
     REPO_TYPES,
@@ -129,7 +127,7 @@ class TagListCommand(TagCommand):
         except RepositoryNotFoundError:
             print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
             exit(1)
-        except HTTPError as e:
+        except HfHubHTTPError as e:
             print(e)
             print(ANSI.red(e.response.text))
             exit(1)

huggingface_hub/commands/upload.py

@@ -50,7 +50,7 @@ import os
 import time
 import warnings
 from argparse import Namespace, _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub._commit_scheduler import CommitScheduler
@@ -144,9 +144,9 @@ class UploadCommand(BaseHuggingfaceCLICommand):
         self.revision: Optional[str] = args.revision
         self.private: bool = args.private
 
-        self.include: Optional[List[str]] = args.include
-        self.exclude: Optional[List[str]] = args.exclude
-        self.delete: Optional[List[str]] = args.delete
+        self.include: Optional[list[str]] = args.include
+        self.exclude: Optional[list[str]] = args.exclude
+        self.delete: Optional[list[str]] = args.delete
 
         self.commit_message: Optional[str] = args.commit_message
         self.commit_description: Optional[str] = args.commit_description

huggingface_hub/commands/upload_large_folder.py

@@ -16,7 +16,7 @@
 
 import os
 from argparse import Namespace, _SubParsersAction
-from typing import List, Optional
+from typing import Optional
 
 from huggingface_hub import logging
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
@@ -73,8 +73,8 @@ class UploadLargeFolderCommand(BaseHuggingfaceCLICommand):
         self.revision: Optional[str] = args.revision
         self.private: bool = args.private
 
-        self.include: Optional[List[str]] = args.include
-        self.exclude: Optional[List[str]] = args.exclude
+        self.include: Optional[list[str]] = args.include
+        self.exclude: Optional[list[str]] = args.exclude
 
         self.api: HfApi = HfApi(token=args.token, library_name="huggingface-cli")
 

huggingface_hub/commands/user.py

@@ -31,12 +31,11 @@ Usage:
 """
 
 from argparse import _SubParsersAction
-from typing import List, Optional
-
-from requests.exceptions import HTTPError
+from typing import Optional
 
 from huggingface_hub.commands import BaseHuggingfaceCLICommand
 from huggingface_hub.constants import ENDPOINT
+from huggingface_hub.errors import HfHubHTTPError
 from huggingface_hub.hf_api import HfApi
 
 from .._login import auth_list, auth_switch, login, logout
@@ -164,7 +163,7 @@ class AuthSwitchCommand(BaseUserCommand):
             except ValueError:
                 print("Invalid input. Please enter a number or 'q' to quit.")
 
-    def _select_token_name_tui(self, token_names: List[str]) -> Optional[str]:
+    def _select_token_name_tui(self, token_names: list[str]) -> Optional[str]:
         choices = [Choice(token_name, name=token_name) for token_name in token_names]
         try:
             return inquirer.select(
@@ -195,14 +194,14 @@ class WhoamiCommand(BaseUserCommand):
             exit()
         try:
             info = self._api.whoami(token)
-            print(ANSI.bold("user: "), info["name"])
+            print(info["name"])
             orgs = [org["name"] for org in info["orgs"]]
             if orgs:
                 print(ANSI.bold("orgs: "), ",".join(orgs))
 
             if ENDPOINT != "https://huggingface.co":
                 print(f"Authenticated through private endpoint: {ENDPOINT}")
-        except HTTPError as e:
+        except HfHubHTTPError as e:
             print(e)
             print(ANSI.red(e.response.text))
             exit(1)

huggingface_hub/community.py

@@ -7,7 +7,7 @@ for more information on Pull Requests, Discussions, and the community tab.
 
 from dataclasses import dataclass
 from datetime import datetime
-from typing import List, Literal, Optional, Union
+from typing import Literal, Optional, Union
 
 from . import constants
 from .utils import parse_datetime
@@ -116,7 +116,7 @@ class DiscussionWithDetails(Discussion):
             The `datetime` of creation of the Discussion / Pull Request.
         events (`list` of [`DiscussionEvent`])
             The list of [`DiscussionEvents`] in this Discussion or Pull Request.
-        conflicting_files (`Union[List[str], bool, None]`, *optional*):
+        conflicting_files (`Union[list[str], bool, None]`, *optional*):
             A list of conflicting files if this is a Pull Request.
             `None` if `self.is_pull_request` is `False`.
             `True` if there are conflicting files but the list can't be retrieved.
@@ -136,8 +136,8 @@ class DiscussionWithDetails(Discussion):
             (property) URL of the discussion on the Hub.
     """
 
-    events: List["DiscussionEvent"]
-    conflicting_files: Union[List[str], bool, None]
+    events: list["DiscussionEvent"]
+    conflicting_files: Union[list[str], bool, None]
     target_branch: Optional[str]
     merge_commit_oid: Optional[str]
     diff: Optional[str]
@@ -222,7 +222,7 @@ class DiscussionComment(DiscussionEvent):
         return self._event["data"]["latest"].get("author", {}).get("name", "deleted")
 
     @property
-    def edit_history(self) -> List[dict]:
+    def edit_history(self) -> list[dict]:
         """The edit history of the comment"""
         return self._event["data"]["history"]
 

huggingface_hub/constants.py

@@ -1,7 +1,7 @@
 import os
 import re
 import typing
-from typing import Literal, Optional, Tuple
+from typing import Literal, Optional
 
 
 # Possible values for env variables
@@ -118,9 +118,9 @@ REPO_TYPES_MAPPING = {
 }
 
 DiscussionTypeFilter = Literal["all", "discussion", "pull_request"]
-DISCUSSION_TYPES: Tuple[DiscussionTypeFilter, ...] = typing.get_args(DiscussionTypeFilter)
+DISCUSSION_TYPES: tuple[DiscussionTypeFilter, ...] = typing.get_args(DiscussionTypeFilter)
 DiscussionStatusFilter = Literal["all", "open", "closed"]
-DISCUSSION_STATUS: Tuple[DiscussionTypeFilter, ...] = typing.get_args(DiscussionStatusFilter)
+DISCUSSION_STATUS: tuple[DiscussionTypeFilter, ...] = typing.get_args(DiscussionStatusFilter)
 
 # Webhook subscription types
 WEBHOOK_DOMAIN_T = Literal["repo", "discussions"]
@@ -135,7 +135,6 @@ HF_HOME = os.path.expandvars(
         )
     )
 )
-hf_cache_home = HF_HOME  # for backward compatibility. TODO: remove this in 1.0.0
 
 default_cache_path = os.path.join(HF_HOME, "hub")
 default_assets_cache_path = os.path.join(HF_HOME, "assets")
@@ -234,43 +233,6 @@ HF_HUB_DOWNLOAD_TIMEOUT: int = _as_int(os.environ.get("HF_HUB_DOWNLOAD_TIMEOUT")
 # Allows to add information about the requester in the user-agent (eg. partner name)
 HF_HUB_USER_AGENT_ORIGIN: Optional[str] = os.environ.get("HF_HUB_USER_AGENT_ORIGIN")
 
-# List frameworks that are handled by the InferenceAPI service. Useful to scan endpoints and check which models are
-# deployed and running. Since 95% of the models are using the top 4 frameworks listed below, we scan only those by
-# default. We still keep the full list of supported frameworks in case we want to scan all of them.
-MAIN_INFERENCE_API_FRAMEWORKS = [
-    "diffusers",
-    "sentence-transformers",
-    "text-generation-inference",
-    "transformers",
-]
-
-ALL_INFERENCE_API_FRAMEWORKS = MAIN_INFERENCE_API_FRAMEWORKS + [
-    "adapter-transformers",
-    "allennlp",
-    "asteroid",
-    "bertopic",
-    "doctr",
-    "espnet",
-    "fairseq",
-    "fastai",
-    "fasttext",
-    "flair",
-    "k2",
-    "keras",
-    "mindspore",
-    "nemo",
-    "open_clip",
-    "paddlenlp",
-    "peft",
-    "pyannote-audio",
-    "sklearn",
-    "spacy",
-    "span-marker",
-    "speechbrain",
-    "stanza",
-    "timm",
-]
-
 # If OAuth didn't work after 2 redirects, there's likely a third-party cookie issue in the Space iframe view.
 # In this case, we redirect the user to the non-iframe view.
 OAUTH_MAX_REDIRECTS = 2