Rename some methods to better match the API URLs

Gauvain Pocentek · Gauvain Pocentek · commit 45adb6e4dbe7 · 2016-05-12T21:04:21.000+02:00
Also deprecate the file_* methods in favor of the files manager.
diff --git a/gitlab/objects.py b/gitlab/objects.py
@@ -1448,6 +1448,11 @@ def Tag(self, id=None, **kwargs):
                                               **kwargs)
 
     def tree(self, path='', ref_name='', **kwargs):
+        warnings.warn("`tree` is deprecated, use `repository_tree` instead",
+                      DeprecationWarning)
+        return self.repository_tree(path, ref_name, **kwargs)
+
+    def repository_tree(self, path='', ref_name='', **kwargs):
         """Return a list of files in the repository.
 
         Args:
@@ -1474,6 +1479,11 @@ def tree(self, path='', ref_name='', **kwargs):
         return r.json()
 
     def blob(self, sha, filepath, **kwargs):
+        warnings.warn("`blob` is deprecated, use `repository_blob` instead",
+                      DeprecationWarning)
+        return self.repository_blob(sha, filepath, **kwargs)
+
+    def repository_blob(self, sha, filepath, **kwargs):
         """Return the content of a file for a commit.
 
         Args:
@@ -1493,7 +1503,7 @@ def blob(self, sha, filepath, **kwargs):
         raise_error_from_response(r, GitlabGetError)
         return r.content
 
-    def raw_blob(self, sha, **kwargs):
+    def repository_raw_blob(self, sha, **kwargs):
         """Returns the raw file contents for a blob by blob SHA.
 
         Args:
@@ -1511,7 +1521,7 @@ def raw_blob(self, sha, **kwargs):
         raise_error_from_response(r, GitlabGetError)
         return r.content
 
-    def compare(self, from_, to, **kwargs):
+    def repository_compare(self, from_, to, **kwargs):
         """Returns a diff between two branches/commits.
 
         Args:
@@ -1531,7 +1541,7 @@ def compare(self, from_, to, **kwargs):
         raise_error_from_response(r, GitlabGetError)
         return r.json()
 
-    def contributors(self):
+    def repository_contributors(self):
         """Returns a list of contributors for the project.
 
         Returns:
@@ -1580,20 +1590,29 @@ def create_file(self, path, branch, content, message, **kwargs):
             GitlabConnectionError: If the server cannot be reached.
             GitlabCreateError: If the server fails to perform the request.
         """
+        warnings.warn("`create_file` is deprecated, "
+                      "use `files.create()` instead",
+                      DeprecationWarning)
         url = "/projects/%s/repository/files" % self.id
         url += ("?file_path=%s&branch_name=%s&content=%s&commit_message=%s" %
                 (path, branch, content, message))
         r = self.gitlab._raw_post(url, data=None, content_type=None, **kwargs)
         raise_error_from_response(r, GitlabCreateError, 201)
 
     def update_file(self, path, branch, content, message, **kwargs):
+        warnings.warn("`update_file` is deprecated, "
+                      "use `files.update()` instead",
+                      DeprecationWarning)
         url = "/projects/%s/repository/files" % self.id
         url += ("?file_path=%s&branch_name=%s&content=%s&commit_message=%s" %
                 (path, branch, content, message))
         r = self.gitlab._raw_put(url, data=None, content_type=None, **kwargs)
         raise_error_from_response(r, GitlabUpdateError)
 
     def delete_file(self, path, branch, message, **kwargs):
+        warnings.warn("`delete_file` is deprecated, "
+                      "use `files.delete()` instead",
+                      DeprecationWarning)
         url = "/projects/%s/repository/files" % self.id
         url += ("?file_path=%s&branch_name=%s&commit_message=%s" %
                 (path, branch, message))
diff --git a/tools/python_test.py b/tools/python_test.py
@@ -1,4 +1,5 @@
 import base64
+import time
 
 import gitlab
 
@@ -135,6 +136,7 @@
                             'commit_message': 'Initial commit'})
 readme = admin_project.files.get(file_path='README', ref='master')
 readme.content = base64.b64encode("Improved README")
+time.sleep(2)
 readme.save(branch_name="master", commit_message="new commit")
 readme.delete(commit_message="Removing README")
 
@@ -145,10 +147,10 @@
 readme = admin_project.files.get(file_path='README.rst', ref='master')
 assert(readme.decode() == 'Initial content')
 
-tree = admin_project.tree()
+tree = admin_project.repository_tree()
 assert(len(tree) == 1)
 assert(tree[0]['name'] == 'README.rst')
-blob = admin_project.blob('master', 'README.rst')
+blob = admin_project.repository_blob('master', 'README.rst')
 assert(blob == 'Initial content')
 archive1 = admin_project.archive()
 archive2 = admin_project.archive('master')
