Merge pull request #1515 from JohnVillalovos/jlvillal/mypy_v4_obj_users

nejch · web-flow · commit 7753fa2dd009 · 2021-10-06T21:19:49.000+02:00
chore: add type-hints to gitlab/v4/objects/users.py
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
@@ -1,7 +1,11 @@
+from typing import Any, cast, Dict, List, Union
+
+import requests
+
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import types
-from gitlab.base import RequiredOptional, RESTManager, RESTObject
+from gitlab.base import RequiredOptional, RESTManager, RESTObject, RESTObjectList
 from gitlab.mixins import (
     CreateMixin,
     CRUDMixin,
@@ -129,7 +133,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabBlockError)
-    def block(self, **kwargs):
+    def block(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Block the user.
 
         Args:
@@ -150,7 +154,7 @@ def block(self, **kwargs):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabFollowError)
-    def follow(self, **kwargs):
+    def follow(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Follow the user.
 
         Args:
@@ -168,7 +172,7 @@ def follow(self, **kwargs):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabUnfollowError)
-    def unfollow(self, **kwargs):
+    def unfollow(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Unfollow the user.
 
         Args:
@@ -186,7 +190,7 @@ def unfollow(self, **kwargs):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabUnblockError)
-    def unblock(self, **kwargs):
+    def unblock(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Unblock the user.
 
         Args:
@@ -207,7 +211,7 @@ def unblock(self, **kwargs):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabDeactivateError)
-    def deactivate(self, **kwargs):
+    def deactivate(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Deactivate the user.
 
         Args:
@@ -228,7 +232,7 @@ def deactivate(self, **kwargs):
 
     @cli.register_custom_action("User")
     @exc.on_http_error(exc.GitlabActivateError)
-    def activate(self, **kwargs):
+    def activate(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Activate the user.
 
         Args:
@@ -319,6 +323,9 @@ class UserManager(CRUDMixin, RESTManager):
     )
     _types = {"confirm": types.LowercaseStringAttribute, "avatar": types.ImageAttribute}
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> User:
+        return cast(User, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectUser(RESTObject):
     pass
@@ -470,7 +477,7 @@ class UserProjectManager(ListMixin, CreateMixin, RESTManager):
         "id_before",
     )
 
-    def list(self, **kwargs):
+    def list(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
         """Retrieve a list of objects.
 
         Args:
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,7 +23,8 @@ ignore_errors = true
 
 [[tool.mypy.overrides]] # Overrides to negate above patterns
 module = [
-    "gitlab.v4.objects.projects"
+    "gitlab.v4.objects.projects",
+    "gitlab.v4.objects.users"
 ]
 ignore_errors = false
 

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