mirror of
https://github.com/hwchase17/langchain.git
synced 2025-05-08 00:28:47 +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),
}
```
257 lines
9.1 KiB
Python
257 lines
9.1 KiB
Python
"""Lightweight wrapper around requests library, with async support."""
|
|
|
|
from contextlib import asynccontextmanager
|
|
from typing import Any, AsyncGenerator, Dict, Literal, Optional, Union
|
|
|
|
import aiohttp
|
|
import requests
|
|
from langchain_core.pydantic_v1 import BaseModel
|
|
from requests import Response
|
|
|
|
|
|
class Requests(BaseModel):
|
|
"""Wrapper around requests to handle auth and async.
|
|
|
|
The main purpose of this wrapper is to handle authentication (by saving
|
|
headers) and enable easy async methods on the same base object.
|
|
"""
|
|
|
|
headers: Optional[Dict[str, str]] = None
|
|
aiosession: Optional[aiohttp.ClientSession] = None
|
|
auth: Optional[Any] = None
|
|
verify: Optional[bool] = True
|
|
|
|
class Config:
|
|
arbitrary_types_allowed = True
|
|
extra = "forbid"
|
|
|
|
def get(self, url: str, **kwargs: Any) -> requests.Response:
|
|
"""GET the URL and return the text."""
|
|
return requests.get(
|
|
url, headers=self.headers, auth=self.auth, verify=self.verify, **kwargs
|
|
)
|
|
|
|
def post(self, url: str, data: Dict[str, Any], **kwargs: Any) -> requests.Response:
|
|
"""POST to the URL and return the text."""
|
|
return requests.post(
|
|
url,
|
|
json=data,
|
|
headers=self.headers,
|
|
auth=self.auth,
|
|
verify=self.verify,
|
|
**kwargs,
|
|
)
|
|
|
|
def patch(self, url: str, data: Dict[str, Any], **kwargs: Any) -> requests.Response:
|
|
"""PATCH the URL and return the text."""
|
|
return requests.patch(
|
|
url,
|
|
json=data,
|
|
headers=self.headers,
|
|
auth=self.auth,
|
|
verify=self.verify,
|
|
**kwargs,
|
|
)
|
|
|
|
def put(self, url: str, data: Dict[str, Any], **kwargs: Any) -> requests.Response:
|
|
"""PUT the URL and return the text."""
|
|
return requests.put(
|
|
url,
|
|
json=data,
|
|
headers=self.headers,
|
|
auth=self.auth,
|
|
verify=self.verify,
|
|
**kwargs,
|
|
)
|
|
|
|
def delete(self, url: str, **kwargs: Any) -> requests.Response:
|
|
"""DELETE the URL and return the text."""
|
|
return requests.delete(
|
|
url, headers=self.headers, auth=self.auth, verify=self.verify, **kwargs
|
|
)
|
|
|
|
@asynccontextmanager
|
|
async def _arequest(
|
|
self, method: str, url: str, **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""Make an async request."""
|
|
if not self.aiosession:
|
|
async with aiohttp.ClientSession() as session:
|
|
async with session.request(
|
|
method,
|
|
url,
|
|
headers=self.headers,
|
|
auth=self.auth,
|
|
verify_ssl=self.verify,
|
|
**kwargs,
|
|
) as response:
|
|
yield response
|
|
else:
|
|
async with self.aiosession.request(
|
|
method,
|
|
url,
|
|
headers=self.headers,
|
|
auth=self.auth,
|
|
verify_ssl=self.verify,
|
|
**kwargs,
|
|
) as response:
|
|
yield response
|
|
|
|
@asynccontextmanager
|
|
async def aget(
|
|
self, url: str, **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""GET the URL and return the text asynchronously."""
|
|
async with self._arequest("GET", url, **kwargs) as response:
|
|
yield response
|
|
|
|
@asynccontextmanager
|
|
async def apost(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""POST to the URL and return the text asynchronously."""
|
|
async with self._arequest("POST", url, json=data, **kwargs) as response:
|
|
yield response
|
|
|
|
@asynccontextmanager
|
|
async def apatch(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""PATCH the URL and return the text asynchronously."""
|
|
async with self._arequest("PATCH", url, json=data, **kwargs) as response:
|
|
yield response
|
|
|
|
@asynccontextmanager
|
|
async def aput(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""PUT the URL and return the text asynchronously."""
|
|
async with self._arequest("PUT", url, json=data, **kwargs) as response:
|
|
yield response
|
|
|
|
@asynccontextmanager
|
|
async def adelete(
|
|
self, url: str, **kwargs: Any
|
|
) -> AsyncGenerator[aiohttp.ClientResponse, None]:
|
|
"""DELETE the URL and return the text asynchronously."""
|
|
async with self._arequest("DELETE", url, **kwargs) as response:
|
|
yield response
|
|
|
|
|
|
class GenericRequestsWrapper(BaseModel):
|
|
"""Lightweight wrapper around requests library."""
|
|
|
|
headers: Optional[Dict[str, str]] = None
|
|
aiosession: Optional[aiohttp.ClientSession] = None
|
|
auth: Optional[Any] = None
|
|
response_content_type: Literal["text", "json"] = "text"
|
|
verify: bool = True
|
|
|
|
class Config:
|
|
arbitrary_types_allowed = True
|
|
extra = "forbid"
|
|
|
|
@property
|
|
def requests(self) -> Requests:
|
|
return Requests(
|
|
headers=self.headers,
|
|
aiosession=self.aiosession,
|
|
auth=self.auth,
|
|
verify=self.verify,
|
|
)
|
|
|
|
def _get_resp_content(self, response: Response) -> Union[str, Dict[str, Any]]:
|
|
if self.response_content_type == "text":
|
|
return response.text
|
|
elif self.response_content_type == "json":
|
|
return response.json()
|
|
else:
|
|
raise ValueError(f"Invalid return type: {self.response_content_type}")
|
|
|
|
async def _aget_resp_content(
|
|
self, response: aiohttp.ClientResponse
|
|
) -> Union[str, Dict[str, Any]]:
|
|
if self.response_content_type == "text":
|
|
return await response.text()
|
|
elif self.response_content_type == "json":
|
|
return await response.json()
|
|
else:
|
|
raise ValueError(f"Invalid return type: {self.response_content_type}")
|
|
|
|
def get(self, url: str, **kwargs: Any) -> Union[str, Dict[str, Any]]:
|
|
"""GET the URL and return the text."""
|
|
return self._get_resp_content(self.requests.get(url, **kwargs))
|
|
|
|
def post(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""POST to the URL and return the text."""
|
|
return self._get_resp_content(self.requests.post(url, data, **kwargs))
|
|
|
|
def patch(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""PATCH the URL and return the text."""
|
|
return self._get_resp_content(self.requests.patch(url, data, **kwargs))
|
|
|
|
def put(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""PUT the URL and return the text."""
|
|
return self._get_resp_content(self.requests.put(url, data, **kwargs))
|
|
|
|
def delete(self, url: str, **kwargs: Any) -> Union[str, Dict[str, Any]]:
|
|
"""DELETE the URL and return the text."""
|
|
return self._get_resp_content(self.requests.delete(url, **kwargs))
|
|
|
|
async def aget(self, url: str, **kwargs: Any) -> Union[str, Dict[str, Any]]:
|
|
"""GET the URL and return the text asynchronously."""
|
|
async with self.requests.aget(url, **kwargs) as response:
|
|
return await self._aget_resp_content(response)
|
|
|
|
async def apost(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""POST to the URL and return the text asynchronously."""
|
|
async with self.requests.apost(url, data, **kwargs) as response:
|
|
return await self._aget_resp_content(response)
|
|
|
|
async def apatch(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""PATCH the URL and return the text asynchronously."""
|
|
async with self.requests.apatch(url, data, **kwargs) as response:
|
|
return await self._aget_resp_content(response)
|
|
|
|
async def aput(
|
|
self, url: str, data: Dict[str, Any], **kwargs: Any
|
|
) -> Union[str, Dict[str, Any]]:
|
|
"""PUT the URL and return the text asynchronously."""
|
|
async with self.requests.aput(url, data, **kwargs) as response:
|
|
return await self._aget_resp_content(response)
|
|
|
|
async def adelete(self, url: str, **kwargs: Any) -> Union[str, Dict[str, Any]]:
|
|
"""DELETE the URL and return the text asynchronously."""
|
|
async with self.requests.adelete(url, **kwargs) as response:
|
|
return await self._aget_resp_content(response)
|
|
|
|
|
|
class JsonRequestsWrapper(GenericRequestsWrapper):
|
|
"""Lightweight wrapper around requests library, with async support.
|
|
|
|
The main purpose of this wrapper is to always return a json output."""
|
|
|
|
response_content_type: Literal["text", "json"] = "json"
|
|
|
|
|
|
class TextRequestsWrapper(GenericRequestsWrapper):
|
|
"""Lightweight wrapper around requests library, with async support.
|
|
|
|
The main purpose of this wrapper is to always return a text output."""
|
|
|
|
response_content_type: Literal["text", "json"] = "text"
|
|
|
|
|
|
# For backwards compatibility
|
|
RequestsWrapper = TextRequestsWrapper
|