chore: change _update_uses to _update_method and use an Enum

JohnVillalovos · nejch · commit 7073a2dfa3a4 · 2023-10-11T18:30:13.000+02:00
Change the name of the `_update_uses` attribute to `_update_method`
and store an Enum in the attribute to indicate which type of HTTP
method to use. At the moment it supports `POST` and `PUT`. But can in
the future support `PATCH`.
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -1,3 +1,4 @@
+import enum
 from types import ModuleType
 from typing import (
     Any,
@@ -304,14 +305,20 @@ def create(
         return self._obj_cls(self, server_data)
 
 
+@enum.unique
+class UpdateMethod(enum.IntEnum):
+    PUT = 1
+    POST = 2
+
+
 class UpdateMixin(_RestManagerBase):
     _computed_path: Optional[str]
     _from_parent_attrs: Dict[str, Any]
     _obj_cls: Optional[Type[base.RESTObject]]
     _parent: Optional[base.RESTObject]
     _parent_attrs: Dict[str, Any]
     _path: Optional[str]
-    _update_uses_post: bool = False
+    _update_method: UpdateMethod = UpdateMethod.PUT
     gitlab: gitlab.Gitlab
 
     def _get_update_method(
@@ -322,7 +329,7 @@ def _get_update_method(
         Returns:
             http_put (default) or http_post
         """
-        if self._update_uses_post:
+        if self._update_method is UpdateMethod.POST:
             http_method = self.gitlab.http_post
         else:
             http_method = self.gitlab.http_put
@@ -894,7 +901,7 @@ class PromoteMixin(_RestObjectBase):
     _module: ModuleType
     _parent_attrs: Dict[str, Any]
     _updated_attrs: Dict[str, Any]
-    _update_uses_post: bool = False
+    _update_method: UpdateMethod = UpdateMethod.PUT
     manager: base.RESTManager
 
     def _get_update_method(
@@ -905,7 +912,7 @@ def _get_update_method(
         Returns:
             http_put (default) or http_post
         """
-        if self._update_uses_post:
+        if self._update_method is UpdateMethod.POST:
             http_method = self.manager.gitlab.http_post
         else:
             http_method = self.manager.gitlab.http_put
diff --git a/gitlab/v4/objects/merge_request_approvals.py b/gitlab/v4/objects/merge_request_approvals.py
@@ -10,6 +10,7 @@
     ListMixin,
     ObjectDeleteMixin,
     SaveMixin,
+    UpdateMethod,
     UpdateMixin,
 )
 from gitlab.types import RequiredOptional
@@ -45,7 +46,7 @@ class ProjectApprovalManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
             "merge_requests_disable_committers_approval",
         ),
     )
-    _update_uses_post = True
+    _update_method = UpdateMethod.POST
 
     def get(self, **kwargs: Any) -> ProjectApproval:
         return cast(ProjectApproval, super().get(**kwargs))
@@ -76,7 +77,7 @@ class ProjectMergeRequestApprovalManager(GetWithoutIdMixin, UpdateMixin, RESTMan
     _obj_cls = ProjectMergeRequestApproval
     _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"}
     _update_attrs = RequiredOptional(required=("approvals_required",))
-    _update_uses_post = True
+    _update_method = UpdateMethod.POST
 
     def get(self, **kwargs: Any) -> ProjectMergeRequestApproval:
         return cast(ProjectMergeRequestApproval, super().get(**kwargs))
diff --git a/gitlab/v4/objects/milestones.py b/gitlab/v4/objects/milestones.py
@@ -4,7 +4,13 @@
 from gitlab import exceptions as exc
 from gitlab import types
 from gitlab.base import RESTManager, RESTObject, RESTObjectList
-from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, PromoteMixin, SaveMixin
+from gitlab.mixins import (
+    CRUDMixin,
+    ObjectDeleteMixin,
+    PromoteMixin,
+    SaveMixin,
+    UpdateMethod,
+)
 from gitlab.types import RequiredOptional
 
 from .issues import GroupIssue, GroupIssueManager, ProjectIssue, ProjectIssueManager
@@ -100,7 +106,7 @@ def get(
 
 class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
     _repr_attr = "title"
-    _update_uses_post = True
+    _update_method = UpdateMethod.POST
 
     @cli.register_custom_action("ProjectMilestone")
     @exc.on_http_error(exc.GitlabListError)
diff --git a/tests/unit/mixins/test_mixin_methods.py b/tests/unit/mixins/test_mixin_methods.py
@@ -13,6 +13,7 @@
     RefreshMixin,
     SaveMixin,
     SetMixin,
+    UpdateMethod,
     UpdateMixin,
 )
 
@@ -377,7 +378,7 @@ class M(UpdateMixin, FakeManager):
 @responses.activate
 def test_update_mixin_uses_post(gl):
     class M(UpdateMixin, FakeManager):
-        _update_uses_post = True
+        _update_method = UpdateMethod.POST
 
     url = "http://localhost/api/v4/tests/1"
     responses.add(
diff --git a/tests/unit/objects/test_project_merge_request_approvals.py b/tests/unit/objects/test_project_merge_request_approvals.py
@@ -8,6 +8,7 @@
 import responses
 
 import gitlab
+from gitlab.mixins import UpdateMethod
 
 approval_rule_id = 1
 approval_rule_name = "security"
@@ -157,15 +158,15 @@ def resp_delete_mr_approval_rule():
         yield rsps
 
 
-def test_project_approval_manager_update_uses_post(project):
+def test_project_approval_manager_update_method_post(project):
     """Ensure the
     gitlab.v4.objects.merge_request_approvals.ProjectApprovalManager object has
-    _update_uses_post set to True"""
+    _update_method set to UpdateMethod.POST"""
     approvals = project.approvals
     assert isinstance(
         approvals, gitlab.v4.objects.merge_request_approvals.ProjectApprovalManager
     )
-    assert approvals._update_uses_post is True
+    assert approvals._update_method is UpdateMethod.POST
 
 
 def test_list_merge_request_approval_rules(project, resp_mr_approval_rules):
@@ -187,7 +188,7 @@ def test_update_merge_request_approvals_set_approvers(project, resp_mr_approval_
         approvals,
         gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalManager,
     )
-    assert approvals._update_uses_post is True
+    assert approvals._update_method is UpdateMethod.POST
     response = approvals.set_approvers(
         updated_approval_rule_approvals_required,
         approver_ids=updated_approval_rule_user_ids,
@@ -207,7 +208,7 @@ def test_create_merge_request_approvals_set_approvers(project, resp_mr_approval_
         approvals,
         gitlab.v4.objects.merge_request_approvals.ProjectMergeRequestApprovalManager,
     )
-    assert approvals._update_uses_post is True
+    assert approvals._update_method is UpdateMethod.POST
     response = approvals.set_approvers(
         new_approval_rule_approvals_required,
         approver_ids=new_approval_rule_user_ids,
