mirror of
https://github.com/hwchase17/langchain.git
synced 2025-05-08 08:38:48 +00:00
bf5193bb99
Upgrade to using a literal for specifying the extra which is the
recommended approach in pydantic 2.
This works correctly also in pydantic v1.
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel, extra="forbid"):
x: int
Foo(x=5, y=1)
```
And
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel):
x: int
class Config:
extra = "forbid"
Foo(x=5, y=1)
```
## Enum -> literal using grit pattern:
```
engine marzano(0.1)
language python
or {
`extra=Extra.allow` => `extra="allow"`,
`extra=Extra.forbid` => `extra="forbid"`,
`extra=Extra.ignore` => `extra="ignore"`
}
```
Resorted attributes in config and removed doc-string in case we will
need to deal with going back and forth between pydantic v1 and v2 during
the 0.3 release. (This will reduce merge conflicts.)
## Sort attributes in Config:
```
engine marzano(0.1)
language python
function sort($values) js {
return $values.text.split(',').sort().join("\n");
}
class_definition($name, $body) as $C where {
$name <: `Config`,
$body <: block($statements),
$values = [],
$statements <: some bubble($values) assignment() as $A where {
$values += $A
},
$body => sort($values),
}
```
57 lines
2.0 KiB
Python
57 lines
2.0 KiB
Python
import json
|
|
from typing import Any, Callable, Dict, Optional
|
|
|
|
from langchain_core.pydantic_v1 import BaseModel, root_validator
|
|
|
|
|
|
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
|
|
fetch_schema_from_transport: Optional[bool] = None
|
|
graphql_endpoint: str
|
|
gql_client: Any #: :meta private:
|
|
gql_function: Callable[[str], Any] #: :meta private:
|
|
|
|
class Config:
|
|
extra = "forbid"
|
|
|
|
@root_validator(pre=True)
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that the python package exists in the environment."""
|
|
try:
|
|
from gql import Client, gql
|
|
from gql.transport.requests import RequestsHTTPTransport
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Could not import gql python package. "
|
|
f"Try installing it with `pip install gql`. Received error: {e}"
|
|
)
|
|
headers = values.get("custom_headers")
|
|
transport = RequestsHTTPTransport(
|
|
url=values["graphql_endpoint"],
|
|
headers=headers,
|
|
)
|
|
fetch_schema_from_transport = values.get("fetch_schema_from_transport", True)
|
|
client = Client(
|
|
transport=transport, fetch_schema_from_transport=fetch_schema_from_transport
|
|
)
|
|
values["gql_client"] = client
|
|
values["gql_function"] = 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
|