hfutils 0.2.2__tar.gz → 0.2.4__tar.gz

{hfutils-0.2.2/hfutils.egg-info → hfutils-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hfutils
-Version: 0.2.2
+Version: 0.2.4
 Summary: Useful utilities for huggingface
 Home-page: https://github.com/deepghs/hfutils
 Author: narugo1992

{hfutils-0.2.2 → hfutils-0.2.4}/hfutils/config/meta.py

@@ -7,7 +7,7 @@ Overview:
 __TITLE__ = 'hfutils'
 
 #: Version of this project.
-__VERSION__ = '0.2.2'
+__VERSION__ = '0.2.4'
 
 #: Short description of the project, will be included in ``setup.py``.
 __DESCRIPTION__ = 'Useful utilities for huggingface'

{hfutils-0.2.2 → hfutils-0.2.4}/hfutils/entry/cli.py

@@ -2,11 +2,13 @@ from .dispatch import hfutilcli
 from .download import _add_download_subcommand
 from .ls import _add_ls_subcommand
 from .upload import _add_upload_subcommand
+from .whoami import _add_whoami_subcommand
 
 _DECORATORS = [
     _add_download_subcommand,
     _add_upload_subcommand,
     _add_ls_subcommand,
+    _add_whoami_subcommand,
 ]
 
 cli = hfutilcli

hfutils-0.2.4/hfutils/entry/whoami.py

@@ -0,0 +1,50 @@
+import click
+from hbutils.string import plural_word
+from huggingface_hub.utils import LocalTokenNotFoundError
+
+from .base import CONTEXT_SETTINGS
+from ..operate.base import get_hf_client
+
+
+def _add_whoami_subcommand(cli: click.Group) -> click.Group:
+    """
+    Add the 'whoami' subcommand to the CLI.
+
+    This command displays the current identification.
+
+    :param cli: The Click CLI application.
+    :type cli: click.Group
+    :return: The modified Click CLI application.
+    :rtype: click.Group
+    """
+
+    @cli.command('whoami', help='See the current identification.\n\n'
+                                'Set environment $HF_TOKEN to use your own access token.',
+                 context_settings=CONTEXT_SETTINGS)
+    def whoami():
+        """
+        Display the current identification.
+
+        This function retrieves the current user's identification from the Hugging Face Hub API and displays it.
+
+        """
+        hf_client = get_hf_client()
+        try:
+            info = hf_client.whoami()
+            username = info['name']
+            click.echo(f'Hi, {click.style(f"@{username}", fg="green", bold=True)} '
+                       f'(full name: {click.style(info["fullname"], underline=True)}'
+                       f'{", PRO" if info["isPro"] else ""}).')
+            click.echo(f'You can access all resources with this identification.')
+            if info['orgs']:
+                click.echo(f'You have entered {plural_word(len(info["orgs"]), "organizations")}:')
+                for i, org_item in enumerate(info['orgs'], start=1):
+                    click.echo(f'{i}. {click.style("@" + org_item["name"], fg="blue", bold=True)} '
+                               f'(full name: {click.style(org_item["fullname"], underline=True)})')
+        except LocalTokenNotFoundError:
+            click.echo(f'Hi, {click.style("Guest", fg="yellow", bold=True)} (not authenticated).')
+            click.echo(click.style(f'No token for huggingface authentication found.', underline=True))
+            click.echo(f'If you need to access more, just set `HF_TOKEN` environment variable, '
+                       f'or use `huggingface-cli login`.')
+
+    return cli

{hfutils-0.2.2 → hfutils-0.2.4}/hfutils/operate/download.py

@@ -9,7 +9,7 @@ import requests.exceptions
 from .base import RepoTypeTyping, list_files_in_repository, _IGNORE_PATTERN_UNSET, get_hf_client
 from .validate import is_local_file_ready
 from ..archive import archive_unpack
-from ..utils import tqdm, TemporaryDirectory
+from ..utils import tqdm, TemporaryDirectory, hf_normpath
 
 
 def download_file_to_file(local_file: str, repo_id: str, file_in_repo: str,
@@ -41,7 +41,7 @@ def download_file_to_file(local_file: str, repo_id: str, file_in_repo: str,
             hf_client.hf_hub_download(
                 repo_id=repo_id,
                 repo_type=repo_type,
-                filename=file_in_repo,
+                filename=hf_normpath(file_in_repo),
                 revision=revision,
                 local_dir=td,
                 force_download=True,
@@ -120,11 +120,12 @@ def download_directory_as_directory(local_directory: str, repo_id: str, dir_in_r
         current_resume_download = resume_download
         try:
             dst_file = os.path.join(local_directory, rel_file)
+            file_in_repo = hf_normpath(f'{dir_in_repo}/{rel_file}')
             if os.path.exists(dst_file) and is_local_file_ready(
                     repo_id=repo_id,
                     repo_type=repo_type,
                     local_file=dst_file,
-                    file_in_repo=f'{dir_in_repo}/{rel_file}',
+                    file_in_repo=file_in_repo,
                     revision=revision,
                     hf_token=hf_token,
             ):
@@ -136,7 +137,7 @@ def download_directory_as_directory(local_directory: str, repo_id: str, dir_in_r
                         download_file_to_file(
                             local_file=dst_file,
                             repo_id=repo_id,
-                            file_in_repo=f'{dir_in_repo}/{rel_file}',
+                            file_in_repo=file_in_repo,
                             repo_type=repo_type,
                             revision=revision,
                             resume_download=current_resume_download,

{hfutils-0.2.2 → hfutils-0.2.4}/hfutils/utils/__init__.py

@@ -1,5 +1,6 @@
 from .binary import is_binary_file
 from .download import download_file
+from .path import hf_normpath
 from .temp import TemporaryDirectory
 from .tqdm_ import tqdm
 from .walk import walk_files

hfutils-0.2.4/hfutils/utils/path.py

@@ -0,0 +1,5 @@
+import os
+
+
+def hf_normpath(path):
+    return os.path.normpath(path).replace('\\', '/')

{hfutils-0.2.2 → hfutils-0.2.4/hfutils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hfutils
-Version: 0.2.2
+Version: 0.2.4
 Summary: Useful utilities for huggingface
 Home-page: https://github.com/deepghs/hfutils
 Author: narugo1992

{hfutils-0.2.2 → hfutils-0.2.4}/hfutils.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ hfutils/entry/dispatch.py
 hfutils/entry/download.py
 hfutils/entry/ls.py
 hfutils/entry/upload.py
+hfutils/entry/whoami.py
 hfutils/index/__init__.py
 hfutils/index/fetch.py
 hfutils/index/hash.py
@@ -44,6 +45,7 @@ hfutils/operate/validate.py
 hfutils/utils/__init__.py
 hfutils/utils/binary.py
 hfutils/utils/download.py
+hfutils/utils/path.py
 hfutils/utils/temp.py
 hfutils/utils/tqdm_.py
 hfutils/utils/walk.py