Ensure get() methods have correct type-hints

JohnVillalovos · JohnVillalovos · commit 3df0d8abca36 · 2021-11-08T17:30:46.000-08:00
Fix classes which don't have correct 'get()' methods.
diff --git a/gitlab/v4/objects/award_emojis.py b/gitlab/v4/objects/award_emojis.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 
@@ -27,6 +29,11 @@ class ProjectIssueAwardEmojiManager(NoUpdateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"}
     _create_attrs = RequiredOptional(required=("name",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectIssueAwardEmoji:
+        return cast(ProjectIssueAwardEmoji, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectIssueNoteAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
@@ -44,6 +51,11 @@ class ProjectIssueNoteAwardEmojiManager(NoUpdateMixin, RESTManager):
     }
     _create_attrs = RequiredOptional(required=("name",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectIssueNoteAwardEmoji:
+        return cast(ProjectIssueNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectMergeRequestAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
@@ -55,6 +67,13 @@ class ProjectMergeRequestAwardEmojiManager(NoUpdateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"}
     _create_attrs = RequiredOptional(required=("name",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectMergeRequestAwardEmoji:
+        return cast(
+            ProjectMergeRequestAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)
+        )
+
 
 class ProjectMergeRequestNoteAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
@@ -73,6 +92,13 @@ class ProjectMergeRequestNoteAwardEmojiManager(NoUpdateMixin, RESTManager):
     }
     _create_attrs = RequiredOptional(required=("name",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectMergeRequestNoteAwardEmoji:
+        return cast(
+            ProjectMergeRequestNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)
+        )
+
 
 class ProjectSnippetAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
@@ -84,6 +110,11 @@ class ProjectSnippetAwardEmojiManager(NoUpdateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "project_id", "snippet_id": "id"}
     _create_attrs = RequiredOptional(required=("name",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectSnippetAwardEmoji:
+        return cast(ProjectSnippetAwardEmoji, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectSnippetNoteAwardEmoji(ObjectDeleteMixin, RESTObject):
     pass
@@ -101,3 +132,10 @@ class ProjectSnippetNoteAwardEmojiManager(NoUpdateMixin, RESTManager):
         "note_id": "id",
     }
     _create_attrs = RequiredOptional(required=("name",))
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectSnippetNoteAwardEmoji:
+        return cast(
+            ProjectSnippetNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)
+        )
diff --git a/gitlab/v4/objects/custom_attributes.py b/gitlab/v4/objects/custom_attributes.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import DeleteMixin, ObjectDeleteMixin, RetrieveMixin, SetMixin
 
@@ -39,3 +41,8 @@ class UserCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTManag
     _path = "/users/%(user_id)s/custom_attributes"
     _obj_cls = UserCustomAttribute
     _from_parent_attrs = {"user_id": "id"}
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> UserCustomAttribute:
+        return cast(UserCustomAttribute, super().get(id=id, lazy=lazy, **kwargs))
diff --git a/gitlab/v4/objects/discussions.py b/gitlab/v4/objects/discussions.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import CreateMixin, RetrieveMixin, SaveMixin, UpdateMixin
 
@@ -30,6 +32,11 @@ class ProjectCommitDiscussionManager(RetrieveMixin, CreateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "project_id", "commit_id": "id"}
     _create_attrs = RequiredOptional(required=("body",), optional=("created_at",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectCommitDiscussion:
+        return cast(ProjectCommitDiscussion, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectIssueDiscussion(RESTObject):
     notes: ProjectIssueDiscussionNoteManager
@@ -41,6 +48,11 @@ class ProjectIssueDiscussionManager(RetrieveMixin, CreateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"}
     _create_attrs = RequiredOptional(required=("body",), optional=("created_at",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectIssueDiscussion:
+        return cast(ProjectIssueDiscussion, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectMergeRequestDiscussion(SaveMixin, RESTObject):
     notes: ProjectMergeRequestDiscussionNoteManager
@@ -57,6 +69,13 @@ class ProjectMergeRequestDiscussionManager(
     )
     _update_attrs = RequiredOptional(required=("resolved",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectMergeRequestDiscussion:
+        return cast(
+            ProjectMergeRequestDiscussion, super().get(id=id, lazy=lazy, **kwargs)
+        )
+
 
 class ProjectSnippetDiscussion(RESTObject):
     notes: ProjectSnippetDiscussionNoteManager
@@ -67,3 +86,8 @@ class ProjectSnippetDiscussionManager(RetrieveMixin, CreateMixin, RESTManager):
     _obj_cls = ProjectSnippetDiscussion
     _from_parent_attrs = {"project_id": "project_id", "snippet_id": "id"}
     _create_attrs = RequiredOptional(required=("body",), optional=("created_at",))
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectSnippetDiscussion:
+        return cast(ProjectSnippetDiscussion, super().get(id=id, lazy=lazy, **kwargs))
diff --git a/gitlab/v4/objects/notes.py b/gitlab/v4/objects/notes.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import (
     CreateMixin,
@@ -147,6 +149,11 @@ class ProjectSnippetNoteManager(CRUDMixin, RESTManager):
     _create_attrs = RequiredOptional(required=("body",))
     _update_attrs = RequiredOptional(required=("body",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectSnippetNote:
+        return cast(ProjectSnippetNote, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectSnippetDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
diff --git a/gitlab/v4/objects/tags.py b/gitlab/v4/objects/tags.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 
@@ -22,6 +24,9 @@ class ProjectTagManager(NoUpdateMixin, RESTManager):
         required=("tag_name", "ref"), optional=("message",)
     )
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectTag:
+        return cast(ProjectTag, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectProtectedTag(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
@@ -35,3 +40,8 @@ class ProjectProtectedTagManager(NoUpdateMixin, RESTManager):
     _create_attrs = RequiredOptional(
         required=("name",), optional=("create_access_level",)
     )
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectProtectedTag:
+        return cast(ProjectProtectedTag, super().get(id=id, lazy=lazy, **kwargs))
diff --git a/gitlab/v4/objects/templates.py b/gitlab/v4/objects/templates.py
@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import RetrieveMixin
 
@@ -21,6 +23,9 @@ class DockerfileManager(RetrieveMixin, RESTManager):
     _path = "/templates/dockerfiles"
     _obj_cls = Dockerfile
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Dockerfile:
+        return cast(Dockerfile, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class Gitignore(RESTObject):
     _id_attr = "name"
@@ -30,6 +35,9 @@ class GitignoreManager(RetrieveMixin, RESTManager):
     _path = "/templates/gitignores"
     _obj_cls = Gitignore
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Gitignore:
+        return cast(Gitignore, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class Gitlabciyml(RESTObject):
     _id_attr = "name"
@@ -39,6 +47,11 @@ class GitlabciymlManager(RetrieveMixin, RESTManager):
     _path = "/templates/gitlab_ci_ymls"
     _obj_cls = Gitlabciyml
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> Gitlabciyml:
+        return cast(Gitlabciyml, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class License(RESTObject):
     _id_attr = "key"
@@ -49,3 +62,6 @@ class LicenseManager(RetrieveMixin, RESTManager):
     _obj_cls = License
     _list_filters = ("popular",)
     _optional_get_attrs = ("project", "fullname")
+
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> License:
+        return cast(License, super().get(id=id, lazy=lazy, **kwargs))
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
@@ -74,6 +74,11 @@ class CurrentUserEmailManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManag
     _obj_cls = CurrentUserEmail
     _create_attrs = RequiredOptional(required=("email",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> CurrentUserEmail:
+        return cast(CurrentUserEmail, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class CurrentUserGPGKey(ObjectDeleteMixin, RESTObject):
     pass
@@ -84,6 +89,11 @@ class CurrentUserGPGKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTMana
     _obj_cls = CurrentUserGPGKey
     _create_attrs = RequiredOptional(required=("key",))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> CurrentUserGPGKey:
+        return cast(CurrentUserGPGKey, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class CurrentUserKey(ObjectDeleteMixin, RESTObject):
     _short_print_attr = "title"
@@ -94,6 +104,11 @@ class CurrentUserKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager
     _obj_cls = CurrentUserKey
     _create_attrs = RequiredOptional(required=("title", "key"))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> CurrentUserKey:
+        return cast(CurrentUserKey, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class CurrentUserStatus(SaveMixin, RESTObject):
     _id_attr = None
@@ -357,6 +372,9 @@ class UserEmailManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager):
     _from_parent_attrs = {"user_id": "id"}
     _create_attrs = RequiredOptional(required=("email",))
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> UserEmail:
+        return cast(UserEmail, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class UserActivities(RESTObject):
     _id_attr = "username"
@@ -388,6 +406,9 @@ class UserGPGKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager):
     _from_parent_attrs = {"user_id": "id"}
     _create_attrs = RequiredOptional(required=("key",))
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> UserGPGKey:
+        return cast(UserGPGKey, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class UserKey(ObjectDeleteMixin, RESTObject):
     pass
@@ -424,6 +445,11 @@ class UserImpersonationTokenManager(NoUpdateMixin, RESTManager):
     )
     _list_filters = ("state",)
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> UserImpersonationToken:
+        return cast(UserImpersonationToken, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class UserMembership(RESTObject):
     _id_attr = "source_id"
@@ -435,6 +461,11 @@ class UserMembershipManager(RetrieveMixin, RESTManager):
     _from_parent_attrs = {"user_id": "id"}
     _list_filters = ("type",)
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> UserMembership:
+        return cast(UserMembership, super().get(id=id, lazy=lazy, **kwargs))
+
 
 # Having this outside projects avoids circular imports due to ProjectUser
 class UserProject(RESTObject):
diff --git a/tests/unit/objects/test_ensure_type_hints.py b/tests/unit/objects/test_ensure_type_hints.py
@@ -0,0 +1,78 @@
+"""
+Ensure type-hints are setup correctly and detect if missing functions.
+
+Original notes by John L. Villalovos
+
+"""
+import inspect
+from typing import Tuple, Type
+
+import toml
+
+import gitlab.mixins
+import gitlab.v4.objects
+
+
+def pytest_generate_tests(metafunc):
+    """Find all of the classes in gitlab.v4.objects and pass them to our test
+    function"""
+
+    # Ignore any modules that we are ignoring in our pyproject.toml
+    excluded_modules = set()
+    with open("pyproject.toml", "r") as in_file:
+        pyproject = toml.load(in_file)
+    overrides = pyproject.get("tool", {}).get("mypy", {}).get("overrides", [])
+    for override in overrides:
+        if override.get("ignore_errors") is True:
+            for module in override.get("module", []):
+                if module.startswith("gitlab.v4.objects"):
+                    excluded_modules.add(module)
+
+    class_info_list = []
+    for module_name, module_value in inspect.getmembers(gitlab.v4.objects):
+        if not inspect.ismodule(module_value):
+            # We only care about the modules
+            continue
+        # Iterate through all the classes in our module
+        for class_name, class_value in inspect.getmembers(module_value):
+            if not inspect.isclass(class_value):
+                continue
+
+            module_name = class_value.__module__
+            # Ignore modules that mypy is ignoring
+            if module_name in excluded_modules:
+                continue
+
+            # Ignore imported classes from gitlab.base
+            if module_name == "gitlab.base":
+                continue
+
+            class_info_list.append((class_name, class_value))
+
+    metafunc.parametrize("class_info", class_info_list)
+
+
+class TestTypeHints:
+    def test_check_get_function_type_hints(self, class_info: Tuple[str, Type]):
+        """Ensure classes derived from GetMixin have defined a 'get()' method with
+        correct type-hints.
+        """
+        class_name, class_value = class_info
+        if not class_name.endswith("Manager"):
+            return
+
+        mro = class_value.mro()
+        # The class needs to be derived from GetMixin or we ignore it
+        if gitlab.mixins.GetMixin not in mro:
+            return
+
+        obj_cls = class_value._obj_cls
+        signature = inspect.signature(class_value.get)
+        filename = inspect.getfile(class_value)
+
+        fail_message = (
+            f"class definition for {class_name!r} in file {filename!r} "
+            f"must have defined a 'get' method with a return annotation of "
+            f"{obj_cls} but found {signature.return_annotation}"
+        )
+        assert obj_cls == signature.return_annotation, fail_message
