feat(project): add file blame api

minitux · minitux · commit f5b4a113a298 · 2019-10-04T22:26:24.000+02:00
https://docs.gitlab.com/ee/api/repository_files.html#get-file-blame-from-repository
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -362,6 +362,10 @@ Delete a file::
 
     f.delete(commit_message='Delete testfile')
 
+Get file blame::
+
+    b = project.files.blame(file_path='README.rst', ref='master')
+
 Project tags
 ============
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -3211,6 +3211,28 @@ def raw(
         )
         return utils.response_content(result, streamed, action, chunk_size)
 
+    @cli.register_custom_action("ProjectFileManager", ("file_path", "ref"))
+    @exc.on_http_error(exc.GitlabListError)
+    def blame(self, file_path, ref, **kwargs):
+        """Return the content of a file for a commit.
+
+        Args:
+            file_path (str): Path of the file to retrieve
+            ref (str): Name of the branch, tag or commit
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabListError:  If the server failed to perform the request
+
+        Returns:
+            list(blame): a list of commits/lines matching the file
+        """
+        file_path = file_path.replace("/", "%2F").replace(".", "%2E")
+        path = "%s/%s/blame" % (self.path, file_path)
+        query_data = {"ref": ref}
+        return self.gitlab.http_list(path, query_data, **kwargs)
+
 
 class ProjectPipelineJob(RESTObject):
     pass
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -423,6 +423,8 @@
 # object method
 assert readme.decode().decode() == "Initial content"
 
+blame = admin_project.files.blame(file_path="README.rst", ref="master")
+
 data = {
     "branch": "master",
     "commit_message": "blah blah blah",
