`HTTPConnection` class ¶

When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes anHTTPConnection instead of aRequest or aWebSocket.

You can import it fromfastapi.requests:

fromfastapi.requestsimportHTTPConnection

fastapi.requests.HTTPConnection¶

HTTPConnection(scope,receive=None)

Bases:Mapping[str,Any],Generic[StateT]

A base class for incoming HTTP connections, that is used to provideany functionality that is common to bothRequest andWebSocket.

Source code instarlette/requests.py

def__init__(self,scope:Scope,receive:Receive|None=None)->None:assertscope["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(name,/,**path_params)

Source code instarlette/requests.py

192193194195196197

defurl_for(self,name:str,/,**path_params:Any)->URL:url_path_provider:Router|Starlette|None=self.scope.get("router")orself.scope.get("app")ifurl_path_providerisNone:raiseRuntimeError("The `url_for` method can only be used inside a Starlette application or with a router.")url_path=url_path_provider.url_path_for(name,**path_params)returnurl_path.make_absolute_url(base_url=self.base_url)

Movatterモバイル変換

HTTPConnection class¶

fastapi.requests.HTTPConnection¶

scopeinstance-attribute¶

appproperty¶

urlproperty¶

base_urlproperty¶

headersproperty¶

query_paramsproperty¶

path_paramsproperty¶

cookiesproperty¶

clientproperty¶

sessionproperty¶

authproperty¶

userproperty¶

stateproperty¶