support options parameter

Author: DaleSeo

python_graphql_client/graphql_client.py

@@ -13,10 +13,11 @@
 class GraphqlClient:
     """Class which represents the interface to make graphQL requests through."""
 
-    def __init__(self, endpoint: str, headers: dict = None):
+    def __init__(self, endpoint: str, headers: dict = {}, options: dict = {}):
         """Insantiate the client."""
         self.endpoint = endpoint
-        self.headers = headers or {}
+        self.headers = headers
+        self.options = options
 
     def __request_body(
         self, query: str, variables: dict = None, operation_name: str = None
@@ -31,15 +32,13 @@ def __request_body(
 
         return json
 
-    def __request_headers(self, headers: dict = None) -> dict:
-        return {**self.headers, **headers} if headers else self.headers
-
     def execute(
         self,
         query: str,
         variables: dict = None,
         operation_name: str = None,
-        headers: dict = None,
+        headers: dict = {},
+        options: dict = {},
     ):
         """Make synchronous request to graphQL server."""
         request_body = self.__request_body(
@@ -49,7 +48,8 @@ def execute(
         result = requests.post(
             self.endpoint,
             json=request_body,
-            headers=self.__request_headers(headers),
+            headers={**self.headers, **headers},
+            **{**self.options, **options},
         )
 
         result.raise_for_status()
@@ -60,7 +60,7 @@ async def execute_async(
         query: str,
         variables: dict = None,
         operation_name: str = None,
-        headers: dict = None,
+        headers: dict = {},
     ):
         """Make asynchronous request to graphQL server."""
         request_body = self.__request_body(
@@ -69,9 +69,7 @@ async def execute_async(
 
         async with aiohttp.ClientSession() as session:
             async with session.post(
-                self.endpoint,
-                json=request_body,
-                headers=self.__request_headers(headers),
+                self.endpoint, json=request_body, headers={**self.headers, **headers},
             ) as response:
                 return await response.json()
 
@@ -81,7 +79,7 @@ async def subscribe(
         handle: Callable,
         variables: dict = None,
         operation_name: str = None,
-        headers: dict = None,
+        headers: dict = {},
     ):
         """Make asynchronous request for GraphQL subscription."""
         connection_init_message = json.dumps({"type": "connection_init", "payload": {}})
@@ -96,7 +94,7 @@ async def subscribe(
         async with websockets.connect(
             self.endpoint,
             subprotocols=["graphql-ws"],
-            extra_headers=self.__request_headers(headers),
+            extra_headers={**self.headers, **headers},
         ) as websocket:
             await websocket.send(connection_init_message)
             await websocket.send(request_message)

tests/test_graphql_client.py

@@ -4,6 +4,7 @@
 from unittest.mock import AsyncMock, MagicMock, call, patch
 
 from aiohttp import web
+from requests.auth import HTTPBasicAuth
 from requests.exceptions import HTTPError
 
 from python_graphql_client import GraphqlClient
@@ -98,6 +99,24 @@ def test_execute_query_with_headers(self, post_mock):
             },
         )
 
+    @patch("python_graphql_client.graphql_client.requests.post")
+    def test_execute_query_with_options(self, post_mock):
+        """Sends a graphql POST request with headers."""
+        auth = HTTPBasicAuth("fake@example.com", "not_a_real_password")
+        client = GraphqlClient(
+            endpoint="http://www.test-api.com/", options={"auth": auth},
+        )
+        query = ""
+        client.execute(query=query, options={"verify": False})
+
+        post_mock.assert_called_once_with(
+            "http://www.test-api.com/",
+            json={"query": query},
+            headers={},
+            auth=HTTPBasicAuth("fake@example.com", "not_a_real_password"),
+            verify=False,
+        )
+
     @patch("python_graphql_client.graphql_client.requests.post")
     def test_execute_query_with_operation_name(self, post_mock):
         """Sends a graphql POST request with the operationName key set."""
@@ -302,8 +321,4 @@ async def test_headers_passed_to_websocket_connect(self, mock_connect):
             extra_headers=expected_headers,
         )
 
-        mock_handle.assert_has_calls(
-            [
-                call({"data": {"messageAdded": "one"}}),
-            ]
-        )
+        mock_handle.assert_has_calls([call({"data": {"messageAdded": "one"}})])