Mark raise_for_error as deprecated

Author: gmazoyer

infrahub_sdk/client.py

@@ -4,6 +4,7 @@
 import copy
 import logging
 import time
+import warnings
 from collections.abc import Coroutine, MutableMapping
 from functools import wraps
 from time import sleep
@@ -893,13 +894,20 @@ async def execute_graphql(
             branch_name (str, optional): Name of the branch on which the query will be executed. Defaults to None.
             at (str, optional): Time when the query should be executed. Defaults to None.
             timeout (int, optional): Timeout in second for the query. Defaults to None.
-            raise_for_error (bool, optional): Flag to indicate that we need to raise an exception if the response has some errors. Defaults to True.
+            raise_for_error (bool, optional): Deprecated, flag to indicate that we need to raise an exception if the response has some errors.
+            Defaults to True.
         Raises:
             GraphQLError: _description_
 
         Returns:
             _type_: _description_
         """
+        if not raise_for_error:
+            warnings.warn(
+                "Setting `raise_for_error=False` is deprecated, use `try/except` to handle errors.",
+                DeprecationWarning,
+                stacklevel=1,
+            )
 
         branch_name = branch_name or self.default_branch
         url = self._graphql_url(branch_name=branch_name, at=at)
@@ -950,9 +958,7 @@ async def execute_graphql(
         response = decode_json(response=resp)
 
         if "errors" in response:
-            if raise_for_error:
-                raise GraphQLError(errors=response["errors"], query=query, variables=variables)
-            return response["errors"]
+            raise GraphQLError(errors=response["errors"], query=query, variables=variables)
 
         return response["data"]
 
@@ -1639,13 +1645,20 @@ def execute_graphql(
             branch_name (str, optional): Name of the branch on which the query will be executed. Defaults to None.
             at (str, optional): Time when the query should be executed. Defaults to None.
             timeout (int, optional): Timeout in second for the query. Defaults to None.
-            raise_for_error (bool, optional): Flag to indicate that we need to raise an exception if the response has some errors. Defaults to True.
+            raise_for_error (bool, optional): Deprecated, flag to indicate that we need to raise an exception if the response has some errors.
+            Defaults to True.
         Raises:
             GraphQLError: When an error occurs during the execution of the GraphQL query or mutation.
 
         Returns:
             dict: The result of the GraphQL query or mutation.
         """
+        if not raise_for_error:
+            warnings.warn(
+                "Setting `raise_for_error=False` is deprecated, use `try/except` to handle errors.",
+                DeprecationWarning,
+                stacklevel=1,
+            )
 
         branch_name = branch_name or self.default_branch
         url = self._graphql_url(branch_name=branch_name, at=at)
@@ -1696,9 +1709,7 @@ def execute_graphql(
         response = decode_json(response=resp)
 
         if "errors" in response:
-            if raise_for_error:
-                raise GraphQLError(errors=response["errors"], query=query, variables=variables)
-            return response["errors"]
+            raise GraphQLError(errors=response["errors"], query=query, variables=variables)
 
         return response["data"]
 

tests/unit/sdk/test_client.py

@@ -4,7 +4,7 @@
 from pytest_httpx import HTTPXMock
 
 from infrahub_sdk import InfrahubClient, InfrahubClientSync
-from infrahub_sdk.exceptions import GraphQLError, NodeNotFoundError
+from infrahub_sdk.exceptions import NodeNotFoundError
 from infrahub_sdk.node import InfrahubNode, InfrahubNodeSync
 from tests.unit.sdk.conftest import BothClients
 
@@ -800,35 +800,3 @@ async def test_clone_define_branch(clients: BothClients, client_type: str) -> No
     assert clone.default_branch == clone_branch
     assert original_branch != clone_branch
     assert clone.store._default_branch == clone_branch
-
-
-@pytest.mark.parametrize("client_type", client_types)
-async def test_execute_graphql_error(httpx_mock: HTTPXMock, clients, client_type) -> None:
-    httpx_mock.add_response(method="POST", json={"errors": ["foo"]}, is_reusable=True)
-
-    query = """
-    query GetTags {
-        BuiltinTag {
-            edges {
-                node {
-                    id
-                    display_label
-                }
-            }
-        }
-    }
-    """
-
-    if client_type == "standard":
-        with pytest.raises(GraphQLError):
-            await clients.standard.execute_graphql(query=query, raise_for_error=True)
-
-        response = await clients.standard.execute_graphql(query=query, raise_for_error=False)
-    else:
-        with pytest.raises(GraphQLError):
-            clients.sync.execute_graphql(query=query, raise_for_error=True)
-
-        response = clients.sync.execute_graphql(query=query, raise_for_error=False)
-
-    assert response
-    assert response[0] == "foo"