Skip to content

DependsHXRequest

Annotated type (dependency) for get_hx_request() for FastAPI.

get_hx_request()

FastAPI dependency that returns the current request if it is an HTMX one, i.e. it contains an "HX-Request: true" header.

Source code in fasthx/dependencies.py 
 6
 7
 8
 9
10
11
def get_hx_request(request: Request, hx_request: Annotated[str | None, Header()] = None) -> Request | None:
    """
    FastAPI dependency that returns the current request if it is an HTMX one,
    i.e. it contains an `"HX-Request: true"` header.
    """
    return request if hx_request == "true" else None