Responses

Air uses custom response classes to improve the developer experience.

AirResponse

Bases: Response

Response class to handle air.tags.Tags or HTML (from Jinja2).

render

render(content)

Render Tag elements to bytes of HTML.

Source code in src/air/responses.py

def render(self, content: Any) -> bytes:
    """Render Tag elements to bytes of HTML."""
    if isinstance(content, str):
        return content.encode("utf-8")
    if isinstance(content, dict):
        content = dict_to_airtag(content)
    return content.render().encode("utf-8")

SSEResponse

Bases: StreamingResponse

Response class for Server Sent Events

Example:

# For tags
import random
from asyncio import sleep

import air

app = air.Air()


@app.page
def index():
    return air.layouts.mvpcss(
        air.Script(src="https://unpkg.com/htmx-ext-sse@2.2.1/sse.js"),
        air.Title("Server Sent Event Demo"),
        air.H1("Server Sent Event Demo"),
        air.P("Lottery number generator"),
        air.Section(
            hx_ext="sse",
            sse_connect="/lottery-numbers",
            hx_swap="beforeend show:bottom",
            sse_swap="message",
        ),
    )

async def lottery_generator():
    while True:
        lottery_numbers = ", ".join([str(random.randint(1, 40)) for x in range(6)])
        # Tags work seamlessly
        yield air.Aside(lottery_numbers)
        # As do strings. Non-strings are cast to strings via the str built-in
        yield "Hello, world"
        await sleep(1)


@app.get("/lottery-numbers")
async def get():
    return air.SSEResponse(lottery_generator())

TagResponse

Bases: Response

Response class to handle air.tags.Tags.

render

render(content)

Render Tag elements to bytes of HTML.

Source code in src/air/responses.py

def render(self, content: Any) -> bytes:
    """Render Tag elements to bytes of HTML."""
    if isinstance(content, dict):
        content = dict_to_airtag(content)
    return content.render().encode("utf-8")