Generic API client based on Pydantic
Project description
Combadge
📻 Application to the service, please respond!
Features
- Pydantic-based request and response models
- Automatically derived exception classes
- Using Protocols to define service classes
- Built-in backends:
- Pluggable backends
Documentation
🚀 Quick example
from http import HTTPStatus
from typing import List
from httpx import Client
from pydantic import BaseModel, Field
from typing_extensions import Annotated, Protocol
from combadge.core.binder import bind
from combadge.support.http.aliases import StatusCode
from combadge.support.http.markers import QueryParam, http_method, path
from combadge.support.httpx.backends.sync import HttpxBackend
# 1️⃣ Declare the response models:
class CurrentCondition(BaseModel):
humidity: int
temperature: Annotated[float, Field(alias="temp_C")]
class Weather(BaseModel):
status: StatusCode[HTTPStatus]
current: Annotated[List[CurrentCondition], Field(alias="current_condition")]
# 2️⃣ Declare the protocol:
class SupportsWttrIn(Protocol):
@http_method("GET")
@path("/{in_}")
def get_weather(
self,
*,
in_: str,
format_: Annotated[str, QueryParam("format")] = "j1",
) -> Weather:
raise NotImplementedError
# 3️⃣ Bind the service:
backend = HttpxBackend(Client(base_url="https://wttr.in"))
service = bind(SupportsWttrIn, backend)
# 🚀 Call the service:
response = service.get_weather(in_="amsterdam")
assert response.status == HTTPStatus.OK
assert response.current[0].humidity == 71
assert response.current[0].temperature == 8.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
combadge-0.1.0b3.tar.gz
(20.2 kB
view hashes)
Built Distribution
combadge-0.1.0b3-py3-none-any.whl
(31.2 kB
view hashes)
Close
Hashes for combadge-0.1.0b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31f326261da52681fba62f59cd70f79227702646cd7c031065b08b8015af4942 |
|
MD5 | 846d997fd8fd2bf232167c8898bd9f1e |
|
BLAKE2b-256 | bda28c0679ffa0671b60984a1231ebcb3cd36548eaf00e3bec082cd4f0c08649 |