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(
app,
base_url="http://testserver",
raise_server_exceptions=True,
root_path="",
backend="asyncio",
backend_options=None,
cookies=None,
headers=None,
follow_redirects=True,
)
Bases: Client
PARAMETER | DESCRIPTION |
---|---|
app
|
TYPE:
|
base_url
|
TYPE:
|
raise_server_exceptions
|
TYPE:
|
root_path
|
TYPE:
|
backend
|
TYPE:
|
backend_options
|
TYPE:
|
cookies
|
TYPE:
|
headers
|
TYPE:
|
follow_redirects
|
TYPE:
|
Source code in starlette/testclient.py
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 437 438 439 440 441 442 |
|
auth
property
writable
¶
auth
Authentication class used when none is passed at the request-level.
See also Authentication.
async_backend
instance-attribute
¶
async_backend = _AsyncBackend(
backend=backend, backend_options=backend_options or {}
)
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
)
Build and return a request instance.
- The
params
,headers
andcookies
arguments are merged with any values set on the client. - The
url
argument is merged with anybase_url
set on the client.
See also: Request instances
PARAMETER | DESCRIPTION |
---|---|
method
|
TYPE:
|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
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 |
|
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
)
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:
|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
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 |
|
send
¶
send(
request,
*,
stream=False,
auth=USE_CLIENT_DEFAULT,
follow_redirects=USE_CLIENT_DEFAULT
)
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:
|
stream
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
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 |
|
close
¶
close()
Close transport and proxies.
Source code in httpx/_client.py
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
method
|
TYPE:
|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
468 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 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
content
|
TYPE:
|
data
|
TYPE:
|
files
|
TYPE:
|
json
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 |
|
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
)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
params
|
TYPE:
|
headers
|
TYPE:
|
cookies
|
TYPE:
|
auth
|
TYPE:
|
follow_redirects
|
TYPE:
|
allow_redirects
|
TYPE:
|
timeout
|
TYPE:
|
extensions
|
TYPE:
|
Source code in starlette/testclient.py
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
|
websocket_connect
¶
websocket_connect(url, subprotocols=None, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
url
|
TYPE:
|
subprotocols
|
TYPE:
|
**kwargs
|
TYPE:
|
Source code in starlette/testclient.py
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
|
lifespan
async
¶
lifespan()
Source code in starlette/testclient.py
756 757 758 759 760 761 |
|
wait_startup
async
¶
wait_startup()
Source code in starlette/testclient.py
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 |
|
wait_shutdown
async
¶
wait_shutdown()
Source code in starlette/testclient.py
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 |
|