テストクライアント - `TestClient`¶

TestClientクラスを使用すると、実際のHTTPおよびソケット接続を作成せずに、FastAPIアプリケーションをテストできます。FastAPIコードと直接通信するだけです。

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

from fastapi.testclient import TestClient

fastapi.testclient.TestClient ¶

TestClient(
    app,
    base_url="http://testserver",
    raise_server_exceptions=True,
    root_path="",
    backend="asyncio",
    backend_options=None,
    cookies=None,
    headers=None,
    follow_redirects=True,
)

ベースクラス: Client

パラメータ	説明
`app`	型: `ASGIApp`
`base_url`	型: `str` デフォルト: `'http://testserver'`
`raise_server_exceptions`	型: `bool` デフォルト: `True`
`root_path`	型: `str` デフォルト: `''`
`backend`	型: `Literal['asyncio', 'trio']` デフォルト: `'asyncio'`
`backend_options`	型: `dict[str, Any] \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`headers`	型: `dict[str, str] \| None` デフォルト: `None`
`follow_redirects`	型: `bool` デフォルト: `True`

ソースコード: starlette/testclient.py

def __init__(
    self,
    app: ASGIApp,
    base_url: str = "http://testserver",
    raise_server_exceptions: bool = True,
    root_path: str = "",
    backend: typing.Literal["asyncio", "trio"] = "asyncio",
    backend_options: dict[str, typing.Any] | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    headers: dict[str, str] | None = None,
    follow_redirects: bool = True,
) -> None:
    self.async_backend = _AsyncBackend(backend=backend, backend_options=backend_options or {})
    if _is_asgi3(app):
        asgi_app = app
    else:
        app = typing.cast(ASGI2App, app)  # type: ignore[assignment]
        asgi_app = _WrapASGI2(app)  # type: ignore[arg-type]
    self.app = asgi_app
    self.app_state: dict[str, typing.Any] = {}
    transport = _TestClientTransport(
        self.app,
        portal_factory=self._portal_factory,
        raise_server_exceptions=raise_server_exceptions,
        root_path=root_path,
        app_state=self.app_state,
    )
    if headers is None:
        headers = {}
    headers.setdefault("user-agent", "testclient")
    super().__init__(
        base_url=base_url,
        headers=headers,
        transport=transport,
        follow_redirects=follow_redirects,
        cookies=cookies,
    )

headers `プロパティ` `書き込み可能` ¶

headers

リクエスト送信時に含めるHTTPヘッダー。

follow_redirects `インスタンス属性` ¶

follow_redirects = follow_redirects

max_redirects `インスタンス属性` ¶

max_redirects = max_redirects

is_closed `プロパティ` ¶

is_closed

クライアントが閉じられているかどうかをチェックします。

trust_env `プロパティ` ¶

trust_env

timeout `プロパティ` `書き込み可能` ¶

timeout

event_hooks `プロパティ` `書き込み可能` ¶

event_hooks

auth `プロパティ` `書き込み可能` ¶

auth

リクエストレベルで何も渡されない場合に使用される認証クラス。

こちらも参照してください認証.

base_url `プロパティ` `書き込み可能` ¶

base_url

相対URLでリクエストを送信する際に使用する基本URL。

cookies `プロパティ` `書き込み可能` ¶

cookies

リクエスト送信時に含めるCookie値。

params `プロパティ` `書き込み可能` ¶

params

リクエスト送信時にURLに含めるクエリパラメータ。

task `インスタンス属性` ¶

task

portal `クラス属性` `インスタンス属性` ¶

portal = None

async_backend `インスタンス属性` ¶

async_backend = _AsyncBackend(
    backend=backend, backend_options=backend_options or {}
)

app `インスタンス属性` ¶

app = asgi_app

app_state `インスタンス属性` ¶

app_state = {}

build_request ¶

build_request(
    method,
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

リクエストインスタンスを構築して返します。

params、headers、cookies引数は、クライアントに設定されている値とマージされます。
url引数は、クライアントに設定されているbase_urlとマージされます。

こちらも参照してください: リクエストインスタンス

パラメータ	説明
`method`	型: `str`
`url`	型: `URLTypes`
`content`	型: `Optional[RequestContent]` デフォルト: `None`
`data`	型: `Optional[RequestData]` デフォルト: `None`
`files`	型: `Optional[RequestFiles]` デフォルト: `None`
`json`	型: `Optional[Any]` デフォルト: `None`
`params`	型: `Optional[QueryParamTypes]` デフォルト: `None`
`headers`	型: `Optional[HeaderTypes]` デフォルト: `None`
`cookies`	型: `Optional[CookieTypes]` デフォルト: `None`
`timeout`	型: `Union[TimeoutTypes, UseClientDefault]` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `Optional[RequestExtensions]` デフォルト: `None`

ソースコード: httpx/_client.py

def build_request(
    self,
    method: str,
    url: URLTypes,
    *,
    content: typing.Optional[RequestContent] = None,
    data: typing.Optional[RequestData] = None,
    files: typing.Optional[RequestFiles] = None,
    json: typing.Optional[typing.Any] = None,
    params: typing.Optional[QueryParamTypes] = None,
    headers: typing.Optional[HeaderTypes] = None,
    cookies: typing.Optional[CookieTypes] = None,
    timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
    extensions: typing.Optional[RequestExtensions] = None,
) -> Request:
    """
    Build and return a request instance.

    * The `params`, `headers` and `cookies` arguments
    are merged with any values set on the client.
    * The `url` argument is merged with any `base_url` set on the client.

    See also: [Request instances][0]

    [0]: /advanced/#request-instances
    """
    url = self._merge_url(url)
    headers = self._merge_headers(headers)
    cookies = self._merge_cookies(cookies)
    params = self._merge_queryparams(params)
    extensions = {} if extensions is None else extensions
    if "timeout" not in extensions:
        timeout = (
            self.timeout
            if isinstance(timeout, UseClientDefault)
            else Timeout(timeout)
        )
        extensions = dict(**extensions, timeout=timeout.as_dict())
    return Request(
        method,
        url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        extensions=extensions,
    )

stream ¶

stream(
    method,
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=USE_CLIENT_DEFAULT,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

一度にメモリに読み込むのではなく、レスポンスボディをストリーミングするhttpx.request()の代替手段です。

パラメータ: httpx.requestを参照してください。

こちらも参照してください: ストリーミングレスポンス

パラメータ	説明
`method`	型: `str`
`url`	型: `URLTypes`
`content`	型: `Optional[RequestContent]` デフォルト: `None`
`data`	型: `Optional[RequestData]` デフォルト: `None`
`files`	型: `Optional[RequestFiles]` デフォルト: `None`
`json`	型: `Optional[Any]` デフォルト: `None`
`params`	型: `Optional[QueryParamTypes]` デフォルト: `None`
`headers`	型: `Optional[HeaderTypes]` デフォルト: `None`
`cookies`	型: `Optional[CookieTypes]` デフォルト: `None`
`auth`	型: `Union[AuthTypes, UseClientDefault, None]` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `Union[bool, UseClientDefault]` デフォルト: `USE_CLIENT_DEFAULT`
`timeout`	型: `Union[TimeoutTypes, UseClientDefault]` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `Optional[RequestExtensions]` デフォルト: `None`

生成	説明
`レスポンス`

ソースコード: httpx/_client.py

@contextmanager
def stream(
    self,
    method: str,
    url: URLTypes,
    *,
    content: typing.Optional[RequestContent] = None,
    data: typing.Optional[RequestData] = None,
    files: typing.Optional[RequestFiles] = None,
    json: typing.Optional[typing.Any] = None,
    params: typing.Optional[QueryParamTypes] = None,
    headers: typing.Optional[HeaderTypes] = None,
    cookies: typing.Optional[CookieTypes] = None,
    auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
    follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
    timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
    extensions: typing.Optional[RequestExtensions] = None,
) -> typing.Iterator[Response]:
    """
    Alternative to `httpx.request()` that streams the response body
    instead of loading it into memory at once.

    **Parameters**: See `httpx.request`.

    See also: [Streaming Responses][0]

    [0]: /quickstart#streaming-responses
    """
    request = self.build_request(
        method=method,
        url=url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        timeout=timeout,
        extensions=extensions,
    )
    response = self.send(
        request=request,
        auth=auth,
        follow_redirects=follow_redirects,
        stream=True,
    )
    try:
        yield response
    finally:
        response.close()

send ¶

send(
    request,
    *,
    stream=False,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=USE_CLIENT_DEFAULT
)

リクエストを送信します。

リクエストは変更されずにそのまま送信されます。

通常はClient.build_request()を使用してリクエストを構築し、クライアントレベルの設定をリクエストにマージすることをお勧めしますが、明示的なhttpx.Request()を渡すこともサポートされています。

こちらも参照してください: リクエストインスタンス

パラメータ	説明
`request`	型: `Request`
`stream`	型: `bool` デフォルト: `False`
`auth`	型: `Union[AuthTypes, UseClientDefault, None]` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `Union[bool, UseClientDefault]` デフォルト: `USE_CLIENT_DEFAULT`

ソースコード: httpx/_client.py

def send(
    self,
    request: Request,
    *,
    stream: bool = False,
    auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
    follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
) -> Response:
    """
    Send a request.

    The request is sent as-is, unmodified.

    Typically you'll want to build one with `Client.build_request()`
    so that any client-level configuration is merged into the request,
    but passing an explicit `httpx.Request()` is supported as well.

    See also: [Request instances][0]

    [0]: /advanced/#request-instances
    """
    if self._state == ClientState.CLOSED:
        raise RuntimeError("Cannot send a request, as the client has been closed.")

    self._state = ClientState.OPENED
    follow_redirects = (
        self.follow_redirects
        if isinstance(follow_redirects, UseClientDefault)
        else follow_redirects
    )

    auth = self._build_request_auth(request, auth)

    response = self._send_handling_auth(
        request,
        auth=auth,
        follow_redirects=follow_redirects,
        history=[],
    )
    try:
        if not stream:
            response.read()

        return response

    except BaseException as exc:
        response.close()
        raise exc

close ¶

close()

トランスポートとプロキシを閉じます。

ソースコード: httpx/_client.py

def close(self) -> None:
    """
    Close transport and proxies.
    """
    if self._state != ClientState.CLOSED:
        self._state = ClientState.CLOSED

        self._transport.close()
        for transport in self._mounts.values():
            if transport is not None:
                transport.close()

request ¶

request(
    method,
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`method`	型: `str`
`url`	型: `URLTypes`
`content`	型: `RequestContent \| None` デフォルト: `None`
`data`	型: `_RequestData \| None` デフォルト: `None`
`files`	型: `RequestFiles \| None` デフォルト: `None`
`json`	型: `Any` デフォルト: `None`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def request(  # type: ignore[override]
    self,
    method: str,
    url: httpx._types.URLTypes,
    *,
    content: httpx._types.RequestContent | None = None,
    data: _RequestData | None = None,
    files: httpx._types.RequestFiles | None = None,
    json: typing.Any = None,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    url = self._merge_url(url)
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().request(
        method,
        url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

get ¶

get(
    url,
    *,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def get(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().get(
        url,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

options ¶

options(
    url,
    *,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def options(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().options(
        url,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

head ¶

head(
    url,
    *,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def head(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().head(
        url,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

post ¶

post(
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`content`	型: `RequestContent \| None` デフォルト: `None`
`data`	型: `_RequestData \| None` デフォルト: `None`
`files`	型: `RequestFiles \| None` デフォルト: `None`
`json`	型: `Any` デフォルト: `None`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def post(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    content: httpx._types.RequestContent | None = None,
    data: _RequestData | None = None,
    files: httpx._types.RequestFiles | None = None,
    json: typing.Any = None,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().post(
        url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

put ¶

put(
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`content`	型: `RequestContent \| None` デフォルト: `None`
`data`	型: `_RequestData \| None` デフォルト: `None`
`files`	型: `RequestFiles \| None` デフォルト: `None`
`json`	型: `Any` デフォルト: `None`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def put(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    content: httpx._types.RequestContent | None = None,
    data: _RequestData | None = None,
    files: httpx._types.RequestFiles | None = None,
    json: typing.Any = None,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().put(
        url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

patch ¶

patch(
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`content`	型: `RequestContent \| None` デフォルト: `None`
`data`	型: `_RequestData \| None` デフォルト: `None`
`files`	型: `RequestFiles \| None` デフォルト: `None`
`json`	型: `Any` デフォルト: `None`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def patch(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    content: httpx._types.RequestContent | None = None,
    data: _RequestData | None = None,
    files: httpx._types.RequestFiles | None = None,
    json: typing.Any = None,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().patch(
        url,
        content=content,
        data=data,
        files=files,
        json=json,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

delete ¶

delete(
    url,
    *,
    params=None,
    headers=None,
    cookies=None,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=None,
    allow_redirects=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None
)

パラメータ	説明
`url`	型: `URLTypes`
`params`	型: `QueryParamTypes \| None` デフォルト: `None`
`headers`	型: `HeaderTypes \| None` デフォルト: `None`
`cookies`	型: `CookieTypes \| None` デフォルト: `None`
`auth`	型: `AuthTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`follow_redirects`	型: `bool \| None` デフォルト: `None`
`allow_redirects`	型: `bool \| None` デフォルト: `None`
`timeout`	型: `TimeoutTypes \| UseClientDefault` デフォルト: `USE_CLIENT_DEFAULT`
`extensions`	型: `dict[str, Any] \| None` デフォルト: `None`

