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

JohnVillalovos · JohnVillalovos · commit 370ae43f3bf8 · 2021-11-21T14:27:37.000-08:00
diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.py
@@ -3,23 +3,38 @@
 
 Currently this module only contains repository-related methods for projects.
 """
+from typing import Any, Callable, Dict, List, Optional, TYPE_CHECKING, Union
 
+import requests
+
+import gitlab
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import utils
 
+if TYPE_CHECKING:
+    # When running mypy we use these as the base classes
+    _RestManagerBase = gitlab.base.RESTManager
+    _RestObjectBase = gitlab.base.RESTObject
+else:
+    _RestManagerBase = object
+    _RestObjectBase = object
+
 
-class RepositoryMixin:
+class RepositoryMixin(_RestObjectBase):
     @cli.register_custom_action("Project", ("submodule", "branch", "commit_sha"))
     @exc.on_http_error(exc.GitlabUpdateError)
-    def update_submodule(self, submodule, branch, commit_sha, **kwargs):
+    def update_submodule(
+        self, submodule: str, branch: str, commit_sha: str, **kwargs: Any
+    ) -> Union[Dict[str, Any], requests.Response]:
         """Update a project submodule
 
         Args:
             submodule (str): Full path to the submodule
             branch (str): Name of the branch to commit into
             commit_sha (str): Full commit SHA to update the submodule to
-            commit_message (str): Commit message. If no message is provided, a default one will be set (optional)
+            commit_message (str): Commit message. If no message is provided, a
+                default one will be set (optional)
 
         Raises:
             GitlabAuthenticationError: If authentication is not correct
@@ -35,7 +50,9 @@ def update_submodule(self, submodule, branch, commit_sha, **kwargs):
 
     @cli.register_custom_action("Project", tuple(), ("path", "ref", "recursive"))
     @exc.on_http_error(exc.GitlabGetError)
-    def repository_tree(self, path="", ref="", recursive=False, **kwargs):
+    def repository_tree(
+        self, path: str = "", ref: str = "", recursive: bool = False, **kwargs: Any
+    ) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]:
         """Return a list of files in the repository.
 
         Args:
@@ -57,7 +74,7 @@ def repository_tree(self, path="", ref="", recursive=False, **kwargs):
             list: The representation of the tree
         """
         gl_path = f"/projects/{self.get_id()}/repository/tree"
-        query_data = {"recursive": recursive}
+        query_data: Dict[str, Any] = {"recursive": recursive}
         if path:
             query_data["path"] = path
         if ref:
@@ -66,7 +83,9 @@ def repository_tree(self, path="", ref="", recursive=False, **kwargs):
 
     @cli.register_custom_action("Project", ("sha",))
     @exc.on_http_error(exc.GitlabGetError)
-    def repository_blob(self, sha, **kwargs):
+    def repository_blob(
+        self, sha: str, **kwargs: Any
+    ) -> Union[Dict[str, Any], requests.Response]:
         """Return a file by blob SHA.
 
         Args:
@@ -87,8 +106,13 @@ def repository_blob(self, sha, **kwargs):
     @cli.register_custom_action("Project", ("sha",))
     @exc.on_http_error(exc.GitlabGetError)
     def repository_raw_blob(
-        self, sha, streamed=False, action=None, chunk_size=1024, **kwargs
-    ):
+        self,
+        sha: str,
+        streamed: bool = False,
+        action: Optional[Callable[..., Any]] = None,
+        chunk_size: int = 1024,
+        **kwargs: Any,
+    ) -> Optional[bytes]:
         """Return the raw file contents for a blob.
 
         Args:
@@ -112,11 +136,15 @@ def repository_raw_blob(
         result = self.manager.gitlab.http_get(
             path, streamed=streamed, raw=True, **kwargs
         )
+        if TYPE_CHECKING:
+            assert isinstance(result, requests.Response)
         return utils.response_content(result, streamed, action, chunk_size)
 
     @cli.register_custom_action("Project", ("from_", "to"))
     @exc.on_http_error(exc.GitlabGetError)
-    def repository_compare(self, from_, to, **kwargs):
+    def repository_compare(
+        self, from_: str, to: str, **kwargs: Any
+    ) -> Union[Dict[str, Any], requests.Response]:
         """Return a diff between two branches/commits.
 
         Args:
@@ -137,7 +165,9 @@ def repository_compare(self, from_, to, **kwargs):
 
     @cli.register_custom_action("Project")
     @exc.on_http_error(exc.GitlabGetError)
-    def repository_contributors(self, **kwargs):
+    def repository_contributors(
+        self, **kwargs: Any
+    ) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]:
         """Return a list of contributors for the project.
 
         Args:
@@ -161,8 +191,13 @@ def repository_contributors(self, **kwargs):
     @cli.register_custom_action("Project", tuple(), ("sha",))
     @exc.on_http_error(exc.GitlabListError)
     def repository_archive(
-        self, sha=None, streamed=False, action=None, chunk_size=1024, **kwargs
-    ):
+        self,
+        sha: str = None,
+        streamed: bool = False,
+        action: Optional[Callable[..., Any]] = None,
+        chunk_size: int = 1024,
+        **kwargs: Any,
+    ) -> Optional[bytes]:
         """Return a tarball of the repository.
 
         Args:
@@ -189,11 +224,13 @@ def repository_archive(
         result = self.manager.gitlab.http_get(
             path, query_data=query_data, raw=True, streamed=streamed, **kwargs
         )
+        if TYPE_CHECKING:
+            assert isinstance(result, requests.Response)
         return utils.response_content(result, streamed, action, chunk_size)
 
     @cli.register_custom_action("Project")
     @exc.on_http_error(exc.GitlabDeleteError)
-    def delete_merged_branches(self, **kwargs):
+    def delete_merged_branches(self, **kwargs: Any) -> None:
         """Delete merged branches.
 
         Args:
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,6 @@ files = "."
 module = [
     "docs.*",
     "docs.ext.*",
-    "gitlab.v4.objects.repositories",
     "gitlab.v4.objects.services",
     "gitlab.v4.objects.sidekiq",
     "tests.functional.*",
