Merge pull request #1681 from python-gitlab/jlvillal/mypy_ensure_type…

…_hints

Ensure get() methods have correct type-hints

gitlab/v4/objects/audit_events.py

@@ -2,6 +2,8 @@
 GitLab API:
 https://docs.gitlab.com/ee/api/audit_events.html
 """
+from typing import Any, cast, Union
+
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import RetrieveMixin
 
@@ -26,6 +28,9 @@ class AuditEventManager(RetrieveMixin, RESTManager):
     _obj_cls = AuditEvent
     _list_filters = ("created_after", "created_before", "entity_type", "entity_id")
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> AuditEvent:
+        return cast(AuditEvent, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class GroupAuditEvent(RESTObject):
     _id_attr = "id"
@@ -37,6 +42,11 @@ class GroupAuditEventManager(RetrieveMixin, RESTManager):
     _from_parent_attrs = {"group_id": "id"}
     _list_filters = ("created_after", "created_before")
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> GroupAuditEvent:
+        return cast(GroupAuditEvent, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectAuditEvent(RESTObject):
     _id_attr = "id"
@@ -48,6 +58,11 @@ class ProjectAuditEventManager(RetrieveMixin, RESTManager):
     _from_parent_attrs = {"project_id": "id"}
     _list_filters = ("created_after", "created_before")
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectAuditEvent:
+        return cast(ProjectAuditEvent, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectAudit(ProjectAuditEvent):
     pass

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
@@ -42,6 +49,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
@@ -53,6 +65,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
@@ -68,6 +87,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
@@ -79,6 +105,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
@@ -93,3 +124,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)
+        )

gitlab/v4/objects/badges.py

@@ -22,6 +22,9 @@ class GroupBadgeManager(BadgeRenderMixin, CRUDMixin, RESTManager):
     _create_attrs = RequiredOptional(required=("link_url", "image_url"))
     _update_attrs = RequiredOptional(optional=("link_url", "image_url"))
 
+    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupBadge:
+        return cast(GroupBadge, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectBadge(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass

gitlab/v4/objects/branches.py

@@ -1,3 +1,5 @@
+from typing import Any, cast, Union
+
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 
@@ -19,6 +21,11 @@ class ProjectBranchManager(NoUpdateMixin, RESTManager):
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(required=("branch", "ref"))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectBranch:
+        return cast(ProjectBranch, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectProtectedBranch(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
@@ -40,3 +47,8 @@ class ProjectProtectedBranchManager(NoUpdateMixin, RESTManager):
             "code_owner_approval_required",
         ),
     )
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectProtectedBranch:
+        return cast(ProjectProtectedBranch, super().get(id=id, lazy=lazy, **kwargs))

gitlab/v4/objects/clusters.py

@@ -1,4 +1,4 @@
-from typing import Any, cast, Dict, Optional
+from typing import Any, cast, Dict, Optional, Union
 
 from gitlab import exceptions as exc
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
@@ -57,6 +57,11 @@ def create(
         path = f"{self.path}/user"
         return cast(GroupCluster, CreateMixin.create(self, data, path=path, **kwargs))
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> GroupCluster:
+        return cast(GroupCluster, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectCluster(SaveMixin, ObjectDeleteMixin, RESTObject):
     pass
@@ -102,3 +107,8 @@ def create(
         """
         path = f"{self.path}/user"
         return cast(ProjectCluster, CreateMixin.create(self, data, path=path, **kwargs))
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectCluster:
+        return cast(ProjectCluster, super().get(id=id, lazy=lazy, **kwargs))

gitlab/v4/objects/commits.py

@@ -151,6 +151,11 @@ class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager):
         optional=("author_email", "author_name"),
     )
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectCommit:
+        return cast(ProjectCommit, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectCommitComment(RESTObject):
     _id_attr = None

gitlab/v4/objects/container_registry.py

@@ -1,4 +1,4 @@
-from typing import Any, TYPE_CHECKING
+from typing import Any, cast, TYPE_CHECKING, Union
 
 from gitlab import cli
 from gitlab import exceptions as exc
@@ -60,3 +60,8 @@ def delete_in_bulk(self, name_regex_delete: str, **kwargs: Any) -> None:
         if TYPE_CHECKING:
             assert self.path is not None
         self.gitlab.http_delete(self.path, query_data=data, **kwargs)
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectRegistryTag:
+        return cast(ProjectRegistryTag, super().get(id=id, lazy=lazy, **kwargs))

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
 
@@ -20,6 +22,11 @@ class GroupCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTMana
     _obj_cls = GroupCustomAttribute
     _from_parent_attrs = {"group_id": "id"}
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> GroupCustomAttribute:
+        return cast(GroupCustomAttribute, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class ProjectCustomAttribute(ObjectDeleteMixin, RESTObject):
     _id_attr = "key"
@@ -30,6 +37,11 @@ class ProjectCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTMa
     _obj_cls = ProjectCustomAttribute
     _from_parent_attrs = {"project_id": "id"}
 
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectCustomAttribute:
+        return cast(ProjectCustomAttribute, super().get(id=id, lazy=lazy, **kwargs))
+
 
 class UserCustomAttribute(ObjectDeleteMixin, RESTObject):
     _id_attr = "key"
@@ -39,3 +51,8 @@ class UserCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTManag
     _path = "/users/{user_id}/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))

gitlab/v4/objects/deployments.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
 
@@ -28,3 +30,8 @@ class ProjectDeploymentManager(RetrieveMixin, CreateMixin, UpdateMixin, RESTMana
     _create_attrs = RequiredOptional(
         required=("sha", "ref", "tag", "status", "environment")
     )
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectDeployment:
+        return cast(ProjectDeployment, super().get(id=id, lazy=lazy, **kwargs))

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))

gitlab/v4/objects/environments.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Union
+from typing import Any, cast, Dict, Union
 
 import requests
 
@@ -48,3 +48,8 @@ class ProjectEnvironmentManager(
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(required=("name",), optional=("external_url",))
     _update_attrs = RequiredOptional(optional=("name", "external_url"))
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectEnvironment:
+        return cast(ProjectEnvironment, super().get(id=id, lazy=lazy, **kwargs))