ソースコード: starlette/testclient.py

def delete(  # type: ignore[override]
    self,
    url: httpx._types.URLTypes,
    *,
    params: httpx._types.QueryParamTypes | None = None,
    headers: httpx._types.HeaderTypes | None = None,
    cookies: httpx._types.CookieTypes | None = None,
    auth: httpx._types.AuthTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    follow_redirects: bool | None = None,
    allow_redirects: bool | None = None,
    timeout: httpx._types.TimeoutTypes | httpx._client.UseClientDefault = httpx._client.USE_CLIENT_DEFAULT,
    extensions: dict[str, typing.Any] | None = None,
) -> httpx.Response:
    redirect = self._choose_redirect_arg(follow_redirects, allow_redirects)
    return super().delete(
        url,
        params=params,
        headers=headers,
        cookies=cookies,
        auth=auth,
        follow_redirects=redirect,
        timeout=timeout,
        extensions=extensions,
    )

websocket_connect ¶

websocket_connect(url, subprotocols=None, **kwargs)

パラメータ	説明
`url`	型: `str`
`subprotocols`	型: `Sequence[str] \| None` デフォルト: `None`
`**kwargs`	型: `Any` デフォルト: `{}`

ソースコード: starlette/testclient.py

def websocket_connect(
    self,
    url: str,
    subprotocols: typing.Sequence[str] | None = None,
    **kwargs: typing.Any,
) -> WebSocketTestSession:
    url = urljoin("ws://testserver", url)
    headers = kwargs.get("headers", {})
    headers.setdefault("connection", "upgrade")
    headers.setdefault("sec-websocket-key", "testserver==")
    headers.setdefault("sec-websocket-version", "13")
    if subprotocols is not None:
        headers.setdefault("sec-websocket-protocol", ", ".join(subprotocols))
    kwargs["headers"] = headers
    try:
        super().request("GET", url, **kwargs)
    except _Upgrade as exc:
        session = exc.session
    else:
        raise RuntimeError("Expected WebSocket upgrade")  # pragma: no cover

    return session

