requests API reference

105 public APIs from requests (psf/requests) — 32 classes, 44 functions, 29 methods. Signatures extracted by static analysis of the actual source.

Repository: psf/requests

Kind	Count
Classes	32
Functions	44
Methods	29

API list

funcsrc.requests._internal_utils.unicode_is_ascii(u_string:str) -> bool

Determine if unicode string only contains ASCII characters.

classsrc.requests._types.DataKwargs

kwargs for put(), patch().

classsrc.requests._types.RequestKwargs

kwargs for request(), options(), head(), delete().

funcsrc.requests._types.has_read(obj:Any) -> TypeIs[SupportsRead[str | bytes]]

Check if obj supports read, including __getattr__ based proxies.

funcsrc.requests._types.is_prepared(request:PreparedRequest) -> TypeIs[_ValidatedRequest]

Verify a PreparedRequest has been fully prepared.

classsrc.requests.adapters.BaseAdapter

The Base Transport Adapter

methodsrc.requests.adapters.BaseAdapter.close() -> None

Cleans up adapter specific items.

method

src.requests.adapters.BaseAdapter.send(request:PreparedRequest, stream:bool=False, timeout:_t.TimeoutType=None, verify:_t.VerifyType=True, cert:_t.CertType=None, proxies:dict[str, str] | None=None) -> Response

Sends PreparedRequest object.

classsrc.requests.adapters.HTTPAdapter

The built-in HTTP Adapter for urllib3.

methodsrc.requests.adapters.HTTPAdapter.add_headers(request:PreparedRequest, **kwargs:Any) -> None

Add any headers needed by the connection.

methodsrc.requests.adapters.HTTPAdapter.cert_verify(conn:Any, url:str, verify:_t.VerifyType, cert:_t.CertType) -> None

Verify a SSL certificate.

methodsrc.requests.adapters.HTTPAdapter.close() -> None

Disposes of any internal state.

method

src.requests.adapters.HTTPAdapter.init_poolmanager(connections:int, maxsize:int, block:bool=DEFAULT_POOLBLOCK, **pool_kwargs:Any) -> None

Initializes a urllib3 PoolManager.

methodsrc.requests.adapters.HTTPAdapter.proxy_manager_for(proxy:str, **proxy_kwargs:Any) -> Any

Return urllib3 ProxyManager for the given proxy.

methodsrc.requests.adapters.HTTPAdapter.request_url(request:PreparedRequest, proxies:dict[str, str] | None) -> str

Obtain the url to use when making the final request.

method

src.requests.adapters.HTTPAdapter.send(request:PreparedRequest, stream:bool=False, timeout:_t.TimeoutType=None, verify:_t.VerifyType=True, cert:_t.CertType=None, proxies:dict[str, str] | None=None) -> Response

Sends PreparedRequest object.

