Requestクラス

パスオペレーション関数または依存関係で、パラメータをRequest型として宣言できます。その後、検証などを行わずに、生のリクエストオブジェクトに直接アクセスできます。

fastapiから直接インポートできます。

from fastapi import Request

ヒント

HTTPとWebSocketsの両方に対応する依存関係を定義する場合は、RequestまたはWebSocketの代わりにHTTPConnectionを受け取るパラメータを定義できます。

fastapi.Request

Request(scope, receive=empty_receive, send=empty_send)

ベース：HTTPConnection

パラメータ	説明
scope	型： Scope
receive	型： Receive デフォルト： empty_receive
send	型： Send デフォルト： empty_send

starlette/requests.pyのソースコード

def __init__(self, scope: Scope, receive: Receive = empty_receive, send: Send = empty_send):
    super().__init__(scope)
    assert scope["type"] == "http"
    self._receive = receive
    self._send = send
    self._stream_consumed = False
    self._is_disconnected = False
    self._form = None

scope インスタンス属性

scope = scope

app プロパティ

app

url プロパティ

url

base_url プロパティ

base_url

headers プロパティ

headers

query_params プロパティ

query_params

path_params プロパティ

path_params

cookies プロパティ

cookies

client プロパティ

client

session プロパティ

session

auth プロパティ

auth

user プロパティ

user

state プロパティ

state

method プロパティ

method

receive プロパティ

receive

url_for

url_for(name, /, **path_params)

パラメータ	説明
名前	型: str
**path_params**	型: Any デフォルト: {}

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)

stream 非同期

stream()

starlette/requests.pyのソースコード

async def stream(self) -> typing.AsyncGenerator[bytes, None]:
    if hasattr(self, "_body"):
        yield self._body
        yield b""
        return
    if self._stream_consumed:
        raise RuntimeError("Stream consumed")
    while not self._stream_consumed:
        message = await self._receive()
        if message["type"] == "http.request":
            body = message.get("body", b"")
            if not message.get("more_body", False):
                self._stream_consumed = True
            if body:
                yield body
        elif message["type"] == "http.disconnect":
            self._is_disconnected = True
            raise ClientDisconnect()
    yield b""

body 非同期

body()

starlette/requests.pyのソースコード

async def body(self) -> bytes:
    if not hasattr(self, "_body"):
        chunks: list[bytes] = []
        async for chunk in self.stream():
            chunks.append(chunk)
        self._body = b"".join(chunks)
    return self._body

json 非同期

json()

starlette/requests.pyのソースコード

async def json(self) -> typing.Any:
    if not hasattr(self, "_json"):
        body = await self.body()
        self._json = json.loads(body)
    return self._json

form

form(*, max_files=1000, max_fields=1000)

パラメータ	説明
最大ファイル数	型: int | float デフォルト: 1000
最大フィールド数	型: int | float デフォルト: 1000

starlette/requests.pyのソースコード

def form(
    self, *, max_files: int | float = 1000, max_fields: int | float = 1000
) -> AwaitableOrContextManager[FormData]:
    return AwaitableOrContextManagerWrapper(self._get_form(max_files=max_files, max_fields=max_fields))

close 非同期

close()

starlette/requests.pyのソースコード

async def close(self) -> None:
    if self._form is not None:
        await self._form.close()

is_disconnected 非同期

is_disconnected()

starlette/requests.pyのソースコード

async def is_disconnected(self) -> bool:
    if not self._is_disconnected:
        message: Message = {}

        # If message isn't immediately available, move on
        with anyio.CancelScope() as cs:
            cs.cancel()
            message = await self._receive()

        if message.get("type") == "http.disconnect":
            self._is_disconnected = True

    return self._is_disconnected

send_push_promise 非同期

send_push_promise(path)

パラメータ	説明
パス	型: str

starlette/requests.pyのソースコード

async def send_push_promise(self, path: str) -> None:
    if "http.response.push" in self.scope.get("extensions", {}):
        raw_headers: list[tuple[bytes, bytes]] = []
        for name in SERVER_PUSH_HEADERS_TO_COPY:
            for value in self.headers.getlist(name):
                raw_headers.append((name.encode("latin-1"), value.encode("latin-1")))
        await self._send({"type": "http.response.push", "path": path, "headers": raw_headers})