lifespan `非同期` ¶

lifespan()

ソースコード: starlette/testclient.py

async def lifespan(self) -> None:
    scope = {"type": "lifespan", "state": self.app_state}
    try:
        await self.app(scope, self.stream_receive.receive, self.stream_send.send)
    finally:
        await self.stream_send.send(None)

wait_startup `非同期` ¶

wait_startup()

ソースコード: starlette/testclient.py

async def wait_startup(self) -> None:
    await self.stream_receive.send({"type": "lifespan.startup"})

    async def receive() -> typing.Any:
        message = await self.stream_send.receive()
        if message is None:
            self.task.result()
        return message

    message = await receive()
    assert message["type"] in (
        "lifespan.startup.complete",
        "lifespan.startup.failed",
    )
    if message["type"] == "lifespan.startup.failed":
        await receive()

wait_shutdown `非同期` ¶

wait_shutdown()

ソースコード: starlette/testclient.py

async def wait_shutdown(self) -> None:
    async def receive() -> typing.Any:
        message = await self.stream_send.receive()
        if message is None:
            self.task.result()
        return message

    async with self.stream_send:
        await self.stream_receive.send({"type": "lifespan.shutdown"})
        message = await receive()
        assert message["type"] in (
            "lifespan.shutdown.complete",
            "lifespan.shutdown.failed",
        )
        if message["type"] == "lifespan.shutdown.failed":
            await receive()

