Http client base pydantic with requests, aiohttp and httpx, support the json response or file(bytes).
only support
requests
:pip install pydantic-client
support
aiohttp
andrequests
:pip install "pydantic-client[aiohttp]"
support
httpx(async)
andrequests
:pip install "pydantic-client[httpx]"
support all:
pip install "pydantic-client[all]"
from pydantic import BaseModel
from pydantic_client import delete, get, post, put, pydantic_client_manager
from pydantic_client import ClientConfig
class Book(BaseModel):
name: str
age: int
@pydantic_client_manager.register(
ClientConfig(
base_url="https://example.com",
headers={"Authorization": "Bearer abcdefg"},
timeout=10
)
)
class WebClient:
@get("/books/{book_id}?query={query}")
def get_book(self, book_id: int, query: str) -> Book:
...
@post("/books", form_body=True)
def create_book_form(self, book: Book) -> Book:
""" will post the form with book"""
...
@put("/books/{book_id}")
def change_book(self, book_id: int, book: Book) -> Book:
"""will put the json body"""
...
@delete("/books/{book_id}")
def change_book(self, book_id: int, request_headers: dict = None) -> Book:
...
client = pydantic_client_manager.get()
# will get the book with book_id=1
book: Book = client.get_book(1)
# request_headers will overwrite the headers in client_config
client.change_book(1, request_headers={"Authorization": "Bearer abcdefg"})
And see the examples.
Change Log
import aiohttp
from pydantic_client import ClientConfig, ClientType
client_config = ClientConfig(
client_type=ClientType.aiohttp,
base_url="https://example.com",
headers={"Authorization": "Bearer abcdefg"},
timeout=10,
session=lambda: aiohttp.ClientSession()
)
from pydantic_client.schema.file import File
from pydantic_client import post
@post("/download")
def download_file(self) -> File:
# you will get the bytes content of the file
...