pydantic-client
Http client base pydantic, with requests, aiohttp and httpx.
Only support the json response.
If you like this project, please give me a star.
How to install
only support requests
:
pip install pydantic-client
support aiohttp
and requests
:
pip install "pydantic-client[aiohttp]"
support httpx(async)
and requests
:
pip install "pydantic-client[httpx]"
support all:
pip install "pydantic-client[all]"
How to use
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()
book: Book = client.get_book(1)
client.change_book(1, request_headers={"Authorization": "Bearer abcdefg"})
And see the examples.
Change Log
v1.0.3: you can define your own client session in client_config
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()
)
v1.0.5: support file response type.
from pydantic_client.schema.file import File
from pydantic_client import post
@post("/download")
def download_file(self) -> File:
...