Types

All core type hints to use throughout the entire package.

Classes:

RequestKwargs

TypedDict for kwargs relating to an HTTP request.

class aiorequestful.types.RequestKwargs

Bases: TypedDict

TypedDict for kwargs relating to an HTTP request.

Arguments passed through to .aiohttp.ClientSession.request. See aiohttp reference for more info on available kwargs: https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession.request

Attributes:

`method`
`url`
`params`
`data`
`json`
`cookies`
`headers`
`skip_auto_headers`
`auth`
`allow_redirects`
`max_redirects`
`compress`
`chunked`
`expect100`
`raise_for_status`
`read_until_eof`
`proxy`
`proxy_auth`
`timeout`
`verify_ssl`
`fingerprint`
`ssl_context`
`ssl`
`server_hostname`
`proxy_headers`
`trace_request_ctx`
`read_bufsize`
`auto_decompress`
`max_line_size`
`max_field_size`

method: MethodInput

url: URLInput

params: NotRequired[Mapping[str, str]]

data: NotRequired[Any]

json: NotRequired[Any]

cookies: NotRequired[LooseCookies]

headers: NotRequired[LooseHeaders]

skip_auto_headers: NotRequired[Iterable[str]]

auth: NotRequired[BasicAuth]

allow_redirects: NotRequired[bool]

max_redirects: NotRequired[int]

compress: NotRequired[str]

chunked: NotRequired[bool]

expect100: NotRequired[bool]

raise_for_status: NotRequired[Union[bool, Callable[[ClientResponse], Awaitable[None]]]]

read_until_eof: NotRequired[bool]

proxy: NotRequired[StrOrURL]

proxy_auth: NotRequired[BasicAuth]

timeout: NotRequired[Union[ClientTimeout, _SENTINEL]]

verify_ssl: NotRequired[bool]

fingerprint: NotRequired[bytes]

ssl_context: NotRequired[SSLContext]

ssl: NotRequired[Union[SSLContext, bool, Fingerprint]]

server_hostname: NotRequired[str]

proxy_headers: NotRequired[LooseHeaders]

trace_request_ctx: NotRequired[SimpleNamespace]

read_bufsize: NotRequired[int]

auto_decompress: NotRequired[bool]

max_line_size: NotRequired[int]

max_field_size: NotRequired[int]