huggingface-hub 0.13.1__py3-none-any.whl → 0.13.3__py3-none-any.whl

huggingface_hub/__init__.py

@@ -46,7 +46,7 @@ import sys
 from typing import TYPE_CHECKING
 
 
-__version__ = "0.13.1"
+__version__ = "0.13.3"
 
 # Alphabetical order of definitions is ensured in tests
 # WARNING: any comment added in this dictionary definition will be lost when

huggingface_hub/file_download.py

@@ -103,7 +103,7 @@ def are_symlinks_supported(cache_dir: Union[str, Path, None] = None) -> bool:
             src_path.touch()
             dst_path = Path(tmpdir) / "dummy_file_dst"
 
-            # Relative source path as in `_create_relative_symlink``
+            # Relative source path as in `_create_symlink``
             relative_src = os.path.relpath(src_path, start=os.path.dirname(dst_path))
             try:
                 os.symlink(relative_src, dst_path)
@@ -558,7 +558,7 @@ def cached_download(
     token: Union[bool, str, None] = None,
     local_files_only: bool = False,
     legacy_cache_layout: bool = False,
-) -> Optional[str]:  # pragma: no cover
+) -> str:
     """
     Download from a given URL and cache it if it's not already present in the
     local cache.
@@ -820,60 +820,81 @@ def _normalize_etag(etag: Optional[str]) -> Optional[str]:
 
 
 def _create_relative_symlink(src: str, dst: str, new_blob: bool = False) -> None:
-    """Create a symbolic link named dst pointing to src as a relative path to dst.
+    """Alias method used in `transformers` conversion script."""
+    return _create_symlink(src=src, dst=dst, new_blob=new_blob)
+
+
+def _create_symlink(src: str, dst: str, new_blob: bool = False) -> None:
+    """Create a symbolic link named dst pointing to src.
+
+    By default, it will try to create a symlink using a relative path. Relative paths have 2 advantages:
+    - If the cache_folder is moved (example: back-up on a shared drive), relative paths within the cache folder will
+      not brake.
+    - Relative paths seems to be better handled on Windows. Issue was reported 3 times in less than a week when
+      changing from relative to absolute paths. See https://github.com/huggingface/huggingface_hub/issues/1398,
+      https://github.com/huggingface/diffusers/issues/2729 and https://github.com/huggingface/transformers/pull/22228.
+      NOTE: The issue with absolute paths doesn't happen on admin mode.
+    When creating a symlink from the cache to a local folder, it is possible that a relative path cannot be created.
+    This happens when paths are not on the same volume. In that case, we use absolute paths.
 
-    The relative part is mostly because it seems more elegant to the author.
 
     The result layout looks something like
         └── [ 128]  snapshots
             ├── [ 128]  2439f60ef33a0d46d85da5001d52aeda5b00ce9f
-            │   ├── [  52]  README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
-            │   └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
+            │   ├── [  52]  README.md -> ../../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
+            │   └── [  76]  pytorch_model.bin -> ../../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
 
-    If symlinks cannot be created on this platform (most likely to be Windows), the
-    workaround is to avoid symlinks by having the actual file in `dst`. If it is a new
-    file (`new_blob=True`), we move it to `dst`. If it is not a new file
-    (`new_blob=False`), we don't know if the blob file is already referenced elsewhere.
-    To avoid breaking existing cache, the file is duplicated on the disk.
+    If symlinks cannot be created on this platform (most likely to be Windows), the workaround is to avoid symlinks by
+    having the actual file in `dst`. If it is a new file (`new_blob=True`), we move it to `dst`. If it is not a new file
+    (`new_blob=False`), we don't know if the blob file is already referenced elsewhere. To avoid breaking existing
+    cache, the file is duplicated on the disk.
 
-    In case symlinks are not supported, a warning message is displayed to the user once
-    when loading `huggingface_hub`. The warning message can be disable with the
-    `DISABLE_SYMLINKS_WARNING` environment variable.
+    In case symlinks are not supported, a warning message is displayed to the user once when loading `huggingface_hub`.
+    The warning message can be disable with the `DISABLE_SYMLINKS_WARNING` environment variable.
     """
     try:
         os.remove(dst)
     except OSError:
         pass
 
+    abs_src = os.path.abspath(os.path.expanduser(src))
+    abs_dst = os.path.abspath(os.path.expanduser(dst))
+
+    # Use relative_dst in priority
     try:
-        _support_symlinks = are_symlinks_supported(
-            os.path.dirname(os.path.commonpath([os.path.realpath(src), os.path.realpath(dst)]))
-        )
+        relative_src = os.path.relpath(abs_src, os.path.dirname(abs_dst))
+    except ValueError:
+        # Raised on Windows if src and dst are not on the same volume. This is the case when creating a symlink to a
+        # local_dir instead of within the cache directory.
+        # See https://docs.python.org/3/library/os.path.html#os.path.relpath
+        relative_src = None
+
+    try:
+        _support_symlinks = are_symlinks_supported(os.path.dirname(os.path.commonpath([abs_src, abs_dst])))
     except PermissionError:
         # Permission error means src and dst are not in the same volume (e.g. destination path has been provided
         # by the user via `local_dir`. Let's test symlink support there)
-        _support_symlinks = are_symlinks_supported(os.path.dirname(dst))
+        _support_symlinks = are_symlinks_supported(os.path.dirname(abs_dst))
 
     if _support_symlinks:
-        logger.info(f"Creating pointer from {src} to {dst}")
+        src_rel_or_abs = relative_src or abs_src
+        logger.info(f"Creating pointer from {src_rel_or_abs} to {abs_dst}")
         try:
-            os.symlink(src, dst)
+            os.symlink(src_rel_or_abs, abs_dst)
         except FileExistsError:
-            if os.path.islink(dst) and os.path.realpath(dst) == os.path.realpath(src):
-                # `dst` already exists and is a symlink to the `src` blob. It is most
-                # likely that the file has been cached twice concurrently (exactly
-                # between `os.remove` and `os.symlink`). Do nothing.
+            if os.path.islink(abs_dst) and os.path.realpath(abs_dst) == os.path.realpath(abs_src):
+                # `abs_dst` already exists and is a symlink to the `abs_src` blob. It is most likely that the file has
+                # been cached twice concurrently (exactly between `os.remove` and `os.symlink`). Do nothing.
                 pass
             else:
-                # Very unlikely to happen. Means a file `dst` has been created exactly
-                # between `os.remove` and `os.symlink` and is not a symlink to the `src`
-                # blob file. Raise exception.
+                # Very unlikely to happen. Means a file `dst` has been created exactly between `os.remove` and
+                # `os.symlink` and is not a symlink to the `abs_src` blob file. Raise exception.
                 raise
     elif new_blob:
-        logger.info(f"Symlink not supported. Moving file from {src} to {dst}")
+        logger.info(f"Symlink not supported. Moving file from {abs_src} to {abs_dst}")
         os.replace(src, dst)
     else:
-        logger.info(f"Symlink not supported. Copying file from {src} to {dst}")
+        logger.info(f"Symlink not supported. Copying file from {abs_src} to {abs_dst}")
         shutil.copyfile(src, dst)
 
 
