Adding TransportConnectionFailed Exception to docs

graphql-python · leszekhanusz · May 28, 2025 · May 28, 2025 · May 28, 2025 · May 28, 2025
commit 96b4f03a4033720d0ff15a23bb558118b9e5a97c
diff --git a/docs/advanced/error_handling.rst b/docs/advanced/error_handling.rst
@@ -46,6 +46,11 @@ Here are the possible Transport Errors:
   If you don't need the schema, you can try to create the client with
   :code:`fetch_schema_from_transport=False`
 
+- :class:`TransportConnectionFailed <gql.transport.exceptions.TransportConnectionFailed>`:
+  This exception is generated when an unexpected Exception is received from the
+  transport dependency when trying to connect or to send the request.
+  For example in case of an SSL error, or if a websocket connection suddenly fails.
+
 - :class:`TransportClosed <gql.transport.exceptions.TransportClosed>`:
   This exception is generated when the client is trying to use the transport
   while the transport was previously closed.

diff --git a/gql/gql.py b/gql/gql.py
@@ -3,15 +3,14 @@
 
 def gql(request_string: str) -> GraphQLRequest:
     """Given a string containing a GraphQL request,
-       parse it into a Document and put it into a GraphQLRequest object
+       parse it into a Document and put it into a GraphQLRequest object.
 
     :param request_string: the GraphQL request as a String
     :return: a :class:`GraphQLRequest <gql.GraphQLRequest>`
              which can be later executed or subscribed by a
-        :class:`Client <gql.client.Client>`, by an
-        :class:`async session <gql.client.AsyncClientSession>` or by a
-        :class:`sync session <gql.client.SyncClientSession>`
-
+             :class:`Client <gql.client.Client>`, by an
+             :class:`async session <gql.client.AsyncClientSession>` or by a
+             :class:`sync session <gql.client.SyncClientSession>`
     :raises graphql.error.GraphQLError: if a syntax error is encountered.
     """
     return GraphQLRequest(request_string)
diff --git a/gql/graphql_request.py b/gql/graphql_request.py
@@ -14,22 +14,19 @@ def __init__(
         variable_values: Optional[Dict[str, Any]] = None,
         operation_name: Optional[str] = None,
     ):
-        """
-        Initialize a GraphQL request.
+        """Initialize a GraphQL request.
 
         :param request: GraphQL request as DocumentNode object or as a string.
              If string, it will be converted to DocumentNode.
         :param variable_values: Dictionary of input parameters (Default: None).
         :param operation_name: Name of the operation that shall be executed.
             Only required in multi-operation documents (Default: None).
-
         :return: a :class:`GraphQLRequest <gql.GraphQLRequest>`
                  which can be later executed or subscribed by a
-            :class:`Client <gql.client.Client>`, by an
-            :class:`async session <gql.client.AsyncClientSession>` or by a
-            :class:`sync session <gql.client.SyncClientSession>`
+                 :class:`Client <gql.client.Client>`, by an
+                 :class:`async session <gql.client.AsyncClientSession>` or by a
+                 :class:`sync session <gql.client.SyncClientSession>`
         :raises graphql.error.GraphQLError: if a syntax error is encountered.
-
         """
         if isinstance(request, str):
             source = Source(request, "GraphQL request")

diff --git a/gql/transport/exceptions.py b/gql/transport/exceptions.py
@@ -62,9 +62,10 @@ class TransportClosed(TransportError):
 
 
 class TransportConnectionFailed(TransportError):
-    """Transport adapter connection closed.
+    """Transport connection failed.
 
-    This exception is by the connection adapter code when a connection closed.
+    This exception is by the connection adapter code when a connection closed
+    or if an unexpected Exception was received when trying to send a request.
     """