Test Client¶
Esmerald offers an extension of the Lilya TestClient
called EsmeraldTestClient
as well
as a create_client
that can be used for context testing.
from esmerald.testclient import EsmeraldTestClient
esmerald.testclient.EsmeraldTestClient
¶
EsmeraldTestClient(app, base_url='http://testserver', raise_server_exceptions=True, root_path='', backend='asyncio', backend_options=None, cookies=None, headers=None)
Bases: TestClient
PARAMETER | DESCRIPTION |
---|---|
app |
TYPE:
|
base_url |
TYPE:
|
raise_server_exceptions |
TYPE:
|
root_path |
TYPE:
|
backend |
TYPE:
|
backend_options |
TYPE:
|
cookies |
TYPE:
|
headers |
TYPE:
|
Source code in esmerald/testclient.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
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 .venv/lib/python3.8/site-packages/httpx/_client.py
319 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 |
|
request
¶
request(method, url, *, content=None, data=None, files=None, json=None, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.py
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
|
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 .venv/lib/python3.8/site-packages/httpx/_client.py
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 867 868 869 870 871 872 873 874 875 876 877 878 879 |
|
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 .venv/lib/python3.8/site-packages/httpx/_client.py
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 916 917 918 919 920 921 922 923 924 925 926 927 928 |
|
get
¶
get(url, *, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.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 578 579 580 581 |
|
options
¶
options(url, *, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.py
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 |
|
head
¶
head(url, *, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.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 |
|
post
¶
post(url, *, content=None, data=None, files=None, json=None, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.py
641 642 643 644 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 |
|
put
¶
put(url, *, content=None, data=None, files=None, json=None, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.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 702 703 704 705 706 707 708 709 710 711 712 713 |
|
patch
¶
patch(url, *, content=None, data=None, files=None, json=None, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.py
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 |
|
delete
¶
delete(url, *, params=None, headers=None, cookies=None, auth=httpx._client.USE_CLIENT_DEFAULT, follow_redirects=None, allow_redirects=None, timeout=httpx._client.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 .venv/lib/python3.8/site-packages/lilya/testclient/base.py
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 |
|
close
¶
close()
Close transport and proxies.
Source code in .venv/lib/python3.8/site-packages/httpx/_client.py
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 |
|
websocket_connect
¶
websocket_connect(url, subprotocols=None, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
url |
TYPE:
|
subprotocols |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.8/site-packages/lilya/testclient/base.py
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 |
|
lifespan
async
¶
lifespan()
Source code in .venv/lib/python3.8/site-packages/lilya/testclient/base.py
836 837 838 839 840 841 |
|
wait_startup
async
¶
wait_startup()
Source code in .venv/lib/python3.8/site-packages/lilya/testclient/base.py
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 |
|
wait_shutdown
async
¶
wait_shutdown()
Source code in .venv/lib/python3.8/site-packages/lilya/testclient/base.py
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
|
from esmerald.testclient import create_client
You can learn more how to use it in the documentation.
esmerald.testclient.create_client
¶
create_client(routes, *, settings_module=None, debug=None, app_name=None, title=None, version=None, summary=None, description=None, contact=None, terms_of_service=None, license=None, security=None, servers=None, secret_key=get_random_secret_key(), allowed_hosts=None, allow_origins=None, base_url='http://testserver', backend='asyncio', backend_options=None, interceptors=None, pluggables=None, permissions=None, dependencies=None, middleware=None, csrf_config=None, exception_handlers=None, openapi_config=None, on_shutdown=None, on_startup=None, cors_config=None, session_config=None, scheduler_class=None, scheduler_tasks=None, scheduler_configurations=None, enable_scheduler=None, enable_openapi=True, include_in_schema=True, openapi_version='3.1.0', raise_server_exceptions=True, root_path='', static_files_config=None, template_config=None, lifespan=None, cookies=None, redirect_slashes=None, tags=None, webhooks=None)
PARAMETER | DESCRIPTION |
---|---|
routes |
TYPE:
|
settings_module |
TYPE:
|
debug |
TYPE:
|
app_name |
TYPE:
|
title |
TYPE:
|
version |
TYPE:
|
summary |
TYPE:
|
description |
TYPE:
|
contact |
TYPE:
|
terms_of_service |
TYPE:
|
license |
TYPE:
|
security |
TYPE:
|
servers |
TYPE:
|
secret_key |
TYPE:
|
allowed_hosts |
TYPE:
|
allow_origins |
TYPE:
|
base_url |
TYPE:
|
backend |
TYPE:
|
backend_options |
TYPE:
|
interceptors |
TYPE:
|
pluggables |
TYPE:
|
permissions |
TYPE:
|
dependencies |
TYPE:
|
middleware |
TYPE:
|
csrf_config |
TYPE:
|
exception_handlers |
TYPE:
|
openapi_config |
TYPE:
|
on_shutdown |
TYPE:
|
on_startup |
TYPE:
|
cors_config |
TYPE:
|
session_config |
TYPE:
|
scheduler_class |
TYPE:
|
scheduler_tasks |
TYPE:
|
scheduler_configurations |
TYPE:
|
enable_scheduler |
TYPE:
|
enable_openapi |
TYPE:
|
include_in_schema |
TYPE:
|
openapi_version |
TYPE:
|
raise_server_exceptions |
TYPE:
|
root_path |
TYPE:
|
static_files_config |
TYPE:
|
template_config |
TYPE:
|
lifespan |
TYPE:
|
cookies |
TYPE:
|
redirect_slashes |
TYPE:
|
tags |
TYPE:
|
webhooks |
TYPE:
|
Source code in esmerald/testclient.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|