refactor(client): delete methods now return None in case deletion was successful

Author: GG-Yanne

pygitguardian/client.py

@@ -142,7 +142,6 @@ def is_create_ok(resp: Response) -> bool:
 def is_delete_ok(resp: Response) -> bool:
     """
     is_delete_ok returns True if the API returns code 204
-    and the content type is JSON.
     """
     return resp.status_code == codes.no_content
 
@@ -992,7 +991,7 @@ def delete_member(
         self,
         member: DeleteMember,
         extra_headers: Optional[Dict[str, str]] = None,
-    ) -> Union[Detail, int]:
+    ) -> Optional[Detail]:
         member_id = member.id
         data = member.to_dict()
         del data["id"]
@@ -1002,10 +1001,8 @@ def delete_member(
         )
 
         # We bypass `is_ok` because the response content type is none
-        if is_delete_ok(response):
-            return response.status_code
-
-        return load_detail(response)
+        if not is_delete_ok(response):
+            return load_detail(response)
 
     def list_teams(
         self,
@@ -1093,16 +1090,14 @@ def delete_team(
         self,
         team_id: int,
         extra_headers: Optional[Dict[str, str]] = None,
-    ) -> Union[Detail, int]:
+    ) -> Optional[Detail]:
         response = self.delete(
             endpoint=f"teams/{team_id}",
             extra_headers=extra_headers,
         )
 
-        if is_delete_ok(response):
-            return response.status_code
-
-        return load_detail(response)
+        if not is_delete_ok(response):
+            return load_detail(response)
 
     def list_team_invitations(
         self,
@@ -1153,16 +1148,14 @@ def delete_team_invitation(
         team_id: int,
         invitation_id: int,
         extra_headers: Optional[Dict[str, str]] = None,
-    ) -> Union[Detail, int]:
+    ) -> Optional[Detail]:
         response = self.delete(
             endpoint=f"teams/{team_id}/team_invitations/{invitation_id}",
             extra_headers=extra_headers,
         )
 
-        if is_delete_ok(response):
-            return response.status_code
-
-        return load_detail(response)
+        if not is_delete_ok(response):
+            return load_detail(response)
 
     def list_team_members(
         self,
@@ -1215,16 +1208,14 @@ def delete_team_member(
         team_id: int,
         team_member_id: int,
         extra_headers: Optional[Dict[str, str]] = None,
-    ) -> Union[Detail, int]:
+    ) -> Optional[Detail]:
         response = self.delete(
             endpoint=f"teams/{team_id}/team_memberships/{team_member_id}",
             extra_headers=extra_headers,
         )
 
-        if is_delete_ok(response):
-            return response.status_code
-
-        return load_detail(response)
+        if not is_delete_ok(response):
+            return load_detail(response)
 
     def list_sources(
         self,
@@ -1335,12 +1326,10 @@ def delete_invitation(
         self,
         invitation_id: int,
         extra_headers: Optional[Dict[str, str]] = None,
-    ) -> Union[Detail, int]:
+    ) -> Optional[Detail]:
         response = self.delete(
             endpoint=f"invitations/{invitation_id}", extra_headers=extra_headers
         )
 
-        if is_delete_ok(response):
-            return response.status_code
-
-        return load_detail(response)
+        if not is_delete_ok(response):
+            return load_detail(response)

tests/test_client.py

@@ -1498,7 +1498,7 @@ def test_delete_member(client: GGClient):
 
     result = client.delete_member(DeleteMember(id=11))
 
-    assert result == 204, result.content
+    assert result is None, result.content
 
 
 @my_vcr.use_cassette("test_create_team.yaml", ignore_localhost=False)
@@ -1585,7 +1585,7 @@ def test_delete_team(client: GGClient):
 
     result = client.delete_team(8)
 
-    assert result == 204
+    assert result is None
 
 
 @my_vcr.use_cassette("test_create_team_invitation.yaml", ignore_localhost=False)
@@ -1652,7 +1652,7 @@ def test_delete_team_invitation(client: GGClient):
 
     result = client.delete_team_invitation(9, 1)
 
-    assert result == 204
+    assert result is None
 
 
 @my_vcr.use_cassette("test_list_team_members.yaml", ignore_localhost=False)
@@ -1731,7 +1731,7 @@ def test_delete_team_member(client: GGClient):
 
     result = client.delete_team_member(9, 10)
 
-    assert result == 204
+    assert result is None
 
 
 @my_vcr.use_cassette("test_list_sources.yaml", ignore_localhost=False)
@@ -1872,4 +1872,4 @@ def test_delete_invitation(client: GGClient):
 
     result = client.delete_invitation(2)
 
-    assert result == 204
+    assert result is None