Generic API client based on Pydantic
Project description
Combadge
Combadge generates a service client implementation from a user service interface declared by a protocol class or an abstract base class.
Features
- Request and response models based on pydantic
- Declarative services using
Protocol
- Exception classes automatically derived from error models
- Built-in 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.0b9.tar.gz
(21.0 kB
view hashes)
Built Distribution
combadge-0.1.0b9-py3-none-any.whl
(32.1 kB
view hashes)
Close
Hashes for combadge-0.1.0b9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 033bc4696fb68b65a340219dc1fc9f639a54268d64a537dfc2641c3568ee2829 |
|
MD5 | 1e4f03580963b0c58c637615416950b0 |
|
BLAKE2b-256 | 833552836447cbe7e1807a5a3a611fb5d714b33907a86daaecc9b5bccd9705b3 |