forked from Archives/langchain
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
1.9 KiB
Python
62 lines
1.9 KiB
Python
import json
|
|
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional
|
|
|
|
from pydantic import BaseModel, Extra, root_validator
|
|
|
|
if TYPE_CHECKING:
|
|
from gql import Client
|
|
|
|
|
|
class GraphQLAPIWrapper(BaseModel):
|
|
"""Wrapper around GraphQL API.
|
|
|
|
To use, you should have the ``gql`` python package installed.
|
|
This wrapper will use the GraphQL API to conduct queries.
|
|
"""
|
|
|
|
custom_headers: Optional[Dict[str, str]] = None
|
|
graphql_endpoint: str
|
|
gql_client: "Client" #: :meta private:
|
|
gql_function: Callable[[str], Any] #: :meta private:
|
|
|
|
class Config:
|
|
"""Configuration for this pydantic object."""
|
|
|
|
extra = Extra.forbid
|
|
|
|
@root_validator()
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that the python package exists in the environment."""
|
|
|
|
headers = values.get("custom_headers", {})
|
|
|
|
try:
|
|
from gql import Client, gql
|
|
from gql.transport.requests import RequestsHTTPTransport
|
|
|
|
transport = RequestsHTTPTransport(
|
|
url=values["graphql_endpoint"],
|
|
headers=headers or None,
|
|
)
|
|
|
|
client = Client(transport=transport, fetch_schema_from_transport=True)
|
|
values["gql_client"] = client
|
|
values["gql_function"] = gql
|
|
except ImportError:
|
|
raise ValueError(
|
|
"Could not import gql python package. "
|
|
"Please install it with `pip install gql`."
|
|
)
|
|
return values
|
|
|
|
def run(self, query: str) -> str:
|
|
"""Run a GraphQL query and get the results."""
|
|
result = self._execute_query(query)
|
|
return json.dumps(result, indent=2)
|
|
|
|
def _execute_query(self, query: str) -> Dict[str, Any]:
|
|
"""Execute a GraphQL query and return the results."""
|
|
document_node = self.gql_function(query)
|
|
result = self.gql_client.execute(document_node)
|
|
return result
|