Refactor transports (#557)

* Refactor requests transport to be similar to aiohttp and httpx
* Removing _prepare_batch_request to avoid code duplication

Author: leszekhanusz

gql/transport/aiohttp.py

@@ -127,7 +127,7 @@ async def connect(self) -> None:
 
             # Adding custom parameters passed from init
             if self.client_session_args:
-                client_session_args.update(self.client_session_args)  # type: ignore
+                client_session_args.update(self.client_session_args)
 
             log.debug("Connecting transport")
 
@@ -164,36 +164,22 @@ async def close(self) -> None:
 
         self.session = None
 
-    def _prepare_batch_request(
-        self,
-        reqs: List[GraphQLRequest],
-        extra_args: Optional[Dict[str, Any]] = None,
-    ) -> Dict[str, Any]:
-
-        payload = [req.payload for req in reqs]
-
-        post_args = {"json": payload}
-
-        # Log the payload
-        if log.isEnabledFor(logging.DEBUG):
-            log.debug(">>> %s", self.json_serialize(post_args["json"]))
-
-        # Pass post_args to aiohttp post method
-        if extra_args:
-            post_args.update(extra_args)
-
-        return post_args
-
     def _prepare_request(
         self,
-        request: GraphQLRequest,
+        request: Union[GraphQLRequest, List[GraphQLRequest]],
         extra_args: Optional[Dict[str, Any]] = None,
         upload_files: bool = False,
     ) -> Dict[str, Any]:
 
-        payload = request.payload
+        payload: Dict | List
+        if isinstance(request, GraphQLRequest):
+            payload = request.payload
+        else:
+            payload = [req.payload for req in request]
 
         if upload_files:
+            assert isinstance(payload, Dict)
+            assert isinstance(request, GraphQLRequest)
             post_args = self._prepare_file_uploads(request, payload)
         else:
             post_args = {"json": payload}
@@ -379,15 +365,15 @@ async def execute(
         :returns: an ExecutionResult object.
         """
 
+        if self.session is None:
+            raise TransportClosed("Transport is not connected")
+
         post_args = self._prepare_request(
             request,
             extra_args,
             upload_files,
         )
 
-        if self.session is None:
-            raise TransportClosed("Transport is not connected")
-
         try:
             async with self.session.post(self.url, ssl=self.ssl, **post_args) as resp:
                 return await self._prepare_result(resp)
@@ -413,14 +399,14 @@ async def execute_batch(
             if an error occurred.
         """
 
-        post_args = self._prepare_batch_request(
+        if self.session is None:
+            raise TransportClosed("Transport is not connected")
+
+        post_args = self._prepare_request(
             reqs,
             extra_args,
         )
 
-        if self.session is None:
-            raise TransportClosed("Transport is not connected")
-
         async with self.session.post(self.url, ssl=self.ssl, **post_args) as resp:
             return await self._prepare_batch_result(reqs, resp)
 

gql/transport/httpx.py

@@ -59,15 +59,22 @@ def __init__(
 
     def _prepare_request(
         self,
-        req: GraphQLRequest,
+        request: Union[GraphQLRequest, List[GraphQLRequest]],
+        *,
         extra_args: Optional[Dict[str, Any]] = None,
         upload_files: bool = False,
     ) -> Dict[str, Any]:
 
-        payload = req.payload
+        payload: Dict | List
+        if isinstance(request, GraphQLRequest):
+            payload = request.payload
+        else:
+            payload = [req.payload for req in request]
 
         if upload_files:
-            post_args = self._prepare_file_uploads(req, payload)
+            assert isinstance(payload, Dict)
+            assert isinstance(request, GraphQLRequest)
+            post_args = self._prepare_file_uploads(request, payload)
         else:
             post_args = {"json": payload}
 
@@ -81,26 +88,6 @@ def _prepare_request(
 
         return post_args
 
-    def _prepare_batch_request(
-        self,
-        reqs: List[GraphQLRequest],
-        extra_args: Optional[Dict[str, Any]] = None,
-    ) -> Dict[str, Any]:
-
-        payload = [req.payload for req in reqs]
-
-        post_args = {"json": payload}
-
-        # Log the payload
-        if log.isEnabledFor(logging.DEBUG):
-            log.debug(">>> %s", self.json_serialize(payload))
-
-        # Pass post_args to aiohttp post method
-        if extra_args:
-            post_args.update(extra_args)
-
-        return post_args
-
     def _prepare_file_uploads(
         self,
         request: GraphQLRequest,
@@ -244,7 +231,7 @@ def connect(self):
 
         self.client = httpx.Client(**self.kwargs)
 
-    def execute(  # type: ignore
+    def execute(
         self,
         request: GraphQLRequest,
         *,
@@ -269,8 +256,8 @@ def execute(  # type: ignore
 
         post_args = self._prepare_request(
             request,
-            extra_args,
-            upload_files,
+            extra_args=extra_args,
+            upload_files=upload_files,
         )
 
         try:
@@ -292,7 +279,7 @@ def execute_batch(
         :code:`execute_batch` on a client or a session.
 
         :param reqs: GraphQL requests as a list of GraphQLRequest objects.
-        :param extra_args: additional arguments to send to the aiohttp post method
+        :param extra_args: additional arguments to send to the httpx post method
         :return: A list of results of execution.
             For every result `data` is the result of executing the query,
             `errors` is null if no errors occurred, and is a non-empty array
@@ -302,9 +289,9 @@ def execute_batch(
         if not self.client:
             raise TransportClosed("Transport is not connected")
 
-        post_args = self._prepare_batch_request(
+        post_args = self._prepare_request(
             reqs,
-            extra_args,
+            extra_args=extra_args,
         )
 
         response = self.client.post(self.url, **post_args)
@@ -361,8 +348,8 @@ async def execute(
 
         post_args = self._prepare_request(
             request,
-            extra_args,
-            upload_files,
+            extra_args=extra_args,
+            upload_files=upload_files,
         )
 
         try:
@@ -384,7 +371,7 @@ async def execute_batch(
         :code:`execute_batch` on a client or a session.
 
         :param reqs: GraphQL requests as a list of GraphQLRequest objects.
-        :param extra_args: additional arguments to send to the aiohttp post method
+        :param extra_args: additional arguments to send to the httpx post method
         :return: A list of results of execution.
             For every result `data` is the result of executing the query,
             `errors` is null if no errors occurred, and is a non-empty array
@@ -394,9 +381,9 @@ async def execute_batch(
         if not self.client:
             raise TransportClosed("Transport is not connected")
 
-        post_args = self._prepare_batch_request(
+        post_args = self._prepare_request(
             reqs,
-            extra_args,
+            extra_args=extra_args,
         )
 
         response = await self.client.post(self.url, **post_args)