funcsrc.requests.api.delete(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends a DELETE request.

funcsrc.requests.api.get(url:_t.UriType, params:_t.ParamsType=None, **kwargs:Unpack[_t.GetKwargs]) -> Response

Sends a GET request.

funcsrc.requests.api.head(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends a HEAD request.

funcsrc.requests.api.options(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends an OPTIONS request.

funcsrc.requests.api.patch(url:_t.UriType, data:_t.DataType=None, **kwargs:Unpack[_t.DataKwargs]) -> Response

Sends a PATCH request.

func

src.requests.api.post(url:_t.UriType, data:_t.DataType=None, json:_t.JsonType=None, **kwargs:Unpack[_t.PostKwargs]) -> Response

Sends a POST request.

funcsrc.requests.api.put(url:_t.UriType, data:_t.DataType=None, **kwargs:Unpack[_t.DataKwargs]) -> Response

Sends a PUT request.

funcsrc.requests.api.request(method:str, url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Constructs and sends a :class:`Request <Request>`.

classsrc.requests.auth.AuthBase

Base class that all auth implementations derive from

classsrc.requests.auth.HTTPBasicAuth

Attaches HTTP Basic Authentication to the given Request object.

methodsrc.requests.auth.HTTPDigestAuth.build_digest_header(method:str, url:str) -> str | None

:rtype: str

methodsrc.requests.auth.HTTPDigestAuth.handle_401(r:Response, **kwargs:Any) -> Response

Takes the given response and tries digest-auth, if needed.

methodsrc.requests.auth.HTTPDigestAuth.handle_redirect(r:Response, **kwargs:Any) -> None

Reset num_401_calls counter on redirects.

classsrc.requests.auth.HTTPProxyAuth

Attaches HTTP Proxy Authentication to a given Request object.

classsrc.requests.cookies.MockRequest

Wraps a `requests.PreparedRequest` to mimic a `urllib2.Request`.

classsrc.requests.cookies.MockResponse

Wraps a `httplib.HTTPMessage` to mimic a `urllib.addinfourl`.

funcsrc.requests.cookies.create_cookie(name:str, value:str, **kwargs:Any) -> Cookie

Make a cookie from underspecified parameters.

funcsrc.requests.cookies.extract_cookies_to_jar(jar:CookieJar, request:PreparedRequest, response:Any) -> None

Extract the cookies from the response into a CookieJar.

funcsrc.requests.cookies.merge_cookies(cookiejar:CookieJar, cookies:dict[str, str] | CookieJar | None) -> CookieJar

Add cookies to cookiejar and returns a merged CookieJar.

funcsrc.requests.cookies.morsel_to_cookie(morsel:Morsel[Any]) -> Cookie

Convert a Morsel object into a Cookie containing the one k/v pair.

classsrc.requests.exceptions.ConnectionError

A Connection error occurred.

classsrc.requests.exceptions.ContentDecodingError

Failed to decode response content.

classsrc.requests.exceptions.HTTPError

An HTTP error occurred.

classsrc.requests.exceptions.InvalidHeader

The header value provided was somehow invalid.

classsrc.requests.exceptions.InvalidJSONError

A JSON error occurred.

classsrc.requests.exceptions.InvalidProxyURL

The proxy URL provided is invalid.

classsrc.requests.exceptions.InvalidSchema

The URL scheme provided is either invalid or unsupported.

classsrc.requests.exceptions.InvalidURL

The URL provided was somehow invalid.

classsrc.requests.exceptions.JSONDecodeError

Couldn't decode the text into json

classsrc.requests.exceptions.MissingSchema

The URL scheme (e.g.

classsrc.requests.exceptions.ProxyError

A proxy error occurred.

classsrc.requests.exceptions.RequestException

There was an ambiguous exception that occurred while handling your request.

classsrc.requests.exceptions.RequestsWarning

Base warning for Requests.

classsrc.requests.exceptions.RetryError

Custom retries logic failed

classsrc.requests.exceptions.SSLError

An SSL error occurred.

classsrc.requests.exceptions.StreamConsumedError

The content for this response was already consumed.

classsrc.requests.exceptions.Timeout

The request timed out.

classsrc.requests.exceptions.TooManyRedirects

Too many redirects.

classsrc.requests.exceptions.URLRequired

A valid URL is required to make a request.

funcsrc.requests.help.info() -> dict[str, Any]

Generate information for a bug report.

funcsrc.requests.help.main()

Pretty-print the bug information as JSON.

funcsrc.requests.hooks.dispatch_hook(key:str, hooks:_t.HooksInputType | None, hook_data:Response, **kwargs:Any) -> Response

Dispatches a hook dictionary on a given piece of data.

classsrc.requests.models.Request

A user-created :class:`Request <Request>` object.

methodsrc.requests.models.Response.close() -> None

Releases the connection back to the pool.

methodsrc.requests.models.Response.content() -> bytes

Content of the response, in bytes.

methodsrc.requests.models.Response.json(**kwargs:Any) -> Any

Decodes the JSON response body (if any) as a Python object.

methodsrc.requests.models.Response.raise_for_status() -> None

Raises :class:`HTTPError`, if one occurred.

methodsrc.requests.models.Response.text() -> str

Content of the response, in unicode.

classsrc.requests.sessions.Session

A Requests session.

methodsrc.requests.sessions.Session.close() -> None

Closes all adapters and as such the session

methodsrc.requests.sessions.Session.delete(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends a DELETE request.

methodsrc.requests.sessions.Session.get(url:_t.UriType, params:_t.ParamsType=None, **kwargs:Unpack[_t.GetKwargs]) -> Response

Sends a GET request.

methodsrc.requests.sessions.Session.get_adapter(url:str) -> BaseAdapter

Returns the appropriate connection adapter for the given URL.

methodsrc.requests.sessions.Session.head(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends a HEAD request.

methodsrc.requests.sessions.Session.mount(prefix:str, adapter:BaseAdapter) -> None

Registers a connection adapter to a prefix.

methodsrc.requests.sessions.Session.options(url:_t.UriType, **kwargs:Unpack[_t.RequestKwargs]) -> Response

Sends a OPTIONS request.

methodsrc.requests.sessions.Session.patch(url:_t.UriType, data:_t.DataType=None, **kwargs:Unpack[_t.DataKwargs]) -> Response

Sends a PATCH request.

method

src.requests.sessions.Session.post(url:_t.UriType, data:_t.DataType=None, json:_t.JsonType=None, **kwargs:Unpack[_t.PostKwargs]) -> Response

Sends a POST request.

methodsrc.requests.sessions.Session.put(url:_t.UriType, data:_t.DataType=None, **kwargs:Unpack[_t.DataKwargs]) -> Response

Sends a PUT request.

methodsrc.requests.sessions.Session.send(request:PreparedRequest, **kwargs:Any) -> Response

Send a given PreparedRequest.

func

src.requests.sessions.merge_hooks(request_hooks:_t.HooksType, session_hooks:_t.HooksType, dict_class:type=OrderedDict) -> _t.HooksType

Properly merges both requests and session hooks.

funcsrc.requests.sessions.session() -> Session

Returns a :class:`Session` for context-management.

classsrc.requests.structures.CaseInsensitiveDict

A case-insensitive ``dict``-like object.

methodsrc.requests.structures.CaseInsensitiveDict.lower_items() -> Iterator[tuple[str, _VT]]

Like iteritems(), but with all lowercase keys.

classsrc.requests.structures.LookupDict

Dictionary lookup object.

funcsrc.requests.utils.add_dict_to_cookiejar(cj:CookieJar, cookie_dict:dict[str, str]) -> CookieJar

Returns a CookieJar from a key/value dictionary.

funcsrc.requests.utils.atomic_open(filename:str) -> Generator[BufferedWriter, None, None]

Write a file to the disk in an atomic fashion

funcsrc.requests.utils.default_headers() -> CaseInsensitiveDict[str]

:rtype: requests.structures.CaseInsensitiveDict

funcsrc.requests.utils.default_user_agent(name:str='python-requests') -> str

Return a string representing the default user agent.

funcsrc.requests.utils.dict_from_cookiejar(cj:CookieJar) -> dict[str, str | None]

Returns a key/value dictionary from a CookieJar.

func

src.requests.utils.dict_to_sequence(d:_t.SupportsItems[Any, Any] | Iterable[tuple[Any, Any]]) -> Iterable[tuple[Any, Any]]

Returns an internal sequence dictionary update.

funcsrc.requests.utils.get_encoding_from_headers(headers:CaseInsensitiveDict[str]) -> str | None

Returns encodings from given HTTP Header Dict.

funcsrc.requests.utils.get_encodings_from_content(content:str) -> list[str]

Returns encodings from given content string.

funcsrc.requests.utils.get_environ_proxies(url:str, no_proxy:str | None=None) -> dict[str, str]

Return a dict of environment proxies.

funcsrc.requests.utils.get_netrc_auth(url:_t.UriType, raise_errors:bool=False) -> tuple[str, str] | None

Returns the Requests tuple auth for a given url from netrc.

funcsrc.requests.utils.get_unicode_from_response(r:Response) -> str | bytes | None

Returns the requested content back in unicode.

funcsrc.requests.utils.guess_filename(obj:Any) -> str | None

Tries to guess the filename of the given object.

funcsrc.requests.utils.guess_json_utf(data:bytes) -> str | None

:rtype: str

funcsrc.requests.utils.is_ipv4_address(string_ip:str) -> bool

:rtype: bool

funcsrc.requests.utils.is_valid_cidr(string_network:str) -> bool

Very simple check of the cidr format in no_proxy variable.

funcsrc.requests.utils.parse_header_links(value:str) -> list[dict[str, str]]

Return a list of parsed link headers proxies.

funcsrc.requests.utils.parse_list_header(value:str) -> list[str]

Parse lists as described by RFC 2068 Section 2.

funcsrc.requests.utils.proxy_bypass(host:str) -> bool

Return True, if the host should be bypassed.

funcsrc.requests.utils.requote_uri(uri:str) -> str

Re-quote the given URI.

funcsrc.requests.utils.select_proxy(url:str, proxies:dict[str, str] | None) -> str | None

Select a proxy for the url, if applicable.

funcsrc.requests.utils.should_bypass_proxies(url:str, no_proxy:str | None) -> bool

Returns whether we should bypass proxies or not.

func

src.requests.utils.stream_decode_response_unicode(iterator:Iterable[bytes], r:Response) -> Generator[str | bytes, None, None]

Stream decodes an iterator.

funcsrc.requests.utils.unquote_header_value(value:str, is_filename:bool=False) -> str

Unquotes a header value.

funcsrc.requests.utils.urldefragauth(url:str) -> str

Given a url remove the fragment and the authentication part.

About this data

These signatures were extracted from the public source of psf/requests using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries