ENH Deprecate clone_from behavior

src/huggingface_hub/repository.py

@@ -5,6 +5,7 @@
 import tempfile
 import threading
 import time
+import warnings
 from contextlib import contextmanager
 from pathlib import Path
 from typing import Callable, Dict, Iterator, List, Optional, Tuple, Union
@@ -667,6 +668,12 @@ def clone_from(self, repo_url: str, use_auth_token: Union[bool, str, None] = Non
                                 " on Hugging Face Hub."
                             )
                         else:
+                            warnings.warn(
+                                "Creating a repository through 'clone_from' is"
+                                " deprecated and will be removed in v0.11.",
+                                FutureWarning,
+                            )
+
                             self.client.create_repo(
                                 repo_id=repo_id,
                                 token=token,

tests/test_repocard.py

@@ -35,7 +35,12 @@
 from huggingface_hub.utils import logging
 
 from .testing_constants import ENDPOINT_STAGING, TOKEN, USER
-from .testing_utils import repo_name, retry_endpoint, set_write_permission_and_retry
+from .testing_utils import (
+    expect_deprecation,
+    repo_name,
+    retry_endpoint,
+    set_write_permission_and_retry,
+)
 
 
 ROUND_TRIP_MODELCARD_CASE = """
@@ -198,6 +203,7 @@ def setUpClass(cls):
         cls._api.set_access_token(TOKEN)
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def setUp(self) -> None:
         self.repo_path = Path(tempfile.mkdtemp())
         self.REPO_NAME = repo_name()

tests/test_repository.py

@@ -36,6 +36,7 @@
 
 from .testing_constants import ENDPOINT_STAGING, TOKEN, USER
 from .testing_utils import (
+    expect_deprecation,
     repo_name,
     retry_endpoint,
     set_write_permission_and_retry,
@@ -137,6 +138,14 @@ def test_clone_from_space(self):
                 use_auth_token=self._token,
             )
 
+    @expect_deprecation("clone_from")
+    def test_clone_from_deprecation_warning(self):
+        Repository(
+            WORKING_REPO_DIR,
+            clone_from=f"{USER}/{uuid.uuid4()}",
+            use_auth_token=self._token,
+        )
+
     def test_clone_from_model(self):
         temp_repo_url = self._api.create_repo(
             repo_id=f"{self.REPO_NAME}-temp", token=self._token, repo_type="model"
@@ -403,6 +412,7 @@ def test_add_commit_push_non_blocking_process_killed(self):
         self.assertEqual(result.status, -9)
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def test_clone_with_endpoint(self):
         clone = Repository(
             f"{WORKING_REPO_DIR}/{self.REPO_NAME}",
@@ -433,6 +443,7 @@ def test_clone_with_endpoint(self):
         self.assertTrue("model.bin" in files)
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def test_clone_with_repo_name_and_org(self):
         clone = Repository(
             f"{WORKING_REPO_DIR}/{self.REPO_NAME}",
@@ -525,8 +536,8 @@ def test_clone_with_repo_name_user_and_no_auth_token(self):
         )
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def test_clone_with_repo_name_org_and_no_auth_token(self):
-        # Create repo
         Repository(
             f"{WORKING_REPO_DIR}/{self.REPO_NAME}",
             use_auth_token=self._token,
@@ -1694,6 +1705,7 @@ def test_clone_with_endpoint(self):
         self.assertTrue("test.py" in files)
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def test_clone_with_repo_name_and_org(self):
         clone = Repository(
             f"{WORKING_DATASET_DIR}/{self.REPO_NAME}",
@@ -1788,8 +1800,8 @@ def test_clone_with_repo_name_user_and_no_auth_token(self):
         )
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def test_clone_with_repo_name_org_and_no_auth_token(self):
-        # Create repo
         Repository(
             f"{WORKING_DATASET_DIR}/{self.REPO_NAME}",
             clone_from=f"valid_org/{self.REPO_NAME}",

tests/test_snapshot_download.py

@@ -36,6 +36,7 @@ def setUpClass(cls):
         cls._api.set_access_token(TOKEN)
 
     @retry_endpoint
+    @expect_deprecation("clone_from")
     def setUp(self) -> None:
         if os.path.exists(REPO_NAME):
             shutil.rmtree(REPO_NAME, onerror=set_write_permission_and_retry)