API reference

Top level API surface compatible with requests.

exception req2.ConnectionError[source]

The connection to the server failed.

class req2.HTTPAdapter(*, pool_connections=10, pool_maxsize=None, spool_max_size=1048576)[source]

Basic HTTP adapter that drives requests through pycurl.

Parameters:

  • pool_connections (int)

  • pool_maxsize (int | None)

  • spool_max_size (int)

close()[source]
Return type:

None

send(request, *, timeout=None, verify=True, cert=None, stream=False, proxies=None, auth=None)[source]
Parameters:

  • request (PreparedRequest)

  • timeout (float | tuple[float | None, float | None] | None)

  • verify (bool | str)

  • cert (str | tuple[str, str] | None)

  • stream (bool)

  • proxies (dict[str, str] | None)

  • auth (tuple[str, str] | None)

Return type:

tuple[Response, list[tuple[str, str]]]

exception req2.HTTPError[source]

The HTTP response indicated an error.

class req2.PreparedRequest(method, url, headers, body, *, params=None, json=None, files=None, hooks=None)[source]

Prepared request ready for sending.

Parameters:

  • method (str)

  • url (str)

  • headers (Mapping[str, str])

  • body (Any)

  • params (Mapping[str, Any] | None)

  • json (Any)

  • files (Any)

  • hooks (Mapping[str, Iterable[Hook]] | None)

copy()[source]
Return type:

PreparedRequest

prepare_cookies(cookies)[source]
Parameters:

cookies (Mapping[str, str])

Return type:

None

register_hook(event, hook)[source]
Parameters:

  • event (str)

  • hook (Callable[[Response], Any])

Return type:

None

class req2.Request(method, url, headers=None, data=None, params=None, json=None, files=None, hooks=None)[source]

High-level request container mirroring requests.Request.

Parameters:

  • method (str)

  • url (str)

  • headers (Mapping[str, str] | None)

  • data (Any)

  • params (Mapping[str, Any] | None)

  • json (Any)

  • files (Any)

  • hooks (Mapping[str, Iterable[Hook]] | None)

prepare()[source]
Return type:

PreparedRequest

exception req2.RequestException[source]

Base exception for all request errors.

class req2.Response(*, status_code, headers, raw, content, url, reason, elapsed_seconds, timings, request, cookies=None, history=None, stream_consumed=False)[source]

Response container closely mirroring requests.Response.

Parameters:

  • status_code (int)

  • headers (Mapping[str, str])

  • raw (io.BufferedIOBase)

  • content (bytes | None)

  • url (str)

  • reason (str | None)

  • elapsed_seconds (float)

  • timings (Mapping[str, float])

  • request (PreparedRequest)

  • cookies (CookieJar | None)

  • history (Iterable['Response'] | None)

  • stream_consumed (bool)

close()[source]
Return type:

None

property content: bytes
property is_permanent_redirect: bool
property is_redirect: bool
property is_redirectable: bool
iter_content(chunk_size=1024, decode_unicode=False)[source]
Parameters:

  • chunk_size (int)

  • decode_unicode (bool)

Return type:

Iterator[Any]

iter_lines(chunk_size=512, decode_unicode=None, delimiter=None)[source]
Parameters:

  • chunk_size (int)

  • decode_unicode (bool | None)

  • delimiter (bytes | None)

Return type:

Iterator[Any]

json(**kwargs)[source]
Parameters:

kwargs (Any)

Return type:

Any

property ok: bool
raise_for_status()[source]
Return type:

None

property raw: BufferedIOBase
property text: str
property timings: Mapping[str, float]
exception req2.SSLError[source]

SSL negotiation failed.

class req2.Session[source]

Requests-compatible session that executes requests via pycurl.

close()[source]
Return type:

None

delete(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

get(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

get_adapter(url)[source]
Parameters:

url (str)

Return type:

HTTPAdapter

head(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

merge_environment_settings(url, proxies, stream, verify, cert)[source]
Parameters:

  • url (str)

  • proxies (Mapping[str, str] | None)

  • stream (bool)

  • verify (bool | str)

  • cert (str | tuple[str, str] | None)

Return type:

dict[str, Any]

mount(prefix, adapter)[source]
Parameters:
Return type:

None

options(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

patch(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

post(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

prepare_request(request)[source]
Parameters:

request (Request)

Return type:

PreparedRequest

put(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

request(method, url, *, params=None, data=None, json=None, files=None, headers=None, cookies=None, timeout=None, allow_redirects=None, verify=None, cert=None, stream=False, proxies=None, auth=None, hooks=None, **kwargs)[source]
Parameters:

  • method (str)

  • url (str)

  • params (Mapping[str, Any] | None)

  • data (Any | None)

  • json (Any | None)

  • files (Mapping[str, Any] | Iterable[tuple[str, Any]] | None)

  • headers (Mapping[str, str] | None)

  • cookies (Mapping[str, str] | CookieJar | None)

  • timeout (float | tuple[float | None, float | None] | None)

  • allow_redirects (bool | None)

  • verify (bool | str | None)

  • cert (str | tuple[str, str] | None)

  • stream (bool)

  • proxies (Mapping[str, str] | None)

  • auth (Any)

  • hooks (Mapping[str, Iterable[Any]] | None)

  • kwargs (Any)

Return type:

Response

send(request, *, timeout=None, allow_redirects=True, verify=True, cert=None, stream=False, proxies=None, auth=None)[source]
Parameters:

  • request (PreparedRequest)

  • timeout (float | tuple[float | None, float | None] | None)

  • allow_redirects (bool)

  • verify (bool | str)

  • cert (str | tuple[str, str] | None)

  • stream (bool)

  • proxies (Mapping[str, str] | None)

  • auth (tuple[str, str] | None)

Return type:

Response

exception req2.Timeout[source]

The request timed out.

exception req2.TooManyRedirects[source]

Exceeded the configured number of redirects.

req2.delete(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.get(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.head(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.options(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.patch(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.post(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.put(url, **kwargs)[source]
Parameters:

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.request(method, url, **kwargs)[source]
Parameters:

  • method (str)

  • url (str)

  • kwargs (Any)

Return type:

Response

req2.session()[source]
Return type:

Session

Sessions

class req2.Session[source]

Requests-compatible session that executes requests via pycurl.

Adapters

class req2.HTTPAdapter(*, pool_connections=10, pool_maxsize=None, spool_max_size=1048576)[source]

Basic HTTP adapter that drives requests through pycurl.

Parameters:

  • pool_connections (int)

  • pool_maxsize (int | None)

  • spool_max_size (int)

Responses

class req2.Response(*, status_code, headers, raw, content, url, reason, elapsed_seconds, timings, request, cookies=None, history=None, stream_consumed=False)[source]

Response container closely mirroring requests.Response.

Parameters:

  • status_code (int)

  • headers (Mapping[str, str])

  • raw (io.BufferedIOBase)

  • content (bytes | None)

  • url (str)

  • reason (str | None)

  • elapsed_seconds (float)

  • timings (Mapping[str, float])

  • request (PreparedRequest)

  • cookies (CookieJar | None)

  • history (Iterable['Response'] | None)

  • stream_consumed (bool)