huggingface-hub 1.0.0rc2__py3-none-any.whl → 1.0.0rc3__py3-none-any.whl

huggingface_hub/commands/repo_files.py

@@ -1,132 +0,0 @@
-# coding=utf-8
-# Copyright 2023-present, the HuggingFace Inc. team.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Contains command to update or delete files in a repository using the CLI.
-
-Usage:
-    # delete all
-    huggingface-cli repo-files <repo_id> delete "*"
-
-    # delete single file
-    huggingface-cli repo-files <repo_id> delete file.txt
-
-    # delete single folder
-    huggingface-cli repo-files <repo_id> delete folder/
-
-    # delete multiple
-    huggingface-cli repo-files <repo_id> delete file.txt folder/ file2.txt
-
-    # delete multiple patterns
-    huggingface-cli repo-files <repo_id> delete file.txt "*.json" "folder/*.parquet"
-
-    # delete from different revision / repo-type
-    huggingface-cli repo-files <repo_id> delete file.txt --revision=refs/pr/1 --repo-type=dataset
-"""
-
-from argparse import _SubParsersAction
-from typing import Optional
-
-from huggingface_hub import logging
-from huggingface_hub.commands import BaseHuggingfaceCLICommand
-from huggingface_hub.hf_api import HfApi
-
-from ._cli_utils import show_deprecation_warning
-
-
-logger = logging.get_logger(__name__)
-
-
-class DeleteFilesSubCommand:
-    def __init__(self, args) -> None:
-        self.args = args
-        self.repo_id: str = args.repo_id
-        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.commit_message: Optional[str] = args.commit_message
-        self.commit_description: Optional[str] = args.commit_description
-        self.create_pr: bool = args.create_pr
-        self.token: Optional[str] = args.token
-
-    def run(self) -> None:
-        show_deprecation_warning("huggingface-cli repo-files", "hf repo-files")
-
-        logging.set_verbosity_info()
-        url = self.api.delete_files(
-            delete_patterns=self.patterns,
-            repo_id=self.repo_id,
-            repo_type=self.repo_type,
-            revision=self.revision,
-            commit_message=self.commit_message,
-            commit_description=self.commit_description,
-            create_pr=self.create_pr,
-        )
-        print(f"Files correctly deleted from repo. Commit: {url}.")
-        logging.set_verbosity_warning()
-
-
-class RepoFilesCommand(BaseHuggingfaceCLICommand):
-    @staticmethod
-    def register_subcommand(parser: _SubParsersAction):
-        repo_files_parser = parser.add_parser("repo-files", help="Manage files in a repo on the Hub")
-        repo_files_parser.add_argument(
-            "repo_id", type=str, help="The ID of the repo to manage (e.g. `username/repo-name`)."
-        )
-        repo_files_subparsers = repo_files_parser.add_subparsers(
-            help="Action to execute against the files.",
-            required=True,
-        )
-        delete_subparser = repo_files_subparsers.add_parser(
-            "delete",
-            help="Delete files from a repo on the Hub",
-        )
-        delete_subparser.set_defaults(func=lambda args: DeleteFilesSubCommand(args))
-        delete_subparser.add_argument(
-            "patterns",
-            nargs="+",
-            type=str,
-            help="Glob patterns to match files to delete.",
-        )
-        delete_subparser.add_argument(
-            "--repo-type",
-            choices=["model", "dataset", "space"],
-            default="model",
-            help="Type of the repo to upload to (e.g. `dataset`).",
-        )
-        delete_subparser.add_argument(
-            "--revision",
-            type=str,
-            help=(
-                "An optional Git revision to push to. It can be a branch name "
-                "or a PR reference. If revision does not"
-                " exist and `--create-pr` is not set, a branch will be automatically created."
-            ),
-        )
-        delete_subparser.add_argument(
-            "--commit-message", type=str, help="The summary / title / first line of the generated commit."
-        )
-        delete_subparser.add_argument(
-            "--commit-description", type=str, help="The description of the generated commit."
-        )
-        delete_subparser.add_argument(
-            "--create-pr", action="store_true", help="Whether to create a new Pull Request for these changes."
-        )
-        repo_files_parser.add_argument(
-            "--token",
-            type=str,
-            help="A User Access Token generated from https://huggingface.co/settings/tokens",
-        )
-
-        repo_files_parser.set_defaults(func=RepoFilesCommand)

huggingface_hub/commands/scan_cache.py

@@ -1,183 +0,0 @@
-# coding=utf-8
-# Copyright 2022-present, the HuggingFace Inc. team.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Contains command to scan the HF cache directory.
-
-Usage:
-    huggingface-cli scan-cache
-    huggingface-cli scan-cache -v
-    huggingface-cli scan-cache -vvv
-    huggingface-cli scan-cache --dir ~/.cache/huggingface/hub
-"""
-
-import time
-from argparse import Namespace, _SubParsersAction
-from typing import Optional
-
-from ..utils import CacheNotFound, HFCacheInfo, scan_cache_dir
-from . import BaseHuggingfaceCLICommand
-from ._cli_utils import ANSI, show_deprecation_warning, tabulate
-
-
-class ScanCacheCommand(BaseHuggingfaceCLICommand):
-    @staticmethod
-    def register_subcommand(parser: _SubParsersAction):
-        scan_cache_parser = parser.add_parser("scan-cache", help="Scan cache directory.")
-
-        scan_cache_parser.add_argument(
-            "--dir",
-            type=str,
-            default=None,
-            help="cache directory to scan (optional). Default to the default HuggingFace cache.",
-        )
-        scan_cache_parser.add_argument(
-            "-v",
-            "--verbose",
-            action="count",
-            default=0,
-            help="show a more verbose output",
-        )
-        scan_cache_parser.set_defaults(func=ScanCacheCommand)
-
-    def __init__(self, args: Namespace) -> None:
-        self.verbosity: int = args.verbose
-        self.cache_dir: Optional[str] = args.dir
-
-    def run(self):
-        show_deprecation_warning("huggingface-cli scan-cache", "hf cache scan")
-
-        try:
-            t0 = time.time()
-            hf_cache_info = scan_cache_dir(self.cache_dir)
-            t1 = time.time()
-        except CacheNotFound as exc:
-            cache_dir = exc.cache_dir
-            print(f"Cache directory not found: {cache_dir}")
-            return
-
-        self._print_hf_cache_info_as_table(hf_cache_info)
-
-        print(
-            f"\nDone in {round(t1 - t0, 1)}s. Scanned {len(hf_cache_info.repos)} repo(s)"
-            f" for a total of {ANSI.red(hf_cache_info.size_on_disk_str)}."
-        )
-        if len(hf_cache_info.warnings) > 0:
-            message = f"Got {len(hf_cache_info.warnings)} warning(s) while scanning."
-            if self.verbosity >= 3:
-                print(ANSI.gray(message))
-                for warning in hf_cache_info.warnings:
-                    print(ANSI.gray(str(warning)))
-            else:
-                print(ANSI.gray(message + " Use -vvv to print details."))
-
-    def _print_hf_cache_info_as_table(self, hf_cache_info: HFCacheInfo) -> None:
-        print(get_table(hf_cache_info, verbosity=self.verbosity))
-
-
-def get_table(hf_cache_info: HFCacheInfo, *, verbosity: int = 0) -> str:
-    """Generate a table from the [`HFCacheInfo`] object.
-
-    Pass `verbosity=0` to get a table with a single row per repo, with columns
-    "repo_id", "repo_type", "size_on_disk", "nb_files", "last_accessed", "last_modified", "refs", "local_path".
-
-    Pass `verbosity=1` to get a table with a row per repo and revision (thus multiple rows can appear for a single repo), with columns
-    "repo_id", "repo_type", "revision", "size_on_disk", "nb_files", "last_modified", "refs", "local_path".
-
-    Example:
-    ```py
-    >>> from huggingface_hub.utils import scan_cache_dir
-    >>> from huggingface_hub.commands.scan_cache import get_table
-
-    >>> hf_cache_info = scan_cache_dir()
-    HFCacheInfo(...)
-
-    >>> print(get_table(hf_cache_info, verbosity=0))
-    REPO ID                                             REPO TYPE SIZE ON DISK NB FILES LAST_ACCESSED LAST_MODIFIED REFS LOCAL PATH
-    --------------------------------------------------- --------- ------------ -------- ------------- ------------- ---- --------------------------------------------------------------------------------------------------
-    roberta-base                                        model             2.7M        5 1 day ago     1 week ago    main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--roberta-base
-    suno/bark                                           model             8.8K        1 1 week ago    1 week ago    main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--suno--bark
-    t5-base                                             model           893.8M        4 4 days ago    7 months ago  main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--t5-base
-    t5-large                                            model             3.0G        4 5 weeks ago   5 months ago  main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--t5-large
-
-    >>> print(get_table(hf_cache_info, verbosity=1))
-    REPO ID                                             REPO TYPE REVISION                                 SIZE ON DISK NB FILES LAST_MODIFIED REFS LOCAL PATH
-    --------------------------------------------------- --------- ---------------------------------------- ------------ -------- ------------- ---- -----------------------------------------------------------------------------------------------------------------------------------------------------
-    roberta-base                                        model     e2da8e2f811d1448a5b465c236feacd80ffbac7b         2.7M        5 1 week ago    main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--roberta-base\\snapshots\\e2da8e2f811d1448a5b465c236feacd80ffbac7b
-    suno/bark                                           model     70a8a7d34168586dc5d028fa9666aceade177992         8.8K        1 1 week ago    main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--suno--bark\\snapshots\\70a8a7d34168586dc5d028fa9666aceade177992
-    t5-base                                             model     a9723ea7f1b39c1eae772870f3b547bf6ef7e6c1       893.8M        4 7 months ago  main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--t5-base\\snapshots\\a9723ea7f1b39c1eae772870f3b547bf6ef7e6c1
-    t5-large                                            model     150ebc2c4b72291e770f58e6057481c8d2ed331a         3.0G        4 5 months ago  main C:\\Users\\admin\\.cache\\huggingface\\hub\\models--t5-large\\snapshots\\150ebc2c4b72291e770f58e6057481c8d2ed331a                                                 ```
-    ```
-
-    Args:
-        hf_cache_info ([`HFCacheInfo`]):
-            The HFCacheInfo object to print.
-        verbosity (`int`, *optional*):
-            The verbosity level. Defaults to 0.
-
-    Returns:
-        `str`: The table as a string.
-    """
-    if verbosity == 0:
-        return tabulate(
-            rows=[
-                [
-                    repo.repo_id,
-                    repo.repo_type,
-                    "{:>12}".format(repo.size_on_disk_str),
-                    repo.nb_files,
-                    repo.last_accessed_str,
-                    repo.last_modified_str,
-                    ", ".join(sorted(repo.refs)),
-                    str(repo.repo_path),
-                ]
-                for repo in sorted(hf_cache_info.repos, key=lambda repo: repo.repo_path)
-            ],
-            headers=[
-                "REPO ID",
-                "REPO TYPE",
-                "SIZE ON DISK",
-                "NB FILES",
-                "LAST_ACCESSED",
-                "LAST_MODIFIED",
-                "REFS",
-                "LOCAL PATH",
-            ],
-        )
-    else:
-        return tabulate(
-            rows=[
-                [
-                    repo.repo_id,
-                    repo.repo_type,
-                    revision.commit_hash,
-                    "{:>12}".format(revision.size_on_disk_str),
-                    revision.nb_files,
-                    revision.last_modified_str,
-                    ", ".join(sorted(revision.refs)),
-                    str(revision.snapshot_path),
-                ]
-                for repo in sorted(hf_cache_info.repos, key=lambda repo: repo.repo_path)
-                for revision in sorted(repo.revisions, key=lambda revision: revision.commit_hash)
-            ],
-            headers=[
-                "REPO ID",
-                "REPO TYPE",
-                "REVISION",
-                "SIZE ON DISK",
-                "NB FILES",
-                "LAST_MODIFIED",
-                "REFS",
-                "LOCAL PATH",
-            ],
-        )

