Skip to content

Clients

clients ¤

Modules:

Name Description
curl

Classes:

Name Description
RequestLike
HeadersLike
ResponseLike
HTTPStatusError
AsyncClientLike

Functions:

Name Description
default_client

Attributes:

Name Type Description
QueryScalar
QueryValue

QueryScalar module-attribute ¤

QueryScalar = Union[str, int, float, bool]

QueryValue module-attribute ¤

QueryValue = Union[QueryScalar, Sequence[QueryScalar]]

RequestLike ¤

Bases: Protocol

Attributes:

Name Type Description
method str

method property ¤

method: str

HeadersLike ¤

Bases: Protocol

Methods:

Name Description
get

get ¤

get(key: str, default: str | None = None) -> str | None

ResponseLike ¤

Bases: Protocol

Methods:

Name Description
json
raise_for_status
aiter_bytes
aclose

Attributes:

Name Type Description
status_code int
headers HeadersLike
content bytes

status_code property ¤

status_code: int

headers property ¤

headers: HeadersLike

content property ¤

content: bytes

json ¤

json() -> object

raise_for_status ¤

raise_for_status() -> object

aiter_bytes ¤

aiter_bytes() -> AsyncIterator[bytes]

aclose async ¤

aclose() -> None

HTTPStatusError ¤

HTTPStatusError(status_code: int)

Bases: Exception

Attributes:

Name Type Description
status_code

status_code instance-attribute ¤

status_code = status_code

AsyncClientLike ¤

Bases: Protocol

Methods:

Name Description
build_request
aclose

Attributes:

Name Type Description
send Callable[..., Awaitable[ResponseLike]]

send property ¤

send: Callable[..., Awaitable[ResponseLike]]

build_request ¤

build_request(
    method: str,
    url: str,
    *,
    content: bytes | None = None,
    data: Mapping[str, str] | None = None,
    headers: Mapping[str, str] | None = None,
    params: Mapping[str, QueryValue] | None = None,
) -> RequestLike

aclose async ¤

aclose() -> None

default_client ¤

default_client() -> AsyncClientLike

curl ¤

Classes:

Name Description
CurlResponse
CurlAsyncClient

CurlResponse ¤

CurlResponse(response: Response)

Bases: ResponseLike

Methods:

Name Description
json
raise_for_status
aiter_bytes
aclose

Attributes:

Name Type Description
status_code int
headers Headers
content bytes
status_code property ¤
status_code: int
headers property ¤
headers: Headers
content property writable ¤
content: bytes
json ¤
json() -> object
raise_for_status ¤
raise_for_status() -> object
aiter_bytes async ¤
aiter_bytes() -> AsyncIterator[bytes]
aclose async ¤
aclose() -> None

CurlAsyncClient ¤

CurlAsyncClient(
    session: AsyncSession[Response] | None = None,
)

Bases: AsyncClientLike

Methods:

Name Description
build_request
send
aclose
__aenter__
__aexit__
build_request ¤
build_request(
    method: str,
    url: str,
    *,
    content: bytes | None = None,
    data: Mapping[str, str] | None = None,
    headers: Mapping[str, str] | None = None,
    params: Mapping[str, QueryValue] | None = None,
) -> Request
send async ¤
send(
    request: Request, *, stream: bool = False
) -> ResponseLike
aclose async ¤
aclose() -> None
__aenter__ async ¤
__aenter__() -> Self
__aexit__ async ¤
__aexit__(*args: object) -> None