From f5b4a113a298d33cb72f80c94d85bdfec3c4e149 Mon Sep 17 00:00:00 2001 From: Vincent Lae Date: Fri, 4 Oct 2019 22:11:49 +0200 Subject: feat(project): add file blame api https://docs.gitlab.com/ee/api/repository_files.html#get-file-blame-from-repository --- gitlab/v4/objects.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'gitlab/v4/objects.py') diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index 9f1918b..15aecf5 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -3211,6 +3211,28 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa ) 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 -- cgit v1.2.1