spacs 0.0.5

Simple Pydantic AIOHTTP Client Sessions

SPACS: Simple Pydantic AIOHTTP Client Sessions

A package to assist in managing and using long-lived AIOHTTP client sessions with simplicity. Built to handle Pydantic objects.

Features

• Handles request params and bodies as either Pydantic objects or native Python dictionaries, converting items to JSON-safe format.
• Abstracts away internals of managing the request/response objects, instead either returning parsed response content on success, or raising a specialized error object.
• Automatically manages persistent connections to be shared over extended lifespan across application, cleaning up all open connections on teardown.
• Utilizes modern Python type hinting.

Installation

Using poetry (preferred):

poetry add spacs

Using pip:

pip install spacs

Usage

from spacs import SpacsClient, SpacsRequest, SpacsRequestError
from pydantic import BaseModel

...

example_client = SpacsClient(base_url="http://example.com")

# Basic request with error handling
try:
    request = SpacsRequest(path="/fruit/apple", params={"cultivar": "honeycrisp"})
    apples = await example_client.get(request)
except SpacsRequestError as error:
    print({"code": error.status_code, "reason": error.reason})

# Sending Pydantic objects via HTTP POST
class MyModel(BaseModel):
    name: str
    age: int

example_object = MyModel(name="James", age=25)
request = SpacsRequest(path="/person", body=example_object, response_model=MyModel)
created_person = await example_client.post(request)

# Manually closing a session
await example_client.close()
# Alternatively, to close all open sessions:
await SpacsClient.close_all()

Building

poetry build