Report PDFs in FastAPI

Why reports become PDFs

A report is a snapshot of numbers at a moment in time. Its whole value is that it does not change when the underlying dashboard does. That is the difference between a document and a view of a database, and it is why analytics, operations and account teams keep asking for this.

What a report has to carry

Before any of the code below matters, the template has to produce a document that is actually a report. These are the fields that make it one, and the ones a reader or an auditor will look for first.

• the reporting period as an explicit start and end date
• the generation timestamp, distinct from the period
• the data source or filter set, so a reader can tell what was excluded
• each metric with its unit, since a bare number is not a figure
• comparison against the prior period where the report claims a trend

Turning your Jinja2Templates template into a document

You already have the markup. Templates.get_template("invoice.html").render(context) gives you it as a string, which is the only input the render needs. TemplateResponse is for returning HTML to a browser. When the HTML is going to a renderer you want the string, so call the underlying Jinja template directly rather than unwrapping a Response you never send.

The FastAPI implementation

httpx is the client most projects here already have. The render happens in an async endpoint returning StreamingResponse, and you return StreamingResponse over the httpx byte iterator.

# routers/reports.py
import httpx
from fastapi import APIRouter, Depends
from fastapi.responses import StreamingResponse
from fastapi.templating import Jinja2Templates

router = APIRouter()
templates = Jinja2Templates(directory="templates")


@router.get("/reports/{report_id}.pdf")
async def report_pdf(report_id: int, db=Depends(get_db)):
    report = await db.get_report(report_id)

    # The template directly, not TemplateResponse: we want the string, and
    # TemplateResponse is for HTML you are actually sending to a browser.
    html = templates.get_template("report.html").render(report=report)

    client = httpx.AsyncClient(timeout=60.0)
    request = client.build_request(
        "POST",
        "https://api.pdfpipe.xyz/v1/pdf",
        headers={"Authorization": f"Bearer {settings.pdfpipe_key}"},
        json={"html": html, "options": {"format": "A4", "printBackground": True}},
    )
    upstream = await client.send(request, stream=True)
    upstream.raise_for_status()

    return StreamingResponse(
        upstream.aiter_bytes(),
        media_type="application/pdf",
        background=BackgroundTask(upstream.aclose),
    )

The CSS that makes a report page correctly

The layout problem specific to this document is that charts and tables must not split mid-element, and a report long enough to matter will page-break somewhere awkward unless break rules are set. These rules handle it.

/* Charts and tables must not split. Sections start on a fresh
   page so a heading never ends up alone at the foot of one. */
.chart, figure, table { break-inside: avoid; }
h2 { break-after: avoid; }
section { break-before: page; }
section:first-of-type { break-before: auto; }

@page { size: A4; margin: 20mm 18mm; }

What goes wrong in FastAPI

Calling a synchronous HTTP client inside an async def endpoint blocks the event loop for the whole render, which stalls every other request on that worker. Either use httpx.AsyncClient, or declare the endpoint def rather than async def so it runs in the threadpool.

What people try first

Most FastAPI projects reach for WeasyPrint called from a background task, which moves the memory cost off the request but not out of the process. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.

Where the report lives afterwards

Rendering is the short part. Reports pile up faster than any other document here because they are produced on a schedule whether or not anyone reads them. Most teams keep twelve months and expire the rest, which makes storage lifecycle a design decision rather than an afterthought.

Getting the document right

• Check the period the figures cover, because a report without an unambiguous date range is worse than no report.
• Generation is triggered by a schedule, usually month end or week end, so size the timeout for that path rather than for a health check.
• This is a batch shape: render the run through the batch endpoint rather than firing thousands of individual requests.
• Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.

Frequently asked

Related

Other FastAPI documents, and the same report in other stacks.