テストクライアント - TestClient¶

fastapi.testclient.TestClient ¶

headers プロパティ 書き込み可能 ¶

follow_redirects インスタンス属性 ¶

max_redirects インスタンス属性 ¶

is_closed プロパティ ¶

trust_env プロパティ ¶

timeout プロパティ 書き込み可能 ¶

event_hooks プロパティ 書き込み可能 ¶

auth プロパティ 書き込み可能 ¶

base_url プロパティ 書き込み可能 ¶

cookies プロパティ 書き込み可能 ¶

params プロパティ 書き込み可能 ¶

task インスタンス属性 ¶

portal クラス属性 インスタンス属性 ¶

async_backend インスタンス属性 ¶

app インスタンス属性 ¶

app_state インスタンス属性 ¶

build_request ¶

stream ¶

send ¶

close ¶

request ¶

get ¶

options ¶

head ¶

post ¶

put ¶

patch ¶

delete ¶

websocket_connect ¶

lifespan 非同期 ¶

wait_startup 非同期 ¶

wait_shutdown 非同期 ¶

テストクライアント - `TestClient`¶

headers `プロパティ` `書き込み可能` ¶

follow_redirects `インスタンス属性` ¶

max_redirects `インスタンス属性` ¶

is_closed `プロパティ` ¶

trust_env `プロパティ` ¶

timeout `プロパティ` `書き込み可能` ¶

event_hooks `プロパティ` `書き込み可能` ¶

auth `プロパティ` `書き込み可能` ¶

base_url `プロパティ` `書き込み可能` ¶

cookies `プロパティ` `書き込み可能` ¶

params `プロパティ` `書き込み可能` ¶

task `インスタンス属性` ¶

portal `クラス属性` `インスタンス属性` ¶

async_backend `インスタンス属性` ¶

app `インスタンス属性` ¶

app_state `インスタンス属性` ¶

lifespan `非同期` ¶

wait_startup `非同期` ¶

wait_shutdown `非同期` ¶