chore: add type-hints to gitlab/v4/objects/merge_requests.py

JohnVillalovos · JohnVillalovos · commit 8a0f9de9d38a · 2021-11-06T12:16:10.000-07:00
* Add type-hints to gitlab/v4/objects/merge_requests.py
 * Add return value to cancel_merge_when_pipeline_succeeds() function
   as GitLab docs show it returns a value.
 * Add return value to approve() function as GitLab docs show it
   returns a value.
 * Add 'get()' method so that type-checkers will understand that
   getting a project merge request is of type ProjectMergeRequest.
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
@@ -3,6 +3,11 @@
 https://docs.gitlab.com/ee/api/merge_requests.html
 https://docs.gitlab.com/ee/api/merge_request_approvals.html
 """
+from typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union
+
+import requests
+
+import gitlab
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import types
@@ -159,7 +164,7 @@ class ProjectMergeRequest(
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabMROnBuildSuccessError)
-    def cancel_merge_when_pipeline_succeeds(self, **kwargs):
+    def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> ProjectMergeRequest:
         """Cancel merge when the pipeline succeeds.
 
         Args:
@@ -169,17 +174,23 @@ def cancel_merge_when_pipeline_succeeds(self, **kwargs):
             GitlabAuthenticationError: If authentication is not correct
             GitlabMROnBuildSuccessError: If the server could not handle the
                 request
+
+        Returns:
+            ProjectMergeRequest
         """
 
         path = (
             f"{self.manager.path}/{self.get_id()}/cancel_merge_when_pipeline_succeeds"
         )
         server_data = self.manager.gitlab.http_put(path, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
         self._update_attrs(server_data)
+        return ProjectMergeRequest(self.manager, server_data)
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabListError)
-    def closes_issues(self, **kwargs):
+    def closes_issues(self, **kwargs: Any) -> RESTObjectList:
         """List issues that will close on merge."
 
         Args:
@@ -199,12 +210,14 @@ def closes_issues(self, **kwargs):
         """
         path = f"{self.manager.path}/{self.get_id()}/closes_issues"
         data_list = self.manager.gitlab.http_list(path, as_list=False, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(data_list, gitlab.GitlabList)
         manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent)
         return RESTObjectList(manager, ProjectIssue, data_list)
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabListError)
-    def commits(self, **kwargs):
+    def commits(self, **kwargs: Any) -> RESTObjectList:
         """List the merge request commits.
 
         Args:
@@ -225,12 +238,14 @@ def commits(self, **kwargs):
 
         path = f"{self.manager.path}/{self.get_id()}/commits"
         data_list = self.manager.gitlab.http_list(path, as_list=False, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(data_list, gitlab.GitlabList)
         manager = ProjectCommitManager(self.manager.gitlab, parent=self.manager._parent)
         return RESTObjectList(manager, ProjectCommit, data_list)
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabListError)
-    def changes(self, **kwargs):
+    def changes(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """List the merge request changes.
 
         Args:
@@ -248,7 +263,7 @@ def changes(self, **kwargs):
 
     @cli.register_custom_action("ProjectMergeRequest", tuple(), ("sha",))
     @exc.on_http_error(exc.GitlabMRApprovalError)
-    def approve(self, sha=None, **kwargs):
+    def approve(self, sha: Optional[str] = None, **kwargs: Any) -> Dict[str, Any]:
         """Approve the merge request.
 
         Args:
@@ -259,6 +274,9 @@ def approve(self, sha=None, **kwargs):
             GitlabAuthenticationError: If authentication is not correct
             GitlabMRApprovalError: If the approval failed
 
+        Returns:
+           A dict containing the result.
+
         https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request
         """
         path = f"{self.manager.path}/{self.get_id()}/approve"
@@ -267,11 +285,14 @@ def approve(self, sha=None, **kwargs):
             data["sha"] = sha
 
         server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
         self._update_attrs(server_data)
+        return server_data
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabMRApprovalError)
-    def unapprove(self, **kwargs):
+    def unapprove(self, **kwargs: Any) -> None:
         """Unapprove the merge request.
 
         Args:
@@ -284,14 +305,16 @@ def unapprove(self, **kwargs):
         https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request
         """
         path = f"{self.manager.path}/{self.get_id()}/unapprove"
-        data = {}
+        data: Dict[str, Any] = {}
 
         server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
         self._update_attrs(server_data)
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabMRRebaseError)
-    def rebase(self, **kwargs):
+    def rebase(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Attempt to rebase the source branch onto the target branch
 
         Args:
@@ -302,12 +325,12 @@ def rebase(self, **kwargs):
             GitlabMRRebaseError: If rebasing failed
         """
         path = f"{self.manager.path}/{self.get_id()}/rebase"
-        data = {}
+        data: Dict[str, Any] = {}
         return self.manager.gitlab.http_put(path, post_data=data, **kwargs)
 
     @cli.register_custom_action("ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabGetError)
-    def merge_ref(self, **kwargs):
+    def merge_ref(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Attempt to merge changes between source and target branches into
             `refs/merge-requests/:iid/merge`.
 
@@ -332,15 +355,15 @@ def merge_ref(self, **kwargs):
     @exc.on_http_error(exc.GitlabMRClosedError)
     def merge(
         self,
-        merge_commit_message=None,
-        should_remove_source_branch=False,
-        merge_when_pipeline_succeeds=False,
-        **kwargs,
-    ):
+        merge_commit_message: Optional[str] = None,
+        should_remove_source_branch: bool = False,
+        merge_when_pipeline_succeeds: bool = False,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
         """Accept the merge request.
 
         Args:
-            merge_commit_message (bool): Commit message
+            merge_commit_message (str): Commit message
             should_remove_source_branch (bool): If True, removes the source
                                                 branch
             merge_when_pipeline_succeeds (bool): Wait for the build to succeed,
@@ -352,7 +375,7 @@ def merge(
             GitlabMRClosedError: If the merge failed
         """
         path = f"{self.manager.path}/{self.get_id()}/merge"
-        data = {}
+        data: Dict[str, Any] = {}
         if merge_commit_message:
             data["merge_commit_message"] = merge_commit_message
         if should_remove_source_branch is not None:
@@ -361,7 +384,10 @@ def merge(
             data["merge_when_pipeline_succeeds"] = True
 
         server_data = self.manager.gitlab.http_put(path, post_data=data, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
         self._update_attrs(server_data)
+        return server_data
 
 
 class ProjectMergeRequestManager(CRUDMixin, RESTManager):
@@ -428,6 +454,11 @@ class ProjectMergeRequestManager(CRUDMixin, RESTManager):
         "labels": types.ListAttribute,
     }
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectMergeRequest:
+        return cast(ProjectMergeRequest, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectDeploymentMergeRequest(MergeRequest):
     pass
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,6 +23,7 @@ ignore_errors = true
 
 [[tool.mypy.overrides]] # Overrides to negate above patterns
 module = [
+    "gitlab.v4.objects.merge_requests",
     "gitlab.v4.objects.projects",
     "gitlab.v4.objects.users"
 ]

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ ignore_errors = true`
`23`	`23`
`24`	`24`	`[[tool.mypy.overrides]] # Overrides to negate above patterns`
`25`	`25`	`module = [`
	`26`	`+ "gitlab.v4.objects.merge_requests",`
`26`	`27`	`"gitlab.v4.objects.projects",`
`27`	`28`	`"gitlab.v4.objects.users"`
`28`	`29`	`]`