HTTP requests (Effect's HttpClientRequest): immutable values a client
executes.
Build one with get / post / ... and refine it with its methods,
each giving a new request::
request = (
post("https://api.example.com/todos", accept_json=True)
.bearer_token(token)
.body_json_unsafe({"title": "write docs"})
)The URL stays as written; url_params and hash are added to it when
the request is sent (to_url).
Values#
| Attribute | Type | Description |
|---|---|---|
EMPTY | HttpClientRequest |
Types#
| Type | Definition | Description |
|---|---|---|
UrlInput | type UrlInput = str | _url.Url | |
CompressionAlgorithm | type CompressionAlgorithm = Literal['gzip', 'deflate'] |
Classes#
Functions#
from_web#
from_web(request) -> HttpClientRequestA client request sending what request received (Effect's
HttpClientRequest.fromWeb): its method (an extension method such as
PROPFIND kept), URL, headers, and its body as a Raw body with
the received content-type and a valid content-length.
| Parameter | Type | Description |
|---|---|---|
request | WebRequest |
Returns HttpClientRequest
def from_web(request: WebRequest) -> HttpClientRequest:
"""A client request sending what ``request`` received (Effect's
``HttpClientRequest.fromWeb``): its method (an extension method such as
``PROPFIND`` kept), URL, headers, and its body as a ``Raw`` body with
the received ``content-type`` and a valid ``content-length``."""
match _url.from_string(request.url):
case Ok(url):
target: UrlInput = url
case _:
target = request.url
base = HttpClientRequest(request.method, "", _params.EMPTY, None, EMPTY_HEADERS, _body.EMPTY)
return base.set_url(target).set_headers(request.headers).set_body(_web_body(request))make#
make(method, url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
method | HttpMethod | |
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def make(method: HttpMethod, url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return EMPTY.modify(method=method, url=url, **options)get#
get(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def get(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("GET", url, **options)post#
post(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def post(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("POST", url, **options)put#
put(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def put(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("PUT", url, **options)patch#
patch(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def patch(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("PATCH", url, **options)delete#
delete(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def delete(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("DELETE", url, **options)head#
head(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def head(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("HEAD", url, **options)options#
options(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def options(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("OPTIONS", url, **options)trace#
trace(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def trace(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("TRACE", url, **options)query#
query(url, **options) -> HttpClientRequest| Parameter | Type | Description |
|---|---|---|
url | UrlInput | |
options | Unpack[RequestOptions] = {} |
Returns HttpClientRequest
def query(url: UrlInput, **options: Unpack[RequestOptions]) -> HttpClientRequest:
return make("QUERY", url, **options)schema_body_json#
schema_body_json[T, RE](schema, **parse_options) -> Callable[[HttpClientRequest, T], Effect[HttpClientRequest, _body.HttpBodyError, RE]]A setter of JSON bodies encoded by schema:
schema_body_json(Todo)(request, todo).
| Parameter | Type | Description |
|---|---|---|
schema | Codec[T, object, object, RE] | |
parse_options | Unpack[ParseOptions] = {} |
Returns Callable[[HttpClientRequest, T], Effect[HttpClientRequest, _body.HttpBodyError, RE]]
def schema_body_json[T, RE](
schema: Codec[T, object, object, RE], **parse_options: Unpack[ParseOptions]
) -> Callable[[HttpClientRequest, T], Effect[HttpClientRequest, _body.HttpBodyError, RE]]:
"""A setter of JSON bodies encoded by ``schema``:
``schema_body_json(Todo)(request, todo)``."""
encode = _body.json_schema(schema, **parse_options)
return lambda request, value: encode(value, None).map(request.set_body)