HTTPConnection class

When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an HTTPConnection instead of a Request or a WebSocket.

You can import it from fastapi.requests:

from fastapi.requests import HTTPConnection

fastapi.requests.HTTPConnection

HTTPConnection(<span data-autorefs-optional="fastapi.requests.HTTPConnection(scope)">scope</span>, <span data-autorefs-optional="fastapi.requests.HTTPConnection(receive)">receive</span>=None)

Bases: Mapping[str, Any]

A base class for incoming HTTP connections, that is used to provide any functionality that is common to both Request and WebSocket.

PARAMETER	DESCRIPTION
scope	TYPE: Scope
receive	TYPE: Receive | None DEFAULT: None

Source code in starlette/requests.py

def __init__(self, scope: Scope, receive: Receive | None = None) -> None:
    assert scope["type"] in ("http", "websocket")
    self.scope = scope

scope instance-attribute

scope = scope

app property

app

url property

url

base_url property

base_url

headers property

headers

query_params property

query_params

path_params property

path_params

cookies property

cookies

client property

client

session property

session

auth property

auth

user property

user

state property

state

url_for

url_for(<span data-autorefs-optional="fastapi.requests.HTTPConnection.url_for(name)">name</span>, /, <span data-autorefs-optional="fastapi.requests.HTTPConnection.url_for(**path_params)">**path_params</span>)

PARAMETER	DESCRIPTION
name	TYPE: str
**path_params	TYPE: Any DEFAULT: {}

Source code in starlette/requests.py

def url_for(self, name: str, /, **path_params: typing.Any) -> URL:
    router: Router = self.scope["router"]
    url_path = router.url_path_for(name, **path_params)
    return url_path.make_absolute_url(base_url=self.base_url)