Undocumented
Method | __init__ |
Undocumented |
Method | auth.setter |
Undocumented |
Method | base_url.setter |
Undocumented |
Method | build_request |
Build and return a request instance. |
Method | cookies.setter |
Undocumented |
Method | event_hooks.setter |
Undocumented |
Method | headers.setter |
Undocumented |
Method | params.setter |
Undocumented |
Method | timeout.setter |
Undocumented |
Instance Variable | follow_redirects |
Undocumented |
Instance Variable | max_redirects |
Undocumented |
Property | auth |
Authentication class used when none is passed at the request-level. |
Property | base_url |
Base URL to use when sending requests with relative URLs. |
Property | cookies |
Cookie values to include when sending requests. |
Property | event_hooks |
Undocumented |
Property | headers |
HTTP headers to include when sending requests. |
Property | is_closed |
Check if the client being closed |
Property | params |
Query parameters to include in the URL when sending requests. |
Property | timeout |
Undocumented |
Property | trust_env |
Undocumented |
Method | _build_auth |
Undocumented |
Method | _build_redirect_request |
Given a request and a redirect response, return a new request that should be used to effect the redirect. |
Method | _build_request_auth |
Undocumented |
Method | _enforce_trailing_slash |
Undocumented |
Method | _get_proxy_map |
Undocumented |
Method | _merge_cookies |
Merge a cookies argument together with any cookies on the client, to create the cookies used for the outgoing request. |
Method | _merge_headers |
Merge a headers argument together with any headers on the client, to create the headers used for the outgoing request. |
Method | _merge_queryparams |
Merge a queryparams argument together with any queryparams on the client, to create the queryparams used for the outgoing request. |
Method | _merge_url |
Merge a URL argument together with any 'base_url' on the client, to create the URL used for the outgoing request. |
Method | _redirect_headers |
Return the headers that should be used for the redirect request. |
Method | _redirect_method |
When being redirected we may want to change the method of the request based on certain specs or browser behavior. |
Method | _redirect_stream |
Return the body that should be used for the redirect request. |
Method | _redirect_url |
Return the URL for the redirect to follow. |
Instance Variable | _auth |
Undocumented |
Instance Variable | _base_url |
Undocumented |
Instance Variable | _cookies |
Undocumented |
Instance Variable | _event_hooks |
Undocumented |
Instance Variable | _headers |
Undocumented |
Instance Variable | _netrc |
Undocumented |
Instance Variable | _params |
Undocumented |
Instance Variable | _state |
Undocumented |
Instance Variable | _timeout |
Undocumented |
Instance Variable | _trust_env |
Undocumented |
httpx.AsyncClient
, httpx.Client
Undocumented
Parameters | |
auth:AuthTypes | Undocumented |
params:QueryParamTypes | Undocumented |
headers:HeaderTypes | Undocumented |
cookies:CookieTypes | Undocumented |
timeout:TimeoutTypes | Undocumented |
follow_redirects:bool | Undocumented |
max_redirects:int | Undocumented |
event_hooks:typing.Mapping[ | Undocumented |
base_url:URLTypes | Undocumented |
trust_env:bool | Undocumented |
Build and return a request instance.
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
Parameters | |
method:str | Undocumented |
url:URLTypes | Undocumented |
content:RequestContent | Undocumented |
data:RequestData | Undocumented |
files:RequestFiles | Undocumented |
json:typing.Any | Undocumented |
params:QueryParamTypes | Undocumented |
headers:HeaderTypes | Undocumented |
cookies:CookieTypes | Undocumented |
timeout:typing.Union[ | Undocumented |
extensions:dict | Undocumented |
Returns | |
Request | Undocumented |
typing.Optional[ Auth]
=
Authentication class used when none is passed at the request-level.
See also [Authentication][0].
[0]: /quickstart/#authentication
Undocumented
Parameters | |
auth:AuthTypes | Undocumented |
Returns | |
typing.Optional[ | Undocumented |
Parameters | |
request:Request | Undocumented |
response:Response | Undocumented |
Returns | |
Request | Undocumented |
Undocumented
Parameters | |
request:Request | Undocumented |
auth:typing.Union[ | Undocumented |
Returns | |
Auth | Undocumented |
Undocumented
Parameters | |
url:URL | Undocumented |
Returns | |
URL | Undocumented |
Undocumented
Parameters | |
proxies:typing.Optional[ | Undocumented |
allow_env_proxies:bool | Undocumented |
Returns | |
typing.Dict[ | Undocumented |
Parameters | |
cookies:CookieTypes | Undocumented |
Returns | |
typing.Optional[ | Undocumented |
Parameters | |
headers:HeaderTypes | Undocumented |
Returns | |
typing.Optional[ | Undocumented |
Parameters | |
params:QueryParamTypes | Undocumented |
Returns | |
typing.Optional[ | Undocumented |
Parameters | |
url:URLTypes | Undocumented |
Returns | |
URL | Undocumented |
Parameters | |
request:Request | Undocumented |
url:URL | Undocumented |
method:str | Undocumented |
Returns | |
Headers | Undocumented |
Parameters | |
request:Request | Undocumented |
response:Response | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
request:Request | Undocumented |
method:str | Undocumented |
Returns | |
typing.Optional[ | Undocumented |