Перейти к содержанию

Test Client - TestClient

You can use the TestClient class to test FastAPI applications without creating an actual HTTP and socket connection, just communicating directly with the FastAPI code.

Read more about it in the FastAPI docs for Testing.

You can import it directly from fastapi.testclient:

from fastapi.testclient import TestClient

fastapi.testclient.TestClient 

TestClient(<span data-autorefs-optional="fastapi.testclient.TestClient(app)">app</span>, <span data-autorefs-optional="fastapi.testclient.TestClient(base_url)">base_url</span>='http://testserver', <span data-autorefs-optional="fastapi.testclient.TestClient(raise_server_exceptions)">raise_server_exceptions</span>=True, <span data-autorefs-optional="fastapi.testclient.TestClient(root_path)">root_path</span>='', <span data-autorefs-optional="fastapi.testclient.TestClient(backend)">backend</span>='asyncio', <span data-autorefs-optional="fastapi.testclient.TestClient(backend_options)">backend_options</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient(follow_redirects)">follow_redirects</span>=True)

Bases: Client

PARAMETER DESCRIPTION
app

TYPE: ASGIApp

base_url

TYPE: str DEFAULT: 'http://testserver'

raise_server_exceptions

TYPE: bool DEFAULT: True

root_path

TYPE: str DEFAULT: ''

backend

TYPE: Literal['asyncio', 'trio'] DEFAULT: 'asyncio'

backend_options

TYPE: dict[str, Any] | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

headers

TYPE: dict[str, str] | None DEFAULT: None

follow_redirects

TYPE: bool DEFAULT: True

Source code in starlette/testclient.py 
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
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__(
        app=self.app,
        base_url=base_url,
        headers=headers,
        transport=transport,
        follow_redirects=follow_redirects,
        cookies=cookies,
    )

headers property writable 

headers

HTTP headers to include when sending requests.

follow_redirects instance-attribute 

follow_redirects = follow_redirects

max_redirects instance-attribute 

max_redirects = max_redirects

is_closed property 

is_closed

Check if the client being closed

trust_env property 

trust_env

timeout property writable 

timeout

event_hooks property writable 

event_hooks

auth property writable 

auth

Authentication class used when none is passed at the request-level.

See also Authentication.

base_url property writable 

base_url

Base URL to use when sending requests with relative URLs.

cookies property writable 

cookies

Cookie values to include when sending requests.

params property writable 

params

Query parameters to include in the URL when sending requests.

task instance-attribute 

task

portal class-attribute instance-attribute 

portal = None

async_backend instance-attribute 

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

app instance-attribute 

app = asgi_app

app_state instance-attribute 

app_state = {}

build_request 

build_request(<span data-autorefs-optional="fastapi.testclient.TestClient.build_request(method)">method</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.build_request(extensions)">extensions</span>=None)

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

PARAMETER DESCRIPTION
method

TYPE: str

url

TYPE: URLTypes

content

TYPE: Optional[RequestContent] DEFAULT: None

data

TYPE: Optional[RequestData] DEFAULT: None

files

TYPE: Optional[RequestFiles] DEFAULT: None

json

TYPE: Optional[Any] DEFAULT: None

params

TYPE: Optional[QueryParamTypes] DEFAULT: None

headers

TYPE: Optional[HeaderTypes] DEFAULT: None

cookies

TYPE: Optional[CookieTypes] DEFAULT: None

timeout

TYPE: Union[TimeoutTypes, UseClientDefault] DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: Optional[RequestExtensions] DEFAULT: None

Source code in httpx/_client.py 
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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(<span data-autorefs-optional="fastapi.testclient.TestClient.stream(method)">method</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(follow_redirects)">follow_redirects</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.stream(extensions)">extensions</span>=None)

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

PARAMETER DESCRIPTION
method

TYPE: str

url

TYPE: URLTypes

content

TYPE: Optional[RequestContent] DEFAULT: None

data

TYPE: Optional[RequestData] DEFAULT: None

files

TYPE: Optional[RequestFiles] DEFAULT: None

json

TYPE: Optional[Any] DEFAULT: None

params

TYPE: Optional[QueryParamTypes] DEFAULT: None

headers

TYPE: Optional[HeaderTypes] DEFAULT: None

cookies

TYPE: Optional[CookieTypes] DEFAULT: None

auth

TYPE: Union[AuthTypes, UseClientDefault, None] DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: Union[bool, UseClientDefault] DEFAULT: USE_CLIENT_DEFAULT

timeout

TYPE: Union[TimeoutTypes, UseClientDefault] DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: Optional[RequestExtensions] DEFAULT: None

YIELDS DESCRIPTION
Response
Source code in httpx/_client.py 
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
@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(<span data-autorefs-optional="fastapi.testclient.TestClient.send(request)">request</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.send(stream)">stream</span>=False, <span data-autorefs-optional="fastapi.testclient.TestClient.send(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.send(follow_redirects)">follow_redirects</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>)

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

PARAMETER DESCRIPTION
request

TYPE: Request

stream

TYPE: bool DEFAULT: False

auth

TYPE: Union[AuthTypes, UseClientDefault, None] DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: Union[bool, UseClientDefault] DEFAULT: USE_CLIENT_DEFAULT

Source code in httpx/_client.py 
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
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()

Close transport and proxies.

Source code in httpx/_client.py 
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
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(<span data-autorefs-optional="fastapi.testclient.TestClient.request(method)">method</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.request(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.request(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.request(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.request(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.request(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
method

TYPE: str

url

TYPE: URLTypes

content

TYPE: RequestContent | None DEFAULT: None

data

TYPE: _RequestData | None DEFAULT: None

files

TYPE: RequestFiles | None DEFAULT: None

json

TYPE: Any DEFAULT: None

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
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(<span data-autorefs-optional="fastapi.testclient.TestClient.get(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.get(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.get(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.get(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.get(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.get(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.get(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.get(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.get(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
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(<span data-autorefs-optional="fastapi.testclient.TestClient.options(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.options(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.options(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.options(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.options(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.options(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.options(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.options(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.options(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
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(<span data-autorefs-optional="fastapi.testclient.TestClient.head(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.head(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.head(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.head(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.head(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.head(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.head(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.head(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.head(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
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(<span data-autorefs-optional="fastapi.testclient.TestClient.post(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.post(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.post(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.post(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.post(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

content

TYPE: RequestContent | None DEFAULT: None

data

TYPE: _RequestData | None DEFAULT: None

files

TYPE: RequestFiles | None DEFAULT: None

json

TYPE: Any DEFAULT: None

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
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(<span data-autorefs-optional="fastapi.testclient.TestClient.put(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.put(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.put(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.put(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.put(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

content

TYPE: RequestContent | None DEFAULT: None

data

TYPE: _RequestData | None DEFAULT: None

files

TYPE: RequestFiles | None DEFAULT: None

json

TYPE: Any DEFAULT: None

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
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(<span data-autorefs-optional="fastapi.testclient.TestClient.patch(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(content)">content</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(data)">data</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(files)">files</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(json)">json</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.patch(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

content

TYPE: RequestContent | None DEFAULT: None

data

TYPE: _RequestData | None DEFAULT: None

files

TYPE: RequestFiles | None DEFAULT: None

json

TYPE: Any DEFAULT: None

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
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(<span data-autorefs-optional="fastapi.testclient.TestClient.delete(url)">url</span>, *, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(params)">params</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(headers)">headers</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(cookies)">cookies</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(auth)">auth</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(follow_redirects)">follow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(allow_redirects)">allow_redirects</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(timeout)">timeout</span>=<span data-autorefs-optional-hover="httpx._client.USE_CLIENT_DEFAULT">USE_CLIENT_DEFAULT</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.delete(extensions)">extensions</span>=None)
PARAMETER DESCRIPTION
url

TYPE: URLTypes

params

TYPE: QueryParamTypes | None DEFAULT: None

headers

TYPE: HeaderTypes | None DEFAULT: None

cookies

TYPE: CookieTypes | None DEFAULT: None

auth

TYPE: AuthTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

follow_redirects

TYPE: bool | None DEFAULT: None

allow_redirects

TYPE: bool | None DEFAULT: None

timeout

TYPE: TimeoutTypes | UseClientDefault DEFAULT: USE_CLIENT_DEFAULT

extensions

TYPE: dict[str, Any] | None DEFAULT: None

Source code in starlette/testclient.py 
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
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(<span data-autorefs-optional="fastapi.testclient.TestClient.websocket_connect(url)">url</span>, <span data-autorefs-optional="fastapi.testclient.TestClient.websocket_connect(subprotocols)">subprotocols</span>=None, <span data-autorefs-optional="fastapi.testclient.TestClient.websocket_connect(**kwargs)">**kwargs</span>)
PARAMETER DESCRIPTION
url

TYPE: str

subprotocols

TYPE: Sequence[str] | None DEFAULT: None

**kwargs

TYPE: Any DEFAULT: {}

Source code in starlette/testclient.py 
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
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 async 

lifespan()
Source code in starlette/testclient.py 
775
776
777
778
779
780
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 async 

wait_startup()
Source code in starlette/testclient.py 
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
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 async 

wait_shutdown()
Source code in starlette/testclient.py 
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
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()