Add HTTPX transport (#370)

Author: helderco

.github/workflows/tests.yml

@@ -40,7 +40,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        dependency: ["aiohttp", "requests", "websockets"]
+        dependency: ["aiohttp", "requests", "httpx", "websockets"]
 
     steps:
       - uses: actions/checkout@v3

Makefile

@@ -3,7 +3,7 @@
 SRC_PYTHON := gql tests docs/code_examples
 
 dev-setup:
-	python pip install -e ".[test]"
+	python -m pip install -e ".[test]"
 
 tests:
 	pytest tests --cov=gql --cov-report=term-missing -vv
@@ -17,6 +17,9 @@ tests_aiohttp:
 tests_requests:
 	pytest tests --requests-only
 
+tests_httpx:
+	pytest tests --httpx-only
+
 tests_websockets:
 	pytest tests --websockets-only
 

docs/code_examples/httpx_async.py

@@ -0,0 +1,34 @@
+import asyncio
+
+from gql import Client, gql
+from gql.transport.httpx import HTTPXAsyncTransport
+
+
+async def main():
+
+    transport = HTTPXAsyncTransport(url="https://countries.trevorblades.com/graphql")
+
+    # Using `async with` on the client will start a connection on the transport
+    # and provide a `session` variable to execute queries on this connection
+    async with Client(
+        transport=transport,
+        fetch_schema_from_transport=True,
+    ) as session:
+
+        # Execute single query
+        query = gql(
+            """
+            query getContinents {
+              continents {
+                code
+                name
+              }
+            }
+        """
+        )
+
+        result = await session.execute(query)
+        print(result)
+
+
+asyncio.run(main())

docs/code_examples/httpx_sync.py

@@ -0,0 +1,20 @@
+from gql import Client, gql
+from gql.transport.httpx import HTTPXTransport
+
+transport = HTTPXTransport(url="https://countries.trevorblades.com/")
+
+client = Client(transport=transport, fetch_schema_from_transport=True)
+
+query = gql(
+    """
+    query getContinents {
+      continents {
+        code
+        name
+      }
+    }
+"""
+)
+
+result = client.execute(query)
+print(result)

docs/intro.rst

@@ -45,6 +45,10 @@ The corresponding between extra dependencies required and the GQL classes is:
 +---------------------+----------------------------------------------------------------+
 | requests            | :ref:`RequestsHTTPTransport <requests_transport>`              |
 +---------------------+----------------------------------------------------------------+
+| httpx               | :ref:`HTTPTXTransport <httpx_transport>`                       |
+|                     |                                                                |
+|                     | :ref:`HTTPXAsyncTransport <httpx_async_transport>`             |
++---------------------+----------------------------------------------------------------+
 | botocore            | :ref:`AppSyncIAMAuthentication <appsync_iam_auth>`             |
 +---------------------+----------------------------------------------------------------+
 

docs/modules/gql.rst

@@ -26,6 +26,7 @@ Sub-Packages
    transport_exceptions
    transport_phoenix_channel_websockets
    transport_requests
+   transport_httpx
    transport_websockets
    transport_websockets_base
    dsl

docs/modules/transport_httpx.rst

@@ -0,0 +1,7 @@
+gql.transport.httpx
+===================
+
+.. currentmodule:: gql.transport.httpx
+
+.. automodule:: gql.transport.httpx
+    :member-order: bysource

docs/transports/async_transports.rst

@@ -10,6 +10,7 @@ Async transports are transports which are using an underlying async library. The
    :maxdepth: 1
 
    aiohttp
+   httpx_async
    websockets
    phoenix
    appsync

docs/transports/httpx.rst

@@ -0,0 +1,13 @@
+.. _httpx_transport:
+
+HTTPXTransport
+==============
+
+The HTTPXTransport is a sync transport using the `httpx`_ library
+and allows you to send GraphQL queries using the HTTP protocol.
+
+Reference: :class:`gql.transport.httpx.HTTPXTransport`
+
+.. literalinclude:: ../code_examples/httpx_sync.py
+
+.. _httpx: https://www.python-httpx.org

docs/transports/httpx_async.rst

@@ -0,0 +1,39 @@
+.. _httpx_async_transport:
+
+HTTPXAsyncTransport
+===================
+
+This transport uses the `httpx`_ library and allows you to send GraphQL queries using the HTTP protocol.
+
+Reference: :class:`gql.transport.httpx.HTTPXAsyncTransport`
+
+.. note::
+
+    GraphQL subscriptions are not supported on the HTTP transport.
+    For subscriptions you should use the :ref:`websockets transport <websockets_transport>`.
+
+.. literalinclude:: ../code_examples/httpx_async.py
+
+Authentication
+--------------
+
+There are multiple ways to authenticate depending on the server configuration.
+
+1. Using HTTP Headers
+
+.. code-block:: python
+
+    transport = HTTPXAsyncTransport(
+        url='https://SERVER_URL:SERVER_PORT/graphql',
+        headers={'Authorization': 'token'}
+    )
+
+2. Using HTTP Cookies
+
+You can manually set the cookies which will be sent with each connection:
+
+.. code-block:: python
+
+    transport = HTTPXAsyncTransport(url=url, cookies={"cookie1": "val1"})
+
+.. _httpx: https://www.python-httpx.org