@@ -926,7 +947,7 @@ def hf_hub_download(
     token: Union[bool, str, None] = None,
     local_files_only: bool = False,
     legacy_cache_layout: bool = False,
-):
+) -> str:
     """Download a given file if it's not already present in the local cache.
 
     The new cache file layout looks like this:
@@ -1258,7 +1279,7 @@ def hf_hub_download(
         if local_dir is not None:  # to local dir
             return _to_local_dir(blob_path, local_dir, relative_filename, use_symlinks=local_dir_use_symlinks)
         else:  # or in snapshot cache
-            _create_relative_symlink(blob_path, pointer_path, new_blob=False)
+            _create_symlink(blob_path, pointer_path, new_blob=False)
             return pointer_path
 
     # Prevent parallel downloads of the same file with a lock.
@@ -1313,7 +1334,7 @@ def hf_hub_download(
         if local_dir is None:
             logger.info(f"Storing {url} in cache at {blob_path}")
             _chmod_and_replace(temp_file.name, blob_path)
-            _create_relative_symlink(blob_path, pointer_path, new_blob=True)
+            _create_symlink(blob_path, pointer_path, new_blob=True)
         else:
             local_dir_filepath = os.path.join(local_dir, relative_filename)
             os.makedirs(os.path.dirname(local_dir_filepath), exist_ok=True)
@@ -1325,7 +1346,7 @@ def hf_hub_download(
                 logger.info(f"Storing {url} in cache at {blob_path}")
                 _chmod_and_replace(temp_file.name, blob_path)
                 logger.info("Create symlink to local dir")
-                _create_relative_symlink(blob_path, local_dir_filepath, new_blob=False)
+                _create_symlink(blob_path, local_dir_filepath, new_blob=False)
             elif local_dir_use_symlinks == "auto" and not is_big_file:
                 logger.info(f"Storing {url} in cache at {blob_path}")
                 _chmod_and_replace(temp_file.name, blob_path)
@@ -1544,7 +1565,7 @@ def _to_local_dir(
         use_symlinks = os.stat(real_blob_path).st_size > constants.HF_HUB_LOCAL_DIR_AUTO_SYMLINK_THRESHOLD
 
     if use_symlinks:
-        _create_relative_symlink(real_blob_path, local_dir_filepath, new_blob=False)
+        _create_symlink(real_blob_path, local_dir_filepath, new_blob=False)
     else:
         shutil.copyfile(real_blob_path, local_dir_filepath)
     return local_dir_filepath

huggingface_hub/repocard.py

@@ -170,17 +170,19 @@ class RepoCard:
         if Path(repo_id_or_path).exists():
             card_path = Path(repo_id_or_path)
         elif isinstance(repo_id_or_path, str):
-            card_path = hf_hub_download(
-                repo_id_or_path,
-                REPOCARD_NAME,
-                repo_type=repo_type or cls.repo_type,
-                token=token,
+            card_path = Path(
+                hf_hub_download(
+                    repo_id_or_path,
+                    REPOCARD_NAME,
+                    repo_type=repo_type or cls.repo_type,
+                    token=token,
+                )
             )
         else:
             raise ValueError(f"Cannot load RepoCard: path not found on disk ({repo_id_or_path}).")
 
         # Preserve newlines in the existing file.
-        with Path(card_path).open(mode="r", newline="", encoding="utf-8") as f:
+        with card_path.open(mode="r", newline="", encoding="utf-8") as f:
             return cls(f.read(), ignore_metadata_errors=ignore_metadata_errors)
 
     def validate(self, repo_type: Optional[str] = None):

{huggingface_hub-0.13.1.dist-info → huggingface_hub-0.13.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: huggingface-hub
-Version: 0.13.1
+Version: 0.13.3
 Summary: Client library to download and publish models, datasets and other repos on the huggingface.co hub
 Home-page: https://github.com/huggingface/huggingface_hub
 Author: Hugging Face, Inc.

{huggingface_hub-0.13.1.dist-info → huggingface_hub-0.13.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-huggingface_hub/__init__.py,sha256=7TrPGrf7OzODiuZCRu27LegHdX5Og7R0_zobCzSideU,14645
+huggingface_hub/__init__.py,sha256=8PDH0M8_c2CwqboAvkN8wrnOiMWUNZxfEqclxK4aLfQ,14645
 huggingface_hub/_commit_api.py,sha256=QP3YtZdMOFKW0EchiS9JGPo5EVlkUz6cGktCagvoOx0,22558
 huggingface_hub/_login.py,sha256=iKK6-4tDBcdCoJar_TXILUdJ76G00QYbgFVM5Dtput8,11531
 huggingface_hub/_snapshot_download.py,sha256=eY0OWOpunWJY32d1d30ggV3rr3ND_LpEnYmu87nzZcY,11339
@@ -6,13 +6,13 @@ huggingface_hub/_space_api.py,sha256=URSt8IDDnzZ4wiGiuoZgwNP3ZMgNmXZQGFcOQhfkQEU
 huggingface_hub/community.py,sha256=WwVSOtephAX0OqALlOW_1EPu09r-Y5WpIF7jPkn0ze8,11062
 huggingface_hub/constants.py,sha256=EIhFt9LSDZKnstgJ3Zwqu2coHBHg8ms7dXNPE6QkFU8,4714
 huggingface_hub/fastai_utils.py,sha256=5I7zAfgHJU_mZnxnf9wgWTHrCRu_EAV8VTangDVfE_o,16676
-huggingface_hub/file_download.py,sha256=F-e5x4prIK5qMm-gjIG_KO9grCDvbb9byURRio4Y2aU,63666
+huggingface_hub/file_download.py,sha256=2KBueqiPJ2MGuuvCIkH2yOEhfAwODnpWERrKpRhIgic,65133
 huggingface_hub/hf_api.py,sha256=Zh_iIV_Qhk79nbKaXigtcanCeGVfIpqdkqU9yYhaH3M,173043
 huggingface_hub/hub_mixin.py,sha256=94BN_vzHDBX2tDgVV8la4CfkUzN2OgLsV9p9sz4OP7c,16783
 huggingface_hub/inference_api.py,sha256=3NkHAAGS9wK8PbXxly8YI-0V6gfZgZvV3N5bTdRfvDM,7882
 huggingface_hub/keras_mixin.py,sha256=cvLoaf2GNpeYOyDEQrZnSkYxeYPoDjgrxCr8BRWHPcA,18797
 huggingface_hub/lfs.py,sha256=Ij-QF8sWjVtL2XwWw4SaLIlsEP8sL2hdr7efFoonrEU,16007
-huggingface_hub/repocard.py,sha256=mhceadB9iG9GXBNyTEYI0eKeAKbJEtDu5062lN-RV7M,34169
+huggingface_hub/repocard.py,sha256=TV0V6UxCCRlJ0Yvr9p2KA8dGUFlTgzSObczNqkNIItw,34219
 huggingface_hub/repocard_data.py,sha256=xpLC_PNIEIArNu4EVMBOXtC8VPnpXRQLHyXAlvUMVss,29768
 huggingface_hub/repository.py,sha256=arXVSuom8jTJxbia_fm2HAvWeEVnowK5cHajcO6n_vQ,53727
 huggingface_hub/commands/__init__.py,sha256=AkbM2a-iGh0Vq_xAWhK3mu3uZ44km8-X5uWjKcvcrUQ,928
@@ -48,9 +48,9 @@ huggingface_hub/utils/endpoint_helpers.py,sha256=wXE3U1resSFvfdZbNevzrFyf39o9LfE
 huggingface_hub/utils/logging.py,sha256=-Uov2WGLv16hS-V4Trvs_XO-TvSeZ1xIWZ-cfvDl7ac,4778
 huggingface_hub/utils/sha.py,sha256=Wmeh2lwS2H0_CNLqDk_mNyb4jAjfTdlG6FZsuh6LqVg,890
 huggingface_hub/utils/tqdm.py,sha256=iTe9IhbPWIezSn6GBAuPlZe_q-5T47ARwUJAQZ6xepc,5741
-huggingface_hub-0.13.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-huggingface_hub-0.13.1.dist-info/METADATA,sha256=IYjewWZDzBjQ1yh-rIKTJN0RXAwz514YuQLk5lH-9Bg,7476
-huggingface_hub-0.13.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-huggingface_hub-0.13.1.dist-info/entry_points.txt,sha256=7-_O79Kk26OM9R3QgywVzfyrNjZ3F8tCUhDtozJ7yIc,83
-huggingface_hub-0.13.1.dist-info/top_level.txt,sha256=8KzlQJAY4miUvjAssOAJodqKOw3harNzuiwGQ9qLSSk,16
-huggingface_hub-0.13.1.dist-info/RECORD,,
+huggingface_hub-0.13.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+huggingface_hub-0.13.3.dist-info/METADATA,sha256=nt-YabDZxogsoN7HxTX4nyVt0TXB6cPAYTVZb7eZJKI,7476
+huggingface_hub-0.13.3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+huggingface_hub-0.13.3.dist-info/entry_points.txt,sha256=7-_O79Kk26OM9R3QgywVzfyrNjZ3F8tCUhDtozJ7yIc,83
+huggingface_hub-0.13.3.dist-info/top_level.txt,sha256=8KzlQJAY4miUvjAssOAJodqKOw3harNzuiwGQ9qLSSk,16
+huggingface_hub-0.13.3.dist-info/RECORD,,

{huggingface_hub-0.13.1.dist-info → huggingface_hub-0.13.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: bdist_wheel (0.40.0)
 Root-Is-Purelib: true
 Tag: py3-none-any