huggingface_hub/commands/tag.py

@@ -1,159 +0,0 @@
-# coding=utf-8
-# Copyright 2024-present, the HuggingFace Inc. team.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Contains commands to perform tag management with the CLI.
-
-Usage Examples:
-    - Create a tag:
-        $ huggingface-cli tag user/my-model 1.0 --message "First release"
-        $ huggingface-cli tag user/my-model 1.0 -m "First release" --revision develop
-        $ huggingface-cli tag user/my-dataset 1.0 -m "First release" --repo-type dataset
-        $ huggingface-cli tag user/my-space 1.0
-    - List all tags:
-        $ huggingface-cli tag -l user/my-model
-        $ huggingface-cli tag --list user/my-dataset --repo-type dataset
-    - Delete a tag:
-        $ huggingface-cli tag -d user/my-model 1.0
-        $ huggingface-cli tag --delete user/my-dataset 1.0 --repo-type dataset
-        $ huggingface-cli tag -d user/my-space 1.0 -y
-"""
-
-from argparse import Namespace, _SubParsersAction
-
-from huggingface_hub.commands import BaseHuggingfaceCLICommand
-from huggingface_hub.constants import (
-    REPO_TYPES,
-)
-from huggingface_hub.hf_api import HfApi
-
-from ..errors import HfHubHTTPError, RepositoryNotFoundError, RevisionNotFoundError
-from ._cli_utils import ANSI, show_deprecation_warning
-
-
-class TagCommands(BaseHuggingfaceCLICommand):
-    @staticmethod
-    def register_subcommand(parser: _SubParsersAction):
-        tag_parser = parser.add_parser("tag", help="(create, list, delete) tags for a repo in the hub")
-
-        tag_parser.add_argument("repo_id", type=str, help="The ID of the repo to tag (e.g. `username/repo-name`).")
-        tag_parser.add_argument("tag", nargs="?", type=str, help="The name of the tag for creation or deletion.")
-        tag_parser.add_argument("-m", "--message", type=str, help="The description of the tag to create.")
-        tag_parser.add_argument("--revision", type=str, help="The git revision to tag.")
-        tag_parser.add_argument(
-            "--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens."
-        )
-        tag_parser.add_argument(
-            "--repo-type",
-            choices=["model", "dataset", "space"],
-            default="model",
-            help="Set the type of repository (model, dataset, or space).",
-        )
-        tag_parser.add_argument("-y", "--yes", action="store_true", help="Answer Yes to prompts automatically.")
-
-        tag_parser.add_argument("-l", "--list", action="store_true", help="List tags for a repository.")
-        tag_parser.add_argument("-d", "--delete", action="store_true", help="Delete a tag for a repository.")
-
-        tag_parser.set_defaults(func=lambda args: handle_commands(args))
-
-
-def handle_commands(args: Namespace):
-    show_deprecation_warning("huggingface-cli tag", "hf repo tag")
-
-    if args.list:
-        return TagListCommand(args)
-    elif args.delete:
-        return TagDeleteCommand(args)
-    else:
-        return TagCreateCommand(args)
-
-
-class TagCommand:
-    def __init__(self, args: Namespace):
-        self.args = args
-        self.api = HfApi(token=self.args.token)
-        self.repo_id = self.args.repo_id
-        self.repo_type = self.args.repo_type
-        if self.repo_type not in REPO_TYPES:
-            print("Invalid repo --repo-type")
-            exit(1)
-
-
-class TagCreateCommand(TagCommand):
-    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)}")
-
-        try:
-            self.api.create_tag(
-                repo_id=self.repo_id,
-                tag=self.args.tag,
-                tag_message=self.args.message,
-                revision=self.args.revision,
-                repo_type=self.repo_type,
-            )
-        except RepositoryNotFoundError:
-            print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
-            exit(1)
-        except RevisionNotFoundError:
-            print(f"Revision {ANSI.bold(self.args.revision)} 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)}")
-                exit(1)
-            raise e
-
-        print(f"Tag {ANSI.bold(self.args.tag)} created on {ANSI.bold(self.repo_id)}")
-
-
-class TagListCommand(TagCommand):
-    def run(self):
-        try:
-            refs = self.api.list_repo_refs(
-                repo_id=self.repo_id,
-                repo_type=self.repo_type,
-            )
-        except RepositoryNotFoundError:
-            print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
-            exit(1)
-        except HfHubHTTPError as e:
-            print(e)
-            print(ANSI.red(e.response.text))
-            exit(1)
-        if len(refs.tags) == 0:
-            print("No tags found")
-            exit(0)
-        print(f"Tags for {self.repo_type} {ANSI.bold(self.repo_id)}:")
-        for tag in refs.tags:
-            print(tag.name)
-
-
-class TagDeleteCommand(TagCommand):
-    def run(self):
-        print(f"You are about to delete tag {ANSI.bold(self.args.tag)} on {self.repo_type} {ANSI.bold(self.repo_id)}")
-
-        if not self.args.yes:
-            choice = input("Proceed? [Y/n] ").lower()
-            if choice not in ("", "y", "yes"):
-                print("Abort")
-                exit()
-        try:
-            self.api.delete_tag(repo_id=self.repo_id, tag=self.args.tag, repo_type=self.repo_type)
-        except RepositoryNotFoundError:
-            print(f"{self.repo_type.capitalize()} {ANSI.bold(self.repo_id)} not found.")
-            exit(1)
-        except RevisionNotFoundError:
-            print(f"Tag {ANSI.bold(self.args.tag)} not found on {ANSI.bold(self.repo_id)}")
-            exit(1)
-        print(f"Tag {ANSI.bold(self.args.tag)} deleted on {ANSI.bold(self.repo_id)}")